Skip to main content

FixedClock

Struct FixedClock 

Source
pub struct FixedClock {
    pub alpha: f32,
    pub steps_this_frame: u32,
    pub dropped_dt: Duration,
    /* private fields */
}
Expand description

A fixed-timestep accumulator + render interpolation factor.

Usage per rendered frame:

clock.begin_frame(frame_elapsed); // a Duration
while clock.step() { /* one fixed sim step of clock.fixed_dt() */ }
clock.finish();
let alpha = clock.alpha; // overstep fraction: lerp(prev, curr, alpha)

Fields§

§alpha: f32

Overstep fraction in [0, 1), set by finish; the render interpolation alpha. Carried debt is not part of it.

§steps_this_frame: u32

Fixed steps consumed during the current frame (cadence diagnostic).

§dropped_dt: Duration

Supplied time this frame will never simulate, set by begin_frame: the clamped-off delta when render-paced, whole discarded steps under a catch-up policy.

Implementations§

Source§

impl FixedClock

Source

pub fn new() -> Self

A render-paced clock at the default 60 Hz simulation rate.

Source

pub fn with_hz(hz: f32) -> Self

A render-paced clock at an arbitrary fixed rate: at most one step per frame. The step is Duration::from_secs_f64(1.0 / f64::from(hz)); hz must be positive and give a step of at least one nanosecond.

Source

pub fn with_catch_up(hz: f32, catch_up: CatchUp) -> Self

A clock that follows elapsed time with bounded catch-up (hz as for with_hz and max_steps_per_frame at least 1).

Source

pub fn fixed_step(&self) -> Duration

The exact simulation step.

Source

pub fn fixed_dt(&self) -> f32

The simulation step in seconds, for the game’s integration.

Source

pub fn begin_frame(&mut self, elapsed: Duration)

Begin a rendered frame: add the frame’s elapsed time to the accumulator under the clock’s policy, record dropped_dt, and reset the per-frame step counter.

Source

pub fn step(&mut self) -> bool

Consume one fixed step if enough time has accumulated and the frame’s step budget allows. Drive the fixed simulation in a while clock.step() { .. } loop.

Source

pub fn finish(&mut self)

Finish the frame: compute the render interpolation alpha from the leftover accumulator (the overstep fraction, excluding whole steps of carried debt).

Trait Implementations§

Source§

impl Clone for FixedClock

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for FixedClock

Source§

impl Debug for FixedClock

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FixedClock

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.