devotee 0.1.47

Visualization engine
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

use std::time::Duration;

use super::config::Config;
use super::sound_system::SoundSystem;
use super::window::{Window, WindowCommand};

/// Context that stores various update-related data.
pub struct Context<Cfg>
where
    Cfg: Config,
{
    pub(super) delta: Duration,
    pub(super) input: Cfg::Input,
    pub(super) shall_stop: bool,
    pub(super) window_commands: Vec<WindowCommand>,
    pub(super) sound_system: Option<SoundSystem>,
    pub(super) converter: Cfg::Converter,
}

impl<Cfg> Context<Cfg>
where
    Cfg: Config,
{
    /// Get `Duration` of simulation step.
    pub fn delta(&self) -> Duration {
        self.delta
    }

    /// Get reference to the `Input` structure.
    pub fn input(&self) -> &Cfg::Input {
        &self.input
    }

    /// Tell the `App` to stop execution.
    pub fn shutdown(&mut self) {
        self.shall_stop = true;
    }

    pub(super) fn shall_stop(&self) -> bool {
        self.shall_stop
    }

    /// Enqueue command to be executed on app's window.
    pub fn add_window_command<F: 'static + FnOnce(&mut Window)>(&mut self, command: F) {
        self.window_commands.push(Box::new(command))
    }

    /// Get optional reference to the `SoundSystem`.
    pub fn sound_system(&mut self) -> Option<&SoundSystem> {
        self.sound_system.as_ref()
    }

    /// Get optional mutable reference to the `SoundSystem`.
    pub fn sound_system_mut(&mut self) -> Option<&mut SoundSystem> {
        self.sound_system.as_mut()
    }

    /// Get reference to the palette converter.
    pub fn converter(&self) -> &Cfg::Converter {
        &self.converter
    }

    /// Get mutable reference to the palette converter.
    pub fn converter_mut(&mut self) -> &mut Cfg::Converter {
        &mut self.converter
    }
}