Struct UpdateResult

pub struct UpdateResult {
    pub num_updates: u64,
    pub total_num_updates: u64,
    pub frame_time: Duration,
    pub blending_factor: f64,
    pub total_time_passed: Duration,
    pub exit: bool,
}

The result of calling GameLoop::update.

Fields

num_updates: u64

The number of updates.

total_num_updates: u64

Total number of updates since GameLoop’s creation.

frame_time: Duration

Time between previous and current update.

blending_factor: f64

Blending between current and next frames. Primarily useful for rendering.

total_time_passed: Duration

Total time passed since GameLoop’s creation. This is a sum of the provided elapsed arguments.

exit: bool

Whether to exit next iteration. This is only useful in UpdateResult::run() or UpdateResult::run_result().

Implementations

impl UpdateResult

pub fn run<F>(self, func: F) -> Self

where F: FnMut(&mut Self),

Run the provided function UpdateResult::num_updates times. Aborts early if UpdateResult::exit is true.

Returns self for convenience.

pub fn run_result<F, E>(self, func: F) -> Result<Self, E>

where F: FnMut(&mut Self) -> Result<(), E>,

Run the provided function UpdateResult::num_updates times. Aborts early if func returns Err or UpdateResult::exit is true.

Returns self for convenience.

Trait Implementations

impl Clone for UpdateResult

fn clone(&self) -> UpdateResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateResult

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

Formats the value using the given formatter.