[−]Struct ggez::input::keyboard::KeyMods
Bitflags describing the state of keyboard modifiers, such as Control or Shift.
Methods
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 fn empty() -> KeyMods
Returns an empty set of flags.
pub fn all() -> KeyMods
Returns the set containing all flags.
pub 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 fn from_bits_truncate(bits: u8) -> KeyMods
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub fn is_empty(&self) -> bool
Returns true if no flags are currently stored.
pub fn is_all(&self) -> bool
Returns true if all flags are currently set.
pub fn intersects(&self, other: KeyMods) -> bool
Returns true if there are flags common to both self and other.
pub 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 PartialEq<KeyMods> for KeyMods
impl Default for KeyMods[src]
impl Ord for KeyMods
fn cmp(&self, other: &KeyMods) -> Ordering
fn max(self, other: Self) -> Self1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self1.21.0[src]
Compares and returns the minimum of two values. Read more
impl Clone for KeyMods
fn clone(&self) -> KeyMods
fn clone_from(&mut self, source: &Self)1.0.0[src]
Performs copy-assignment from source. Read more
impl Extend<KeyMods> for KeyMods
fn extend<T: IntoIterator<Item = KeyMods>>(&mut self, iterator: T)
impl From<ModifiersState> for KeyMods[src]
fn from(state: ModifiersState) -> Self[src]
impl Eq for KeyMods
impl Copy for KeyMods
impl PartialOrd<KeyMods> for KeyMods
fn partial_cmp(&self, other: &KeyMods) -> Option<Ordering>
fn lt(&self, other: &KeyMods) -> bool
fn le(&self, other: &KeyMods) -> bool
fn gt(&self, other: &KeyMods) -> bool
fn ge(&self, other: &KeyMods) -> bool
impl Hash for KeyMods
fn hash<__H: Hasher>(&self, state: &mut __H)
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher, 1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher]. Read more
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 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 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 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 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 BitAndAssign<KeyMods> for KeyMods
fn bitand_assign(&mut self, other: KeyMods)
Disables all flags disabled in the set.
impl BitOrAssign<KeyMods> for KeyMods
fn bitor_assign(&mut self, other: KeyMods)
Adds the set of flags.
impl BitXorAssign<KeyMods> for KeyMods
fn bitxor_assign(&mut self, other: KeyMods)
Toggles the set of flags.
impl FromIterator<KeyMods> for KeyMods
fn from_iter<T: IntoIterator<Item = KeyMods>>(iterator: T) -> KeyMods
impl Debug for KeyMods
impl Octal for KeyMods
impl Binary for KeyMods
impl LowerHex for KeyMods
impl UpperHex for KeyMods
Auto Trait Implementations
Blanket Implementations
impl<T> From for T[src]
impl<T, U> Into for T where
U: From<T>, [src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
impl<T, U> TryFrom for T where
U: Into<T>, [src]
U: Into<T>,
type Error = !
try_from)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T> Borrow for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> BorrowMut for T where
T: ?Sized, [src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T[src]
impl<T, U> TryInto for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
try_from)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<T> Scalar for T where
T: Copy + PartialEq<T> + Any + Debug, [src]
T: Copy + PartialEq<T> + Any + Debug,
impl<T> Same for T
type Output = T
Should always be Self
impl<T, Right> ClosedSub for T where
T: Sub<Right, Output = T> + SubAssign<Right>,
T: Sub<Right, Output = T> + SubAssign<Right>,
impl<SS, SP> SupersetOf for SP where
SS: SubsetOf<SP>,
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn is_in_subset(&self) -> bool
unsafe fn to_subset_unchecked(&self) -> SS
fn from_subset(element: &SS) -> SP
impl<T> Erased for T
impl<T> SetParameter for T
fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,
T: Parameter<Self>,
Sets value as a parameter of self.