Struct sfml::window::Key

#[repr(transparent)]pub struct Key(_);

Key codes known to SFML.

Implementations

impl Key

pub const UNKNOWN: Self

Unhandled key

pub const A: Self

The A key

pub const B: Self

The B key

pub const C: Self

The C key

pub const D: Self

The D key

pub const E: Self

The E key

pub const F: Self

The F key

pub const G: Self

The G key

pub const H: Self

The H key

pub const I: Self

The I key

pub const J: Self

The J key

pub const K: Self

The K key

pub const L: Self

The L key

pub const M: Self

The M key

pub const N: Self

The N key

pub const O: Self

The O key

pub const P: Self

The P key

pub const Q: Self

The Q key

pub const R: Self

The R key

pub const S: Self

The S key

pub const T: Self

The T key

pub const U: Self

The U key

pub const V: Self

The V key

pub const W: Self

The W key

pub const X: Self

The X key

pub const Y: Self

The Y key

pub const Z: Self

The Z key

pub const NUM0: Self

The 0 key

pub const NUM1: Self

The 1 key

pub const NUM2: Self

The 2 key

pub const NUM3: Self

The 3 key

pub const NUM4: Self

The 4 key

pub const NUM5: Self

The 5 key

pub const NUM6: Self

The 6 key

pub const NUM7: Self

The 7 key

pub const NUM8: Self

The 8 key

pub const NUM9: Self

The 9 key

pub const ESCAPE: Self

The Escape key

pub const LCONTROL: Self

The left Control key

pub const LSHIFT: Self

The left Shift key

pub const LALT: Self

The left Alt key

pub const LSYSTEM: Self

The left OS specific key: window (Windows and Linux), apple (Mac OS X), …

pub const RCONTROL: Self

The right Control key

pub const RSHIFT: Self

The right Shift key

pub const RALT: Self

The right Alt key

pub const RSYSTEM: Self

The right OS specific key: window (Windows and Linux), apple (Mac OS X), …

pub const MENU: Self

The Menu key

pub const LBRACKET: Self

The [ key

pub const RBRACKET: Self

The ] key

pub const SEMICOLON: Self

The ; key

pub const COMMA: Self

The , key

pub const PERIOD: Self

The . key

pub const QUOTE: Self

The ’ key

pub const SLASH: Self

The / key

pub const BACKSLASH: Self

The \ key

pub const TILDE: Self

The ~ key

pub const EQUAL: Self

The = key

pub const HYPHEN: Self

The - key (hyphen)

pub const SPACE: Self

The Space key

pub const ENTER: Self

The Enter/Return keys

pub const BACKSPACE: Self

The Backspace key

pub const TAB: Self

The Tabulation key

pub const PAGEUP: Self

The Page up key

pub const PAGEDOWN: Self

The Page down key

pub const END: Self

The End key

pub const HOME: Self

The Home key

pub const INSERT: Self

The Insert key

pub const DELETE: Self

The Delete key

pub const ADD: Self

The + key

pub const SUBTRACT: Self

The - key (minus, usually from numpad)

pub const MULTIPLY: Self

The * key

pub const DIVIDE: Self

The / key

pub const LEFT: Self

Left arrow

pub const RIGHT: Self

Right arrow

pub const UP: Self

Up arrow

pub const DOWN: Self

Down arrow

pub const NUMPAD0: Self

The numpad 0 key

pub const NUMPAD1: Self

The numpad 1 key

pub const NUMPAD2: Self

The numpad 2 key

pub const NUMPAD3: Self

The numpad 3 key

pub const NUMPAD4: Self

The numpad 4 key

pub const NUMPAD5: Self

The numpad 5 key

pub const NUMPAD6: Self

The numpad 6 key

pub const NUMPAD7: Self

The numpad 7 key

pub const NUMPAD8: Self

The numpad 8 key

pub const NUMPAD9: Self

The numpad 9 key

pub const F1: Self

The F1 key

pub const F2: Self

The F2 key

pub const F3: Self

The F3 key

pub const F4: Self

The F4 key

pub const F5: Self

The F5 key

pub const F6: Self

The F6 key

pub const F7: Self

The F7 key

pub const F8: Self

The F8 key

pub const F9: Self

The F9 key

pub const F10: Self

The F10 key

pub const F11: Self

The F11 key

pub const F12: Self

The F12 key

pub const F13: Self

The F13 key

pub const F14: Self

The F14 key

pub const F15: Self

The F15 key

pub const PAUSE: Self

The Pause key

pub const COUNT: Self

The total number of keyboard keys

impl Key

#[must_use]pub fn is_pressed(self) -> bool

Return whether this key is currently pressed.

Queries the real-time state of the keyboard, even if keys have been pressed or released while no window was focused and no events were triggered.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Key

impl Debug for Key

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

Formats the value using the given formatter.

impl Eq for Key

impl Hash for Key

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Key

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Key> for Key

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

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

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

This method tests for !=.

impl PartialOrd<Key> for Key

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for Key

impl StructuralPartialEq for Key