Struct sfml::system::Clock

pub struct Clock(_);

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.

Methods

impl Clock

pub fn start() -> Clock

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 Drop for Clock

fn drop(&mut self)

Executes the destructor for this type.

impl Clone for Clock

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Clock

fn default() -> Self

Equivalent to Clock::start().

impl Debug for Clock

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

Formats the value using the given formatter.