Struct bevy::dev_tools::fps_overlay::FpsOverlayPlugin

pub struct FpsOverlayPlugin {
    pub config: FpsOverlayConfig,
}

A plugin that adds an FPS overlay to the Bevy application.

This plugin will add the FrameTimeDiagnosticsPlugin if it wasn’t added before.

Note: It is recommended to use native overlay of rendering statistics when possible for lower overhead and more accurate results. The correct way to do this will vary by platform:

• Metal: setting env variable MTL_HUD_ENABLED=1

Fields

config: FpsOverlayConfig

Starting configuration of overlay, this can be later be changed through FpsOverlayConfig resource.

Trait Implementations

impl Default for FpsOverlayPlugin

fn default() -> FpsOverlayPlugin

Returns the “default value” for a type.

impl Plugin for FpsOverlayPlugin

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

Configures the App to which this plugin is added.

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 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 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.