Struct SDL_Keymod 

#[repr(transparent)]
pub struct SDL_Keymod(pub Uint16);

Valid key modifiers (possibly OR’d together).

Availability

This datatype is available since SDL 3.2.0.

Known values (sdl3-sys)

Associated constant	Global constant	Description
NONE	SDL_KMOD_NONE	no modifier is applicable.
LSHIFT	SDL_KMOD_LSHIFT	the left Shift key is down.
RSHIFT	SDL_KMOD_RSHIFT	the right Shift key is down.
LEVEL5	SDL_KMOD_LEVEL5	the Level 5 Shift key is down.
LCTRL	SDL_KMOD_LCTRL	the left Ctrl (Control) key is down.
RCTRL	SDL_KMOD_RCTRL	the right Ctrl (Control) key is down.
LALT	SDL_KMOD_LALT	the left Alt key is down.
RALT	SDL_KMOD_RALT	the right Alt key is down.
LGUI	SDL_KMOD_LGUI	the left GUI key (often the Windows key) is down.
RGUI	SDL_KMOD_RGUI	the right GUI key (often the Windows key) is down.
NUM	SDL_KMOD_NUM	the Num Lock key (may be located on an extended keypad) is down.
CAPS	SDL_KMOD_CAPS	the Caps Lock key is down.
MODE	SDL_KMOD_MODE	the !AltGr key is down.
SCROLL	SDL_KMOD_SCROLL	the Scroll Lock key is down.
CTRL	SDL_KMOD_CTRL	Any Ctrl key is down.
SHIFT	SDL_KMOD_SHIFT	Any Shift key is down.
ALT	SDL_KMOD_ALT	Any Alt key is down.
GUI	SDL_KMOD_GUI	Any GUI key is down.

Tuple Fields

0: Uint16

Implementations

impl SDL_Keymod

pub const NONE: Self

no modifier is applicable.

pub const LSHIFT: Self

the left Shift key is down.

pub const RSHIFT: Self

the right Shift key is down.

pub const LEVEL5: Self

the Level 5 Shift key is down.

pub const LCTRL: Self

the left Ctrl (Control) key is down.

pub const RCTRL: Self

the right Ctrl (Control) key is down.

pub const LALT: Self

the left Alt key is down.

pub const RALT: Self

the right Alt key is down.

pub const LGUI: Self

the left GUI key (often the Windows key) is down.

pub const RGUI: Self

the right GUI key (often the Windows key) is down.

pub const NUM: Self

the Num Lock key (may be located on an extended keypad) is down.

pub const CAPS: Self

the Caps Lock key is down.

pub const MODE: Self

the !AltGr key is down.

pub const SCROLL: Self

the Scroll Lock key is down.

pub const CTRL: Self

Any Ctrl key is down.

pub const SHIFT: Self

Any Shift key is down.

pub const ALT: Self

Any Alt key is down.

pub const GUI: Self

Any GUI key is down.

Trait Implementations

impl BitAnd for SDL_Keymod

type Output = SDL_Keymod

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for SDL_Keymod

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for SDL_Keymod

type Output = SDL_Keymod

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for SDL_Keymod

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for SDL_Keymod

type Output = SDL_Keymod

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for SDL_Keymod

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for SDL_Keymod

fn clone(&self) -> SDL_Keymod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SDL_Keymod

Available on crate feature debug-impls only.

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

Formats the value using the given formatter.

impl Default for SDL_Keymod

fn default() -> SDL_Keymod

Returns the “default value” for a type.

impl From<SDL_Keymod> for Uint16

fn from(value: SDL_Keymod) -> Self

Converts to this type from the input type.

impl GroupMetadata for SDL_Keymod

Available on crate feature metadata only.

const GROUP_METADATA: &'static Group

Metadata for this group

impl Hash for SDL_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 SDL_Keymod

type Output = SDL_Keymod

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq<SDL_Keymod> for Uint16

fn eq(&self, other: &SDL_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 PartialEq<u16> for SDL_Keymod

fn eq(&self, other: &Uint16) -> 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 PartialEq for SDL_Keymod

fn eq(&self, other: &SDL_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 Copy for SDL_Keymod

impl Eq for SDL_Keymod

impl StructuralPartialEq for SDL_Keymod