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

use std::path::PathBuf;

use magma_app::magma_ecs::entities::Entity;
use magma_math::IVec2;

use crate::window::WindowTheme;

/// An event for signaling a window resize.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Default)]
pub struct WindowResized {
    pub window: Entity,
    pub width: u32,
    pub height: u32,
}

/// An event signaling a requested redraw of the whole application.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Default)]
pub struct RedrawRequested;

/// An event signaling a window has been created.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Default)]
pub struct WindowCreated {
    pub window: Entity,
}

/// An event signaling that a window has been requested to close. It should live one more update cycle with a [`ClosingWindow`](crate::ClosingWindow)
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Default)]
pub struct WindowCloseRequested {
    pub window: Entity,
}

/// An event signaling a window has been closed. The corresponding entity will no longer exist at the time this is emmited.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Default)]
pub struct WindowClosed {
    pub window: Entity,
}

/// An event signaling a window has been destroyed. The corresponding entity will no longer exist at the time this is emmited.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Default)]
pub struct WindowDestroyed;

/// An event signaling that the cursor has moved within a window.
#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, Default)]
pub struct CursorMoved {
    pub window: Entity,
    pub position: IVec2,
}

/// An event signaling the cursor has entered a winbdow.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Default)]
pub struct CursorEntered {
    pub window: Entity,
}

/// An event signaling the cursor has left a window.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Default)]
pub struct CursorLeft {
    pub window: Entity,
}

/// An event signaling a focus change for a window.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Default)]
pub struct WindowFocused {
    pub window: Entity,
    pub focus: bool,
}

/// An event signaling the window's occlusion has changed.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
pub enum WindowOcclusion {
    /// The window is occluded by another window.
    Occluded { window: Entity },
    /// The window is not occluded anymore.
    NotOccluded { window: Entity },
}

/// An event signaling file drag and drops.
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
pub enum FileDragDrop {
    /// A file has been dropped on a window.
    Dropped { window: Entity, path: PathBuf },
    /// A file is hovering over a window.
    Hovered { window: Entity, path: PathBuf },
    /// A file hover has been canceled.
    HoverCanceled { window: Entity },
}

/// An event signaling that the window has moved.
#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, Default)]
pub struct WindowMoved {
    pub window: Entity,
    pub position: IVec2,
}

/// An event signaling that the window's theme variant changed.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Default)]
pub struct WindowThemeChanged {
    pub window: Entity,
    pub theme: WindowTheme,
}