Struct sfml::system::Clock

#[repr(C)]
pub struct Clock { /* private fields */ }

Utility type that measures the elapsed time.

Its provides the most precise time that the underlying OS can achieve (generally microseconds or nanoseconds). It also ensures monotonicity, which means that the returned time can never go backward, even if the system time is changed.

Usage example

let mut clock = Clock::start();
// ...
let time1 = clock.elapsed_time();
// ...
let time2 = clock.restart();

The Time value returned by the clock can then be converted to a number of seconds, milliseconds or even microseconds.

Implementations

impl Clock

pub fn start() -> SfBox<Self>

Creates a new Clock and starts it automatically.

pub fn elapsed_time(&self) -> Time

Gets the elapsed time.

This function returns the time elapsed since the last call to restart (or the construction of the instance if restart has not been called).

pub fn restart(&mut self) -> Time

Restarts the clock.

This function puts the time counter back to zero. It also returns the time elapsed since the clock was started.

Trait Implementations

impl Debug for sfClock

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

Formats the value using the given formatter.