Struct leafwing_input_manager::input_streams::InputStreams

pub struct InputStreams<'a> {
    pub gamepad_buttons: &'a ButtonInput<GamepadButton>,
    pub gamepad_button_axes: &'a Axis<GamepadButton>,
    pub gamepad_axes: &'a Axis<GamepadAxis>,
    pub gamepads: &'a Gamepads,
    pub keycodes: Option<&'a ButtonInput<KeyCode>>,
    pub mouse_buttons: Option<&'a ButtonInput<MouseButton>>,
    pub mouse_wheel: Option<Vec<MouseWheel>>,
    pub mouse_motion: Vec<MouseMotion>,
    pub associated_gamepad: Option<Gamepad>,
}

A collection of [ButtonInput] structs, which can be used to update an InputMap.

These are typically collected via a system from the [World] as resources.

Fields

gamepad_buttons: &'a ButtonInput<GamepadButton>

A [GamepadButton] Input stream

gamepad_button_axes: &'a Axis<GamepadButton>

A [GamepadButton] [Axis] stream

gamepad_axes: &'a Axis<GamepadAxis>

A [GamepadAxis] [Axis] stream

gamepads: &'a Gamepads

A list of registered gamepads

keycodes: Option<&'a ButtonInput<KeyCode>>

A [KeyCode] [ButtonInput] stream

mouse_buttons: Option<&'a ButtonInput<MouseButton>>

A [MouseButton] Input stream

mouse_wheel: Option<Vec<MouseWheel>>

A [MouseWheel] event stream

mouse_motion: Vec<MouseMotion>

A [MouseMotion] event stream

associated_gamepad: Option<Gamepad>

The [Gamepad] that this struct will detect inputs from

Implementations

impl<'a> InputStreams<'a>

pub fn from_world(world: &'a World, gamepad: Option<Gamepad>) -> Self

Construct an InputStreams from a [World]

impl<'a> InputStreams<'a>

pub fn input_pressed(&self, input: &UserInput) -> bool

Is the input matched by the InputStreams?

pub fn any_pressed(&self, inputs: &HashSet<UserInput>) -> bool

Is at least one of the inputs pressed?

pub fn button_pressed(&self, button: InputKind) -> bool

Is the button pressed?

pub fn all_buttons_pressed(&self, buttons: &[InputKind]) -> bool

Are all the buttons pressed?

pub fn input_value(&self, input: &UserInput, include_deadzone: bool) -> f32

Get the “value” of the input.

For binary inputs such as buttons, this will always be either 0.0 or 1.0. For analog inputs such as axes, this will be the axis value.

UserInput::Chord inputs are also considered binary and will return 0.0 or 1.0 based on whether the chord has been pressed.

Warning

If you need to ensure that this value is always in the range [-1., 1.], be sure to clamp the returned data.

pub fn input_axis_pair(&self, input: &UserInput) -> Option<DualAxisData>

Get the axis pair associated to the user input.

If input is a chord, returns result of the first dual axis in the chord. If input is not a DualAxis or VirtualDPad, returns None.

Warning

If you need to ensure that this value is always in the range [-1., 1.], be sure to clamp the returned data.

Trait Implementations

impl<'a> Clone for InputStreams<'a>

fn clone(&self) -> InputStreams<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for InputStreams<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a MutableInputStreams<'a>> for InputStreams<'a>

fn from(mutable_streams: &'a MutableInputStreams<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<MutableInputStreams<'a>> for InputStreams<'a>

fn from(mutable_streams: MutableInputStreams<'a>) -> Self

Converts to this type from the input type.

impl QueryInput for InputStreams<'_>

fn pressed(&self, input: impl Into<UserInput>) -> bool

Is the provided user_input pressed?

fn pressed_for_gamepad( &self, input: impl Into<UserInput>, gamepad: Option<Gamepad> ) -> bool

Is the provided user_input pressed for the provided [Gamepad]?