Struct PerfOverlay 

pub struct PerfOverlay {
    pub mode: PerfOverlayMode,
    pub thresholds: PerfThresholds,
    pub current: TimeSample,
    pub kit_timings: KitTimings,
    pub post_fx_passes: u32,
    pub post_fx_names: Vec<String>,
    /* private fields */
}

Full performance overlay state.

Fields

mode: PerfOverlayMode

thresholds: PerfThresholds

current: TimeSample

kit_timings: KitTimings

post_fx_passes: u32

post_fx_names: Vec<String>

Implementations

impl PerfOverlay

pub fn new() -> Self

pub fn begin_frame(&mut self)

Call at the very start of each frame.

pub fn end_frame( &mut self, gpu_ms: f32, particles: u64, draw_calls: u32, vram_mb: f32, ram_mb: f32, )

Call at the end of each frame with measured values.

pub fn begin_kit(&mut self, kit: &'static str)

pub fn end_kit(&mut self, kit: &'static str)

pub fn avg_fps(&self) -> f32

pub fn p95_frame_ms(&self) -> f32

pub fn max_frame_ms(&self) -> f32

pub fn bottleneck(&self) -> Bottleneck

pub fn frame_status(&self) -> FrameStatus

pub fn render_text(&self) -> String

pub fn render_compact(&self) -> String

pub fn render_normal(&self) -> String

pub fn render_verbose(&self) -> String

pub fn render_graph(&self) -> String

pub fn status_line(&self) -> String

Trait Implementations

impl Debug for PerfOverlay

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PerfOverlay

fn default() -> Self

Returns the “default value” for a type.