kero 0.1.12

A simple, approachable framework for creating 2D games in Rust and/or Lua.
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use crate::math::Float;
use std::cell::Cell;
use std::fmt::{Debug, Formatter};
use std::rc::Rc;

/// Handle to the game's core timer.
///
/// This handle can be cloned and passed around freely to give objects access to the time.
///
/// Obtained from [`Context`](super::Context).
#[derive(Clone)]
pub struct Time(pub(crate) Rc<TimeState>);

impl Debug for Time {
    #[inline]
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.debug_tuple("Time").finish_non_exhaustive()
    }
}

#[derive(Debug, Clone)]
pub(crate) struct TimeState {
    pub target_fps: Cell<Option<f64>>,
    pub max_frame_skip: Cell<u32>,
    pub fps: Cell<u32>,
    pub delta: Cell<f32>,
    pub unfixed_delta: Cell<f32>,
    pub since_startup: Cell<f32>,
    pub frame: Cell<u64>,
}

impl Default for TimeState {
    #[inline]
    fn default() -> Self {
        Self {
            target_fps: Cell::new(Some(60.0)),
            max_frame_skip: Cell::new(0),
            fps: Cell::new(60),
            delta: Cell::new(1.0 / 60.0),
            unfixed_delta: Cell::new(0.0),
            since_startup: Cell::new(0.0),
            frame: Cell::new(0),
        }
    }
}

impl Time {
    pub(crate) fn new() -> Self {
        Self(Rc::new(TimeState::default()))
    }

    #[inline]
    pub fn target_fps(&self) -> Option<f64> {
        self.0.target_fps.get()
    }

    #[inline]
    pub fn set_target_fps(&self, fps: Option<f64>) {
        self.0.target_fps.set(fps);
    }

    #[inline]
    pub fn max_frame_skip(&self) -> u32 {
        self.0.max_frame_skip.get()
    }

    #[inline]
    pub fn set_max_frame_skip(&self, max: u32) {
        self.0.max_frame_skip.set(max);
    }

    /// FPS the app is running at.
    #[inline]
    pub fn fps(&self) -> u32 {
        self.0.fps.get()
    }

    /// Duration since the last frame, in seconds.
    #[inline]
    pub fn delta(&self) -> f32 {
        self.0.delta.get()
    }

    /// Unfixed duration since last frame, in seconds.
    #[inline]
    pub fn unfixed_delta(&self) -> f32 {
        self.0.unfixed_delta.get()
    }

    /// Total time since app startup, in seconds.
    #[inline]
    pub fn since_startup(&self) -> f32 {
        self.0.since_startup.get()
    }

    /// The current frame number.
    #[inline]
    pub fn frame(&self) -> u64 {
        self.0.frame.get()
    }

    #[inline]
    pub fn flicker(&self, on_time: f32, off_time: f32) -> bool {
        (self.since_startup() % (on_time + off_time)) < on_time
    }

    #[inline]
    pub fn wave_ext(&self, from: f32, to: f32, duration: f32, offset_percent: f32) -> f32 {
        let range = (to - from) * 0.5;
        from + range
            + (((self.since_startup() + duration * offset_percent) / duration) * f32::TAU).sin()
                * range
    }

    #[inline]
    pub fn wave(&self, from: f32, to: f32, duration: f32) -> f32 {
        self.wave_ext(from, to, duration, 0.0)
    }
}