nightshade 0.57.0

A cross-platform data-oriented game engine.
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

/// Input smoothing parameters for camera movement.
///
/// Applies exponential smoothing to input devices for fluid camera control.
/// Lower smoothness values = more responsive, higher values = smoother but laggier.
#[derive(
    Debug, Clone, Copy, PartialEq, serde::Serialize, serde::Deserialize, enum2schema::Schema,
)]
pub struct Smoothing {
    /// Mouse look speed multiplier.
    pub mouse_sensitivity: f32,
    /// Mouse input smoothing factor (0 = instant, 1 = no change).
    pub mouse_smoothness: f32,
    /// DPI scaling factor for mouse input.
    pub mouse_dpi_scale: f32,
    /// Keyboard movement smoothing factor.
    pub keyboard_smoothness: f32,
    /// Gamepad stick look speed multiplier.
    pub gamepad_sensitivity: f32,
    /// Gamepad input smoothing factor.
    pub gamepad_smoothness: f32,
    /// Gamepad stick deadzone threshold.
    pub gamepad_deadzone: f32,
    /// How fast keyboard movement carries the camera, in units per second.
    /// What counts as fast is a property of the world's scale, not of the
    /// engine: a camera crossing a room and one crossing a landscape want
    /// numbers orders of magnitude apart.
    #[serde(default = "default_move_speed")]
    pub move_speed: f32,
    /// What holding shift multiplies [`Self::move_speed`] by.
    #[serde(default = "default_sprint_multiplier")]
    pub sprint_multiplier: f32,
    /// Smoothed mouse delta (internal state).
    #[schema(type = "array", items = "number", len = 2)]
    pub smoothed_mouse_delta: nalgebra_glm::Vec2,
    /// Smoothed movement direction (internal state).
    #[schema(type = "array", items = "number", len = 3)]
    pub smoothed_movement: nalgebra_glm::Vec3,
    /// Smoothed gamepad input (internal state).
    #[schema(type = "array", items = "number", len = 2)]
    pub smoothed_gamepad_input: nalgebra_glm::Vec2,
}

fn default_move_speed() -> f32 {
    20.0
}

fn default_sprint_multiplier() -> f32 {
    3.0
}

impl Default for Smoothing {
    fn default() -> Self {
        Self {
            mouse_sensitivity: 0.5,
            mouse_smoothness: 0.05,
            mouse_dpi_scale: 1.0,
            keyboard_smoothness: 0.08,
            gamepad_sensitivity: 1.5,
            gamepad_smoothness: 0.06,
            gamepad_deadzone: 0.15,
            move_speed: default_move_speed(),
            sprint_multiplier: default_sprint_multiplier(),
            smoothed_mouse_delta: nalgebra_glm::vec2(0.0, 0.0),
            smoothed_movement: nalgebra_glm::vec3(0.0, 0.0, 0.0),
            smoothed_gamepad_input: nalgebra_glm::vec2(0.0, 0.0),
        }
    }
}