qilin 0.3.2

Lightweight Game Engine for making fun 2d Games in 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

use crate::render::color::Color;
use minifb::{Scale, ScaleMode, WindowOptions};
use std::time::Duration;

/// Game Configuration containing title, max fps, width, height and window options.
#[derive(Clone, Debug)]
pub struct GameConfig {
    /// Window title. Default is "New Game".
    pub title: String,
    /// Maximum FPS/Update Rate. Default is 60 fps.
    pub update_rate_limit: UpdateRate,
    /// Width of the window. Default is 800.
    pub width: usize,
    /// Height of the window. Default is 600.
    pub height: usize,
    /// Defines the fixed time step and how many times [crate::scene::Scene::fixed_update] is called in one second. Default is [Duration::from_secs_f32(1.0 / 30.0)] meaning 30 times per second.
    pub fixed_time_step: TimeStamp,
    /// Window options.
    pub window: WindowOptions,
}

impl Default for GameConfig {
    #[inline]
    fn default() -> Self {
        Self {
            title: String::from("New Game"),
            update_rate_limit: FPS60,
            width: 800,
            height: 600,
            fixed_time_step: TimeStamp::default(),
            window: WindowOptions {
                borderless: false,
                title: true,
                resize: true,
                scale: Scale::X1,
                scale_mode: ScaleMode::AspectRatioStretch,
                topmost: false,
                transparency: false,
                none: false,
            },
        }
    }
}

/// An alternative type to [Duration] to avoid [Default::default] issues.
#[derive(Clone, Debug)]
pub struct TimeStamp(pub Duration);

impl Default for TimeStamp {
    #[inline]
    fn default() -> Self { Self(Duration::from_secs_f32(1.0 / 60.0)) }
}

/// Update Rate as Duration. Use `types::FPS30`, `types::FPS60` or `types::FPS120` for FPS 30, 60 or 120 fps.
pub type UpdateRate = Duration;
pub const FPS30: Duration = Duration::from_nanos(33333333);
pub const FPS60: Duration = Duration::from_nanos(16666666);
pub const FPS120: Duration = Duration::from_nanos(8333333);

/// Vector of colors to represent an image.
pub type Image = Vec<Color>;

#[derive(Clone, Copy, Debug)]
pub enum Button {
    Keyboard(minifb::Key),
    Mouse(minifb::MouseButton),
}