Struct Input 

pub struct Input(/* private fields */);

The frame’s keyboard/mouse/window input state.

A self-contained ECS resource — fetch it directly with Res<Input>, no need to go through WindowResource<W> or name a concrete backend type. Cheap to clone (an Arc internally), and every accessor locks internally and hands back a plain value, so there’s no guard type to hold onto: input.key_held(KeyCode::KeyW) just returns bool.

State is refreshed once per step, before systems run, so every accessor below reflects that step’s input.

Implementations

impl Input

pub fn key_pressed(&self, key: KeyCode) -> bool

True the step a key goes from “not pressed” to “pressed”. Uses physical keys (layout-independent), so this is the one to reach for game controls rather than text entry.

pub fn key_released(&self, key: KeyCode) -> bool

True the step a key goes from “pressed” to “not pressed”.

pub fn key_held(&self, key: KeyCode) -> bool

True for every step the key remains pressed.

pub fn held_shift(&self) -> bool

True while either shift key is held.

pub fn held_control(&self) -> bool

True while either control key is held.

pub fn held_alt(&self) -> bool

True while either alt key is held.

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

True the step a mouse button goes from “not pressed” to “pressed”.

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

True the step a mouse button goes from “pressed” to “not pressed”.

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

True for every step the mouse button remains pressed.

pub fn cursor(&self) -> Option<(f32, f32)>

Cursor position in pixels, or None if the window isn’t focused (or the cursor is off-window and no button is held).

pub fn cursor_diff(&self) -> (f32, f32)

Change in cursor position since the last step. (0.0, 0.0) under the same conditions Input::cursor returns None.

pub fn mouse_diff(&self) -> (f32, f32)

Change in raw mouse motion since the last step — driven by device events rather than cursor position, so this is the one to reach for a captured-mouse first-person camera.

pub fn scroll_diff(&self) -> (f32, f32)

Scroll wheel delta (horizontal, vertical) since the last step.

pub fn close_requested(&self) -> bool

True if the OS requested the window close this step (e.g. the title bar’s close button).

pub fn resolution(&self) -> Option<(u32, u32)>

Current window resolution, or None before the first resize event.

pub fn dropped_file(&self) -> Option<PathBuf>

Path of a file dropped onto the window this step, if any.

pub fn delta_time(&self) -> Option<Duration>

Time elapsed since the last step, or None while the first step is still in progress.

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.