d45ae74286
# Objective - Rebase of https://github.com/bevyengine/bevy/pull/12561 , note that this is blocked on "up-streaming [iyes_perf_ui](https://crates.io/crates/iyes_perf_ui)" , but that work seems to also be stalled > Frame time is often more important to know than FPS but because of the temporal nature of it, just seeing a number is not enough. Seeing a graph that shows the history makes it easier to reason about performance. ## Solution > This PR adds a bar graph of the frame time history. > > Each bar is scaled based on the frame time where a bigger frame time will give a taller and wider bar. > > The color also scales with that frame time where red is at or bellow the minimum target fps and green is at or above the target maximum frame rate. Anything between those 2 values will be interpolated between green and red based on the frame time. > > The algorithm is highly inspired by this article: https://asawicki.info/news_1758_an_idea_for_visualization_of_frame_times ## Testing - Ran `cargo run --example fps_overlay --features="bevy_dev_tools"` --------- Co-authored-by: IceSentry <c.giguere42@gmail.com> Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
96 lines
3.1 KiB
Rust
96 lines
3.1 KiB
Rust
//! Showcase how to use and configure FPS overlay.
|
|
|
|
use bevy::{
|
|
dev_tools::fps_overlay::{FpsOverlayConfig, FpsOverlayPlugin, FrameTimeGraphConfig},
|
|
prelude::*,
|
|
text::FontSmoothing,
|
|
};
|
|
|
|
struct OverlayColor;
|
|
|
|
impl OverlayColor {
|
|
const RED: Color = Color::srgb(1.0, 0.0, 0.0);
|
|
const GREEN: Color = Color::srgb(0.0, 1.0, 0.0);
|
|
}
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins((
|
|
DefaultPlugins,
|
|
FpsOverlayPlugin {
|
|
config: FpsOverlayConfig {
|
|
text_config: TextFont {
|
|
// Here we define size of our overlay
|
|
font_size: 42.0,
|
|
// If we want, we can use a custom font
|
|
font: default(),
|
|
// We could also disable font smoothing,
|
|
font_smoothing: FontSmoothing::default(),
|
|
..default()
|
|
},
|
|
// We can also change color of the overlay
|
|
text_color: OverlayColor::GREEN,
|
|
// We can also set the refresh interval for the FPS counter
|
|
refresh_interval: core::time::Duration::from_millis(100),
|
|
enabled: true,
|
|
frame_time_graph_config: FrameTimeGraphConfig {
|
|
enabled: true,
|
|
// The minimum acceptable fps
|
|
min_fps: 30.0,
|
|
// The target fps
|
|
target_fps: 144.0,
|
|
},
|
|
},
|
|
},
|
|
))
|
|
.add_systems(Startup, setup)
|
|
.add_systems(Update, customize_config)
|
|
.run();
|
|
}
|
|
|
|
fn setup(mut commands: Commands) {
|
|
// We need to spawn a camera (2d or 3d) to see the overlay
|
|
commands.spawn(Camera2d);
|
|
|
|
// Instruction text
|
|
|
|
commands.spawn((
|
|
Text::new(concat!(
|
|
"Press 1 to toggle the overlay color.\n",
|
|
"Press 2 to decrease the overlay size.\n",
|
|
"Press 3 to increase the overlay size.\n",
|
|
"Press 4 to toggle the text visibility.\n",
|
|
"Press 5 to toggle the frame time graph."
|
|
)),
|
|
Node {
|
|
position_type: PositionType::Absolute,
|
|
bottom: Val::Px(12.),
|
|
left: Val::Px(12.),
|
|
..default()
|
|
},
|
|
));
|
|
}
|
|
|
|
fn customize_config(input: Res<ButtonInput<KeyCode>>, mut overlay: ResMut<FpsOverlayConfig>) {
|
|
if input.just_pressed(KeyCode::Digit1) {
|
|
// Changing resource will affect overlay
|
|
if overlay.text_color == OverlayColor::GREEN {
|
|
overlay.text_color = OverlayColor::RED;
|
|
} else {
|
|
overlay.text_color = OverlayColor::GREEN;
|
|
}
|
|
}
|
|
if input.just_pressed(KeyCode::Digit2) {
|
|
overlay.text_config.font_size -= 2.0;
|
|
}
|
|
if input.just_pressed(KeyCode::Digit3) {
|
|
overlay.text_config.font_size += 2.0;
|
|
}
|
|
if input.just_pressed(KeyCode::Digit4) {
|
|
overlay.enabled = !overlay.enabled;
|
|
}
|
|
if input.just_released(KeyCode::Digit5) {
|
|
overlay.frame_time_graph_config.enabled = !overlay.frame_time_graph_config.enabled;
|
|
}
|
|
}
|