Struct ftvf::Metronome

pub struct Metronome<N: NowSource> { /* private fields */ }

The meat of the crate. Contains all state necessary to turn pure temporal chaos into an orderly stream of ticks and frames.

See the crate-level documentation for more information.

Implementations

impl<N: NowSource> Metronome<N>

pub fn new(now_source: N, tickrate: Rate, max_ticks_behind: u32) -> Metronome<N>

Create a new Metronome, initialized with the given properties.

• now_source: The NowSource to use.
• tickrate: The target rate of ticks per second, represented as a Rate.
• max_ticks_behind: The maximum number of ticks we can “fall behind” before we start dropping ticks. Increasing this value makes your game’s tick pacing more steady over time, at the cost of making the play experience more miserable on computers too slow to play the game in realtime.
  For a non-multiplayer application this should be fairly low, e.g. in the 1-3 range. In multiplayer, we should try harder to keep up, and a value on the order of several seconds’ worth of ticks might be preferred.

pub fn sample<'a>( &'a mut self, mode: Mode ) -> impl Iterator<Item = Reading> + 'a

Call this from your logic loop, after checking for user input. Returns an Iterator of Readings, describing how you should respond to the passage of time. See Reading for info on what each reading means.

pub fn set_tickrate(&mut self, new_rate: Rate)

Dynamically change the tickrate. You can call this at any time and it will take effect after the current tick. If you call this from within a loop over an iterator returned by sample, you should break out of the loop, because it does not currently detect the new tick rate mid-loop.

Trait Implementations

impl<N: Clone + NowSource> Clone for Metronome<N>where N::Instant: Clone,

fn clone(&self) -> Metronome<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug + NowSource> Debug for Metronome<N>where N::Instant: Debug,

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

Formats the value using the given formatter.