Enum leafwing_input_manager::user_input::InputKind

#[non_exhaustive]
pub enum InputKind {
    GamepadButton(GamepadButtonType),
    SingleAxis(SingleAxis),
    DualAxis(DualAxis),
    Keyboard(KeyCode),
    KeyLocation(ScanCode),
    Modifier(Modifier),
    Mouse(MouseButton),
    MouseWheel(MouseWheelDirection),
    MouseMotion(MouseMotionDirection),
}

The different kinds of supported input bindings.

Commonly stored in the UserInput enum.

Unfortunately we cannot use a trait object here, as the types used by Input require traits that are not object-safe.

Please contact the maintainers if you need support for another type!

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

GamepadButton(GamepadButtonType)

A button on a gamepad

SingleAxis(SingleAxis)

A single axis of continuous motion

DualAxis(DualAxis)

Two paired axes of continuous motion

Keyboard(KeyCode)

A logical key on the keyboard.

The actual (physical) key that has to be pressed depends on the keyboard layout. If you care about the position of the key rather than what it stands for, use InputKind::KeyLocation instead.

KeyLocation(ScanCode)

The physical location of a key on the keyboard.

The logical key which is emitted by this key depends on the keyboard layout. If you care about the output of the key rather than where it is positioned, use InputKind::Keyboard instead.

Modifier(Modifier)

A keyboard modifier, like Ctrl or Alt, which doesn’t care about which side it’s on.

Mouse(MouseButton)

A button on a mouse

MouseWheel(MouseWheelDirection)

A discretized mousewheel movement

MouseMotion(MouseMotionDirection)

A discretized mouse movement

Trait Implementations

impl Clone for InputKind

fn clone(&self) -> InputKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InputKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InputKind

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

Formats the value using the given formatter.

impl From<DualAxis> for InputKind

fn from(input: DualAxis) -> Self

Converts to this type from the input type.

impl From<GamepadButtonType> for InputKind

fn from(input: GamepadButtonType) -> Self

Converts to this type from the input type.

impl From<InputKind> for UserInput

fn from(input: InputKind) -> Self

Converts to this type from the input type.

impl From<KeyCode> for InputKind

fn from(input: KeyCode) -> Self

Converts to this type from the input type.

impl From<Modifier> for InputKind

fn from(input: Modifier) -> Self

Converts to this type from the input type.

impl From<MouseButton> for InputKind

fn from(input: MouseButton) -> Self

Converts to this type from the input type.

impl From<MouseMotionDirection> for InputKind

fn from(input: MouseMotionDirection) -> Self

Converts to this type from the input type.

impl From<MouseWheelDirection> for InputKind

fn from(input: MouseWheelDirection) -> Self

Converts to this type from the input type.

impl From<QwertyScanCode> for InputKind

fn from(input: QwertyScanCode) -> Self

Converts to this type from the input type.

impl From<ScanCode> for InputKind

fn from(input: ScanCode) -> Self

Converts to this type from the input type.

impl From<SingleAxis> for InputKind

fn from(input: SingleAxis) -> Self

Converts to this type from the input type.

impl Hash for InputKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for InputKind

fn eq(&self, other: &InputKind) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for InputKind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for InputKind

impl Eq for InputKind

impl StructuralEq for InputKind

impl StructuralPartialEq for InputKind