magma_input 0.1.0-alpha.2

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

use crate::{
    ButtonState,
    keyboard::{Key, KeyCode},
    mouse::{MouseButton, MouseScrollUnit},
};
use magma_app::entities::Entity;
use magma_math::Vec2;

/// Event emmited for keyboard input
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
pub struct KeyboardInput {
    /// key name
    pub key: Key,
    /// key code
    pub key_code: KeyCode,
    // pub text: Option<&'static str>, - needs ime support #34
    /// The current state of the key
    pub state: ButtonState,
    /// Sometimes a key being held down for a period of time causes it to be repeated. This will be true if that is the case.
    pub repeat: bool,
    /// The window which emmited the event
    pub window: Entity,
}

/// Event emmited when a mouse button is pressed
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
pub struct MouseButtonInput {
    /// The button of the mouse
    pub button: MouseButton,
    /// The current state of the button
    pub state: ButtonState,
    /// The window which emmited the event
    pub window: Entity,
}

/// Event emmited when the mouse scroll wheel is used
#[derive(Clone, Copy, PartialEq, PartialOrd, Debug)]
pub struct MouseScrollInput {
    /// The unit of the scroll event. Can be either in pixels or lines.
    pub unit: MouseScrollUnit,
    /// The horizontal value
    pub x: f32,
    /// The vertical value
    pub y: f32,
    /// The window which emmited the event
    pub window: Entity,
}

/// Event emmited when the mouse is moved
#[derive(Clone, Copy, PartialEq, Debug, Default)]
pub struct MouseMotionInput {
    /// The movement delta
    pub delta: Vec2,
}