bevy_mod_debugdump 0.13.0

Visualization tools for bevy
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

# bevy_mod_debugdump
![Crates.io](https://img.shields.io/crates/v/bevy_mod_debugdump)
![Crates.io](https://img.shields.io/crates/d/bevy_mod_debugdump)

Live playground: [jakobhellermann.github.io/bevy_mod_debugdump](https://jakobhellermann.github.io/bevy_mod_debugdump)

```rust
use bevy::prelude::*;
use bevy::log::LogPlugin;

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(bevy_mod_debugdump::CommandLineArgs)
        .run()
}
```

```
$ cargo run -- --help
Commands:

dump-schedule <schedule_name> <file>
dump-render <file>

--no-exit Do not exit after performing debugdump action
```


## Schedule graph

```rust
use bevy::prelude::*;
use bevy::log::LogPlugin;

fn main() {
    let mut app = App::new();
    app.add_plugins(DefaultPlugins.build().disable::<LogPlugin>()); // disable LogPlugin so that you can pipe the output directly into `dot -Tsvg`
    bevy_mod_debugdump::print_schedule_graph(&mut app, Update);
}
```

`PreUpdate` schedule:

<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/schedule/dark/schedule_PreUpdate.dot.svg">
<img alt="Main (filtered)" src="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/schedule/light/schedule_PreUpdate.dot.svg">
</picture>

See all schedules at [docs/schedule](./docs/schedule/README.md).

## Render app

### Render graph

```rust
use bevy::prelude::*;
use bevy::log::LogPlugin;

fn main() {
    let mut app = App::new();
    app.add_plugins(DefaultPlugins.build().disable::<LogPlugin>()); 
    bevy_mod_debugdump::print_render_graph(&mut app);
}
```

<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/render/dark/render_graph.dot.svg">
<img alt="render graph" src="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/render/light/render_graph.dot.svg">
</picture>

### Extract schedule

<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/schedule/dark/render_schedule_ExtractSchedule.dot.svg">
<img alt="ExtractSchedule" src="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/schedule/light/render_schedule_ExtractSchedule.dot.svg" height=512>
</picture>

### Main render schedule

<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/schedule/dark/render_schedule_Render.dot.svg">
<img alt="Main" src="https://raw.githubusercontent.com/jakobhellermann/bevy_mod_debugdump/main/docs/schedule/light/render_schedule_Render.dot.svg">
</picture>


## Bevy support table

|bevy|bevy\_mod\_debugdump|
|---|---|
|0.16|0.13|
|0.15|0.12|
|0.14|0.11|
|0.13|0.10|
|0.12|0.9|
|0.11|0.8|
|0.10|0.7|
|0.9|0.6|
|0.8|0.5|
|0.7|0.4|
|0.6|0.3|
|0.5|0.2|
|0.5|0.1|