Skip to main content

FrameProfiler

Struct FrameProfiler 

Source
pub struct FrameProfiler { /* private fields */ }
Expand description

Named-stage, per-frame profiler with independent EMA smoothing per stage — the generic mechanism behind the source app’s own FrameProfile. Stage names are caller-supplied &'static str keys (e.g. "grid", "scene_build", "overlay"), not a fixed enum, so any app’s own frame-phase vocabulary ports over unchanged.

Clock-free by design (module doc) — the caller measures each stage with whatever monotonic clock its platform has and feeds the elapsed milliseconds into FrameProfiler::record_ms.

Implementations§

Source§

impl FrameProfiler

Source

pub const DEFAULT_ALPHA: f64 = 0.08

The source app’s own smoothing constant (previous * 0.92 + sample * 0.08).

Source

pub fn new(alpha: f64) -> Self

A profiler smoothing every stage at alpha (see EmaF64::update).

Source

pub fn record_ms(&mut self, stage: &'static str, sample_ms: f64)

Record a caller-measured sample in milliseconds for stage, folding it into that stage’s own running EMA — the stage’s tracker is created (uninitialized) on first use, so its own first sample wins outright rather than blending against a synthetic 0.0.

Source

pub fn stage_ms(&self, stage: &str) -> f64

Current smoothed value (ms) for stage, or 0.0 if it has never been recorded.

Source

pub fn stages(&self) -> impl Iterator<Item = (&'static str, f64)> + '_

Every currently-tracked stage’s smoothed value — iteration order is NOT guaranteed (backed by a HashMap); a caller that needs a fixed field order should read FrameProfiler::stage_ms per named stage instead.

Source

pub fn frame_count(&self) -> u64

Total frames FrameProfiler::end_frame has been called for.

Source

pub fn end_frame(&mut self)

Bump the frame counter — call once per frame (typically after recording that frame’s stages), independent of how many stages were actually recorded that frame.

Trait Implementations§

Source§

impl Clone for FrameProfiler

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FrameProfiler

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FrameProfiler

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.