Struct dotrix_core::input::Input

pub struct Input {
    pub events: Vec<Event>,
    pub modifiers: Modifiers,
    // some fields omitted
}

Input Service

Collects input events, tracks state changes and provides mapping to game actions

Fields

events: Vec<Event>

events collector

modifiers: Modifiers

modifiers collector

Implementations

impl Input

pub fn action_state<T>(&self, action: T) -> Option<State> where
    Self: ActionMapper<T>,
    T: Copy + Eq + Hash, 

Returns the status of the mapped action.

pub fn button_state(&self, button: Button) -> Option<State>

Returns the status of the raw input

pub fn is_action_activated<T>(&self, action: T) -> bool where
    Self: ActionMapper<T>,
    T: Copy + Eq + Hash, 

Checks if mapped action button is pressed

pub fn is_action_deactivated<T>(&self, action: T) -> bool where
    Self: ActionMapper<T>,
    T: Copy + Eq + Hash, 

Checks if mapped action button is released

pub fn is_action_hold<T>(&self, action: T) -> bool where
    Self: ActionMapper<T>,
    T: Copy + Eq + Hash, 

Checks if mapped button is pressed or hold

pub fn set_mapper(&mut self, mapper: Box<dyn Any + Send + Sync>)

Set custom ActionMapper

pub fn mapper<T: 'static + Send + Sync>(&self) -> &T

Get input mapper reference

pub fn mapper_mut<T: 'static + Send + Sync>(&mut self) -> &mut T

Get mutual mapper reference

pub fn set_window_size(&mut self, width: f32, height: f32)

Set window size

pub fn mouse_scroll(&self) -> f32

Mouse scroll delta

Value can be positive (up) or negative (down)

pub fn mouse_position(&self) -> Option<&Vec2>

Current mouse position in pixel coordinates. The top-left of the window is at (0, 0)

pub fn mouse_delta(&self) -> Vec2

Difference of the mouse position from the last frame in pixel coordinates

The top-left of the window is at (0, 0).

pub fn mouse_moved(&self) -> bool

Returns true if mouse was moved this frame.

This can be handy to do quick check before doing some performance costly operation.

pub fn mouse_position_normalized(&self) -> Vec2

Normalized mouse position

The top-left of the window is at (0, 0), bottom-right at (1, 1)

Trait Implementations

impl Default for Input

fn default() -> Self

Input service constructor