magma_windowing 0.1.0-alpha.3

Part of the Magma-API, which is the API of the Magma3D game engine. This is responsable for handling windows.
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

use magma_math::{IVec2, UVec2};

/// An ECS component representing a monitor
#[derive(Clone, PartialEq, Debug, Default)]
pub struct Monitor {
    /// Optional name of the monitor
    pub name: Option<String>,
    /// Physical height of the monitor
    pub height: u32,
    /// Physical width of the monitor
    pub width: u32,
    /// Physical position of the monitor
    pub position: IVec2,
    /// Refresh rate of the monitor in *millihertz*
    pub refresh_rate: Option<u32>,
    /// Scale factor for conversion between physical and logical pixels
    pub scale_factor: f64,
    /// The monitor's video modes
    pub video_modes: Vec<VideoMode>,
    /// The monitors id in the backend
    pub id: usize,
}

impl Monitor {
    /// Returns the physical size of the monitor.
    pub fn size(&self) -> UVec2 {
        UVec2::new(self.width, self.height)
    }
}

/// Marker component for the primary monitor
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Default)]
pub struct PrimaryMonitor;

/// Representation for a video mode
#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, Default)]
pub struct VideoMode {
    /// Resolution of the video mode
    pub size: UVec2,
    /// Bit depth of the video mode
    pub bit_depth: u16,
    /// Refresh rate in *millihertz*
    pub refresh_rate: u32,
}