Struct Profiler 

pub struct Profiler {
    pub enabled: bool,
    pub counters: HashMap<String, Counter>,
    pub span_stats: HashMap<String, SpanStats>,
    pub max_history: usize,
    pub frame_index: u64,
    pub memory: MemoryStats,
    pub gpu: GpuFrameStats,
    pub fps_history: VecDeque<f64>,
    pub fps: f64,
    /* private fields */
}

Main CPU profiler. Not thread-safe (use per-thread instances or a Mutex).

Fields

enabled: bool

counters: HashMap<String, Counter>

span_stats: HashMap<String, SpanStats>

max_history: usize

frame_index: u64

memory: MemoryStats

gpu: GpuFrameStats

fps_history: VecDeque<f64>

fps: f64

Implementations

impl Profiler

pub fn new() -> Self

pub fn begin(&mut self, name: &str)

Start a new timing span. Must be matched with end(name).

pub fn end(&mut self, name: &str)

End the most recent span with this name.

pub fn count(&mut self, name: &str, delta: f64)

Increment a named counter.

pub fn set_counter(&mut self, name: &str, value: f64)

Set a named counter to an absolute value.

pub fn frame_begin(&mut self)

Call at the start of each frame.

pub fn frame_end(&mut self) -> FrameRecord

Call at the end of each frame. Returns the completed FrameRecord.

pub fn stats(&self, name: &str) -> Option<&SpanStats>

Get rolling stats for a span by name.

pub fn build_flame_graph(&self, last_n_frames: usize) -> FlameNode

Build a flame graph from the last N frames.

pub fn recent_frames(&self, n: usize) -> &[FrameRecord]

Get the last N frame records.

pub fn last_frame(&self) -> Option<&FrameRecord>

Get the last completed frame.

pub fn avg_fps(&self) -> f64

Average FPS over the history window.

pub fn avg_frame_ms(&self) -> f64

Average frame time in ms.

pub fn summary(&self) -> String

Report summary string.

pub fn reset(&mut self)

Reset all history.

Trait Implementations

impl Default for Profiler

fn default() -> Self

Returns the “default value” for a type.