Crate bevy_screen_diagnostics

bevy_screen_diagnostics

Display bevy diagnostics on the window without any hassle.

What this can do:

• easy frame and entity dignostics
• add custom diagnostics
• change display of diagnostics on the fly
• toggle diagnostics easily

see the examples on how to do this.

Quickstart

This adds the framerate and frametime diagnostics to your window.

use bevy::prelude::*;

use bevy_screen_diagnostics::{ScreenDiagnosticsPlugin, ScreenFrameDiagnosticsPlugin};

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(ScreenDiagnosticsPlugin::default())
        .add_plugins(ScreenFrameDiagnosticsPlugin)
        .add_startup_system(setup_camera)
        .run();
}

fn setup_camera(mut commands: Commands) {
    commands.spawn(Camera2dBundle::default());
}

The ScreenFrameDiagnosticsPlugin is a very simple plugin

Plugins

bevy_screen_diagnostics provides the following bevy plugins:

• ScreenDiagnostics which offers the basic functionality of displaying diagnostics.
• ScreenFrameDiagnosticsPlugin display the framerate and frametime (also adds the corresponding bevy diagnostic plugin)
• ScreenEntityDiagnosticsPlugin display the amount of entities (also adds the corresponding bevy diagnostic plugin)

Font

This crate uses bevy’s default font (a stripped version of FiraCode) through the builtin-font default feature. You can provide your own font while initialising the ScreenDiagnosticsPlugin by passing it a asset file path.

compatible bevy versions

bevy	bevy_screen_diagnostics
0.13	0.5
0.12	0.4
0.11	0.3
0.10	0.2
0.9	0.1

Structs

• DiagnosticsTextBuilder
  Builder-like interface for a [DiagnosticsText].
• ScreenDiagnostics
  Resource which maps the name to the [DiagnosticPath], Aggregate and [ConvertFn]
• ScreenDiagnosticsPlugin
  Plugin for displaying Diagnostics on screen.
• ScreenEntityDiagnosticsPlugin
  Plugin which adds the bevy [EntityCountDiagnosticsPlugin] and adds its diagnostics to [DiagnosticsText]
• ScreenFrameDiagnosticsPlugin
  Plugin which adds the bevy [FrameTimeDiagnosticsPlugin] and adds its diagnostics to [DiagnosticsText]

Enums

• Aggregate
  Aggregaes which can be used for displaying Diagnostics.

Type Aliases

• FormatFn
  Type alias for the fuction used to format a diagnostic value to a string.