Struct RenderDiagnosticsPlugin

pub struct RenderDiagnosticsPlugin;

Enables collecting render diagnostics, such as CPU/GPU elapsed time per render pass, as well as pipeline statistics (number of primitives, number of shader invocations, etc).

To access the diagnostics, you can use DiagnosticsStore resource, or add LogDiagnosticsPlugin.

To record diagnostics in your own passes:

1. First, obtain the diagnostic recorder using RenderContext::diagnostic_recorder.

   It won’t do anything unless RenderDiagnosticsPlugin is present, so you’re free to omit #[cfg] clauses.

   let diagnostics = render_context.diagnostic_recorder();

2. Begin the span inside a command encoder, or a render/compute pass encoder.

   let time_span = diagnostics.time_span(render_context.command_encoder(), "shadows");

3. End the span, providing the same encoder.

   time_span.end(render_context.command_encoder());

Supported platforms

Timestamp queries and pipeline statistics are currently supported only on Vulkan and DX12. On other platforms (Metal, WebGPU, WebGL2) only CPU time will be recorded.

Trait Implementations

impl Default for RenderDiagnosticsPlugin

fn default() -> RenderDiagnosticsPlugin

Returns the “default value” for a type.

impl Plugin for RenderDiagnosticsPlugin

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.