Struct quicksilver::input::Input

pub struct Input { /* fields omitted */ }

The source of events and input device state

Implementations

impl Input

pub async fn next_event<'_>(&'_ mut self) -> Option<Event>

Retrieve the next event from the environment, or wait until there is one

If an event has occured since this method was last called, it will be return as Some(event). Once all events have been handled, None will be returned. At this point you should run any update or drawing logic in your app. When this method is called after it returns None, it will yield control back to the environment until your app should run again.

impl Input

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

Check if a given key is down

pub fn mouse(&self) -> PointerState

The state of the global mouse

Under a system with touch input or with multiple cursors, this may report erratic results. The state here is tracked for every pointer event, regardless of pointer ID.

pub fn pointer(&self, id: &PointerId) -> Option<PointerState>

The state of the given pointer

pub fn pointers(&self) -> impl Iterator<Item = (&PointerId, PointerState)>

The pointer ID and values that have been tracked

pub fn gamepad(&self, id: &GamepadId) -> Option<&GamepadState>

The state of the given gamepad

pub fn gamepads(&self) -> impl Iterator<Item = (&GamepadId, &GamepadState)>

The gamepad ID and values that have been tracked