mirror of
https://github.com/bevyengine/bevy
synced 2024-11-10 15:14:50 +00:00
320ac65a9e
# Objective Implements #9216 ## Solution - Replace `DiagnosticId` by `DiagnosticPath`. It's pre-hashed using `const-fnv1a-hash` crate, so it's possible to create path in const contexts. --- ## Changelog - Replaced `DiagnosticId` by `DiagnosticPath` - Set default history length to 120 measurements (2 seconds on 60 fps). I've noticed hardcoded constant 20 everywhere and decided to change it to `DEFAULT_MAX_HISTORY_LENGTH` , which is set to new diagnostics by default. To override it, use `with_max_history_length`. ## Migration Guide ```diff - const UNIQUE_DIAG_ID: DiagnosticId = DiagnosticId::from_u128(42); + const UNIQUE_DIAG_PATH: DiagnosticPath = DiagnosticPath::const_new("foo/bar"); - Diagnostic::new(UNIQUE_DIAG_ID, "example", 10) + Diagnostic::new(UNIQUE_DIAG_PATH).with_max_history_length(10) - diagnostics.add_measurement(UNIQUE_DIAG_ID, || 42); + diagnostics.add_measurement(&UNIQUE_DIAG_ID, || 42); ```
45 lines
1.6 KiB
Rust
45 lines
1.6 KiB
Rust
use crate::{Diagnostic, DiagnosticPath, Diagnostics, RegisterDiagnostic};
|
|
use bevy_app::prelude::*;
|
|
use bevy_core::FrameCount;
|
|
use bevy_ecs::prelude::*;
|
|
use bevy_time::{Real, Time};
|
|
|
|
/// Adds "frame time" diagnostic to an App, specifically "frame time", "fps" and "frame count"
|
|
///
|
|
/// # See also
|
|
///
|
|
/// [`LogDiagnosticsPlugin`](crate::LogDiagnosticsPlugin) to output diagnostics to the console.
|
|
#[derive(Default)]
|
|
pub struct FrameTimeDiagnosticsPlugin;
|
|
|
|
impl Plugin for FrameTimeDiagnosticsPlugin {
|
|
fn build(&self, app: &mut bevy_app::App) {
|
|
app.register_diagnostic(Diagnostic::new(Self::FRAME_TIME).with_suffix("ms"))
|
|
.register_diagnostic(Diagnostic::new(Self::FPS))
|
|
.register_diagnostic(Diagnostic::new(Self::FRAME_COUNT).with_smoothing_factor(0.0))
|
|
.add_systems(Update, Self::diagnostic_system);
|
|
}
|
|
}
|
|
|
|
impl FrameTimeDiagnosticsPlugin {
|
|
pub const FPS: DiagnosticPath = DiagnosticPath::const_new("fps");
|
|
pub const FRAME_COUNT: DiagnosticPath = DiagnosticPath::const_new("frame_count");
|
|
pub const FRAME_TIME: DiagnosticPath = DiagnosticPath::const_new("frame_time");
|
|
|
|
pub fn diagnostic_system(
|
|
mut diagnostics: Diagnostics,
|
|
time: Res<Time<Real>>,
|
|
frame_count: Res<FrameCount>,
|
|
) {
|
|
diagnostics.add_measurement(&Self::FRAME_COUNT, || frame_count.0 as f64);
|
|
|
|
let delta_seconds = time.delta_seconds_f64();
|
|
if delta_seconds == 0.0 {
|
|
return;
|
|
}
|
|
|
|
diagnostics.add_measurement(&Self::FRAME_TIME, || delta_seconds * 1000.0);
|
|
|
|
diagnostics.add_measurement(&Self::FPS, || 1.0 / delta_seconds);
|
|
}
|
|
}
|