Struct CommandLineArgs

pub struct CommandLineArgs;

Check the command line for arguments relevant to this crate.

Dump the render graph

Use dump-render <file.dot> to dump the render graph.

Dump the schedule graph

Use dump-update-schedule <file.dot> to dump the Update schedule graph.

Exit the app

By default the app will exit after performing the dump. If you want to keep the app running, use --no-exit.

Usage

Set up your app as usual. No log disabling required. Add the bevy_mod_debugdump::CommandLineArgs plugin at the end. And run your app.

use bevy::prelude::*;

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        // Include all other setup as normal.
        .add_plugins(bevy_mod_debugdump::CommandLineArgs)
        .run();
}

Trait Implementations

impl Plugin for CommandLineArgs

fn build(&self, _app: &mut App)

Configures the App to which this plugin is added.

fn finish(&self, app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.