Struct puffin::GlobalProfiler

pub struct GlobalProfiler { /* private fields */ }

Singleton. Collects profiling data from multiple threads and passes them on to different FrameSinks.

Implementations

impl GlobalProfiler

pub fn lock() -> MutexGuard<'static, Self>

Access to the global profiler singleton.

pub fn new_frame(&mut self)

You need to call this once at the start of every frame.

It is fine to call this from within a profile scope.

This takes all completed profiling scopes from all threads, and sends it to the sinks.

pub fn add_frame(&mut self, new_frame: Arc<FrameData>)

Manually add frame data.

pub fn report(&mut self, info: ThreadInfo, stream_info: &StreamInfoRef<'_>)

Report some profiling data. Called from ThreadProfiler.

pub fn add_sink(&mut self, sink: FrameSink) -> FrameSinkId

Tells GlobalProfiler to call this function with each new finished frame.

The returned FrameSinkId can be used to remove the sink with Self::remove_sink().

pub fn remove_sink(&mut self, id: FrameSinkId) -> Option<FrameSink>

Trait Implementations

impl Default for GlobalProfiler

fn default() -> Self

Returns the “default value” for a type.