Skip to main content

FrameProfiler

Struct FrameProfiler 

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

Rolling-window CPU frame profiler.

Spans are identified by string name. Begin/end calls must be paired. Stats are available as averages, min, max, and last value.

Implementations§

Source§

impl FrameProfiler

Source

pub fn new(window_frames: usize) -> Self

Create a profiler with a rolling window of window_frames frames.

Source

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

Begin timing a named span.

Source

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

End timing a named span.

Source

pub fn begin_frame(&mut self)

Mark the start of a new frame (measures total frame time under “frame”).

Source

pub fn end_frame(&mut self)

Mark the end of a frame.

Source

pub fn avg_us(&self, name: &str) -> u64

Average duration of a span in microseconds.

Source

pub fn max_us(&self, name: &str) -> u64

Maximum duration of a span in microseconds.

Source

pub fn min_us(&self, name: &str) -> u64

Minimum duration of a span in microseconds.

Source

pub fn last_us(&self, name: &str) -> u64

Last recorded duration of a span in microseconds.

Source

pub fn fps(&self) -> f32

Average FPS derived from the “frame” span.

Source

pub fn frame_count(&self) -> u64

Total frame count since creation.

Source

pub fn report(&self) -> Vec<(&str, u64)>

Sorted list of (name, avg_us) for all tracked spans.

Source

pub fn format_report(&self) -> String

Format the profiler report as a multi-line string.

Source

pub fn reset(&mut self)

Reset all span accumulators.

Source

pub fn over_budget(&self, budget_ms: f32) -> bool

Returns true if the “frame” span average exceeds budget_ms milliseconds.

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,