Struct piston::keyboard::ModifierKey
source · pub struct ModifierKey { /* private fields */ }
Implementations§
source§impl ModifierKey
impl ModifierKey
sourcepub const NO_MODIFIER: ModifierKey = _
pub const NO_MODIFIER: ModifierKey = _
No modifier.
sourcepub const CTRL: ModifierKey = _
pub const CTRL: ModifierKey = _
Ctrl.
sourcepub const SHIFT: ModifierKey = _
pub const SHIFT: ModifierKey = _
Shift.
sourcepub const ALT: ModifierKey = _
pub const ALT: ModifierKey = _
Alt.
sourcepub const GUI: ModifierKey = _
pub const GUI: ModifierKey = _
Gui.
sourcepub const CTRL_SHIFT: ModifierKey = _
pub const CTRL_SHIFT: ModifierKey = _
Ctrl + Shift.
sourcepub const CTRL_ALT: ModifierKey = _
pub const CTRL_ALT: ModifierKey = _
Ctrl + Alt.
sourcepub const CTRL_GUI: ModifierKey = _
pub const CTRL_GUI: ModifierKey = _
Ctrl + Gui.
sourcepub const CTRL_SHIFT_ALT: ModifierKey = _
pub const CTRL_SHIFT_ALT: ModifierKey = _
Ctrl + Shift + Alt.
sourcepub const CTRL_SHIFT_GUI: ModifierKey = _
pub const CTRL_SHIFT_GUI: ModifierKey = _
Ctrl + Shift + Gui.
sourcepub const CTRL_SHIFT_ALT_GUI: ModifierKey = _
pub const CTRL_SHIFT_ALT_GUI: ModifierKey = _
Ctrl + Shift + Alt + Gui.
sourcepub const SHIFT_ALT: ModifierKey = _
pub const SHIFT_ALT: ModifierKey = _
Shift + Alt.
sourcepub const SHIFT_GUI: ModifierKey = _
pub const SHIFT_GUI: ModifierKey = _
Shift + Gui.
sourcepub const SHIFT_ALT_GUI: ModifierKey = _
pub const SHIFT_ALT_GUI: ModifierKey = _
Shift + Alt + Gui.
sourcepub const ALT_GUI: ModifierKey = _
pub const ALT_GUI: ModifierKey = _
Alt + Gui.
sourcepub const fn empty() -> ModifierKey
pub const fn empty() -> ModifierKey
Returns an empty set of flags.
sourcepub const fn all() -> ModifierKey
pub const fn all() -> ModifierKey
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u8) -> Option<ModifierKey>
pub const fn from_bits(bits: u8) -> Option<ModifierKey>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u8) -> ModifierKey
pub const fn from_bits_truncate(bits: u8) -> ModifierKey
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> ModifierKey
pub const unsafe fn from_bits_unchecked(bits: u8) -> ModifierKey
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: ModifierKey) -> bool
pub const fn intersects(&self, other: ModifierKey) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: ModifierKey) -> bool
pub const fn contains(&self, other: ModifierKey) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: ModifierKey)
pub fn insert(&mut self, other: ModifierKey)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: ModifierKey)
pub fn remove(&mut self, other: ModifierKey)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: ModifierKey)
pub fn toggle(&mut self, other: ModifierKey)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: ModifierKey, value: bool)
pub fn set(&mut self, other: ModifierKey, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: ModifierKey) -> ModifierKey
pub const fn intersection(self, other: ModifierKey) -> ModifierKey
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: ModifierKey) -> ModifierKey
pub const fn union(self, other: ModifierKey) -> ModifierKey
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: ModifierKey) -> ModifierKey
pub const fn difference(self, other: ModifierKey) -> ModifierKey
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: ModifierKey) -> ModifierKey
pub const fn symmetric_difference(self, other: ModifierKey) -> ModifierKey
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> ModifierKey
pub const fn complement(self) -> ModifierKey
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
source§impl ModifierKey
impl ModifierKey
sourcepub fn event<E>(&mut self, e: &E)where
E: GenericEvent,
pub fn event<E>(&mut self, e: &E)where E: GenericEvent,
Change modifier key state depending on input.
If the left or side button is released, it counts as a release.
Trait Implementations§
source§impl Binary for ModifierKey
impl Binary for ModifierKey
source§impl BitAnd<ModifierKey> for ModifierKey
impl BitAnd<ModifierKey> for ModifierKey
source§fn bitand(self, other: ModifierKey) -> ModifierKey
fn bitand(self, other: ModifierKey) -> ModifierKey
Returns the intersection between the two sets of flags.
§type Output = ModifierKey
type Output = ModifierKey
&
operator.source§impl BitAndAssign<ModifierKey> for ModifierKey
impl BitAndAssign<ModifierKey> for ModifierKey
source§fn bitand_assign(&mut self, other: ModifierKey)
fn bitand_assign(&mut self, other: ModifierKey)
Disables all flags disabled in the set.
source§impl BitOr<ModifierKey> for ModifierKey
impl BitOr<ModifierKey> for ModifierKey
source§fn bitor(self, other: ModifierKey) -> ModifierKey
fn bitor(self, other: ModifierKey) -> ModifierKey
Returns the union of the two sets of flags.
§type Output = ModifierKey
type Output = ModifierKey
|
operator.source§impl BitOrAssign<ModifierKey> for ModifierKey
impl BitOrAssign<ModifierKey> for ModifierKey
source§fn bitor_assign(&mut self, other: ModifierKey)
fn bitor_assign(&mut self, other: ModifierKey)
Adds the set of flags.
source§impl BitXor<ModifierKey> for ModifierKey
impl BitXor<ModifierKey> for ModifierKey
source§fn bitxor(self, other: ModifierKey) -> ModifierKey
fn bitxor(self, other: ModifierKey) -> ModifierKey
Returns the left flags, but with all the right flags toggled.
§type Output = ModifierKey
type Output = ModifierKey
^
operator.source§impl BitXorAssign<ModifierKey> for ModifierKey
impl BitXorAssign<ModifierKey> for ModifierKey
source§fn bitxor_assign(&mut self, other: ModifierKey)
fn bitxor_assign(&mut self, other: ModifierKey)
Toggles the set of flags.
source§impl Clone for ModifierKey
impl Clone for ModifierKey
source§fn clone(&self) -> ModifierKey
fn clone(&self) -> ModifierKey
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ModifierKey
impl Debug for ModifierKey
source§impl Default for ModifierKey
impl Default for ModifierKey
source§fn default() -> ModifierKey
fn default() -> ModifierKey
source§impl<'de> Deserialize<'de> for ModifierKey
impl<'de> Deserialize<'de> for ModifierKey
source§fn deserialize<__D>(
__deserializer: __D
) -> Result<ModifierKey, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>( __deserializer: __D ) -> Result<ModifierKey, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,
source§impl Extend<ModifierKey> for ModifierKey
impl Extend<ModifierKey> for ModifierKey
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ModifierKey>,
fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = ModifierKey>,
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<ModifierKey> for ModifierKey
impl FromIterator<ModifierKey> for ModifierKey
source§fn from_iter<T>(iterator: T) -> ModifierKeywhere
T: IntoIterator<Item = ModifierKey>,
fn from_iter<T>(iterator: T) -> ModifierKeywhere T: IntoIterator<Item = ModifierKey>,
source§impl Hash for ModifierKey
impl Hash for ModifierKey
source§impl LowerHex for ModifierKey
impl LowerHex for ModifierKey
source§impl Not for ModifierKey
impl Not for ModifierKey
source§fn not(self) -> ModifierKey
fn not(self) -> ModifierKey
Returns the complement of this set of flags.
§type Output = ModifierKey
type Output = ModifierKey
!
operator.source§impl Octal for ModifierKey
impl Octal for ModifierKey
source§impl Ord for ModifierKey
impl Ord for ModifierKey
source§fn cmp(&self, other: &ModifierKey) -> Ordering
fn cmp(&self, other: &ModifierKey) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<ModifierKey> for ModifierKey
impl PartialEq<ModifierKey> for ModifierKey
source§fn eq(&self, other: &ModifierKey) -> bool
fn eq(&self, other: &ModifierKey) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<ModifierKey> for ModifierKey
impl PartialOrd<ModifierKey> for ModifierKey
source§fn partial_cmp(&self, other: &ModifierKey) -> Option<Ordering>
fn partial_cmp(&self, other: &ModifierKey) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Serialize for ModifierKey
impl Serialize for ModifierKey
source§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,
source§impl Sub<ModifierKey> for ModifierKey
impl Sub<ModifierKey> for ModifierKey
source§fn sub(self, other: ModifierKey) -> ModifierKey
fn sub(self, other: ModifierKey) -> ModifierKey
Returns the set difference of the two sets of flags.
§type Output = ModifierKey
type Output = ModifierKey
-
operator.source§impl SubAssign<ModifierKey> for ModifierKey
impl SubAssign<ModifierKey> for ModifierKey
source§fn sub_assign(&mut self, other: ModifierKey)
fn sub_assign(&mut self, other: ModifierKey)
Disables all flags enabled in the set.