|
253
|
1 # Module: key |
|
|
2 |
|
|
3 Synopsis |
|
|
4 |
|
|
5 ```c |
|
|
6 #include <core/key.h> |
|
|
7 ``` |
|
|
8 |
|
|
9 Keyboard definitions. |
|
|
10 |
|
|
11 ## Enums |
|
|
12 |
|
|
13 ### key |
|
|
14 |
|
|
15 This enumeration contains keys supported by the API. |
|
|
16 |
|
|
17 !!! caution |
|
|
18 Many keys are not portable or may be not available on every keyboards. For |
|
|
19 example, it's pretty common to not see some keys on laptops which has much |
|
|
20 smaller keyboards. Avoid use of non “simple” keys in your game play. |
|
|
21 |
|
|
22 | Enumerator | Description | |
|
|
23 |-----------------------|-------------------------------| |
|
|
24 | `KEY_UNKNOWN` | Unknown key | |
|
|
25 | `KEY_ENTER` | Return | |
|
|
26 | `KEY_ESCAPE` | Escape | |
|
|
27 | `KEY_BACKSPACE` | Backspace | |
|
|
28 | `KEY_TAB` | Tab | |
|
|
29 | `KEY_SPACE` | Space | |
|
|
30 | `KEY_EXCLAIM` | ! | |
|
|
31 | `KEY_DOUBLE_QUOTE` | " | |
|
|
32 | `KEY_HASH` | # | |
|
|
33 | `KEY_PERCENT` | % | |
|
|
34 | `KEY_DOLLAR` | $ | |
|
|
35 | `KEY_AMPERSAND` | % | |
|
|
36 | `KEY_QUOTE` | ' | |
|
|
37 | `KEY_LEFT_PAREN` | ( | |
|
|
38 | `KEY_RIGHT_PAREN` | ) | |
|
|
39 | `KEY_ASTERISK` | \* | |
|
|
40 | `KEY_PLUS` | + (top row) | |
|
|
41 | `KEY_COMMA` | , | |
|
|
42 | `KEY_MINUS` | - (top row) | |
|
|
43 | `KEY_PERIOD` | . | |
|
|
44 | `KEY_SLASH` | / | |
|
|
45 | `KEY_0` | (top row) | |
|
|
46 | `KEY_1` | (top row) | |
|
|
47 | `KEY_2` | (top row) | |
|
|
48 | `KEY_3` | (top row) | |
|
|
49 | `KEY_4` | (top row) | |
|
|
50 | `KEY_5` | (top row) | |
|
|
51 | `KEY_6` | (top row) | |
|
|
52 | `KEY_7` | (top row) | |
|
|
53 | `KEY_8` | (top row) | |
|
|
54 | `KEY_9` | (top row) | |
|
|
55 | `KEY_COLON` | : | |
|
|
56 | `KEY_SEMICOLON` | ; | |
|
|
57 | `KEY_LESS` | < | |
|
|
58 | `KEY_EQUALS` | = | |
|
|
59 | `KEY_GREATER` | > | |
|
|
60 | `KEY_QUESTION` | ? | |
|
|
61 | `KEY_AT` | @ | |
|
|
62 | `KEY_LEFT_BRACKET` | [ | |
|
|
63 | `KEY_BACKSLASH` | \ | |
|
|
64 | `KEY_RIGHT_BRACKET` | ] | |
|
|
65 | `KEY_CARET` | ^ | |
|
|
66 | `KEY_UNDERSCORE` | \_ | |
|
|
67 | `KEY_BACKQUOTE` | \` | |
|
|
68 | `KEY_a` | | |
|
|
69 | `KEY_b` | | |
|
|
70 | `KEY_c` | | |
|
|
71 | `KEY_d` | | |
|
|
72 | `KEY_e` | | |
|
|
73 | `KEY_f` | | |
|
|
74 | `KEY_g` | | |
|
|
75 | `KEY_h` | | |
|
|
76 | `KEY_i` | | |
|
|
77 | `KEY_j` | | |
|
|
78 | `KEY_k` | | |
|
|
79 | `KEY_l` | | |
|
|
80 | `KEY_m` | | |
|
|
81 | `KEY_n` | | |
|
|
82 | `KEY_o` | | |
|
|
83 | `KEY_p` | | |
|
|
84 | `KEY_q` | | |
|
|
85 | `KEY_r` | | |
|
|
86 | `KEY_s` | | |
|
|
87 | `KEY_t` | | |
|
|
88 | `KEY_u` | | |
|
|
89 | `KEY_v` | | |
|
|
90 | `KEY_w` | | |
|
|
91 | `KEY_x` | | |
|
|
92 | `KEY_y` | | |
|
|
93 | `KEY_z` | | |
|
|
94 | `KEY_CAPSLOCK` | Caps lock | |
|
|
95 | `KEY_F1` | | |
|
|
96 | `KEY_F2` | | |
|
|
97 | `KEY_F3` | | |
|
|
98 | `KEY_F4` | | |
|
|
99 | `KEY_F5` | | |
|
|
100 | `KEY_F6` | | |
|
|
101 | `KEY_F7` | | |
|
|
102 | `KEY_F8` | | |
|
|
103 | `KEY_F9` | | |
|
|
104 | `KEY_F10` | | |
|
|
105 | `KEY_F11` | | |
|
|
106 | `KEY_F12` | | |
|
|
107 | `KEY_F13` | (not portable) | |
|
|
108 | `KEY_F14` | (not portable) | |
|
|
109 | `KEY_F15` | (not portable) | |
|
|
110 | `KEY_F16` | (not portable) | |
|
|
111 | `KEY_F17` | (not portable) | |
|
|
112 | `KEY_F18` | (not portable) | |
|
|
113 | `KEY_F19` | (not portable) | |
|
|
114 | `KEY_F20` | (not portable) | |
|
|
115 | `KEY_F21` | (not portable) | |
|
|
116 | `KEY_F22` | (not portable) | |
|
|
117 | `KEY_F23` | (not portable) | |
|
|
118 | `KEY_F24` | (not portable) | |
|
|
119 | `KEY_PRINTSCREEN` | Print screen | |
|
|
120 | `KEY_PAUSE` | Media pause | |
|
|
121 | `KEY_INSERT` | Insert (not portable) | |
|
|
122 | `KEY_HOME` | Home (not portable) | |
|
|
123 | `KEY_PAGEUP` | Page up | |
|
|
124 | `KEY_DELETE` | Back delete | |
|
|
125 | `KEY_END` | End | |
|
|
126 | `KEY_PAGEDOWN` | Page down | |
|
|
127 | `KEY_RIGHT` | Right arrow | |
|
|
128 | `KEY_LEFT` | Left arrow | |
|
|
129 | `KEY_DOWN` | Down arrow | |
|
|
130 | `KEY_UP` | Up arrow | |
|
|
131 | `KEY_KP_DIVIDE` | / (keypad) | |
|
|
132 | `KEY_KP_MULTIPLY` | * (keypad) | |
|
|
133 | `KEY_KP_MINUS` | - (keypad) | |
|
|
134 | `KEY_KP_PLUS` | + (keypad) | |
|
|
135 | `KEY_KP_ENTER` | Return (keypad) | |
|
|
136 | `KEY_KP_1` | (keypad) | |
|
|
137 | `KEY_KP_2` | (keypad) | |
|
|
138 | `KEY_KP_3` | (keypad) | |
|
|
139 | `KEY_KP_4` | (keypad) | |
|
|
140 | `KEY_KP_5` | (keypad) | |
|
|
141 | `KEY_KP_6` | (keypad) | |
|
|
142 | `KEY_KP_7` | (keypad) | |
|
|
143 | `KEY_KP_8` | (keypad) | |
|
|
144 | `KEY_KP_9` | (keypad) | |
|
|
145 | `KEY_KP_0` | (keypad) | |
|
|
146 | `KEY_KP_PERIOD` | . (keypad) | |
|
|
147 | `KEY_KP_COMMA` | , (keypad) | |
|
|
148 | `KEY_MENU` | Menu key (not portable) | |
|
|
149 | `KEY_MUTE` | Volumne mute (not portable) | |
|
|
150 | `KEY_VOLUME_UP` | Volume up (not portable) | |
|
|
151 | `KEY_VOLUME_DOWN` | Volume down (not portable) | |
|
|
152 | `KEY_LCTRL` | Left control | |
|
|
153 | `KEY_LSHIFT` | Left shift | |
|
|
154 | `KEY_LALT` | Left alt | |
|
|
155 | `KEY_LSUPER` | Left super (or logo) | |
|
|
156 | `KEY_RCTRL` | Right control | |
|
|
157 | `KEY_RSHIFT` | Right shift | |
|
|
158 | `KEY_RALT` | Right alt | |
|
|
159 | `KEY_RSUPER` | Right super (or logo) | |
|
|
160 |
|
|
161 ### keymod |
|
|
162 |
|
|
163 This enumeration contains keyboards modifiers that can be OR'ed because you may |
|
|
164 press them more than one at once. |
|
|
165 |
|
|
166 | Enumerator | Description | |
|
|
167 |-----------------|--------------------| |
|
|
168 | `KEYMOD_LSHIFT` | Left shift | |
|
|
169 | `KEYMOD_LCTRL` | Left control | |
|
|
170 | `KEYMOD_LALT` | Left alt | |
|
|
171 | `KEYMOD_LSUPER` | Left super (logo) | |
|
|
172 | `KEYMOD_RSHIFT` | Right shift | |
|
|
173 | `KEYMOD_RCTRL` | Right control | |
|
|
174 | `KEYMOD_RALT` | Right alt | |
|
|
175 | `KEYMOD_RSUPER` | Right super (logo) | |
