Gorgon Game Engine
Functions | Variables
Gorgon::Input::Keyboard::Keycodes Namespace Reference

Functions

std::string GetName (Key key)
 Returns the name of the key. More...
 
constexpr bool IsEnter (Key key)
 Returns if the key is an enter key. More...
 
constexpr bool IsModifier (Key key)
 Returns if the given key is a known modifier. More...
 

Variables

constexpr Key A
 
constexpr Key Alt
 
constexpr Key B
 
constexpr Key Backspace
 
constexpr Key C
 
constexpr Key CapsLock
 
constexpr Key Control
 
constexpr Key D
 
constexpr Key Delete
 
constexpr Key Down
 
constexpr Key E
 
constexpr Key End
 
constexpr Key Enter
 
constexpr Key Escape
 
constexpr Key F
 
constexpr Key F1
 
constexpr Key F10
 
constexpr Key F11
 
constexpr Key F12
 
constexpr Key F2
 
constexpr Key F3
 
constexpr Key F4
 
constexpr Key F5
 
constexpr Key F6
 
constexpr Key F7
 
constexpr Key F8
 
constexpr Key F9
 
constexpr Key G
 
constexpr Key H
 
constexpr Key Home
 
constexpr Key I
 
constexpr Key Insert
 
constexpr Key J
 
constexpr Key K
 
constexpr Key L
 
constexpr Key Left
 
constexpr Key M
 
constexpr Key Menu
 
constexpr Key Meta
 
constexpr Key N
 
constexpr Key Number_0
 
constexpr Key Number_1
 
constexpr Key Number_2
 
constexpr Key Number_3
 
constexpr Key Number_4
 
constexpr Key Number_5
 
constexpr Key Number_6
 
constexpr Key Number_7
 
constexpr Key Number_8
 
constexpr Key Number_9
 
constexpr Key Numlock
 
constexpr Key Numpad_0
 
constexpr Key Numpad_1
 
constexpr Key Numpad_2
 
constexpr Key Numpad_3
 
constexpr Key Numpad_4
 
constexpr Key Numpad_5
 
constexpr Key Numpad_6
 
constexpr Key Numpad_7
 
constexpr Key Numpad_8
 
constexpr Key Numpad_9
 
constexpr Key Numpad_Decimal
 
constexpr Key Numpad_Div
 
constexpr Key Numpad_Enter
 
constexpr Key Numpad_Minus
 
constexpr Key Numpad_Mult
 
constexpr Key Numpad_Plus
 
constexpr Key O
 
constexpr Key OSTransport
 Keycodes that are transported from OS. More...
 
constexpr Key P
 
constexpr Key PageDown
 
constexpr Key PageUp
 
constexpr Key Pause
 
constexpr Key PrintScreen
 
constexpr Key Q
 
constexpr Key R
 
constexpr Key RAlt
 
constexpr Key RControl
 
constexpr Key Right
 
constexpr Key RMeta
 
constexpr Key RShift
 
constexpr Key S
 
constexpr Key ScrollLock
 
constexpr Key Shift
 
constexpr Key Space
 
constexpr Key T
 
constexpr Key Tab
 
constexpr Key U
 
constexpr Key Up
 
constexpr Key V
 
constexpr Key W
 
constexpr Key X
 
constexpr Key Y
 
constexpr Key Z
 

Function Documentation

◆ GetName()

std::string GetName ( Key  key)

Returns the name of the key.

This function returns capital letters for printable letter keys, names of known keys and OS dependent names for other keys.

References Alt, Backspace, CapsLock, Control, Delete, Down, End, Enter, Escape, F1, F10, F12, F9, Home, Insert, Left, Menu, Meta, Numlock, Numpad_0, Numpad_9, Numpad_Decimal, Numpad_Div, Numpad_Enter, Numpad_Minus, Numpad_Mult, Numpad_Plus, Gorgon::WindowManager::osgetkeyname(), OSTransport, PageDown, PageUp, Pause, PrintScreen, RAlt, RControl, Right, RMeta, RShift, ScrollLock, Shift, Space, Tab, and Up.

◆ IsEnter()

constexpr bool Gorgon::Input::Keyboard::Keycodes::IsEnter ( Key  key)
constexpr

Returns if the key is an enter key.

References Enter, and Numpad_Enter.

◆ IsModifier()

constexpr bool Gorgon::Input::Keyboard::Keycodes::IsModifier ( Key  key)
constexpr

Returns if the given key is a known modifier.

References Alt, Control, Meta, RAlt, RControl, RMeta, RShift, and Shift.

Variable Documentation

◆ A

constexpr Key A
constexpr

◆ Alt

constexpr Key Alt
constexpr

◆ B

constexpr Key B
constexpr

◆ Backspace

constexpr Key Backspace
constexpr

◆ C

constexpr Key C
constexpr

◆ CapsLock

constexpr Key CapsLock
constexpr

◆ Control

constexpr Key Control
constexpr

◆ D

constexpr Key D
constexpr

◆ Delete

constexpr Key Delete
constexpr

◆ Down

constexpr Key Down
constexpr

◆ E

constexpr Key E
constexpr

◆ End

constexpr Key End
constexpr

◆ Enter

constexpr Key Enter
constexpr

◆ Escape

constexpr Key Escape
constexpr

◆ F

constexpr Key F
constexpr

◆ F1

constexpr Key F1
constexpr

◆ F10

constexpr Key F10
constexpr

◆ F11

constexpr Key F11
constexpr

◆ F12

constexpr Key F12
constexpr

◆ F2

constexpr Key F2
constexpr

◆ F3

constexpr Key F3
constexpr

◆ F4

constexpr Key F4
constexpr

◆ F5

constexpr Key F5
constexpr

◆ F6

constexpr Key F6
constexpr

◆ F7

constexpr Key F7
constexpr

◆ F8

constexpr Key F8
constexpr

◆ F9

constexpr Key F9
constexpr

◆ G

constexpr Key G
constexpr

◆ H

constexpr Key H
constexpr

◆ Home

constexpr Key Home
constexpr

◆ I

constexpr Key I
constexpr

◆ Insert

constexpr Key Insert
constexpr

◆ J

constexpr Key J
constexpr

◆ K

constexpr Key K
constexpr

◆ L

constexpr Key L
constexpr

◆ Left

constexpr Key Left
constexpr

◆ M

constexpr Key M
constexpr

◆ Menu

constexpr Key Menu
constexpr

◆ Meta

constexpr Key Meta
constexpr

◆ N

constexpr Key N
constexpr

◆ Number_0

constexpr Key Number_0
constexpr

◆ Number_1

constexpr Key Number_1
constexpr

◆ Number_2

constexpr Key Number_2
constexpr

◆ Number_3

constexpr Key Number_3
constexpr

◆ Number_4

constexpr Key Number_4
constexpr

◆ Number_5

constexpr Key Number_5
constexpr

◆ Number_6

constexpr Key Number_6
constexpr

◆ Number_7

constexpr Key Number_7
constexpr

◆ Number_8

constexpr Key Number_8
constexpr

◆ Number_9

constexpr Key Number_9
constexpr

◆ Numlock

constexpr Key Numlock
constexpr

◆ Numpad_0

constexpr Key Numpad_0
constexpr

◆ Numpad_1

constexpr Key Numpad_1
constexpr

◆ Numpad_2

constexpr Key Numpad_2
constexpr

◆ Numpad_3

constexpr Key Numpad_3
constexpr

◆ Numpad_4

constexpr Key Numpad_4
constexpr

◆ Numpad_5

constexpr Key Numpad_5
constexpr

◆ Numpad_6

constexpr Key Numpad_6
constexpr

◆ Numpad_7

constexpr Key Numpad_7
constexpr

◆ Numpad_8

constexpr Key Numpad_8
constexpr

◆ Numpad_9

constexpr Key Numpad_9
constexpr

◆ Numpad_Decimal

constexpr Key Numpad_Decimal
constexpr

◆ Numpad_Div

constexpr Key Numpad_Div
constexpr

◆ Numpad_Enter

constexpr Key Numpad_Enter
constexpr

◆ Numpad_Minus

constexpr Key Numpad_Minus
constexpr

◆ Numpad_Mult

constexpr Key Numpad_Mult
constexpr

◆ Numpad_Plus

constexpr Key Numpad_Plus
constexpr

◆ O

constexpr Key O
constexpr

◆ OSTransport

constexpr Key OSTransport
constexpr

Keycodes that are transported from OS.

◆ P

constexpr Key P
constexpr

◆ PageDown

constexpr Key PageDown
constexpr

◆ PageUp

constexpr Key PageUp
constexpr

◆ Pause

constexpr Key Pause
constexpr

◆ PrintScreen

constexpr Key PrintScreen
constexpr

◆ Q

constexpr Key Q
constexpr

◆ R

constexpr Key R
constexpr

◆ RAlt

constexpr Key RAlt
constexpr

◆ RControl

constexpr Key RControl
constexpr

◆ Right

constexpr Key Right
constexpr

◆ RMeta

constexpr Key RMeta
constexpr

◆ RShift

constexpr Key RShift
constexpr

◆ S

constexpr Key S
constexpr

◆ ScrollLock

constexpr Key ScrollLock
constexpr

◆ Shift

constexpr Key Shift
constexpr

◆ Space

constexpr Key Space
constexpr

◆ T

constexpr Key T
constexpr

◆ Tab

constexpr Key Tab
constexpr

◆ U

constexpr Key U
constexpr

◆ Up

constexpr Key Up
constexpr

◆ V

constexpr Key V
constexpr

◆ W

constexpr Key W
constexpr

◆ X

constexpr Key X
constexpr

◆ Y

constexpr Key Y
constexpr

◆ Z

constexpr Key Z
constexpr