Struct riddle_time::TimeSystem

pub struct TimeSystem { /* fields omitted */ }

The Riddle time system core state.

Manages tracking framerate and timer state.

It is possible to manage the audio system state independantly - the most important thing to note is that TimeSystem::process_frame must be called once per "frame". The default Riddle integration calls that method whenever the riddle::Event::ProcessFrame event is fired.

Implementations

impl TimeSystem

pub fn new() -> TimeSystemHandle

Create a new time system. The time the system is created is used as the time of the 0th frame.

pub fn process_frame(&self)

Update the time system state, marking the beginning of a the next frame.

The instant that this method is called is taken as the reference time for the frame that is about to be executed.

Timers will also be triggered during this function call if they are due to trigger.

Do not call this function directly if you are using this through the riddle crate.

Example

let frame_1 = time_system.frame_instant();

// A while later
let frame_n = time_system.frame_instant();

assert_eq!(true, frame_n - frame_1 > std::time::Duration::from_secs(0));

pub fn fps(&self) -> f32

Get the current FPS as calculated based on previous frame durations.

pub fn delta_secs(&self) -> f32

Get the current delta t as calculated based on previous frame durations.

pub fn frame_instant(&self) -> Instant

Get the reference time for this frame. Captured during TimeSystem::process_frame.

pub fn register_timer<F>(&self, duration: Duration, callback: F) -> TimerHandle where
    F: FnOnce() + Send + 'static, 

Register a timer with a callback which will be fired when the time elpases.

The returned handle may be dropped without cancelling the timer.

Example

let val = Arc::new(AtomicBool::new(false));

time_system.register_timer(std::time::Duration::from_millis(200), {
    let val = val.clone();
    move || { val.store(true, Ordering::Relaxed); }
});

// A while later
assert_eq!(true, val.load(Ordering::Relaxed));

Trait Implementations

impl CloneHandle for TimeSystem

type Handle = TimeSystemHandle

The type which represents a strong reference, and which may be dereferenced as Self.

type WeakHandle = TimeSystemWeak

The type which represents a weak reference.

fn clone_handle(&self) -> TimeSystemHandle

Clone a strong handle to the object.

fn clone_weak_handle(&self) -> TimeSystemWeak

Clone a weak handle to the object.