Struct ggez::input::keyboard::KeyMods

pub struct KeyMods { /* fields omitted */ }

Bitflags describing the state of keyboard modifiers, such as Control or Shift.

Implementations

impl KeyMods

pub const NONE: KeyMods

No modifiers; equivalent to KeyMods::default() and KeyMods::empty().

pub const SHIFT: KeyMods

Left or right Shift key.

pub const CTRL: KeyMods

Left or right Control key.

pub const ALT: KeyMods

Left or right Alt key.

pub const LOGO: KeyMods

Left or right Win/Cmd/equivalent key.

pub const fn empty() -> KeyMods

Returns an empty set of flags

pub const fn all() -> KeyMods

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<KeyMods>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u8) -> KeyMods

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u8) -> KeyMods

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: KeyMods) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: KeyMods) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: KeyMods)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: KeyMods)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: KeyMods)

Toggles the specified flags in-place.

pub fn set(&mut self, other: KeyMods, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for KeyMods

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

Formats the value using the given formatter.

impl BitAnd<KeyMods> for KeyMods

type Output = KeyMods

The resulting type after applying the & operator.

fn bitand(self, other: KeyMods) -> KeyMods

Returns the intersection between the two sets of flags.

impl BitAndAssign<KeyMods> for KeyMods

fn bitand_assign(&mut self, other: KeyMods)

Disables all flags disabled in the set.

impl BitOr<KeyMods> for KeyMods

type Output = KeyMods

The resulting type after applying the | operator.

fn bitor(self, other: KeyMods) -> KeyMods

Returns the union of the two sets of flags.

impl BitOrAssign<KeyMods> for KeyMods

fn bitor_assign(&mut self, other: KeyMods)

Adds the set of flags.

impl BitXor<KeyMods> for KeyMods

type Output = KeyMods

The resulting type after applying the ^ operator.

fn bitxor(self, other: KeyMods) -> KeyMods

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<KeyMods> for KeyMods

fn bitxor_assign(&mut self, other: KeyMods)

Toggles the set of flags.

impl Clone for KeyMods

fn clone(&self) -> KeyMods

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for KeyMods

impl Debug for KeyMods

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

Formats the value using the given formatter.

impl Default for KeyMods

fn default() -> KeyMods

Returns the "default value" for a type.

impl Eq for KeyMods

impl Extend<KeyMods> for KeyMods

fn extend<T: IntoIterator<Item = KeyMods>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<ModifiersState> for KeyMods

fn from(state: ModifiersState) -> Self

Performs the conversion.

impl FromIterator<KeyMods> for KeyMods

fn from_iter<T: IntoIterator<Item = KeyMods>>(iterator: T) -> KeyMods

Creates a value from an iterator.

impl Hash for KeyMods

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for KeyMods

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

Formats the value using the given formatter.

impl Not for KeyMods

type Output = KeyMods

The resulting type after applying the ! operator.

fn not(self) -> KeyMods

Returns the complement of this set of flags.

impl Octal for KeyMods

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

Formats the value using the given formatter.

impl Ord for KeyMods

fn cmp(&self, other: &KeyMods) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<KeyMods> for KeyMods

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

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

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

This method tests for !=.

impl PartialOrd<KeyMods> for KeyMods

fn partial_cmp(&self, other: &KeyMods) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &KeyMods) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &KeyMods) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &KeyMods) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &KeyMods) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for KeyMods

impl StructuralPartialEq for KeyMods

impl Sub<KeyMods> for KeyMods

type Output = KeyMods

The resulting type after applying the - operator.

fn sub(self, other: KeyMods) -> KeyMods

Returns the set difference of the two sets of flags.

impl SubAssign<KeyMods> for KeyMods

fn sub_assign(&mut self, other: KeyMods)

Disables all flags enabled in the set.

impl UpperHex for KeyMods

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

Formats the value using the given formatter.