Struct Keycode 

#[repr(transparent)]
pub struct Keycode(pub u32);

A logical keycode — either a Unicode code point or scancode | SCANCODE_MASK.

Tuple Fields

0: u32

Implementations

impl Keycode

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

pub const fn raw(self) -> u32

pub const fn from_scancode(sc: Scancode) -> Self

Create a keycode from a scancode (encodes with SCANCODE_MASK).

pub const fn to_scancode(self) -> Option<Scancode>

If this keycode is scancode-encoded, return the scancode portion.

pub fn to_char(self) -> Option<char>

If this keycode is a printable Unicode code point, return it as a char.

impl Keycode

Common SDLK_* constants. Values identical in SDL2 and SDL3.

pub const UNKNOWN: Keycode

pub const RETURN: Keycode

pub const ESCAPE: Keycode

pub const BACKSPACE: Keycode

pub const TAB: Keycode

pub const SPACE: Keycode

pub const EXCLAIM: Keycode

pub const QUOTEDBL: Keycode

pub const HASH: Keycode

pub const DOLLAR: Keycode

pub const PERCENT: Keycode

pub const AMPERSAND: Keycode

pub const QUOTE: Keycode

pub const LEFTPAREN: Keycode

pub const RIGHTPAREN: Keycode

pub const ASTERISK: Keycode

pub const PLUS: Keycode

pub const COMMA: Keycode

pub const MINUS: Keycode

pub const PERIOD: Keycode

pub const SLASH: Keycode

pub const NUM_0: Keycode

pub const NUM_1: Keycode

pub const NUM_2: Keycode

pub const NUM_3: Keycode

pub const NUM_4: Keycode

pub const NUM_5: Keycode

pub const NUM_6: Keycode

pub const NUM_7: Keycode

pub const NUM_8: Keycode

pub const NUM_9: Keycode

pub const COLON: Keycode

pub const SEMICOLON: Keycode

pub const LESS: Keycode

pub const EQUALS: Keycode

pub const GREATER: Keycode

pub const QUESTION: Keycode

pub const AT: Keycode

pub const LEFTBRACKET: Keycode

pub const BACKSLASH: Keycode

pub const RIGHTBRACKET: Keycode

pub const CARET: Keycode

pub const UNDERSCORE: Keycode

pub const BACKQUOTE: Keycode

pub const A: Keycode

pub const B: Keycode

pub const C: Keycode

pub const D: Keycode

pub const E: Keycode

pub const F: Keycode

pub const G: Keycode

pub const H: Keycode

pub const I: Keycode

pub const J: Keycode

pub const K: Keycode

pub const L: Keycode

pub const M: Keycode

pub const N: Keycode

pub const O: Keycode

pub const P: Keycode

pub const Q: Keycode

pub const R: Keycode

pub const S: Keycode

pub const T: Keycode

pub const U: Keycode

pub const V: Keycode

pub const W: Keycode

pub const X: Keycode

pub const Y: Keycode

pub const Z: Keycode

pub const CAPSLOCK: Keycode

pub const F1: Keycode

pub const F2: Keycode

pub const F3: Keycode

pub const F4: Keycode

pub const F5: Keycode

pub const F6: Keycode

pub const F7: Keycode

pub const F8: Keycode

pub const F9: Keycode

pub const F10: Keycode

pub const F11: Keycode

pub const F12: Keycode

pub const F13: Keycode

pub const F14: Keycode

pub const F15: Keycode

pub const F16: Keycode

pub const F17: Keycode

pub const F18: Keycode

pub const F19: Keycode

pub const F20: Keycode

pub const F21: Keycode

pub const F22: Keycode

pub const F23: Keycode

pub const F24: Keycode

pub const PRINT_SCREEN: Keycode

pub const SCROLL_LOCK: Keycode

pub const PAUSE: Keycode

pub const INSERT: Keycode

pub const HOME: Keycode

pub const PAGE_UP: Keycode

pub const DELETE: Keycode

pub const END: Keycode

pub const PAGE_DOWN: Keycode

pub const RIGHT: Keycode

pub const LEFT: Keycode

pub const DOWN: Keycode

pub const UP: Keycode

pub const NUM_LOCK_CLEAR: Keycode

pub const KP_DIVIDE: Keycode

pub const KP_MULTIPLY: Keycode

pub const KP_MINUS: Keycode

pub const KP_PLUS: Keycode

pub const KP_ENTER: Keycode

pub const KP_1: Keycode

pub const KP_2: Keycode

pub const KP_3: Keycode

pub const KP_4: Keycode

pub const KP_5: Keycode

pub const KP_6: Keycode

pub const KP_7: Keycode

pub const KP_8: Keycode

pub const KP_9: Keycode

pub const KP_0: Keycode

pub const KP_PERIOD: Keycode

pub const KP_EQUALS: Keycode

pub const APPLICATION: Keycode

pub const MENU: Keycode

pub const LCTRL: Keycode

pub const LSHIFT: Keycode

pub const LALT: Keycode

pub const LGUI: Keycode

pub const RCTRL: Keycode

pub const RSHIFT: Keycode

pub const RALT: Keycode

pub const RGUI: Keycode

Trait Implementations

impl Clone for Keycode

fn clone(&self) -> Keycode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Keycode

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

Formats the value using the given formatter.

impl From<Keycode> for u32

fn from(value: Keycode) -> Self

Converts to this type from the input type.

impl From<char> for Keycode

fn from(c: char) -> Self

Converts to this type from the input type.

impl From<u32> for Keycode

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Hash for Keycode

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 Ord for Keycode

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

fn eq(&self, other: &Keycode) -> 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 Keycode

fn partial_cmp(&self, other: &Keycode) -> 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 Keycode

impl Eq for Keycode

impl StructuralPartialEq for Keycode