logo
pub struct Input<T> where
    T: Eq + Hash
{ /* private fields */ }
Expand description

A “press-able” input of type T.

Usage

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:

Multiple systems

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:

Note

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

Implementations

Registers a press for the given input.

Returns true if the input has been pressed.

Returns true if any item in inputs has been pressed.

Registers a release for the given input.

Registers a release for all currently pressed inputs.

Returns true if the input has just been pressed.

Returns true if any item in inputs has just been pressed.

Clears the just_pressed state of the input and returns true if the input has just been pressed.

Future calls to Input::just_pressed for the given input will return false until a new press event occurs.

Returns true if the input has just been released.

Returns true if any item in inputs has just been released.

Clears the just_released state of the input and returns true if the input has just been released.

Future calls to Input::just_released for the given input will return false until a new release event occurs.

Clears the pressed, just_pressed and just_released data of the input.

Clears the pressed, just_pressed, and just_released data for every input.

See also Input::clear for simulating elapsed time steps.

Clears the just pressed and just released data for every input.

See also Input::reset_all for a full reset.

An iterator visiting every pressed input in arbitrary order.

An iterator visiting every just pressed input in arbitrary order.

An iterator visiting every just released input in arbitrary order.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

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

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

Returns the argument unchanged.

Creates Self using data from the given World

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

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

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more