
# Objective I have an application where I'd like to measure average frame rate over the entire life of the application, and it would be handy if I could just configure this on the existing `FrameTimeDiagnosticsPlugin`. Probably fixes #10948? ## Solution Add `max_history_length` to `FrameTimeDiagnosticsPlugin`, and because `smoothing_factor` seems to be based on history length, add that too. ## Discussion I'm not totally sure that `DEFAULT_MAX_HISTORY_LENGTH` is a great default for `FrameTimeDiagnosticsPlugin` (or any diagnostic?). That's 1/3 of a second at typical game frame rates. Moreover, the default print interval for `LogDiagnosticsPlugin` is 1 second. So when the two are combined, you are printing the average over the last third of the duration between now and the previous print, which seems a bit wonky. (related: #11429) I'm pretty sure this default value discussed and the current value wasn't totally arbitrary though. Maybe it would be nice for `Diagnostic` to have a `with_max_history_length_and_also_calculate_a_good_default_smoothing_factor` method? And then make an explicit smoothing factor in `FrameTimeDiagnosticsPlugin` optional? Or add a `new(max_history_length: usize)` method to `FrameTimeDiagnosticsPlugin` that sets a reasonable default `smoothing_factor`? edit: This one seems like a no-brainer, doing it. ## Alternatives It's really easy to roll your own `FrameTimeDiagnosticsPlugin`, but that might not be super interoperable with, for example, third party FPS overlays. Still, might be the right call. ## Testing `cargo run --example many_sprites` (modified to use a custom `max_history_length`) ## Migration Guide `FrameTimeDiagnosticsPlugin` now contains two fields. Use `FrameTimeDiagnosticsPlugin::default()` to match Bevy's previous behavior or, for example, `FrameTimeDiagnosticsPlugin::new(60)` to configure it.
116 lines
3.3 KiB
Rust
116 lines
3.3 KiB
Rust
//! Simple text rendering benchmark.
|
|
//!
|
|
//! Creates a text block with a single span containing `100_000` glyphs,
|
|
//! and renders it with the UI in a white color and with Text2d in a red color.
|
|
//!
|
|
//! To recompute all text each frame run
|
|
//! `cargo run --example many_glyphs --release recompute-text`
|
|
use argh::FromArgs;
|
|
use bevy::{
|
|
color::palettes::basic::RED,
|
|
diagnostic::{FrameTimeDiagnosticsPlugin, LogDiagnosticsPlugin},
|
|
prelude::*,
|
|
text::{LineBreak, TextBounds},
|
|
window::{PresentMode, WindowResolution},
|
|
winit::{UpdateMode, WinitSettings},
|
|
};
|
|
|
|
#[derive(FromArgs, Resource)]
|
|
/// `many_glyphs` stress test
|
|
struct Args {
|
|
/// don't draw the UI text.
|
|
#[argh(switch)]
|
|
no_ui: bool,
|
|
|
|
/// don't draw the Text2d text.
|
|
#[argh(switch)]
|
|
no_text2d: bool,
|
|
|
|
/// whether to force the text to recompute every frame by triggering change detection.
|
|
#[argh(switch)]
|
|
recompute_text: bool,
|
|
}
|
|
|
|
fn main() {
|
|
// `from_env` panics on the web
|
|
#[cfg(not(target_arch = "wasm32"))]
|
|
let args: Args = argh::from_env();
|
|
#[cfg(target_arch = "wasm32")]
|
|
let args = Args::from_args(&[], &[]).unwrap();
|
|
|
|
let mut app = App::new();
|
|
app.add_plugins((
|
|
DefaultPlugins.set(WindowPlugin {
|
|
primary_window: Some(Window {
|
|
present_mode: PresentMode::AutoNoVsync,
|
|
resolution: WindowResolution::new(1920.0, 1080.0).with_scale_factor_override(1.0),
|
|
..default()
|
|
}),
|
|
..default()
|
|
}),
|
|
FrameTimeDiagnosticsPlugin::default(),
|
|
LogDiagnosticsPlugin::default(),
|
|
))
|
|
.insert_resource(WinitSettings {
|
|
focused_mode: UpdateMode::Continuous,
|
|
unfocused_mode: UpdateMode::Continuous,
|
|
})
|
|
.add_systems(Startup, setup);
|
|
|
|
if args.recompute_text {
|
|
app.add_systems(Update, force_text_recomputation);
|
|
}
|
|
|
|
app.insert_resource(args).run();
|
|
}
|
|
|
|
fn setup(mut commands: Commands, args: Res<Args>) {
|
|
warn!(include_str!("warning_string.txt"));
|
|
|
|
commands.spawn(Camera2d);
|
|
let text_string = "0123456789".repeat(10_000);
|
|
let text_font = TextFont {
|
|
font_size: 4.,
|
|
..Default::default()
|
|
};
|
|
let text_block = TextLayout {
|
|
justify: JustifyText::Left,
|
|
linebreak: LineBreak::AnyCharacter,
|
|
};
|
|
|
|
if !args.no_ui {
|
|
commands
|
|
.spawn(Node {
|
|
width: Val::Percent(100.),
|
|
align_items: AlignItems::Center,
|
|
justify_content: JustifyContent::Center,
|
|
..default()
|
|
})
|
|
.with_children(|commands| {
|
|
commands
|
|
.spawn(Node {
|
|
width: Val::Px(1000.),
|
|
..Default::default()
|
|
})
|
|
.with_child((Text(text_string.clone()), text_font.clone(), text_block));
|
|
});
|
|
}
|
|
|
|
if !args.no_text2d {
|
|
commands.spawn((
|
|
Text2d::new(text_string),
|
|
text_font.clone(),
|
|
TextColor(RED.into()),
|
|
bevy::sprite::Anchor::Center,
|
|
TextBounds::new_horizontal(1000.),
|
|
text_block,
|
|
));
|
|
}
|
|
}
|
|
|
|
fn force_text_recomputation(mut text_query: Query<&mut TextLayout>) {
|
|
for mut block in &mut text_query {
|
|
block.set_changed();
|
|
}
|
|
}
|