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
impl FrameProfiler
Sourcepub fn new(window_frames: usize) -> Self
pub fn new(window_frames: usize) -> Self
Create a profiler with a rolling window of window_frames frames.
Sourcepub fn begin_frame(&mut self)
pub fn begin_frame(&mut self)
Mark the start of a new frame (measures total frame time under “frame”).
Sourcepub fn frame_count(&self) -> u64
pub fn frame_count(&self) -> u64
Total frame count since creation.
Sourcepub fn format_report(&self) -> String
pub fn format_report(&self) -> String
Format the profiler report as a multi-line string.
Sourcepub fn over_budget(&self, budget_ms: f32) -> bool
pub fn over_budget(&self, budget_ms: f32) -> bool
Returns true if the “frame” span average exceeds budget_ms milliseconds.
Auto Trait Implementations§
impl Freeze for FrameProfiler
impl RefUnwindSafe for FrameProfiler
impl Send for FrameProfiler
impl Sync for FrameProfiler
impl Unpin for FrameProfiler
impl UnsafeUnpin for FrameProfiler
impl UnwindSafe for FrameProfiler
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
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>
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)
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)
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.