bevy_brp_extras 0.18.5

Extra BRP methods for Bevy apps including screenshot, shutdown, and keyboard input capabilities
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

//! FPS diagnostics handler for BRP extras

use bevy::diagnostic::DiagnosticsStore;
use bevy::diagnostic::FrameTimeDiagnosticsPlugin;
use bevy::prelude::*;
use bevy_remote::BrpError;
use bevy_remote::BrpResult;
use bevy_remote::error_codes::INTERNAL_ERROR;
use serde_json::Value;
use serde_json::json;

/// Handler for `get_diagnostics` requests
///
/// Returns FPS and frame time diagnostics from Bevy's `DiagnosticsStore`.
/// Requires `FrameTimeDiagnosticsPlugin` to be installed (done automatically
/// by `BrpExtrasPlugin` when the `diagnostics` feature is enabled).
#[allow(clippy::unnecessary_wraps)]
pub fn handler(In(_params): In<Option<Value>>, world: &mut World) -> BrpResult {
    let Some(store) = world.get_resource::<DiagnosticsStore>() else {
        return Err(BrpError {
            code:    INTERNAL_ERROR,
            message: "DiagnosticsStore not found - FrameTimeDiagnosticsPlugin may not be installed"
                .to_string(),
            data:    None,
        });
    };

    let fps = store.get(&FrameTimeDiagnosticsPlugin::FPS);
    let frame_time = store.get(&FrameTimeDiagnosticsPlugin::FRAME_TIME);
    let frame_count = store.get(&FrameTimeDiagnosticsPlugin::FRAME_COUNT);

    let fps_value = fps.and_then(bevy::diagnostic::Diagnostic::value);
    let fps_avg = fps.and_then(bevy::diagnostic::Diagnostic::average);
    let fps_smoothed = fps.and_then(bevy::diagnostic::Diagnostic::smoothed);
    let fps_history_len = fps.map_or(0, bevy::diagnostic::Diagnostic::history_len);
    let fps_max_history = fps.map_or(0, bevy::diagnostic::Diagnostic::get_max_history_length);
    let fps_duration_secs = fps
        .and_then(bevy::diagnostic::Diagnostic::duration)
        .map(|d| d.as_secs_f64());

    let frame_time_value = frame_time.and_then(bevy::diagnostic::Diagnostic::value);
    let frame_time_avg = frame_time.and_then(bevy::diagnostic::Diagnostic::average);
    let frame_time_smoothed = frame_time.and_then(bevy::diagnostic::Diagnostic::smoothed);

    let total_frames = frame_count.and_then(bevy::diagnostic::Diagnostic::value);

    Ok(json!({
        "fps": {
            "current": fps_value,
            "average": fps_avg,
            "smoothed": fps_smoothed,
            "history_len": fps_history_len,
            "max_history_len": fps_max_history,
            "history_duration_secs": fps_duration_secs,
        },
        "frame_time_ms": {
            "current": frame_time_value,
            "average": frame_time_avg,
            "smoothed": frame_time_smoothed,
        },
        "frame_count": total_frames,
    }))
}