PerformanceHud builder

A compact or expanded frame diagnostics surface.

A builder is RenderOnce. Construct and mount it in one expression.

The verified performance-hud scene in studio-dark

The performance-hud scene in studio-light

use gpui_kit::display::performance_hud::PerformanceHud;

Reviewed in performance-hud.

Construct

new(ident: impl Into<Ident>, state: PerformanceHudState) -> Self

Options

Chain onto the value.

expanded(expanded: bool) -> Self
on_expanded(handler: impl Fn(bool, &mut Window, &mut App) + 'static) -> Self

Example · performance-hud

fn performance_hud(_window: &mut Window, cx: &mut App) -> AnyElement {
    let theme = cx.theme().clone();
    let summary = gpui::FrameTimingSummary {
        sample_count: 8,
        frames_per_second: 58.7,
        frame_budget: Duration::from_micros(16_667),
        mean_draw_duration: Duration::from_micros(8_425),
        p95_draw_duration: Duration::from_micros(18_900),
        over_budget_fraction: 0.125,
        mean_invalidations: 1.4,
        mean_dirty_to_draw_duration: Some(Duration::from_micros(10_600)),
        mean_submission_duration: Duration::from_micros(1_200),
        mean_dirty_to_submission_duration: Some(Duration::from_micros(11_800)),
        mean_input_to_submission_duration: Some(Duration::from_micros(13_400)),
        mean_input_events: 1.6,
        draw_durations: [7_200, 7_800, 8_100, 7_600, 9_300, 18_900, 8_000, 8_500]
            .map(Duration::from_micros)
            .into(),
        submission_durations: [900, 1_100, 1_000, 1_200, 1_300, 1_800, 1_100, 1_200]
            .map(Duration::from_micros)
            .into(),
    };
    stack(&theme)
        .w(px(620.0))
        .child(caption(
            &theme,
            "The framework observes existing draws; the controlled HUD only presents the caller's latest summary",
        ))
        .child(
            PerformanceHud::new(
                "scene.performance.ready",
                PerformanceHudState::Ready(summary),
            )
            .expanded(true)
            .on_expanded(|_, _, _| {}),
        )
        .child(
            div()
                .row()
                .items_stretch()
                .gap_token(&theme, Space::Md)
                .child(
                    div().flex_1().min_w_0().child(PerformanceHud::new(
                        "scene.performance.waiting",
                        PerformanceHudState::Waiting,
                    )),
                )
                .child(
                    div().flex_1().min_w_0().child(PerformanceHud::new(
                        "scene.performance.unavailable",
                        PerformanceHudState::Unavailable(
                            "Frame tracing is disabled by this host.".into(),
                        ),
                    )),
                ),
        )
        .into_any_element()
}

Source: crates/gpui-kit/src/display/performance_hud.rs