sky_ecs 0.1.3

High-performance typed chunk-based ECS for Rust
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

/// Timing information updated automatically by [`World`](crate::ecs::World).
///
/// `Time` is built into `World` because it is core frame state rather than a
/// user-owned resource.  Systems usually read [`delta`](Self::delta).  Render
/// and UI-facing code should prefer [`frame_delta`](Self::frame_delta), because
/// fixed stages temporarily set `delta` to their fixed step while they run.
#[derive(Debug, Clone)]
pub struct Time {
    /// Delta time for the currently running stage invocation.
    ///
    /// Equals [`frame_delta`](Self::frame_delta) for every-frame stages, or the
    /// fixed step size while a fixed stage is running.
    pub delta: f32,

    /// Delta for the current application frame after clamping and
    /// [`time_scale`](Self::time_scale).
    pub frame_delta: f32,

    /// Raw real-world frame delta before clamping and time scaling.
    pub raw_delta: f32,

    /// Total elapsed time since the first tick, affected by
    /// [`time_scale`](Self::time_scale).
    pub elapsed: f32,

    /// Real elapsed time since the first tick, unaffected by
    /// [`time_scale`](Self::time_scale).
    pub raw_elapsed: f32,

    /// Number of ticks since the schedule started.
    pub frame_count: u64,

    /// Fraction of the next built-in [`FixedUpdate`](crate::ecs::FixedUpdate)
    /// step accumulated after fixed execution.
    ///
    /// This is in `0.0..=1.0`; carried backlog is clamped to `1.0` until the
    /// fixed stage catches up. Render systems can use it for interpolation.
    /// Custom fixed stages expose their accumulator through schedule
    /// diagnostics and do not overwrite this value.
    pub fixed_alpha: f32,

    /// Time multiplier. 1.0 = normal, 0.5 = slow-mo, 0.0 = paused.
    pub time_scale: f32,

    // Ordinary systems may share Time but must not request ResMut<Time>.
    // Exclusive code can still mutate it through World between worker waves.
    _not_send: std::marker::PhantomData<std::rc::Rc<()>>,
}

// Safety: the marker is zero-sized and all actual Time fields are primitive
// values. Schedule execution permits only shared worker access to Time.
unsafe impl Sync for Time {}

impl Time {
    #[inline]
    pub fn delta(&self) -> f32 {
        self.delta
    }

    #[inline]
    pub fn frame_delta(&self) -> f32 {
        self.frame_delta
    }

    #[inline]
    pub fn raw_delta(&self) -> f32 {
        self.raw_delta
    }

    #[inline]
    pub fn elapsed(&self) -> f32 {
        self.elapsed
    }

    #[inline]
    pub fn raw_elapsed(&self) -> f32 {
        self.raw_elapsed
    }

    #[inline]
    pub fn fixed_alpha(&self) -> f32 {
        self.fixed_alpha
    }
}

impl Default for Time {
    fn default() -> Self {
        Self {
            delta: 0.0,
            frame_delta: 0.0,
            raw_delta: 0.0,
            elapsed: 0.0,
            raw_elapsed: 0.0,
            frame_count: 0,
            fixed_alpha: 0.0,
            time_scale: 1.0,
            _not_send: std::marker::PhantomData,
        }
    }
}