Struct SDL_Keycode

#[repr(transparent)]
pub struct SDL_Keycode(pub i32);

The SDL keyboard keycode representation.

This is used in places like the SDL_Keysym struct for the “software” / “logical” designation of a key.

Values of this type are used to represent keyboard keys using the current layout of the keyboard. These values include Unicode values representing the unmodified character that would be generated by pressing the key, or an SDLK_* constant for those keys that do not generate characters.

A special exception is the number keys at the top of the keyboard which always map to SDLK_0 through SDLK_9, regardless of layout.

See all the constants named SDLK_*

Tuple Fields

0: i32

Trait Implementations

impl Clone for SDL_Keycode

fn clone(&self) -> SDL_Keycode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SDL_Keycode

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

Formats the value using the given formatter.

impl Default for SDL_Keycode

fn default() -> SDL_Keycode

Returns the “default value” for a type.

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

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

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

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

impl Eq for SDL_Keycode

impl StructuralPartialEq for SDL_Keycode