pkecs_window 9.3.0

Provides windowing capabilities for `pkecs`.
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

//! Configuration primitives.

use winit::{dpi::PhysicalSize, window::WindowAttributes};
use super::event::resize::Resized;

/// Configures a graphical application.
pub struct GraphicalApplicationOptions {
    pub tick_rate: f64,
    pub title: &'static str,
    pub width: u32,
    pub height: u32,
}

impl GraphicalApplicationOptions {
    /// Configures [`self`] with a tick rate.
    pub fn with_tick_rate(&mut self, tick_rate: f64) -> &mut Self {
        self.tick_rate = tick_rate;

        self
    }

    /// Configures [`self`] with a title.
    pub fn with_title(&mut self, title: &'static str) -> &mut Self {
        self.title = title;

        self
    }

    /// Configures [`self`] with a physical per-pixel size.
    pub fn with_size(&mut self, width: u32, height: u32) -> &mut Self {
        self.width = width;
        self.height = height;

        self
    }

    /// Creates [`WindowAttributes`] from [`self`].
    pub(crate) fn to_attr(&self) -> WindowAttributes {
        WindowAttributes::default()
            .with_title(self.title)
            .with_inner_size(PhysicalSize::new(self.width, self.height))
    }

    /// Creates a [`Resized`] event from [`self`].
    pub(crate) fn to_resized(&self) -> Resized {
        Resized::from_size(self.width, self.height)
    }
}

impl Default for GraphicalApplicationOptions {
    fn default() -> Self {
        let tick_rate = 1.;
        let title = "Application";
        let width = 1200;
        let height = 800;

        Self { tick_rate, title, width, height }
    }
}