Enum bevy::prelude::KeyCode

#[repr(u32)]
pub enum KeyCode {
    Key1,
    Key2,
    Key3,
    Key4,
    Key5,
    Key6,
    Key7,
    Key8,
    Key9,
    Key0,
    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,
    Escape,
    F1,
    F2,
    F3,
    F4,
    F5,
    F6,
    F7,
    F8,
    F9,
    F10,
    F11,
    F12,
    F13,
    F14,
    F15,
    F16,
    F17,
    F18,
    F19,
    F20,
    F21,
    F22,
    F23,
    F24,
    Snapshot,
    Scroll,
    Pause,
    Insert,
    Home,
    Delete,
    End,
    PageDown,
    PageUp,
    Left,
    Up,
    Right,
    Down,
    Back,
    Return,
    Space,
    Compose,
    Caret,
    Numlock,
    Numpad0,
    Numpad1,
    Numpad2,
    Numpad3,
    Numpad4,
    Numpad5,
    Numpad6,
    Numpad7,
    Numpad8,
    Numpad9,
    AbntC1,
    AbntC2,
    NumpadAdd,
    Apostrophe,
    Apps,
    Asterisk,
    Plus,
    At,
    Ax,
    Backslash,
    Calculator,
    Capital,
    Colon,
    Comma,
    Convert,
    NumpadDecimal,
    NumpadDivide,
    Equals,
    Grave,
    Kana,
    Kanji,
    AltLeft,
    BracketLeft,
    ControlLeft,
    ShiftLeft,
    SuperLeft,
    Mail,
    MediaSelect,
    MediaStop,
    Minus,
    NumpadMultiply,
    Mute,
    MyComputer,
    NavigateForward,
    NavigateBackward,
    NextTrack,
    NoConvert,
    NumpadComma,
    NumpadEnter,
    NumpadEquals,
    Oem102,
    Period,
    PlayPause,
    Power,
    PrevTrack,
    AltRight,
    BracketRight,
    ControlRight,
    ShiftRight,
    SuperRight,
    Semicolon,
    Slash,
    Sleep,
    Stop,
    NumpadSubtract,
    Sysrq,
    Tab,
    Underline,
    Unlabeled,
    VolumeDown,
    VolumeUp,
    Wake,
    WebBack,
    WebFavorites,
    WebForward,
    WebHome,
    WebRefresh,
    WebSearch,
    WebStop,
    Yen,
    Copy,
    Paste,
    Cut,
}

The key code of a KeyboardInput.

Usage

It is used as the generic T value of an Input to create a Res<Input<KeyCode>>. The resource values are mapped to the current layout of the keyboard and correlate to an ScanCode.

Updating

The resource is updated inside of the keyboard_input_system.

Variants

Key1

The 1 key over the letters.

Key2

The 2 key over the letters.

Key3

The 3 key over the letters.

Key4

The 4 key over the letters.

Key5

The 5 key over the letters.

Key6

The 6 key over the letters.

Key7

The 7 key over the letters.

Key8

The 8 key over the letters.

Key9

The 9 key over the letters.

Key0

The 0 key over the letters.

A

The A key.

B

The B key.

C

The C key.

D

The D key.

E

The E key.

F

The F key.

G

The G key.

H

The H key.

I

The I key.

J

The J key.

K

The K key.

L

The L key.

M

The M key.

N

The N key.

O

The O key.

P

The P key.

Q

The Q key.

R

The R key.

S

The S key.

T

The T key.

U

The U key.

V

The V key.

W

The W key.

X

The X key.

Y

The Y key.

Z

The Z key.

Escape

The Escape / ESC key, next to the F1 key.

F1

The F1 key.

F2

The F2 key.

F3

The F3 key.

F4

The F4 key.

F5

The F5 key.

F6

The F6 key.

F7

The F7 key.

F8

The F8 key.

F9

The F9 key.

F10

The F10 key.

F11

The F11 key.

F12

The F12 key.

F13

The F13 key.

F14

The F14 key.

F15

The F15 key.

F16

The F16 key.

F17

The F17 key.

F18

The F18 key.

F19

The F19 key.

F20

The F20 key.

F21

The F21 key.

F22

The F22 key.

F23

The F23 key.

F24

The F24 key.

Snapshot

The Snapshot / Print Screen key.

Scroll

The Scroll / Scroll Lock key.

Pause

The Pause / Break key, next to the Scroll key.

Insert

The Insert key, next to the Backspace key.

Home

The Home key.

Delete

The Delete key.

End

The End key.

PageDown

The PageDown key.

PageUp

The PageUp key.

Left

The Left / Left Arrow key.

Up

The Up / Up Arrow key.

Right

The Right / Right Arrow key.

Down

The Down / Down Arrow key.

Back

The Back / Backspace key.

Return

The Return / Enter key.

Space

The Space / Spacebar / key.

Compose

The Compose key on Linux.

Caret

The Caret / ^ key.

Numlock

The Numlock key.

Numpad0

The Numpad0 / 0 key.

Numpad1

The Numpad1 / 1 key.

Numpad2

The Numpad2 / 2 key.

Numpad3

The Numpad3 / 3 key.

Numpad4

The Numpad4 / 4 key.

Numpad5

The Numpad5 / 5 key.

Numpad6

The Numpad6 / 6 key.

Numpad7

The Numpad7 / 7 key.

Numpad8

The Numpad8 / 8 key.

Numpad9

The Numpad9 / 9 key.

AbntC1

The AbntC1 key.

AbntC2

The AbntC2 key.

NumpadAdd

The NumpadAdd / + key.

Apostrophe

The Apostrophe / ' key.

Apps

The Apps key.

Asterisk

The Asterisk / * key.

Plus

The Plus / + key.

At

The At / @ key.

Ax

The Ax key.

Backslash

The Backslash / \ key.

Calculator

The Calculator key.

Capital

The Capital key.

Colon

The Colon / : key.

Comma

The Comma / , key.

Convert

The Convert key.

NumpadDecimal

The NumpadDecimal / . key.

NumpadDivide

The NumpadDivide / / key.

Equals

The Equals / = key.

Grave

The Grave / Backtick / ` key.

Kana

The Kana key.

Kanji

The Kanji key.

AltLeft

The Left Alt key. Maps to Left Option on Mac.

BracketLeft

The Left Bracket / [ key.

ControlLeft

The Left Control key.

ShiftLeft

The Left Shift key.

SuperLeft

The Left Super key. Generic keyboards usually display this key with the Microsoft Windows logo. Apple keyboards call this key the Command Key and display it using the ⌘ character.

Mail

The Mail key.

MediaSelect

The MediaSelect key.

MediaStop

The MediaStop key.

Minus

The Minus / - key.

NumpadMultiply

The NumpadMultiply / * key.

Mute

The Mute key.

MyComputer

The MyComputer key.

NavigateForward

The NavigateForward / Prior key.

NavigateBackward

The NavigateBackward / Next key.

NextTrack

The NextTrack key.

NoConvert

The NoConvert key.

NumpadComma

The NumpadComma / , key.

NumpadEnter

The NumpadEnter key.

NumpadEquals

The NumpadEquals / = key.

Oem102

The Oem102 key.

Period

The Period / . key.

PlayPause

The PlayPause key.

Power

The Power key.

PrevTrack

The PrevTrack key.

AltRight

The Right Alt key. Maps to Right Option on Mac.

BracketRight

The Right Bracket / ] key.

ControlRight

The Right Control key.

ShiftRight

The Right Shift key.

SuperRight

The Right Super key. Generic keyboards usually display this key with the Microsoft Windows logo. Apple keyboards call this key the Command Key and display it using the ⌘ character.

Semicolon

The Semicolon / ; key.

Slash

The Slash / / key.

Sleep

The Sleep key.

Stop

The Stop key.

NumpadSubtract

The NumpadSubtract / - key.

Sysrq

The Sysrq key.

Tab

The Tab / key.

Underline

The Underline / _ key.

Unlabeled

The Unlabeled key.

VolumeDown

The VolumeDown key.

VolumeUp

The VolumeUp key.

Wake

The Wake key.

WebBack

The WebBack key.

WebFavorites

The WebFavorites key.

WebForward

The WebForward key.

WebHome

The WebHome key.

WebRefresh

The WebRefresh key.

WebSearch

The WebSearch key.

WebStop

The WebStop key.

Yen

The Yen key.

Copy

The Copy key.

Paste

The Paste key.

Cut

The Cut key.

Trait Implementations

impl Clone for KeyCode

fn clone(&self) -> KeyCode

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyCode

fn deserialize<__D>( __deserializer: __D ) -> Result<KeyCode, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Enum for KeyCode

fn field(&self, __name_param: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field (in the current variant) with the given name.

fn field_at(&self, __index_param: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut( &mut self, __name_param: &str ) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut( &mut self, __index_param: usize ) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

fn name_at(&self, __index_param: usize) -> Option<&str>

Returns the name of the field (in the current variant) with the given index.

fn iter_fields(&self) -> VariantFieldIter<'_>

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn clone_dynamic(&self) -> DynamicEnum

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

impl FromReflect for KeyCode

fn from_reflect(__param0: &(dyn Reflect + 'static)) -> Option<KeyCode>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect, Global> ) -> Result<Self, Box<dyn Reflect, Global>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for KeyCode

fn get_type_registration() -> TypeRegistration

impl Hash for KeyCode

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 KeyCode

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<KeyCode> for KeyCode

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

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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 Reflect for KeyCode

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<KeyCode, Global>) -> Box<dyn Any, Global>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<KeyCode, Global>) -> Box<dyn Reflect, Global>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect, Global>

Clones the value as a Reflect trait object.

fn set( &mut self, __value_param: Box<dyn Reflect, Global> ) -> Result<(), Box<dyn Reflect, Global>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, __value_param: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<KeyCode, Global>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Serialize for KeyCode

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypePath for KeyCode

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for KeyCode

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for KeyCode

impl Eq for KeyCode

impl StructuralEq for KeyCode

impl StructuralPartialEq for KeyCode