Struct Timer

pub struct Timer { /* private fields */ }

A timer that you can use to fix the time between actions, for example updates or draw calls.

See the article Fix Your Timestep for more on how to use timers to ensure framerate-independence.

Implementations

impl Timer

pub fn time_per_second(times: f32) -> Timer

Create a timer that ticks n many times per second

pub fn with_duration(period: Duration) -> Timer

Create a timer with a given period (time between ticks)

pub fn tick(&mut self) -> bool

Look if the time has elapsed and if so, starts the countdown for the next tick.

You can use a while loop instead of an if to catch up in the event that you were late. Each tick will only ‘consume’ one period worth of time.

pub fn exhaust(&mut self) -> Option<NonZeroUsize>

Similar to Self::tick() but tells you how many ticks have passed, rather than just if a tick has passed.

This is useful in situations where catching up isn’t needed or possible, like rendering to the screen. If you’ve missed rendering three frames, there’s no point in drawing them now: just render the current state and move on.

pub fn reset(&mut self)

Resets the timer to count from this moment.

This is the same as creating a new Timer with the same period

pub fn period(&self) -> Duration

Gets the time in between ticks

pub fn elapsed(&self) -> Duration

How much time has passed since the timer was last ticked

pub fn remaining(&self) -> Option<Duration>

Look how much time is still left before its time for next tick.

pub fn late_by(&self) -> Option<Duration>

Look how late you are with calling Timer::tick() if you would call it right now

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timer

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

Formats the value using the given formatter.