Skip to content

Commit a985fdf

Browse files
committed
fix README and make bevy_render a dev dependency
- so that README generation works
1 parent 496d2ca commit a985fdf

98 files changed

Lines changed: 19911 additions & 13174 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Cargo.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,15 @@ lexopt = { version = "0.3.0", optional = true }
2626

2727
[dev-dependencies]
2828
bevy = { version = "0.19.0-dev" }
29+
bevy_render = { version = "0.19.0-dev" }
2930

3031
[patch.crates-io]
3132
# bevy_ecs = { path = "../bevy/crates/bevy_ecs" }
3233
# bevy_app = { path = "../bevy/crates/bevy_app" }
3334
# bevy_color = { path = "../bevy/crates/bevy_color" }
3435
# bevy_log = { path = "../bevy/crates/bevy_log" }
3536
# bevy_platform = { path = "../bevy/crates/bevy_platform" }
37+
# bevy_render = { path = "../bevy/crates/bevy_render" }
3638
# bevy_utils = { path = "../bevy/crates/bevy_utils" }
3739
# bevy = { path = "../bevy" }
3840
bevy = { git = "https://github.com/bevyengine/bevy" }

README.md

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ $ cargo run -- --help
2121
Commands:
2222
2323
dump-schedule <schedule_name> <file>
24-
dump-render <file>
2524
2625
--no-exit Do not exit after performing debugdump action
2726
```
@@ -51,24 +50,6 @@ See all schedules at [docs/schedule](./docs/schedule/README.md).
5150

5251
## Render app
5352

54-
### Render graph
55-
56-
```rust
57-
use bevy::prelude::*;
58-
use bevy::log::LogPlugin;
59-
60-
fn main() {
61-
let mut app = App::new();
62-
app.add_plugins(DefaultPlugins.build().disable::<LogPlugin>());
63-
bevy_mod_debugdump::print_render_graph(&mut app);
64-
}
65-
```
66-
67-
<picture>
68-
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/render/dark/render_graph.dot.svg">
69-
<img alt="render graph" src="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/render/light/render_graph.dot.svg">
70-
</picture>
71-
7253
### Extract schedule
7354

7455
<picture>

docs/render/dark/render_graph.dot

Lines changed: 0 additions & 151 deletions
This file was deleted.

docs/render/dark/render_graph.dot.svg

Lines changed: 0 additions & 804 deletions
This file was deleted.

docs/render/light/render_graph.dot

Lines changed: 0 additions & 151 deletions
This file was deleted.

docs/render/light/render_graph.dot.svg

Lines changed: 0 additions & 804 deletions
This file was deleted.

docs/schedule/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,20 @@
135135

136136
# Render App
137137

138+
## Core2d
139+
140+
<picture>
141+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/schedule/dark/render_schedule_Core2d.dot.svg">
142+
<img alt="Core2d" src="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/schedule/light/render_schedule_Core2d.dot.svg">
143+
</picture>
144+
145+
## Core3d
146+
147+
<picture>
148+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/schedule/dark/render_schedule_Core3d.dot.svg">
149+
<img alt="Core3d" src="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/schedule/light/render_schedule_Core3d.dot.svg">
150+
</picture>
151+
138152
## ExtractSchedule
139153

140154
<picture>
@@ -149,6 +163,20 @@
149163
<img alt="Render" src="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/schedule/light/render_schedule_Render.dot.svg">
150164
</picture>
151165

166+
## RenderGraph
167+
168+
<picture>
169+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/schedule/dark/render_schedule_RenderGraph.dot.svg">
170+
<img alt="RenderGraph" src="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/schedule/light/render_schedule_RenderGraph.dot.svg">
171+
</picture>
172+
173+
## RenderRecovery
174+
175+
<picture>
176+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/schedule/dark/render_schedule_RenderRecovery.dot.svg">
177+
<img alt="RenderRecovery" src="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/schedule/light/render_schedule_RenderRecovery.dot.svg">
178+
</picture>
179+
152180
## RenderStartup
153181

154182
<picture>
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
digraph "" {
2+
"compound"="true";
3+
"splines"="spline";
4+
"rankdir"="LR";
5+
"bgcolor"="#0d1117";
6+
"fontname"="Helvetica";
7+
"nodesep"="0.15";
8+
edge ["penwidth"="2"];
9+
node ["shape"="box", "style"="filled"];
10+
subgraph "clusternode_Set(SystemSetKey(1v1))" {
11+
"style"="rounded,filled";
12+
"label"="Prepass";
13+
"tooltip"="Prepass";
14+
"fillcolor"="#ffffff44";
15+
"fontcolor"="#ffffff";
16+
"color"="#ffffff50";
17+
"penwidth"="2";
18+
"set_marker_node_Set(SystemSetKey(1v1))" ["style"="invis", "label"="", "shape"="point"]
19+
}
20+
21+
subgraph "clusternode_Set(SystemSetKey(2v1))" {
22+
"style"="rounded,filled";
23+
"label"="MainPass";
24+
"tooltip"="MainPass";
25+
"fillcolor"="#ffffff44";
26+
"fontcolor"="#ffffff";
27+
"color"="#ffffff50";
28+
"penwidth"="2";
29+
"set_marker_node_Set(SystemSetKey(2v1))" ["style"="invis", "label"="", "shape"="point"]
30+
"node_System(SystemKey(1v1))" ["label"="main_opaque_pass_2d", "tooltip"="bevy_core_pipeline::core_2d::main_opaque_pass_2d_node::main_opaque_pass_2d", "fillcolor"="#eff1f3", "fontname"="Helvetica", "fontcolor"="#15191d", "color"="#b4bec7", "penwidth"="1"]
31+
"node_System(SystemKey(2v1))" ["label"="main_transparent_pass_2d", "tooltip"="bevy_core_pipeline::core_2d::main_transparent_pass_2d_node::main_transparent_pass_2d", "fillcolor"="#eff1f3", "fontname"="Helvetica", "fontcolor"="#15191d", "color"="#b4bec7", "penwidth"="1"]
32+
}
33+
34+
subgraph "clusternode_Set(SystemSetKey(3v1))" {
35+
"style"="rounded,filled";
36+
"label"="EarlyPostProcess";
37+
"tooltip"="EarlyPostProcess";
38+
"fillcolor"="#ffffff44";
39+
"fontcolor"="#ffffff";
40+
"color"="#ffffff50";
41+
"penwidth"="2";
42+
"set_marker_node_Set(SystemSetKey(3v1))" ["style"="invis", "label"="", "shape"="point"]
43+
}
44+
45+
subgraph "clusternode_Set(SystemSetKey(4v1))" {
46+
"style"="rounded,filled";
47+
"label"="PostProcess";
48+
"tooltip"="PostProcess";
49+
"fillcolor"="#ffffff44";
50+
"fontcolor"="#ffffff";
51+
"color"="#ffffff50";
52+
"penwidth"="2";
53+
"set_marker_node_Set(SystemSetKey(4v1))" ["style"="invis", "label"="", "shape"="point"]
54+
"node_System(SystemKey(3v1))" ["label"="tonemapping", "tooltip"="bevy_core_pipeline::tonemapping::node::tonemapping", "fillcolor"="#eff1f3", "fontname"="Helvetica", "fontcolor"="#15191d", "color"="#b4bec7", "penwidth"="1"]
55+
"node_System(SystemKey(6v1))" ["label"="bloom", "tooltip"="bevy_post_process::bloom::bloom", "fillcolor"="#eff1f3", "fontname"="Helvetica", "fontcolor"="#15191d", "color"="#b4bec7", "penwidth"="1"]
56+
"node_System(SystemKey(8v1))" ["label"="fxaa", "tooltip"="bevy_anti_alias::fxaa::node::fxaa", "fillcolor"="#eff1f3", "fontname"="Helvetica", "fontcolor"="#15191d", "color"="#b4bec7", "penwidth"="1"]
57+
"node_System(SystemKey(9v1))" ["label"="smaa", "tooltip"="bevy_anti_alias::smaa::smaa", "fillcolor"="#eff1f3", "fontname"="Helvetica", "fontcolor"="#15191d", "color"="#b4bec7", "penwidth"="1"]
58+
"node_System(SystemKey(10v1))" ["label"="cas", "tooltip"="bevy_anti_alias::contrast_adaptive_sharpening::node::cas", "fillcolor"="#eff1f3", "fontname"="Helvetica", "fontcolor"="#15191d", "color"="#b4bec7", "penwidth"="1"]
59+
}
60+
61+
"node_System(SystemKey(4v1))" ["label"="upscaling", "tooltip"="bevy_core_pipeline::upscaling::node::upscaling"]
62+
"node_System(SystemKey(5v1))" ["label"="msaa_writeback", "tooltip"="bevy_post_process::msaa_writeback::msaa_writeback"]
63+
"node_System(SystemKey(7v1))" ["label"="post_processing", "tooltip"="bevy_post_process::effect_stack::post_processing"]
64+
"node_System(SystemKey(11v1))" ["label"="ui_pass", "tooltip"="bevy_ui_render::render_pass::ui_pass"]
65+
"node_System(SystemKey(7v1))" -> "node_System(SystemKey(3v1))" ["lhead"="", "ltail"="", "tooltip"="post_processing → SystemTypeSet:bevy_core_pipeline::tonemapping::node::tonemapping", "color"="#eede00"]
66+
"set_marker_node_Set(SystemSetKey(1v1))" -> "set_marker_node_Set(SystemSetKey(2v1))" ["lhead"="clusternode_Set(SystemSetKey(2v1))", "ltail"="clusternode_Set(SystemSetKey(1v1))", "tooltip"="Prepass → MainPass", "color"="#881877"]
67+
"node_System(SystemKey(3v1))" -> "node_System(SystemKey(8v1))" ["lhead"="", "ltail"="", "tooltip"="SystemTypeSet:bevy_core_pipeline::tonemapping::node::tonemapping → fxaa", "color"="#00b0cc"]
68+
"set_marker_node_Set(SystemSetKey(3v1))" -> "set_marker_node_Set(SystemSetKey(4v1))" ["lhead"="clusternode_Set(SystemSetKey(4v1))", "ltail"="clusternode_Set(SystemSetKey(3v1))", "tooltip"="EarlyPostProcess → PostProcess", "color"="#aa3a55"]
69+
"node_System(SystemKey(6v1))" -> "node_System(SystemKey(3v1))" ["lhead"="", "ltail"="", "tooltip"="bloom → SystemTypeSet:bevy_core_pipeline::tonemapping::node::tonemapping", "color"="#44d488"]
70+
"node_System(SystemKey(11v1))" -> "node_System(SystemKey(4v1))" ["lhead"="", "ltail"="", "tooltip"="ui_pass → SystemTypeSet:bevy_core_pipeline::upscaling::node::upscaling", "color"="#0090cc"]
71+
"node_System(SystemKey(1v1))" -> "node_System(SystemKey(2v1))" ["lhead"="", "ltail"="", "tooltip"="main_opaque_pass_2d → main_transparent_pass_2d", "color"="#ee9e44"]
72+
"set_marker_node_Set(SystemSetKey(4v1))" -> "node_System(SystemKey(4v1))" ["lhead"="", "ltail"="clusternode_Set(SystemSetKey(4v1))", "tooltip"="PostProcess → upscaling", "color"="#663699"]
73+
"set_marker_node_Set(SystemSetKey(4v1))" -> "node_System(SystemKey(11v1))" ["lhead"="", "ltail"="clusternode_Set(SystemSetKey(4v1))", "tooltip"="PostProcess → ui_pass", "color"="#3363bb"]
74+
"node_System(SystemKey(5v1))" -> "set_marker_node_Set(SystemSetKey(2v1))" ["lhead"="clusternode_Set(SystemSetKey(2v1))", "ltail"="", "tooltip"="msaa_writeback → MainPass", "color"="#22c2bb"]
75+
"node_System(SystemKey(6v1))" -> "node_System(SystemKey(7v1))" ["lhead"="", "ltail"="", "tooltip"="SystemTypeSet:bevy_post_process::bloom::bloom → post_processing", "color"="#99d955"]
76+
"node_System(SystemKey(8v1))" -> "node_System(SystemKey(10v1))" ["lhead"="", "ltail"="", "tooltip"="SystemTypeSet:bevy_anti_alias::fxaa::node::fxaa → cas", "color"="#eede00"]
77+
"node_System(SystemKey(3v1))" -> "node_System(SystemKey(9v1))" ["lhead"="", "ltail"="", "tooltip"="SystemTypeSet:bevy_core_pipeline::tonemapping::node::tonemapping → smaa", "color"="#881877"]
78+
"node_System(SystemKey(9v1))" -> "node_System(SystemKey(10v1))" ["lhead"="", "ltail"="", "tooltip"="SystemTypeSet:bevy_anti_alias::smaa::smaa → cas", "color"="#00b0cc"]
79+
"set_marker_node_Set(SystemSetKey(2v1))" -> "set_marker_node_Set(SystemSetKey(3v1))" ["lhead"="clusternode_Set(SystemSetKey(3v1))", "ltail"="clusternode_Set(SystemSetKey(2v1))", "tooltip"="MainPass → EarlyPostProcess", "color"="#aa3a55"]
80+
}

0 commit comments

Comments
 (0)