Struct FPS

pub struct FPS<const MAX_FPS: usize, C: Clock> { /* private fields */ }

Measures Frames Per Second (FPS).

MAX_FPS - Defines the maximum FPS that you expect to measure.

Implementations

impl<const MAX_FPS: usize, C: Clock> FPS<MAX_FPS, C>

pub fn new(clock: C) -> FPS<MAX_FPS, C>

Creates a new Frames Per Second counter.

pub fn tick(&mut self) -> usize

Adds another frame tick and returns the current Frames Pre Second.

Panics

When Clock::try_now() returns an error or if the MAX_FPS is reached.

pub fn tick_max(&mut self) -> usize

Adds another frame tick and returns the current Frames Pre Second.

This method will not panic if the MAX_FPS is reached, instead it will just return the MAX_FPS value (capping it in a nutshell).

Panics

If Clock::try_now() returns an error.

pub fn try_tick_max(&mut self) -> Result<usize, Error>

Adds another frame tick and returns the current Frames Pre Second.

This method will not return an error if the MAX_FPS is reached, instead it will just return the MAX_FPS value (capping it in a nutshell).

pub fn try_tick(&mut self) -> Result<usize, Error>

Adds another frame tick and returns the current Frames Pre Second.

Panics

When Clock::try_now() returns an error or if the MAX_FPS is reached.

Trait Implementations

impl<const MAX_FPS: usize, C: Clone + Clock> Clone for FPS<MAX_FPS, C>

fn clone(&self) -> FPS<MAX_FPS, C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MAX_FPS: usize, C: Debug + Clock> Debug for FPS<MAX_FPS, C>

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

Formats the value using the given formatter.

impl<const MAX_FPS: usize, C> Default for FPS<MAX_FPS, C>

where C: Clock + Default,

fn default() -> Self

Returns the “default value” for a type.