Struct FrameLog 

pub struct FrameLog { /* private fields */ }

The latest frames an app drew. Recording one is a push into a fixed buffer, so it can stay on while nobody is looking.

use std::time::Duration;
use ravenrs_core::{FrameLog, FrameSample};

let mut log = FrameLog::default();
log.record(FrameSample { update: Duration::from_millis(4), ..Default::default() });
assert_eq!(log.summary().total.median, Duration::from_millis(4));

Implementations

impl FrameLog

pub fn record(&mut self, sample: FrameSample)

Adds a frame, forgetting the oldest once the log is full.

pub fn clear(&mut self)

Forgets every frame, to measure from here on.

pub fn measure(&self, seconds: f64) -> PerformanceResult

Judges the frames recorded since the log was cleared, seconds ago.

pub fn samples(&self) -> impl Iterator<Item = &FrameSample>

The frames in the log, oldest first.

pub fn trace_json(&self) -> String

The frames in the log in the Trace Event format, which Perfetto (https://ui.perfetto.dev) and chrome://tracing open.

pub fn summary(&self) -> FrameSummary

The frames in the log, summed up.

Trait Implementations

impl Clone for FrameLog

fn clone(&self) -> FrameLog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameLog

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

Formats the value using the given formatter.

impl Default for FrameLog

fn default() -> FrameLog

Returns the “default value” for a type.