Struct game_time::clock::GameTime

pub struct GameTime { /* fields omitted */ }

A specific point of time in a simulation.

GameTime knows both the wall time and game time of the simulation at a fixed time. A GameTime object is usually created by calling tick on a GameClock object.

Methods

impl GameTime

pub fn total_game_time(&self) -> FloatDuration

The game time at the time of creation of this GameTime object.

pub fn total_wall_time(&self) -> FloatDuration

The wall time elapsed since the start of the simulation.

pub fn frame_start_time(&self) -> DateTime<Local>

The wall time at the time of creation of this GameTime object.

pub fn elapsed_game_time(&self) -> FloatDuration

The amount of game time that passed since the previous frame.

pub fn elapsed_wall_time(&self) -> FloatDuration

The amount of wall time that passed since the previous frame.

pub fn elapsed_time_since_frame_start(&self) -> FloatDuration

The amount of elapsed wall time since the start of the current frame.

This value is computed from the current instant when called, based on the frame start time. This can be used for intra-frame profiling.

pub fn frame_number(&self) -> u64

The index of the current frame.

This value increases by 1 for each frame created, and represents the total number of frames executed in the simulation.

pub fn instantaneous_frame_rate(&self) -> f64

Return the instantaneous frame rate between the last and current frames.

The "instantaneous" frame rate is computed from the last frame's elapsed time, and takes no previous frames into account.

For a more stable frame rate, use a FrameCount object.

Trait Implementations

impl Clone for GameTime

fn clone(&self) -> GameTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameTime

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

Formats the value using the given formatter.