Skip to main content

InputMap

Struct InputMap 

Source
pub struct InputMap { /* private fields */ }
Expand description

Action / binding map. One per engine — registered as a service in the ServiceRegistry and updated once per frame from the input queue.

Implementations§

Source§

impl InputMap

Source

pub fn new() -> Self

Creates an empty map with no bindings.

Source

pub fn bind(&mut self, action: impl Into<Action>, binding: InputBinding)

Adds a binding for action. An action can have multiple bindings — it fires when ANY of them fires (logical OR).

Source

pub fn unbind(&mut self, action: &Action, binding: &InputBinding) -> bool

Removes a single binding for action. Returns true if found.

Source

pub fn clear_action(&mut self, action: &Action)

Removes every binding for action.

Source

pub fn is_pressed(&self, action: &str) -> bool

Returns true when the named action is currently held.

Source

pub fn just_pressed(&self, action: &str) -> bool

Returns true only on the frame the action transitioned from released → pressed. Cleared on the next update call.

Source

pub fn just_released(&self, action: &str) -> bool

Returns true only on the frame the action transitioned from pressed → released. Cleared on the next update call.

Source

pub fn update(&mut self, events: &[InputEvent])

Drains a frame of input events into the action sets. Call once per frame before game logic queries the map. Edge sets (just_*) are cleared first; held set persists across frames until a Released event arrives.

Trait Implementations§

Source§

impl Debug for InputMap

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for InputMap

Source§

fn default() -> InputMap

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AppLifecycle for T
where T: ?Sized,

Source§

fn on_start(&mut self, ctx: &mut dyn AppContext)

Called once after the backend is up but before the first update. Apps install their theme / fonts here.
Source§

fn on_exit(&mut self)

Called once when the window is closing. Persist state here.
Source§

impl<T> AsAny for T
where T: Any,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Returns a reference to the inner value as &dyn Any.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.