Hi,

First thanks for making this package, it is super useful.

I may be wrong, I'm new to Bevy, but there seems to be no easy way to hide and unhide the UI. I feel like this would be a useful feature as it will allow us to incorporate these into in-game settings.

Maybe I just misunderstand something basic about Bevy UI. :)

I wanted a key to toggle the UI, but I get this error:

2024-04-03T02:39:37.117705Z  WARN bevy_ui::layout: Unstyled child in a UI entity hierarchy. You are using an entity without UI components as a child of an entity with UI components, results may be unexpected.
thread 'Compute Task Pool (22)' panicked at /home/emblemparade/.cargo/registry/src/index.crates.io-6f17d22bba15001f/bevy_ui-0.13.1/src/layout/mod.rs:132:60:
called `Option::unwrap()` on a `None` value

My code:

impl Plugin for MyPlugin {
    fn build(&self, app: &mut App) {
        app.init_state::<Mode>()
            .add_plugins((
                FrameTimeDiagnosticsPlugin,
                EntityCountDiagnosticsPlugin,
                SystemInformationDiagnosticsPlugin,
                PerfUiPlugin,
            ))
            .add_systems(Update, handle_input);
    }
}

fn handle_input(
    mut commands: Commands,
    input: Res<ButtonInput<KeyCode>>,
    perfs: Query<Entity, With<PerfUiRoot>>,
) {
    if input.just_pressed(KeyCode::F1) {
        match perfs.get_single() {
            Ok(perf) => {
                println!("remove perf!");
                commands.entity(perf).despawn_recursive();
            }
            Err(_) => {
                println!("perf!");
                commands.spawn(PerfUiCompleteBundle::default());
            }
        }
    }
}

Currently highlighting only changes the font. It is thus only useful if the user has custom fonts.

We could make it so highlighted entries also get a different background color. This would also help bring even more visual attention to them.

Make it possible to create a Perf UI that only displays values, without labels. This should be a setting on the PerfUiRoot which controls whether UI nodes are spawned for the labels column.

Supporting this would allow users to just make a minimalist FPS counter (or any other metric they want to display, using our API) without any extra text.

In custom user entries, they can do whatever they want for the label string.

But the entry types provided by us hardcode their label string.

Make it configurable.

The color of values that use the gradient color helper are the only part of the appearance that is not currently customizable.

It should be possible to configure custom colors and then have the crate lerp between them.

This ofc opens the can of worms re: color lerping and color spaces 😆 😅 😭

Right now, if you try to remove an entry (by removing its component from the root entity), things break. This should be supported / handled properly.

Adding new entries at runtime works just fine.

Right now some settings do not take effect if changed after the UI is already spawned. The stuff that is used as part of UI setup to set the relevant values in Bevy UI components.

• Background colors
• Padding/margins/etc
• Font size
• others?

Current workaround: despawn the UI (do a despawn_recursive on the entity with the PerfUiRoot) and recreate it.

I also accidentally formatted a bunch of stuff due to having format on save in my editor. I can either revert the formatting changes or run cargo fmt in a separate commit depending on what you prefer.

I tested the examples and they all seem to work.

Hello,

Thanks for creating this plugin. It is cool! This PR adds a FAQ section to the README.md file.

It explains why Total CPU and Total RAM can be shown as N/A.

It took me a few minutes before I realized that I had to add PerfUiPlugin seems obvious that there would be a plugin in retrospect but I'm sure more people will make the same mistake I made. Consider adding it to the README :)

It could be useful if there was an easy built-in way to add entries for custom user components or resources containing timers, which could extract the timer value and display it.

Right now all Clock entries are either hardcoded to UTC if the chrono optional dep is disabled or to Localtime if the chrono optional dep is disabled.

Without chrono, we can only display UTC. With chrono, it would be nice to give the user choice over what to display.