Struct Key 

pub struct Key(/* private fields */);

Key codes known to SFML.

Implementations

impl Key

pub const UNKNOWN: Key

Unhandled key

pub const A: Key

The A key

pub const B: Key

The B key

pub const C: Key

The C key

pub const D: Key

The D key

pub const E: Key

The E key

pub const F: Key

The F key

pub const G: Key

The G key

pub const H: Key

The H key

pub const I: Key

The I key

pub const J: Key

The J key

pub const K: Key

The K key

pub const L: Key

The L key

pub const M: Key

The M key

pub const N: Key

The N key

pub const O: Key

The O key

pub const P: Key

The P key

pub const Q: Key

The Q key

pub const R: Key

The R key

pub const S: Key

The S key

pub const T: Key

The T key

pub const U: Key

The U key

pub const V: Key

The V key

pub const W: Key

The W key

pub const X: Key

The X key

pub const Y: Key

The Y key

pub const Z: Key

The Z key

pub const NUM0: Key

The 0 key

pub const NUM1: Key

The 1 key

pub const NUM2: Key

The 2 key

pub const NUM3: Key

The 3 key

pub const NUM4: Key

The 4 key

pub const NUM5: Key

The 5 key

pub const NUM6: Key

The 6 key

pub const NUM7: Key

The 7 key

pub const NUM8: Key

The 8 key

pub const NUM9: Key

The 9 key

pub const ESCAPE: Key

The Escape key

pub const LCONTROL: Key

The left Control key

pub const LSHIFT: Key

The left Shift key

pub const LALT: Key

The left Alt key

pub const LSYSTEM: Key

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

pub const RCONTROL: Key

The right Control key

pub const RSHIFT: Key

The right Shift key

pub const RALT: Key

The right Alt key

pub const RSYSTEM: Key

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

pub const MENU: Key

The Menu key

pub const LBRACKET: Key

The [ key

pub const RBRACKET: Key

The ] key

pub const SEMICOLON: Key

The ; key

pub const COMMA: Key

The , key

pub const PERIOD: Key

The . key

pub const QUOTE: Key

The ’ key

pub const SLASH: Key

The / key

pub const BACKSLASH: Key

The \ key

pub const TILDE: Key

The ~ key

pub const EQUAL: Key

The = key

pub const HYPHEN: Key

The - key (hyphen)

pub const SPACE: Key

The Space key

pub const ENTER: Key

The Enter/Return keys

pub const BACKSPACE: Key

The Backspace key

pub const TAB: Key

The Tabulation key

pub const PAGEUP: Key

The Page up key

pub const PAGEDOWN: Key

The Page down key

pub const END: Key

The End key

pub const HOME: Key

The Home key

pub const INSERT: Key

The Insert key

pub const DELETE: Key

The Delete key

pub const ADD: Key

The + key

pub const SUBTRACT: Key

The - key (minus, usually from numpad)

pub const MULTIPLY: Key

The * key

pub const DIVIDE: Key

The / key

pub const LEFT: Key

Left arrow

pub const RIGHT: Key

Right arrow

pub const UP: Key

Up arrow

pub const DOWN: Key

Down arrow

pub const NUMPAD0: Key

The numpad 0 key

pub const NUMPAD1: Key

The numpad 1 key

pub const NUMPAD2: Key

The numpad 2 key

pub const NUMPAD3: Key

The numpad 3 key

pub const NUMPAD4: Key

The numpad 4 key

pub const NUMPAD5: Key

The numpad 5 key

pub const NUMPAD6: Key

The numpad 6 key

pub const NUMPAD7: Key

The numpad 7 key

pub const NUMPAD8: Key

The numpad 8 key

pub const NUMPAD9: Key

The numpad 9 key

pub const F1: Key

The F1 key

pub const F2: Key

The F2 key

pub const F3: Key

The F3 key

pub const F4: Key

The F4 key

pub const F5: Key

The F5 key

pub const F6: Key

The F6 key

pub const F7: Key

The F7 key

pub const F8: Key

The F8 key

pub const F9: Key

The F9 key

pub const F10: Key

The F10 key

pub const F11: Key

The F11 key

pub const F12: Key

The F12 key

pub const F13: Key

The F13 key

pub const F14: Key

The F14 key

pub const F15: Key

The F15 key

pub const PAUSE: Key

The Pause key

pub const COUNT: Key

The total number of keyboard keys

impl Key

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 duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Hash for Key

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

where __H: Hasher,

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 Key

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

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

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

impl Eq for Key

impl StructuralPartialEq for Key