gemini-engine 0.14.2

A 2D/3D monospaced ASCII rendering engine for the terminal
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

use std::{thread::sleep, time::Duration};

/// Sleep for a single frame at the declared FPS, subtracting the input `Duration` to account for any time spent processing the frame. Returns a bool value depending on whether or not the frame took longer to render than the intended fps
/// # Example
/// ```rust,no_run
/// use gemini_engine::gameloop;
///
/// let mut frame_skip = false;
/// const FPS: f32 = 60.0;
/// loop {
///     let now = gameloop::Instant::now();
///
///     // all code here will run at 60 FPS
///
///     if frame_skip {
///         frame_skip = false;
///     } else {
///         // calculations and rendering
///     }
///
///     frame_skip = gameloop::sleep_fps(FPS, Some(now.elapsed()));
/// }
#[must_use]
pub fn sleep_fps(fps: f32, elapsed: Option<Duration>) -> bool {
    let elapsed = elapsed.unwrap_or(Duration::ZERO);
    let frame_length = Duration::from_secs_f32(1.0 / fps);
    if frame_length > elapsed {
        sleep(frame_length - elapsed);
        false
    } else {
        true
    }
}