Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
# Objective - Part of #12351 - Add fps overlay ## Solution - Create `FpsOverlayPlugin` - Allow for configuration through resource `FpsOverlayConfig` - Allow for configuration during runtime ### Preview on default settings  --------- Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
- Loading branch information
1 parent
27215b7
commit 2d29954
Showing
6 changed files
with
190 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| //! Module containing logic for FPS overlay. | ||
|
|
||
| use bevy_app::{Plugin, Startup, Update}; | ||
| use bevy_asset::Handle; | ||
| use bevy_color::Color; | ||
| use bevy_diagnostic::{DiagnosticsStore, FrameTimeDiagnosticsPlugin}; | ||
| use bevy_ecs::{ | ||
| component::Component, | ||
| query::With, | ||
| schedule::{common_conditions::resource_changed, IntoSystemConfigs}, | ||
| system::{Commands, Query, Res, Resource}, | ||
| }; | ||
| use bevy_text::{Font, Text, TextSection, TextStyle}; | ||
| use bevy_ui::node_bundles::TextBundle; | ||
|
|
||
| /// A plugin that adds an FPS overlay to the Bevy application. | ||
| /// | ||
| /// This plugin will add the [`FrameTimeDiagnosticsPlugin`] if it wasn't added before. | ||
| /// | ||
| /// Note: It is recommended to use native overlay of rendering statistics when possible for lower overhead and more accurate results. | ||
| /// The correct way to do this will vary by platform: | ||
| /// - **Metal**: setting env variable `MTL_HUD_ENABLED=1` | ||
| #[derive(Default)] | ||
| pub struct FpsOverlayPlugin { | ||
| /// Starting configuration of overlay, this can be later be changed through [`FpsOverlayConfig`] resource. | ||
| pub config: FpsOverlayConfig, | ||
| } | ||
|
|
||
| impl Plugin for FpsOverlayPlugin { | ||
| fn build(&self, app: &mut bevy_app::App) { | ||
| // TODO: Use plugin dependencies, see https://github.com/bevyengine/bevy/issues/69 | ||
| if !app.is_plugin_added::<FrameTimeDiagnosticsPlugin>() { | ||
| app.add_plugins(FrameTimeDiagnosticsPlugin); | ||
| } | ||
| app.insert_resource(self.config.clone()) | ||
| .add_systems(Startup, setup) | ||
| .add_systems( | ||
| Update, | ||
| ( | ||
| customize_text.run_if(resource_changed::<FpsOverlayConfig>), | ||
| update_text, | ||
| ), | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| /// Configuration options for the FPS overlay. | ||
| #[derive(Resource, Clone)] | ||
| pub struct FpsOverlayConfig { | ||
| /// Configuration of text in the overlay. | ||
| pub text_config: TextStyle, | ||
| } | ||
|
|
||
| impl Default for FpsOverlayConfig { | ||
| fn default() -> Self { | ||
| FpsOverlayConfig { | ||
| text_config: TextStyle { | ||
| font: Handle::<Font>::default(), | ||
| font_size: 32.0, | ||
| color: Color::WHITE, | ||
| }, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #[derive(Component)] | ||
| struct FpsText; | ||
|
|
||
| fn setup(mut commands: Commands, overlay_config: Res<FpsOverlayConfig>) { | ||
| commands.spawn(( | ||
| TextBundle::from_sections([ | ||
| TextSection::new("FPS: ", overlay_config.text_config.clone()), | ||
| TextSection::from_style(overlay_config.text_config.clone()), | ||
| ]), | ||
| FpsText, | ||
| )); | ||
| } | ||
|
|
||
| fn update_text(diagnostic: Res<DiagnosticsStore>, mut query: Query<&mut Text, With<FpsText>>) { | ||
| for mut text in &mut query { | ||
| if let Some(fps) = diagnostic.get(&FrameTimeDiagnosticsPlugin::FPS) { | ||
| if let Some(value) = fps.smoothed() { | ||
| text.sections[1].value = format!("{value:.2}"); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| fn customize_text( | ||
| overlay_config: Res<FpsOverlayConfig>, | ||
| mut query: Query<&mut Text, With<FpsText>>, | ||
| ) { | ||
| for mut text in &mut query { | ||
| for section in text.sections.iter_mut() { | ||
| section.style = overlay_config.text_config.clone(); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| //! Showcase how to use and configure FPS overlay. | ||
|
|
||
| use bevy::{ | ||
| dev_tools::fps_overlay::{FpsOverlayConfig, FpsOverlayPlugin}, | ||
| prelude::*, | ||
| }; | ||
|
|
||
| fn main() { | ||
| App::new() | ||
| .add_plugins(( | ||
| DefaultPlugins, | ||
| FpsOverlayPlugin { | ||
| config: FpsOverlayConfig { | ||
| text_config: TextStyle { | ||
| // Here we define size of our overlay | ||
| font_size: 50.0, | ||
| // We can also change color of the overlay | ||
| color: Color::srgb(0.0, 1.0, 0.0), | ||
| // If we want, we can use a custom font | ||
| font: default(), | ||
| }, | ||
| }, | ||
| }, | ||
| )) | ||
| .add_systems(Startup, setup) | ||
| .add_systems(Update, customize_config) | ||
| .run(); | ||
| } | ||
|
|
||
| fn setup(mut commands: Commands) { | ||
| // We need to spawn camera to see overlay | ||
| commands.spawn(Camera2dBundle::default()); | ||
| commands.spawn( | ||
| TextBundle::from_sections([ | ||
| TextSection::new( | ||
| "Press 1 to change color of the overlay.", | ||
| TextStyle { | ||
| font_size: 25.0, | ||
| ..default() | ||
| }, | ||
| ), | ||
| TextSection::new( | ||
| "\nPress 2 to change size of the overlay", | ||
| TextStyle { | ||
| font_size: 25.0, | ||
| ..default() | ||
| }, | ||
| ), | ||
| ]) | ||
| .with_style(Style { | ||
| justify_self: JustifySelf::Center, | ||
| ..default() | ||
| }), | ||
| ); | ||
| } | ||
|
|
||
| fn customize_config(input: Res<ButtonInput<KeyCode>>, mut overlay: ResMut<FpsOverlayConfig>) { | ||
| if input.just_pressed(KeyCode::Digit1) { | ||
| // Changing resource will affect overlay | ||
| overlay.text_config.color = Color::srgb(1.0, 0.0, 0.0); | ||
| } | ||
| if input.just_pressed(KeyCode::Digit2) { | ||
| overlay.text_config.font_size -= 2.0; | ||
| } | ||
| } |