Struct FixedClock 

pub struct FixedClock { /* private fields */ }

Fixed-timestep clock. See the crate docs.

Implementations

impl FixedClock

pub const fn new(config: TickConfig, first_due: u32) -> FixedClock

A clock whose first tick is due at VBlank first_due.

pub fn realign(&mut self, first_due: u32)

Forget any owed time and make the next tick due at first_due. Call after a load, a pause menu or anything else that should not be caught up. Not counted as dropped ticks.

pub fn due(&mut self, now: u32) -> bool

true when a tick is due at VBlank now: run one tick, then ask again. The tick is counted as run when this returns true.

Reading now fresh each time lets a frame keep catching up while its own ticks take time, exactly as a while vblank >= next loop does.

pub fn is_due(&self, now: u32) -> bool

true when a tick is due at VBlank now, without running it and ignoring the catch-up policy. For schedulers that decide first and commit later with consume; game loops use due.

pub fn consume(&mut self)

Record one tick as run: advance the deadline and the counters. The caller has already decided it was due (see is_due).

pub fn end_frame(&mut self)

Close the current frame: record how many ticks it ran and start counting the next frame’s.

pub const fn tick(&self) -> u32

Ticks run since construction.

pub const fn frame_ticks(&self) -> u16

Ticks run so far in the current frame.

pub const fn rate(&self) -> TickRate

Tick length in VBlanks.

pub const fn next_due(&self) -> u32

VBlank at which the next tick is due.

pub fn phase_q12(&self, now: u32) -> u16

How far VBlank now is from the last tick toward the next one, in Q12 (0 = the last tick has just been reached, 4096 = the next one is due). Renderers draw lerp(previous, latest, phase): one tick of latency in exchange for motion that moves on every rendered frame at any tick rate. A game ticking every VBlank can simply draw the latest state instead.

pub const fn stats(&self) -> TickStats

Consistency counters.

pub fn reset_stats(&mut self)

Zero the consistency counters (for example at the start of a level).

Trait Implementations

impl Clone for FixedClock

fn clone(&self) -> FixedClock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FixedClock

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

Formats the value using the given formatter.

impl PartialEq for FixedClock

fn eq(&self, other: &FixedClock) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for FixedClock

impl Eq for FixedClock

impl StructuralPartialEq for FixedClock