bevy_screen_diagnostics 0.8.1

Bevy plugin for displaying diagnostics on screen.
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
104
105
106
107
108
109
110

use bevy::{
    diagnostic::{EntityCountDiagnosticsPlugin, FrameTimeDiagnosticsPlugin},
    prelude::*,
};

use crate::{Aggregate, ScreenDiagnostics};

/// Plugin which adds the bevy [`FrameTimeDiagnosticsPlugin`] and adds its diagnostics to [DiagnosticsText]
///
/// Example: ``16.6 ms/frame 60 fps``
pub struct ScreenFrameDiagnosticsPlugin;

impl Plugin for ScreenFrameDiagnosticsPlugin {
    fn build(&self, app: &mut App) {
        if !app.is_plugin_added::<FrameTimeDiagnosticsPlugin>() {
            app.add_plugins(FrameTimeDiagnosticsPlugin::default());
        }
        app.add_systems(Startup, setup_frame_diagnostics);
    }
}

fn setup_frame_diagnostics(mut diags: ResMut<ScreenDiagnostics>) {
    diags
        .add("fps".to_string(), FrameTimeDiagnosticsPlugin::FPS)
        .aggregate(Aggregate::Value)
        .format(|v| format!("{v:.0}"));

    diags
        .add(
            "ms/frame".to_string(),
            FrameTimeDiagnosticsPlugin::FRAME_TIME,
        )
        .aggregate(Aggregate::MovingAverage(5))
        .format(|v| format!("{v:.2}"));
}

/// Plugin which adds the bevy [`EntityCountDiagnosticsPlugin`] and adds its diagnostics to [DiagnosticsText]
///
/// Example: ``15 entities``
pub struct ScreenEntityDiagnosticsPlugin;

impl Plugin for ScreenEntityDiagnosticsPlugin {
    fn build(&self, app: &mut App) {
        if !app.is_plugin_added::<EntityCountDiagnosticsPlugin>() {
            app.add_plugins(EntityCountDiagnosticsPlugin);
        }
        app.add_systems(Startup, setup_entity_diagnostics);
    }
}

fn setup_entity_diagnostics(mut diags: ResMut<ScreenDiagnostics>) {
    diags
        .add(
            "entities".to_string(),
            EntityCountDiagnosticsPlugin::ENTITY_COUNT,
        )
        .aggregate(Aggregate::Value)
        .format(|v| format!("{v:.0}"));
}
#[cfg(feature = "sysinfo_plugin")]
pub(crate) mod sysinfo_plugin {
    use bevy::{diagnostic::SystemInformationDiagnosticsPlugin, prelude::*};

    use crate::{Aggregate, ScreenDiagnostics};
    /// Plugin which adds the bevy [`SystemInformationDiagnosticsPlugin`] and adds its diagnostics to [DiagnosticsText].
    /// "Total" is the value of the entire machine.
    ///
    /// Example: ``09.8% Memory Total 01.1% Memory 12.5% CPU Total 01.5% CPU``
    pub struct ScreenSystemInformationDiagnosticsPlugin;

    impl Plugin for ScreenSystemInformationDiagnosticsPlugin {
        fn build(&self, app: &mut App) {
            if !app.is_plugin_added::<SystemInformationDiagnosticsPlugin>() {
                app.add_plugins(SystemInformationDiagnosticsPlugin);
            }
            app.add_systems(Startup, setup_systeminfo_diagnostics);
        }
    }

    fn setup_systeminfo_diagnostics(mut diags: ResMut<ScreenDiagnostics>) {
        diags
            .add(
                "CPU".to_string(),
                SystemInformationDiagnosticsPlugin::PROCESS_CPU_USAGE,
            )
            .aggregate(Aggregate::Value)
            .format(|v| format!("{v:0>4.1}%"));
        diags
            .add(
                "Memory".to_string(),
                SystemInformationDiagnosticsPlugin::PROCESS_MEM_USAGE,
            )
            .aggregate(Aggregate::Value)
            .format(|v| format!("{v:0>4.1}%"));
        diags
            .add(
                "CPU Total".to_string(),
                SystemInformationDiagnosticsPlugin::SYSTEM_CPU_USAGE,
            )
            .aggregate(Aggregate::Value)
            .format(|v| format!("{v:0>4.1}%"));
        diags
            .add(
                "Memory Total".to_string(),
                SystemInformationDiagnosticsPlugin::SYSTEM_CPU_USAGE,
            )
            .aggregate(Aggregate::Value)
            .format(|v| format!("{v:0>4.1}%"));
    }
}