Struct Input

pub struct Input { /* private fields */ }

Input wraps a current and previous input state. When window events arrive from winit, you should call Input::process_input_event(); later (e.g. when handling winit::event::Event::AboutToWait and simulating a single game step), you can make queries like Input::is_key_down(), and when you’ve finished processing events for a frame you can call Input::next_frame() to cycle the new state to the old state.

Implementations

impl Input

pub fn process_input_event<T>(&mut self, ev: &Event<T>)

Process a winit event and update the current keys/mouse position.

pub fn is_key_down(&self, kc: Key) -> bool

Is this key currently down?

pub fn is_key_up(&self, kc: Key) -> bool

Is this key currently up?

pub fn is_key_pressed(&self, kc: Key) -> bool

Was this key just pressed on this frame?

pub fn is_key_released(&self, kc: Key) -> bool

Was this key just released on this frame?

pub fn is_mouse_down(&self, button: MouseButton) -> bool

Is this mouse button currently held?

pub fn is_mouse_up(&self, mb: MouseButton) -> bool

Is this mouse button currently up?

pub fn is_mouse_pressed(&self, mb: MouseButton) -> bool

Was this mouse button just pressed this frame?

pub fn is_mouse_released(&self, mb: MouseButton) -> bool

Was this mouse button just released this frame?

pub fn mouse_pos(&self) -> MousePos<f64>

Where is the mouse right now?

pub fn mouse_delta(&self) -> MousePos<f64>

How much has the mouse moved this frame?

pub fn key_axis(&self, down: Key, up: Key) -> f32

Given two keys (a negative and positive direction), produce a value between -1 and 1 based on which are currently held.

pub fn next_frame(&mut self)

Cycle current state to previous state.

Trait Implementations

impl Default for Input

fn default() -> Self

Returns the “default value” for a type.