Enum leafwing_input_manager::user_input::Modifier

pub enum Modifier {
    Alt,
    Control,
    Shift,
    Win,
}

A keyboard modifier that combines two [KeyCode] values into one representation.

This buttonlike input is stored in InputKind, and will be triggered whenever either of these buttons are pressed. This will be decomposed into both values when converted into RawInputs.

Variants

Alt

Corresponds to [KeyCode::LAlt] and [KeyCode::RAlt].

Control

Corresponds to [KeyCode::LControl] and [KeyCode::RControl].

Shift

The key that makes letters capitalized, corresponding to [KeyCode::LShift] and [KeyCode::RShift]

Win

The OS or “Windows” key, corresponding to [KeyCode::LWin] and [KeyCode::RWin].

Implementations

impl Modifier

pub fn key_codes(self) -> [KeyCode; 2]

Returns the pair of [KeyCode] values associated with this modifier.

The left variant will always be in the first position, and the right variant is always in the second position.

Trait Implementations

impl Clone for Modifier

fn clone(&self) -> Modifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Modifier

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Modifier

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Modifier> for InputKind

fn from(input: Modifier) -> Self

Converts to this type from the input type.

impl From<Modifier> for UserInput

fn from(input: Modifier) -> Self

Converts to this type from the input type.

impl Hash for Modifier

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,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Modifier> for Modifier

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

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

const 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 Modifier

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 Modifier

impl Eq for Modifier

impl StructuralEq for Modifier

impl StructuralPartialEq for Modifier