Struct nannou::ui::input::ModifierKey

pub struct ModifierKey { /* fields omitted */ }

Implementations

impl ModifierKey

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.

impl ModifierKey

pub const NO_MODIFIER: ModifierKey

No modifier.

pub const CTRL: ModifierKey

Ctrl.

pub const SHIFT: ModifierKey

Shift.

pub const ALT: ModifierKey

Alt.

pub const GUI: ModifierKey

Gui.

pub const CTRL_SHIFT: ModifierKey

Ctrl + Shift.

pub const CTRL_ALT: ModifierKey

Ctrl + Alt.

pub const CTRL_GUI: ModifierKey

Ctrl + Gui.

pub const CTRL_SHIFT_ALT: ModifierKey

Ctrl + Shift + Alt.

pub const CTRL_SHIFT_GUI: ModifierKey

Ctrl + Shift + Gui.

pub const CTRL_SHIFT_ALT_GUI: ModifierKey

Ctrl + Shift + Alt + Gui.

pub const SHIFT_ALT: ModifierKey

Shift + Alt.

pub const SHIFT_GUI: ModifierKey

Shift + Gui.

pub const SHIFT_ALT_GUI: ModifierKey

Shift + Alt + Gui.

pub const ALT_GUI: ModifierKey

Alt + Gui.

pub const fn empty() -> ModifierKey

Returns an empty set of flags

pub const fn all() -> ModifierKey

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<ModifierKey>

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) -> ModifierKey

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

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).

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: ModifierKey) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for ModifierKey

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

Formats the value using the given formatter.

impl BitAnd<ModifierKey> for ModifierKey

type Output = ModifierKey

The resulting type after applying the & operator.

pub fn bitand(self, other: ModifierKey) -> ModifierKey

Returns the intersection between the two sets of flags.

impl BitAndAssign<ModifierKey> for ModifierKey

pub fn bitand_assign(&mut self, other: ModifierKey)

Disables all flags disabled in the set.

impl BitOr<ModifierKey> for ModifierKey

type Output = ModifierKey

The resulting type after applying the | operator.

pub fn bitor(self, other: ModifierKey) -> ModifierKey

Returns the union of the two sets of flags.

impl BitOrAssign<ModifierKey> for ModifierKey

pub fn bitor_assign(&mut self, other: ModifierKey)

Adds the set of flags.

impl BitXor<ModifierKey> for ModifierKey

type Output = ModifierKey

The resulting type after applying the ^ operator.

pub fn bitxor(self, other: ModifierKey) -> ModifierKey

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

impl BitXorAssign<ModifierKey> for ModifierKey

pub fn bitxor_assign(&mut self, other: ModifierKey)

Toggles the set of flags.

impl Clone for ModifierKey

pub fn clone(&self) -> ModifierKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ModifierKey

impl Debug for ModifierKey

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

Formats the value using the given formatter.

impl Default for ModifierKey

pub fn default() -> ModifierKey

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModifierKey

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

Deserialize this value from the given Serde deserializer.

impl Eq for ModifierKey

impl Extend<ModifierKey> for ModifierKey

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

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 FromIterator<ModifierKey> for ModifierKey

pub fn from_iter<T>(iterator: T) -> ModifierKey where
    T: IntoIterator<Item = ModifierKey>, 

Creates a value from an iterator.

impl Hash for ModifierKey

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

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 ModifierKey

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

Formats the value using the given formatter.

impl Not for ModifierKey

type Output = ModifierKey

The resulting type after applying the ! operator.

pub fn not(self) -> ModifierKey

Returns the complement of this set of flags.

impl Octal for ModifierKey

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

Formats the value using the given formatter.

impl Ord for ModifierKey

pub fn cmp(&self, other: &ModifierKey) -> 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<ModifierKey> for ModifierKey

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

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

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

This method tests for !=.

impl PartialOrd<ModifierKey> for ModifierKey

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl Serialize for ModifierKey

pub fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for ModifierKey

impl StructuralPartialEq for ModifierKey

impl Sub<ModifierKey> for ModifierKey

type Output = ModifierKey

The resulting type after applying the - operator.

pub fn sub(self, other: ModifierKey) -> ModifierKey

Returns the set difference of the two sets of flags.

impl SubAssign<ModifierKey> for ModifierKey

pub fn sub_assign(&mut self, other: ModifierKey)

Disables all flags enabled in the set.

impl UpperHex for ModifierKey

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

Formats the value using the given formatter.