Struct KeyMod 

#[repr(transparent)]
pub struct KeyMod(pub u16);

Bitmask of modifier keys currently pressed / latched.

Tuple Fields

0: u16

Implementations

impl KeyMod

pub const NONE: KeyMod

pub const LSHIFT: KeyMod

pub const RSHIFT: KeyMod

pub const LEVEL5: KeyMod

pub const LCTRL: KeyMod

pub const RCTRL: KeyMod

pub const LALT: KeyMod

pub const RALT: KeyMod

pub const LGUI: KeyMod

pub const RGUI: KeyMod

pub const NUM: KeyMod

pub const CAPS: KeyMod

pub const MODE: KeyMod

pub const SCROLL: KeyMod

pub const SHIFT: KeyMod

pub const CTRL: KeyMod

pub const ALT: KeyMod

pub const GUI: KeyMod

pub const fn new(raw: u16) -> Self

pub const fn raw(self) -> u16

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

pub const fn intersects(self, other: KeyMod) -> bool

pub const fn is_empty(self) -> bool

pub const fn shift(self) -> bool

True if either Shift key is pressed.

pub const fn ctrl(self) -> bool

True if either Ctrl key is pressed.

pub const fn alt(self) -> bool

True if either Alt key is pressed.

pub const fn gui(self) -> bool

True if either GUI (Win / Cmd / Super) key is pressed.

pub const fn altgr(self) -> bool

True if the “AltGr” state is active — either MODE latched or RALT held (the usual encoding on Linux/Windows keyboards).

pub const fn caps(self) -> bool

True if Caps Lock is currently latched.

pub const fn num(self) -> bool

True if Num Lock is currently latched.

Trait Implementations

impl BitAnd for KeyMod

type Output = KeyMod

The resulting type after applying the & operator.

fn bitand(self, rhs: KeyMod) -> KeyMod

Performs the & operation.

impl BitAndAssign for KeyMod

fn bitand_assign(&mut self, rhs: KeyMod)

Performs the &= operation.

impl BitOr for KeyMod

type Output = KeyMod

The resulting type after applying the | operator.

fn bitor(self, rhs: KeyMod) -> KeyMod

Performs the | operation.

impl BitOrAssign for KeyMod

fn bitor_assign(&mut self, rhs: KeyMod)

Performs the |= operation.

impl Clone for KeyMod

fn clone(&self) -> KeyMod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyMod

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

Formats the value using the given formatter.

impl Default for KeyMod

fn default() -> KeyMod

Returns the “default value” for a type.

impl From<KeyMod> for u16

fn from(value: KeyMod) -> Self

Converts to this type from the input type.

impl From<u16> for KeyMod

fn from(value: u16) -> Self

Converts to this type from the input type.

impl Hash for KeyMod

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Not for KeyMod

type Output = KeyMod

The resulting type after applying the ! operator.

fn not(self) -> KeyMod

Performs the unary ! operation.

impl Ord for KeyMod

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for KeyMod

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for KeyMod

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for KeyMod

impl Eq for KeyMod

impl StructuralPartialEq for KeyMod