Struct Timer 

pub struct Timer { /* private fields */ }

A timer that tracks duration, progress fraction, completion, and repetition.

Implementations

impl Timer

pub const fn from_seconds(duration: f32, mode: TimerMode) -> Self

Create a new timer with a duration in seconds and a TimerMode.

pub fn new(duration: Duration, mode: TimerMode) -> Self

Create a new timer from a core::time::Duration.

pub fn tick(&mut self, dt: f32) -> &mut Self

Advance the timer by dt seconds and evaluate completion.

pub fn tick_duration(&mut self, duration: Duration) -> &mut Self

Advance the timer by a core::time::Duration.

pub fn is_finished(&self) -> bool

true if the timer is finished (or reached its target during this tick).

pub fn just_finished(&self) -> bool

true only on the tick when the timer crossed or reached its duration.

pub fn fraction(&self) -> f32

Timer completion percentage between 0.0 and 1.0.

pub fn remaining_secs(&self) -> f32

Remaining duration in seconds until completion.

pub fn reset(&mut self)

Reset the timer to 0 elapsed time.

pub fn pause(&mut self)

Pause the timer.

pub fn unpause(&mut self)

Unpause the timer.

pub fn is_paused(&self) -> bool

true if paused.

pub fn elapsed_secs(&self) -> f32

Elapsed time in seconds.

pub fn duration_secs(&self) -> f32

Total target duration in seconds.

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Timer

impl Debug for Timer

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

Formats the value using the given formatter.

impl Default for Timer

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Timer

fn eq(&self, other: &Timer) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Timer