bones_framework 0.4.0

The Bones game development framework.
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

//! Mouse input resource.

use crate::prelude::*;

/// Resource containing the mouse input events made this frame.
#[derive(HasSchema, Clone, Debug, Default)]
pub struct MouseInputs {
    /// The movement of the mouse this frame.
    pub movement: Vec2,
    /// The mouse wheel event sent this frame.
    pub wheel_events: Vec<MouseScrollEvent>,
    /// The mouse button events sent this frame.
    pub button_events: Vec<MouseButtonEvent>,
}

/// Mouse scroll-wheel input event.
#[derive(Debug, Clone, Copy)]
pub struct MouseScrollEvent {
    /// The unit the mouse scroll is in.
    pub unit: MouseScrollUnit,
    /// the scroll movement.
    pub movement: Vec2,
}

/// The unit that a [`MouseScrollEvent`] is in.
#[derive(Debug, Clone, Copy)]
#[repr(u8)]
pub enum MouseScrollUnit {
    /// The number of lines scrolled.
    Lines,
    /// The number of pixels scrolled.
    Pixels,
}

/// A mouse button input event.
#[derive(Debug, Clone, Copy)]
pub struct MouseButtonEvent {
    /// The button that the event refers to.
    pub button: MouseButton,
    /// Whether the button was pressed or released.
    pub state: ButtonState,
}

/// A button on the mouse.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash)]
#[repr(u8)]
pub enum MouseButton {
    #[default]
    /// The left mouse button.
    Left,
    /// The right mouse button.
    Right,
    /// The middle mouse button.
    Middle,
    /// Another mouse button with the associated number.
    Other(u16),
}