Struct glutin::event::ModifiersState
source · pub struct ModifiersState { /* private fields */ }
Expand description
Represents the current state of the keyboard modifiers
Each flag represents a modifier and is set if this modifier is active.
Implementations§
source§impl ModifiersState
impl ModifiersState
sourcepub const SHIFT: ModifiersState = Self{ bits: 4,}
pub const SHIFT: ModifiersState = Self{ bits: 4,}
The “shift” key.
sourcepub const CTRL: ModifiersState = Self{ bits: 4 << 3,}
pub const CTRL: ModifiersState = Self{ bits: 4 << 3,}
The “control” key.
sourcepub const ALT: ModifiersState = Self{ bits: 4 << 6,}
pub const ALT: ModifiersState = Self{ bits: 4 << 6,}
The “alt” key.
sourcepub const LOGO: ModifiersState = Self{ bits: 4 << 9,}
pub const LOGO: ModifiersState = Self{ bits: 4 << 9,}
This is the “windows” key on PC and “command” key on Mac.
sourcepub const fn empty() -> ModifiersState
pub const fn empty() -> ModifiersState
Returns an empty set of flags.
sourcepub const fn all() -> ModifiersState
pub const fn all() -> ModifiersState
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u32) -> Option<ModifiersState>
pub const fn from_bits(bits: u32) -> Option<ModifiersState>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> ModifiersState
pub const fn from_bits_truncate(bits: u32) -> ModifiersState
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> ModifiersState
pub const unsafe fn from_bits_unchecked(bits: u32) -> ModifiersState
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: ModifiersState) -> bool
pub const fn intersects(&self, other: ModifiersState) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: ModifiersState) -> bool
pub const fn contains(&self, other: ModifiersState) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: ModifiersState)
pub fn insert(&mut self, other: ModifiersState)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: ModifiersState)
pub fn remove(&mut self, other: ModifiersState)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: ModifiersState)
pub fn toggle(&mut self, other: ModifiersState)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: ModifiersState, value: bool)
pub fn set(&mut self, other: ModifiersState, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: ModifiersState) -> ModifiersState
pub const fn intersection(self, other: ModifiersState) -> ModifiersState
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: ModifiersState) -> ModifiersState
pub const fn union(self, other: ModifiersState) -> ModifiersState
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: ModifiersState) -> ModifiersState
pub const fn difference(self, other: ModifiersState) -> ModifiersState
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: ModifiersState) -> ModifiersState
pub const fn symmetric_difference(self, other: ModifiersState) -> ModifiersState
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) -> ModifiersState
pub const fn complement(self) -> ModifiersState
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
.
Trait Implementations§
source§impl Binary for ModifiersState
impl Binary for ModifiersState
source§impl BitAnd<ModifiersState> for ModifiersState
impl BitAnd<ModifiersState> for ModifiersState
source§fn bitand(self, other: ModifiersState) -> ModifiersState
fn bitand(self, other: ModifiersState) -> ModifiersState
Returns the intersection between the two sets of flags.
§type Output = ModifiersState
type Output = ModifiersState
&
operator.source§impl BitAndAssign<ModifiersState> for ModifiersState
impl BitAndAssign<ModifiersState> for ModifiersState
source§fn bitand_assign(&mut self, other: ModifiersState)
fn bitand_assign(&mut self, other: ModifiersState)
Disables all flags disabled in the set.
source§impl BitOr<ModifiersState> for ModifiersState
impl BitOr<ModifiersState> for ModifiersState
source§fn bitor(self, other: ModifiersState) -> ModifiersState
fn bitor(self, other: ModifiersState) -> ModifiersState
Returns the union of the two sets of flags.
§type Output = ModifiersState
type Output = ModifiersState
|
operator.source§impl BitOrAssign<ModifiersState> for ModifiersState
impl BitOrAssign<ModifiersState> for ModifiersState
source§fn bitor_assign(&mut self, other: ModifiersState)
fn bitor_assign(&mut self, other: ModifiersState)
Adds the set of flags.
source§impl BitXor<ModifiersState> for ModifiersState
impl BitXor<ModifiersState> for ModifiersState
source§fn bitxor(self, other: ModifiersState) -> ModifiersState
fn bitxor(self, other: ModifiersState) -> ModifiersState
Returns the left flags, but with all the right flags toggled.
§type Output = ModifiersState
type Output = ModifiersState
^
operator.source§impl BitXorAssign<ModifiersState> for ModifiersState
impl BitXorAssign<ModifiersState> for ModifiersState
source§fn bitxor_assign(&mut self, other: ModifiersState)
fn bitxor_assign(&mut self, other: ModifiersState)
Toggles the set of flags.
source§impl Clone for ModifiersState
impl Clone for ModifiersState
source§fn clone(&self) -> ModifiersState
fn clone(&self) -> ModifiersState
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ModifiersState
impl Debug for ModifiersState
source§impl Default for ModifiersState
impl Default for ModifiersState
source§fn default() -> ModifiersState
fn default() -> ModifiersState
source§impl<'de> Deserialize<'de> for ModifiersState
impl<'de> Deserialize<'de> for ModifiersState
source§fn deserialize<D>(
deserializer: D
) -> Result<ModifiersState, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>( deserializer: D ) -> Result<ModifiersState, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,
source§impl Extend<ModifiersState> for ModifiersState
impl Extend<ModifiersState> for ModifiersState
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ModifiersState>,
fn extend<T>(&mut self, iterator: T)where T: IntoIterator<Item = ModifiersState>,
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 From<ModifiersState> for ModifiersState
impl From<ModifiersState> for ModifiersState
source§fn from(mods: ModifiersState) -> ModifiersState
fn from(mods: ModifiersState) -> ModifiersState
source§impl FromIterator<ModifiersState> for ModifiersState
impl FromIterator<ModifiersState> for ModifiersState
source§fn from_iter<T>(iterator: T) -> ModifiersStatewhere
T: IntoIterator<Item = ModifiersState>,
fn from_iter<T>(iterator: T) -> ModifiersStatewhere T: IntoIterator<Item = ModifiersState>,
source§impl Hash for ModifiersState
impl Hash for ModifiersState
source§impl LowerHex for ModifiersState
impl LowerHex for ModifiersState
source§impl Not for ModifiersState
impl Not for ModifiersState
source§fn not(self) -> ModifiersState
fn not(self) -> ModifiersState
Returns the complement of this set of flags.
§type Output = ModifiersState
type Output = ModifiersState
!
operator.source§impl Octal for ModifiersState
impl Octal for ModifiersState
source§impl Ord for ModifiersState
impl Ord for ModifiersState
source§fn cmp(&self, other: &ModifiersState) -> Ordering
fn cmp(&self, other: &ModifiersState) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<ModifiersState> for ModifiersState
impl PartialEq<ModifiersState> for ModifiersState
source§fn eq(&self, other: &ModifiersState) -> bool
fn eq(&self, other: &ModifiersState) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<ModifiersState> for ModifiersState
impl PartialOrd<ModifiersState> for ModifiersState
source§fn partial_cmp(&self, other: &ModifiersState) -> Option<Ordering>
fn partial_cmp(&self, other: &ModifiersState) -> 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 ModifiersState
impl Serialize for ModifiersState
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<ModifiersState> for ModifiersState
impl Sub<ModifiersState> for ModifiersState
source§fn sub(self, other: ModifiersState) -> ModifiersState
fn sub(self, other: ModifiersState) -> ModifiersState
Returns the set difference of the two sets of flags.
§type Output = ModifiersState
type Output = ModifiersState
-
operator.source§impl SubAssign<ModifiersState> for ModifiersState
impl SubAssign<ModifiersState> for ModifiersState
source§fn sub_assign(&mut self, other: ModifiersState)
fn sub_assign(&mut self, other: ModifiersState)
Disables all flags enabled in the set.