Struct InputState 

pub struct InputState {
    pub keys_down: HashSet<Key>,
    pub keys_pressed: HashSet<Key>,
    pub keys_released: HashSet<Key>,
    pub mouse_down: HashSet<MouseButton>,
    pub mouse_pressed: HashSet<MouseButton>,
    pub mouse_released: HashSet<MouseButton>,
    pub cursor_pos: Option<(f32, f32)>,
    pub wheel_delta: (f32, f32),
    /* private fields */
}

Snapshot of user input.

This is intentionally minimal for now, but it already supports:

• current key/button state (down)
• per-frame transitions (pressed/released)
• cursor position and wheel delta
• mouse movement delta

Fields

keys_down: HashSet<Key>

keys_pressed: HashSet<Key>

keys_released: HashSet<Key>

mouse_down: HashSet<MouseButton>

mouse_pressed: HashSet<MouseButton>

mouse_released: HashSet<MouseButton>

cursor_pos: Option<(f32, f32)>

Cursor position in physical pixels (as reported by winit).

wheel_delta: (f32, f32)

Accumulated wheel delta since last begin_frame.

Implementations

impl InputState

pub fn start_frame(&mut self)

Called at the start of a render/update frame.

Important: this does not clear edge-triggered sets (pressed/released). Those are cleared at end_frame so events delivered before RedrawRequested are still visible to systems during Universe::update.

pub fn end_frame(&mut self)

Clears edge-triggered sets at the end of a frame.

pub fn key_down(&self, key: &Key) -> bool

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

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

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

Returns the mouse movement delta (dx, dy) since the last frame. Returns (0, 0) if cursor position is not available.

pub fn mouse_dragging(&self) -> bool

Whether the user is currently dragging the mouse (button held + cursor moved this frame).

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

Mouse drag delta (dx, dy) in pixels for this frame.

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

Whether the given mouse button is currently dragging (that button is held + cursor moved this frame).

pub fn mouse_drag_delta_button(&self, button: MouseButton) -> (f32, f32)

Mouse drag delta (dx, dy) in pixels for this frame, gated to the given button.

pub fn text_input_events(&self) -> &[TextInputFrameEvent]

Trait Implementations

impl Clone for InputState

fn clone(&self) -> InputState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for InputState

fn default() -> InputState

Returns the “default value” for a type.