Enum tetra::input::Key

#[non_exhaustive]
pub enum Key {
    A,
    B,
    C,
    D,
    E,
    F,
    G,
    H,
    I,
    J,
    K,
    L,
    M,
    N,
    O,
    P,
    Q,
    R,
    S,
    T,
    U,
    V,
    W,
    X,
    Y,
    Z,
    Num0,
    Num1,
    Num2,
    Num3,
    Num4,
    Num5,
    Num6,
    Num7,
    Num8,
    Num9,
    F1,
    F2,
    F3,
    F4,
    F5,
    F6,
    F7,
    F8,
    F9,
    F10,
    F11,
    F12,
    F13,
    F14,
    F15,
    F16,
    F17,
    F18,
    F19,
    F20,
    F21,
    F22,
    F23,
    F24,
    NumLock,
    NumPad1,
    NumPad2,
    NumPad3,
    NumPad4,
    NumPad5,
    NumPad6,
    NumPad7,
    NumPad8,
    NumPad9,
    NumPad0,
    NumPadPlus,
    NumPadMinus,
    NumPadMultiply,
    NumPadDivide,
    NumPadEnter,
    LeftCtrl,
    LeftShift,
    LeftAlt,
    RightCtrl,
    RightShift,
    RightAlt,
    Up,
    Down,
    Left,
    Right,
    Backquote,
    Backslash,
    Backspace,
    CapsLock,
    Comma,
    Delete,
    End,
    Enter,
    Equals,
    Escape,
    Home,
    Insert,
    LeftBracket,
    Minus,
    PageDown,
    PageUp,
    Pause,
    Period,
    PrintScreen,
    Quote,
    RightBracket,
    ScrollLock,
    Semicolon,
    Slash,
    Space,
    Tab,
}

A physical key on a keyboard.

This type represents keys based on their physical position, independent from the user’s active keyboard layout. The variants are named based on how the keys are labelled on a US QWERTY keyboard. For example, Key::A is the key to the right of the Caps Lock, even if the user is on an AZERTY keyboard.

This is used as the default representation as it allows non-QWERTY keyboard layouts to be supported with minimal effort on the developer’s part. However, you should consider providing configurable input bindings too, for maximum accessibility.

If you need to determine what a key represents in the current keyboard layout (e.g. to display button prompts, or for a config screen), you can use the get_key_label function.

Serde

Serialization and deserialization of this type (via Serde) can be enabled via the serde_support feature.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

A

B

C

D

E

F

G

H

I

J

K

L

M

N

O

P

Q

R

S

T

U

V

W

X

Y

Z

Num0

Num1

Num2

Num3

Num4

Num5

Num6

Num7

Num8

Num9

F1

F2

F3

F4

F5

F6

F7

F8

F9

F10

F11

F12

F13

F14

F15

F16

F17

F18

F19

F20

F21

F22

F23

F24

NumLock

NumPad1

NumPad2

NumPad3

NumPad4

NumPad5

NumPad6

NumPad7

NumPad8

NumPad9

NumPad0

NumPadPlus

NumPadMinus

NumPadMultiply

NumPadDivide

NumPadEnter

LeftCtrl

LeftShift

LeftAlt

RightCtrl

RightShift

RightAlt

Up

Down

Left

Right

Backquote

Backslash

Backspace

CapsLock

Comma

Delete

End

Enter

Equals

Escape

Home

Insert

LeftBracket

Minus

PageDown

PageUp

Pause

Period

PrintScreen

Quote

RightBracket

ScrollLock

Semicolon

Slash

Space

Tab

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy 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

Formats the value using the given formatter.

impl Hash for Key

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 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Key

impl Eq for Key

impl StructuralEq for Key

impl StructuralPartialEq for Key