Struct sdl2::keyboard::Mod

pub struct Mod { /* fields omitted */ }

Methods

impl Mod

pub const NOMOD: Mod

pub const LSHIFTMOD: Mod

pub const RSHIFTMOD: Mod

pub const LCTRLMOD: Mod

pub const RCTRLMOD: Mod

pub const LALTMOD: Mod

pub const RALTMOD: Mod

pub const LGUIMOD: Mod

pub const RGUIMOD: Mod

pub const NUMMOD: Mod

pub const CAPSMOD: Mod

pub const MODEMOD: Mod

pub const RESERVEDMOD: Mod

pub const fn empty() -> Mod

Returns an empty set of flags

pub const fn all() -> Mod

Returns the set containing all flags.

pub const fn bits(&self) -> u16

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u16) -> Option<Mod>

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

pub const fn from_bits_truncate(bits: u16) -> Mod

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

pub const unsafe fn from_bits_unchecked(bits: u16) -> Mod

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for Mod

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

Formats the value using the given formatter.

impl BitAnd<Mod> for Mod

type Output = Mod

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<Mod> for Mod

fn bitand_assign(&mut self, other: Mod)

Disables all flags disabled in the set.

impl BitOr<Mod> for Mod

type Output = Mod

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<Mod> for Mod

fn bitor_assign(&mut self, other: Mod)

Adds the set of flags.

impl BitXor<Mod> for Mod

type Output = Mod

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<Mod> for Mod

fn bitxor_assign(&mut self, other: Mod)

Toggles the set of flags.

impl Clone for Mod

fn clone(&self) -> Mod

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Mod

impl Debug for Mod

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

Formats the value using the given formatter.

impl Display for Mod

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

Formats the value using the given formatter.

impl Eq for Mod

impl Extend<Mod> for Mod

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

Extends a collection with the contents of an iterator.

impl FromIterator<Mod> for Mod

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

Creates a value from an iterator.

impl Hash for Mod

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

Feeds this value into the given [Hasher].

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 Mod

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

Formats the value using the given formatter.

impl Not for Mod

type Output = Mod

The resulting type after applying the ! operator.

fn not(self) -> Mod

Returns the complement of this set of flags.

impl Octal for Mod

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

Formats the value using the given formatter.

impl Ord for Mod

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<Mod> for Mod

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

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

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

This method tests for !=.

impl PartialOrd<Mod> for Mod

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Mod

impl StructuralPartialEq for Mod

impl Sub<Mod> for Mod

type Output = Mod

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Mod> for Mod

fn sub_assign(&mut self, other: Mod)

Disables all flags enabled in the set.

impl UpperHex for Mod

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

Formats the value using the given formatter.