Struct Input

pub struct Input<T> { /* private fields */ }

A “press-able” input of type T.

This type can be used as a resource to keep the current state of an input, by reacting to events from the input. For a given input value:

• Input::pressed will return true between a press and a release event.
• Input::just_pressed will return true for one frame after a press event.
• Input::just_released will return true for one frame after a release event.

In case multiple systems are checking for Input::just_pressed or Input::just_released but only one should react, for example in the case of triggering State change, you should consider clearing the input state, either by:

• Using Input::clear_just_pressed or Input::clear_just_released instead.
• Calling Input::clear or Input::reset immediately after the state change.

Notes when adding this resource for a new input type

When adding this resource for a new input type, you should:

• Call the Input::press method for each press event.
• Call the Input::release method for each release event.
• Call the Input::clear method at each frame start, before processing events.

Implementations

impl<T> Input<T>

where T: Copy + Eq + Hash,

pub fn press(&mut self, input: T)

Register a press for input input.

pub fn pressed(&self, input: T) -> bool

Check if input has been pressed.

pub fn any_pressed(&self, inputs: impl IntoIterator<Item = T>) -> bool

Check if any item in inputs has been pressed.

pub fn release(&mut self, input: T)

Register a release for input input.

pub fn just_pressed(&self, input: T) -> bool

Check if input has been just pressed.

pub fn any_just_pressed(&self, inputs: impl IntoIterator<Item = T>) -> bool

Check if any item in inputs has just been pressed.

pub fn clear_just_pressed(&mut self, input: T) -> bool

Clear the “just pressed” state of input. Future calls to Input::just_pressed for the given input will return false until a new press event occurs. Returns true if input is currently “just pressed”

pub fn just_released(&self, input: T) -> bool

Check if input has been just released.

pub fn any_just_released(&self, inputs: impl IntoIterator<Item = T>) -> bool

Check if any item in inputs has just been released.

pub fn clear_just_released(&mut self, input: T) -> bool

Clear the “just released” state of input. Future calls to Input::just_released for the given input will return false until a new release event occurs. Returns true if input is currently “just released”

pub fn reset(&mut self, input: T)

Reset all status for input input.

pub fn clear(&mut self)

Clear just pressed and just released information.

pub fn get_pressed(&self) -> impl ExactSizeIterator

List all inputs that are pressed.

pub fn get_just_pressed(&self) -> impl ExactSizeIterator

List all inputs that are just pressed.

pub fn get_just_released(&self) -> impl ExactSizeIterator

List all inputs that are just released.

Trait Implementations

impl<T> Debug for Input<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Input<T>

fn default() -> Input<T>

Returns the “default value” for a type.