Struct game_time::framerate::counter::FrameCounter

pub struct FrameCounter<S: FrameRateSampler> { /* fields omitted */ }

A basic frame rate counter.

Methods

impl<S: FrameRateSampler> FrameCounter<S>

pub fn new(target_frame_rate: f64, sampler: S) -> FrameCounter<S>

Create a new FrameCounter with a target frame rate and sampler.

pub fn set_slow_threshold(&mut self, val: f64) -> &mut FrameCounter<S>

Set a new slow threshold.

pub fn slow_threshold(&self) -> f64

Return the current slow threshold.

If the current frame rate divided by the target frame rate is less than this value, then FrameCount::is_running_slowly will return true.

pub fn set_target_frame_rate(&mut self, val: f64) -> &mut FrameCounter<S>

Set the target frame rate.

pub fn is_saturated(&self) -> bool

Return true if the sampler is saturated.

pub fn sampler(&self) -> &S

Return a reference to the sampler object.

Trait Implementations

impl<S: FrameRateSampler> FrameCount for FrameCounter<S>

fn target_frame_rate(&self) -> f64

The target frame rate for the simulation.

fn target_time_per_frame(&self) -> FloatDuration

The target wall time for each frame.

fn remaining_frame_time(&self, time: &GameTime) -> FloatDuration

The duration remaining to reach the optimal frame time.

fn tick(&mut self, time: &GameTime)

Update the counter for a new frame.

fn average_frame_rate(&self) -> f64

The average frame rate for the current frame.

fn is_running_slow(&self, time: &GameTime) -> bool

Return whether the simulation is running slowly.

impl<S: Clone + FrameRateSampler> Clone for FrameCounter<S>

fn clone(&self) -> FrameCounter<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug + FrameRateSampler> Debug for FrameCounter<S>

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

Formats the value using the given formatter.