Struct sixtyfps_corelib::input::KeyboardModifiers

#[repr(C)]pub struct KeyboardModifiers(_);

KeyboardModifiers wraps a u32 that reserves a single bit for each possible modifier key on a keyboard, such as Shift, Control, etc.

On macOS, the command key is mapped to the logo modifier.

On Windows, the windows key is mapped to the logo modifier.

Implementations

impl KeyboardModifiers

pub fn test(&self, modifier: KeyboardModifier) -> bool

Returns true if this set of keyboard modifiers includes the given modifier; false otherwise.

Arguments:

• modifier: The keyboard modifier to test for, usually one of the provided convenience constants such as SHIFT_MODIFIER.

pub fn test_exclusive(&self, modifier: KeyboardModifier) -> bool

Returns true if this set of keyboard modifiers consists of exactly the one specified modifier; false otherwise.

Arguments:

• modifier: The only modifier that is allowed to be in this modifier set, in order

pub fn shift(&self) -> bool

Returns true if the shift key is part of this set of keyboard modifiers.

pub fn control(&self) -> bool

Returns true if the control key is part of this set of keyboard modifiers.

pub fn alt(&self) -> bool

Returns true if the alt key is part of this set of keyboard modifiers.

pub fn logo(&self) -> bool

Returns true if on macOS the command key and on Windows the Windows key is part of this set of keyboard modifiers.

Trait Implementations

impl Clone for KeyboardModifiers

pub fn clone(&self) -> KeyboardModifiers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for KeyboardModifiers

impl Debug for KeyboardModifiers

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

Formats the value using the given formatter.

impl Default for KeyboardModifiers

pub fn default() -> Self

Returns the "default value" for a type.

impl Eq for KeyboardModifiers

impl From<KeyboardModifier> for KeyboardModifiers

pub fn from(modifier: KeyboardModifier) -> Self

Performs the conversion.

impl From<ModifiersState> for KeyboardModifiers

pub fn from(state: ModifiersState) -> Self

Performs the conversion.

impl PartialEq<KeyboardModifiers> for KeyboardModifiers

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

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

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

This method tests for !=.

impl StructuralEq for KeyboardModifiers

impl StructuralPartialEq for KeyboardModifiers