orx
1.14
Portable Game Engine
Main Page
Related Pages
Modules
Data Structures
Files
File List
Globals
orxKeyboard.h
Go to the documentation of this file.
1
/* Orx - Portable Game Engine
2
*
3
* Copyright (c) 2008-2022 Orx-Project
4
*
5
* This software is provided 'as-is', without any express or implied
6
* warranty. In no event will the authors be held liable for any damages
7
* arising from the use of this software.
8
*
9
* Permission is granted to anyone to use this software for any purpose,
10
* including commercial applications, and to alter it and redistribute it
11
* freely, subject to the following restrictions:
12
*
13
* 1. The origin of this software must not be misrepresented; you must not
14
* claim that you wrote the original software. If you use this software
15
* in a product, an acknowledgment in the product documentation would be
16
* appreciated but is not required.
17
*
18
* 2. Altered source versions must be plainly marked as such, and must not be
19
* misrepresented as being the original software.
20
*
21
* 3. This notice may not be removed or altered from any source
22
* distribution.
23
*/
24
43
#ifndef _orxKEYBOARD_H_
44
#define _orxKEYBOARD_H_
45
46
#include "
orxInclude.h
"
47
#include "
plugin/orxPluginCore.h
"
48
49
52
typedef
enum
__orxKEYBOARD_KEY_t
53
{
54
orxKEYBOARD_KEY_0
= 0,
55
orxKEYBOARD_KEY_1
,
56
orxKEYBOARD_KEY_2
,
57
orxKEYBOARD_KEY_3
,
58
orxKEYBOARD_KEY_4
,
59
orxKEYBOARD_KEY_5
,
60
orxKEYBOARD_KEY_6
,
61
orxKEYBOARD_KEY_7
,
62
orxKEYBOARD_KEY_8
,
63
orxKEYBOARD_KEY_9
,
64
orxKEYBOARD_KEY_A
,
65
orxKEYBOARD_KEY_B
,
66
orxKEYBOARD_KEY_C
,
67
orxKEYBOARD_KEY_D
,
68
orxKEYBOARD_KEY_E
,
69
orxKEYBOARD_KEY_F
,
70
orxKEYBOARD_KEY_G
,
71
orxKEYBOARD_KEY_H
,
72
orxKEYBOARD_KEY_I
,
73
orxKEYBOARD_KEY_J
,
74
orxKEYBOARD_KEY_K
,
75
orxKEYBOARD_KEY_L
,
76
orxKEYBOARD_KEY_M
,
77
orxKEYBOARD_KEY_N
,
78
orxKEYBOARD_KEY_O
,
79
orxKEYBOARD_KEY_P
,
80
orxKEYBOARD_KEY_Q
,
81
orxKEYBOARD_KEY_R
,
82
orxKEYBOARD_KEY_S
,
83
orxKEYBOARD_KEY_T
,
84
orxKEYBOARD_KEY_U
,
85
orxKEYBOARD_KEY_V
,
86
orxKEYBOARD_KEY_W
,
87
orxKEYBOARD_KEY_X
,
88
orxKEYBOARD_KEY_Y
,
89
orxKEYBOARD_KEY_Z
,
90
orxKEYBOARD_KEY_SPACE
,
91
orxKEYBOARD_KEY_QUOTE
,
92
orxKEYBOARD_KEY_COMMA
,
93
orxKEYBOARD_KEY_DASH
,
94
orxKEYBOARD_KEY_PERIOD
,
95
orxKEYBOARD_KEY_SLASH
,
96
orxKEYBOARD_KEY_SEMICOLON
,
97
orxKEYBOARD_KEY_EQUAL
,
98
orxKEYBOARD_KEY_LBRACKET
,
99
orxKEYBOARD_KEY_BACKSLASH
,
100
orxKEYBOARD_KEY_RBRACKET
,
101
orxKEYBOARD_KEY_BACKQUOTE
,
102
orxKEYBOARD_KEY_WORLD_1
,
103
orxKEYBOARD_KEY_WORLD_2
,
104
orxKEYBOARD_KEY_ESCAPE
,
105
orxKEYBOARD_KEY_ENTER
,
106
orxKEYBOARD_KEY_TAB
,
107
orxKEYBOARD_KEY_BACKSPACE
,
108
orxKEYBOARD_KEY_INSERT
,
109
orxKEYBOARD_KEY_DELETE
,
110
orxKEYBOARD_KEY_RIGHT
,
111
orxKEYBOARD_KEY_LEFT
,
112
orxKEYBOARD_KEY_DOWN
,
113
orxKEYBOARD_KEY_UP
,
114
orxKEYBOARD_KEY_PAGE_UP
,
115
orxKEYBOARD_KEY_PAGE_DOWN
,
116
orxKEYBOARD_KEY_HOME
,
117
orxKEYBOARD_KEY_END
,
118
orxKEYBOARD_KEY_CAPS_LOCK
,
119
orxKEYBOARD_KEY_SCROLL_LOCK
,
120
orxKEYBOARD_KEY_NUM_LOCK
,
121
orxKEYBOARD_KEY_PRINT_SCREEN
,
122
orxKEYBOARD_KEY_PAUSE
,
123
orxKEYBOARD_KEY_VOLUME_DOWN
,
124
orxKEYBOARD_KEY_VOLUME_UP
,
125
orxKEYBOARD_KEY_F1
,
126
orxKEYBOARD_KEY_F2
,
127
orxKEYBOARD_KEY_F3
,
128
orxKEYBOARD_KEY_F4
,
129
orxKEYBOARD_KEY_F5
,
130
orxKEYBOARD_KEY_F6
,
131
orxKEYBOARD_KEY_F7
,
132
orxKEYBOARD_KEY_F8
,
133
orxKEYBOARD_KEY_F9
,
134
orxKEYBOARD_KEY_F10
,
135
orxKEYBOARD_KEY_F11
,
136
orxKEYBOARD_KEY_F12
,
137
orxKEYBOARD_KEY_F13
,
138
orxKEYBOARD_KEY_F14
,
139
orxKEYBOARD_KEY_F15
,
140
orxKEYBOARD_KEY_F16
,
141
orxKEYBOARD_KEY_F17
,
142
orxKEYBOARD_KEY_F18
,
143
orxKEYBOARD_KEY_F19
,
144
orxKEYBOARD_KEY_F20
,
145
orxKEYBOARD_KEY_F21
,
146
orxKEYBOARD_KEY_F22
,
147
orxKEYBOARD_KEY_F23
,
148
orxKEYBOARD_KEY_F24
,
149
orxKEYBOARD_KEY_F25
,
150
orxKEYBOARD_KEY_NUMPAD_0
,
151
orxKEYBOARD_KEY_NUMPAD_1
,
152
orxKEYBOARD_KEY_NUMPAD_2
,
153
orxKEYBOARD_KEY_NUMPAD_3
,
154
orxKEYBOARD_KEY_NUMPAD_4
,
155
orxKEYBOARD_KEY_NUMPAD_5
,
156
orxKEYBOARD_KEY_NUMPAD_6
,
157
orxKEYBOARD_KEY_NUMPAD_7
,
158
orxKEYBOARD_KEY_NUMPAD_8
,
159
orxKEYBOARD_KEY_NUMPAD_9
,
160
orxKEYBOARD_KEY_NUMPAD_DECIMAL
,
161
orxKEYBOARD_KEY_NUMPAD_DIVIDE
,
162
orxKEYBOARD_KEY_NUMPAD_MULTIPLY
,
163
orxKEYBOARD_KEY_NUMPAD_SUBTRACT
,
164
orxKEYBOARD_KEY_NUMPAD_ADD
,
165
orxKEYBOARD_KEY_NUMPAD_ENTER
,
166
orxKEYBOARD_KEY_NUMPAD_EQUAL
,
167
orxKEYBOARD_KEY_LSHIFT
,
168
orxKEYBOARD_KEY_LCTRL
,
169
orxKEYBOARD_KEY_LALT
,
170
orxKEYBOARD_KEY_LSYSTEM
,
171
orxKEYBOARD_KEY_RSHIFT
,
172
orxKEYBOARD_KEY_RCTRL
,
173
orxKEYBOARD_KEY_RALT
,
174
orxKEYBOARD_KEY_RSYSTEM
,
175
orxKEYBOARD_KEY_MENU
,
176
177
orxKEYBOARD_KEY_NUMBER
,
178
179
orxKEYBOARD_KEY_NONE
= orxENUM_NONE
180
181
}
orxKEYBOARD_KEY
;
182
183
184
/***************************************************************************
185
* Functions directly implemented by orx core
186
***************************************************************************/
187
190
extern
orxDLLAPI
void
orxFASTCALL
orxKeyboard_Setup
();
191
192
193
/***************************************************************************
194
* Functions extended by plugins
195
***************************************************************************/
196
199
extern
orxDLLAPI
orxSTATUS
orxFASTCALL
orxKeyboard_Init
();
200
203
extern
orxDLLAPI
void
orxFASTCALL
orxKeyboard_Exit
();
204
209
extern
orxDLLAPI
orxBOOL orxFASTCALL
orxKeyboard_IsKeyPressed
(
orxKEYBOARD_KEY
_eKey);
210
215
extern
orxDLLAPI
const
orxSTRING orxFASTCALL
orxKeyboard_GetKeyDisplayName
(
orxKEYBOARD_KEY
_eKey);
216
220
extern
orxDLLAPI
orxKEYBOARD_KEY
orxFASTCALL
orxKeyboard_ReadKey
();
221
225
extern
orxDLLAPI
const
orxSTRING orxFASTCALL
orxKeyboard_ReadString
();
226
229
extern
orxDLLAPI
void
orxFASTCALL
orxKeyboard_ClearBuffer
();
230
235
extern
orxDLLAPI
const
orxSTRING orxFASTCALL
orxKeyboard_GetKeyName
(
orxKEYBOARD_KEY
_eKey);
236
241
extern
orxDLLAPI
orxSTATUS
orxFASTCALL
orxKeyboard_Show
(orxBOOL _bShow);
242
243
#endif
/* _orxKEYBOARD_H_ */
244
orxKEYBOARD_KEY_F19
Definition:
orxKeyboard.h:143
orxKeyboard_ReadString
orxDLLAPI const orxSTRING orxFASTCALL orxKeyboard_ReadString()
orxKEYBOARD_KEY_7
Definition:
orxKeyboard.h:61
orxKEYBOARD_KEY_CAPS_LOCK
Definition:
orxKeyboard.h:118
orxKEYBOARD_KEY_F18
Definition:
orxKeyboard.h:142
orxKEYBOARD_KEY_LCTRL
Definition:
orxKeyboard.h:168
orxKEYBOARD_KEY_V
Definition:
orxKeyboard.h:85
orxKEYBOARD_KEY_PAGE_DOWN
Definition:
orxKeyboard.h:115
orxKEYBOARD_KEY_F25
Definition:
orxKeyboard.h:149
orxKEYBOARD_KEY_QUOTE
Definition:
orxKeyboard.h:91
orxKEYBOARD_KEY_NUMBER
Definition:
orxKeyboard.h:177
orxKEYBOARD_KEY_F7
Definition:
orxKeyboard.h:131
orxKEYBOARD_KEY_RCTRL
Definition:
orxKeyboard.h:172
orxKEYBOARD_KEY_E
Definition:
orxKeyboard.h:68
orxKEYBOARD_KEY_BACKSLASH
Definition:
orxKeyboard.h:99
orxKEYBOARD_KEY_PERIOD
Definition:
orxKeyboard.h:94
orxKEYBOARD_KEY_SCROLL_LOCK
Definition:
orxKeyboard.h:119
orxKEYBOARD_KEY_F1
Definition:
orxKeyboard.h:125
orxKEYBOARD_KEY_9
Definition:
orxKeyboard.h:63
orxKEYBOARD_KEY_T
Definition:
orxKeyboard.h:83
orxKEYBOARD_KEY_SPACE
Definition:
orxKeyboard.h:90
orxKeyboard_GetKeyName
orxDLLAPI const orxSTRING orxFASTCALL orxKeyboard_GetKeyName(orxKEYBOARD_KEY _eKey)
orxKEYBOARD_KEY_NUMPAD_SUBTRACT
Definition:
orxKeyboard.h:163
orxKeyboard_Setup
orxDLLAPI void orxFASTCALL orxKeyboard_Setup()
orxKEYBOARD_KEY_F11
Definition:
orxKeyboard.h:135
orxKEYBOARD_KEY_H
Definition:
orxKeyboard.h:71
orxKEYBOARD_KEY_BACKSPACE
Definition:
orxKeyboard.h:107
orxKEYBOARD_KEY_DOWN
Definition:
orxKeyboard.h:112
orxKEYBOARD_KEY_NUMPAD_9
Definition:
orxKeyboard.h:159
orxKEYBOARD_KEY_END
Definition:
orxKeyboard.h:117
orxKEYBOARD_KEY_F8
Definition:
orxKeyboard.h:132
orxKeyboard_Show
orxDLLAPI orxSTATUS orxFASTCALL orxKeyboard_Show(orxBOOL _bShow)
orxInclude.h
orxKEYBOARD_KEY_F9
Definition:
orxKeyboard.h:133
orxKEYBOARD_KEY_NONE
Definition:
orxKeyboard.h:179
orxKEYBOARD_KEY
orxKEYBOARD_KEY
Definition:
orxKeyboard.h:52
orxKeyboard_ReadKey
orxDLLAPI orxKEYBOARD_KEY orxFASTCALL orxKeyboard_ReadKey()
orxKEYBOARD_KEY_4
Definition:
orxKeyboard.h:58
orxKEYBOARD_KEY_NUMPAD_5
Definition:
orxKeyboard.h:155
orxKEYBOARD_KEY_VOLUME_DOWN
Definition:
orxKeyboard.h:123
orxKEYBOARD_KEY_P
Definition:
orxKeyboard.h:79
orxKEYBOARD_KEY_VOLUME_UP
Definition:
orxKeyboard.h:124
orxKEYBOARD_KEY_COMMA
Definition:
orxKeyboard.h:92
orxKEYBOARD_KEY_A
Definition:
orxKeyboard.h:64
orxKeyboard_GetKeyDisplayName
orxDLLAPI const orxSTRING orxFASTCALL orxKeyboard_GetKeyDisplayName(orxKEYBOARD_KEY _eKey)
orxKEYBOARD_KEY_HOME
Definition:
orxKeyboard.h:116
orxKEYBOARD_KEY_X
Definition:
orxKeyboard.h:87
orxKEYBOARD_KEY_F15
Definition:
orxKeyboard.h:139
orxKEYBOARD_KEY_NUMPAD_EQUAL
Definition:
orxKeyboard.h:166
orxKEYBOARD_KEY_RBRACKET
Definition:
orxKeyboard.h:100
orxKEYBOARD_KEY_F
Definition:
orxKeyboard.h:69
orxKeyboard_IsKeyPressed
orxDLLAPI orxBOOL orxFASTCALL orxKeyboard_IsKeyPressed(orxKEYBOARD_KEY _eKey)
orxKEYBOARD_KEY_3
Definition:
orxKeyboard.h:57
orxKEYBOARD_KEY_F21
Definition:
orxKeyboard.h:145
orxKeyboard_ClearBuffer
orxDLLAPI void orxFASTCALL orxKeyboard_ClearBuffer()
orxKEYBOARD_KEY_F2
Definition:
orxKeyboard.h:126
orxKEYBOARD_KEY_F3
Definition:
orxKeyboard.h:127
orxKEYBOARD_KEY_O
Definition:
orxKeyboard.h:78
orxKEYBOARD_KEY_R
Definition:
orxKeyboard.h:81
orxKEYBOARD_KEY_NUMPAD_ENTER
Definition:
orxKeyboard.h:165
orxKEYBOARD_KEY_G
Definition:
orxKeyboard.h:70
orxKEYBOARD_KEY_MENU
Definition:
orxKeyboard.h:175
orxKEYBOARD_KEY_Z
Definition:
orxKeyboard.h:89
orxKEYBOARD_KEY_WORLD_2
Definition:
orxKeyboard.h:103
orxKeyboard_Init
orxDLLAPI orxSTATUS orxFASTCALL orxKeyboard_Init()
orxKEYBOARD_KEY_WORLD_1
Definition:
orxKeyboard.h:102
orxKEYBOARD_KEY_F10
Definition:
orxKeyboard.h:134
orxKEYBOARD_KEY_NUMPAD_4
Definition:
orxKeyboard.h:154
orxKEYBOARD_KEY_5
Definition:
orxKeyboard.h:59
orxKEYBOARD_KEY_F14
Definition:
orxKeyboard.h:138
orxKEYBOARD_KEY_LEFT
Definition:
orxKeyboard.h:111
orxKEYBOARD_KEY_NUMPAD_DIVIDE
Definition:
orxKeyboard.h:161
orxKeyboard_Exit
orxDLLAPI void orxFASTCALL orxKeyboard_Exit()
orxKEYBOARD_KEY_D
Definition:
orxKeyboard.h:67
orxSTATUS
orxSTATUS
Definition:
orxType.h:256
orxKEYBOARD_KEY_F5
Definition:
orxKeyboard.h:129
orxKEYBOARD_KEY_LSHIFT
Definition:
orxKeyboard.h:167
orxKEYBOARD_KEY_BACKQUOTE
Definition:
orxKeyboard.h:101
orxKEYBOARD_KEY_L
Definition:
orxKeyboard.h:75
orxKEYBOARD_KEY_1
Definition:
orxKeyboard.h:55
orxKEYBOARD_KEY_F17
Definition:
orxKeyboard.h:141
orxKEYBOARD_KEY_DELETE
Definition:
orxKeyboard.h:109
orxKEYBOARD_KEY_NUMPAD_DECIMAL
Definition:
orxKeyboard.h:160
orxKEYBOARD_KEY_NUMPAD_2
Definition:
orxKeyboard.h:152
orxKEYBOARD_KEY_I
Definition:
orxKeyboard.h:72
orxKEYBOARD_KEY_INSERT
Definition:
orxKeyboard.h:108
orxKEYBOARD_KEY_N
Definition:
orxKeyboard.h:77
orxKEYBOARD_KEY_PRINT_SCREEN
Definition:
orxKeyboard.h:121
orxKEYBOARD_KEY_NUMPAD_3
Definition:
orxKeyboard.h:153
orxKEYBOARD_KEY_NUM_LOCK
Definition:
orxKeyboard.h:120
orxKEYBOARD_KEY_0
Definition:
orxKeyboard.h:54
orxKEYBOARD_KEY_UP
Definition:
orxKeyboard.h:113
orxKEYBOARD_KEY_F12
Definition:
orxKeyboard.h:136
orxKEYBOARD_KEY_RIGHT
Definition:
orxKeyboard.h:110
orxKEYBOARD_KEY_2
Definition:
orxKeyboard.h:56
orxKEYBOARD_KEY_ESCAPE
Definition:
orxKeyboard.h:104
orxKEYBOARD_KEY_EQUAL
Definition:
orxKeyboard.h:97
orxDLLAPI
#define orxDLLAPI
Definition:
orxDecl.h:370
orxKEYBOARD_KEY_PAUSE
Definition:
orxKeyboard.h:122
orxKEYBOARD_KEY_RSHIFT
Definition:
orxKeyboard.h:171
orxKEYBOARD_KEY_B
Definition:
orxKeyboard.h:65
orxKEYBOARD_KEY_NUMPAD_ADD
Definition:
orxKeyboard.h:164
orxKEYBOARD_KEY_F6
Definition:
orxKeyboard.h:130
orxPluginCore.h
orxKEYBOARD_KEY_NUMPAD_0
Definition:
orxKeyboard.h:150
orxKEYBOARD_KEY_F4
Definition:
orxKeyboard.h:128
orxKEYBOARD_KEY_F24
Definition:
orxKeyboard.h:148
orxKEYBOARD_KEY_8
Definition:
orxKeyboard.h:62
orxKEYBOARD_KEY_SEMICOLON
Definition:
orxKeyboard.h:96
orxKEYBOARD_KEY_NUMPAD_6
Definition:
orxKeyboard.h:156
orxKEYBOARD_KEY_NUMPAD_MULTIPLY
Definition:
orxKeyboard.h:162
orxKEYBOARD_KEY_SLASH
Definition:
orxKeyboard.h:95
orxKEYBOARD_KEY_LSYSTEM
Definition:
orxKeyboard.h:170
orxKEYBOARD_KEY_NUMPAD_7
Definition:
orxKeyboard.h:157
orxKEYBOARD_KEY_RSYSTEM
Definition:
orxKeyboard.h:174
orxKEYBOARD_KEY_F20
Definition:
orxKeyboard.h:144
orxKEYBOARD_KEY_PAGE_UP
Definition:
orxKeyboard.h:114
orxKEYBOARD_KEY_F23
Definition:
orxKeyboard.h:147
orxKEYBOARD_KEY_Q
Definition:
orxKeyboard.h:80
orxKEYBOARD_KEY_Y
Definition:
orxKeyboard.h:88
orxKEYBOARD_KEY_U
Definition:
orxKeyboard.h:84
orxKEYBOARD_KEY_ENTER
Definition:
orxKeyboard.h:105
orxKEYBOARD_KEY_F22
Definition:
orxKeyboard.h:146
orxKEYBOARD_KEY_LBRACKET
Definition:
orxKeyboard.h:98
orxKEYBOARD_KEY_6
Definition:
orxKeyboard.h:60
orxKEYBOARD_KEY_W
Definition:
orxKeyboard.h:86
orxKEYBOARD_KEY_NUMPAD_1
Definition:
orxKeyboard.h:151
orxKEYBOARD_KEY_F16
Definition:
orxKeyboard.h:140
orxKEYBOARD_KEY_K
Definition:
orxKeyboard.h:74
orxKEYBOARD_KEY_RALT
Definition:
orxKeyboard.h:173
orxKEYBOARD_KEY_DASH
Definition:
orxKeyboard.h:93
orxKEYBOARD_KEY_TAB
Definition:
orxKeyboard.h:106
orxKEYBOARD_KEY_LALT
Definition:
orxKeyboard.h:169
orxKEYBOARD_KEY_J
Definition:
orxKeyboard.h:73
orxKEYBOARD_KEY_NUMPAD_8
Definition:
orxKeyboard.h:158
orxKEYBOARD_KEY_F13
Definition:
orxKeyboard.h:137
orxKEYBOARD_KEY_S
Definition:
orxKeyboard.h:82
orxKEYBOARD_KEY_M
Definition:
orxKeyboard.h:76
orxKEYBOARD_KEY_C
Definition:
orxKeyboard.h:66
Generated for orx by
1.8.11