orx  stable
Portable Game Engine
orxKeyboard.h
Go to the documentation of this file.
1 /* Orx - Portable Game Engine
2  *
3  * Copyright (c) 2008-2017 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 {
161 
162  orxKEYBOARD_KEY_NONE = orxENUM_NONE
163 
165 
166 
167 /***************************************************************************
168  * Functions directly implemented by orx core
169  ***************************************************************************/
170 
173 extern orxDLLAPI void orxFASTCALL orxKeyboard_Setup();
174 
175 
176 /***************************************************************************
177  * Functions extended by plugins
178  ***************************************************************************/
179 
182 extern orxDLLAPI orxSTATUS orxFASTCALL orxKeyboard_Init();
183 
186 extern orxDLLAPI void orxFASTCALL orxKeyboard_Exit();
187 
192 extern orxDLLAPI orxBOOL orxFASTCALL orxKeyboard_IsKeyPressed(orxKEYBOARD_KEY _eKey);
193 
197 extern orxDLLAPI orxKEYBOARD_KEY orxFASTCALL orxKeyboard_ReadKey();
198 
202 extern orxDLLAPI const orxSTRING orxFASTCALL orxKeyboard_ReadString();
203 
206 extern orxDLLAPI void orxFASTCALL orxKeyboard_ClearBuffer();
207 
212 extern orxDLLAPI const orxSTRING orxFASTCALL orxKeyboard_GetKeyName(orxKEYBOARD_KEY _eKey);
213 
218 extern orxDLLAPI orxSTATUS orxFASTCALL orxKeyboard_Show(orxBOOL _bShow);
219 
220 #endif /* _orxKEYBOARD_H_ */
221 
orxDLLAPI const orxSTRING orxFASTCALL orxKeyboard_ReadString()
orxDLLAPI const orxSTRING orxFASTCALL orxKeyboard_GetKeyName(orxKEYBOARD_KEY _eKey)
orxDLLAPI void orxFASTCALL orxKeyboard_Setup()
orxDLLAPI orxSTATUS orxFASTCALL orxKeyboard_Show(orxBOOL _bShow)
orxKEYBOARD_KEY
Definition: orxKeyboard.h:52
orxDLLAPI orxKEYBOARD_KEY orxFASTCALL orxKeyboard_ReadKey()
orxDLLAPI orxBOOL orxFASTCALL orxKeyboard_IsKeyPressed(orxKEYBOARD_KEY _eKey)
orxDLLAPI void orxFASTCALL orxKeyboard_ClearBuffer()
orxDLLAPI orxSTATUS orxFASTCALL orxKeyboard_Init()
orxDLLAPI void orxFASTCALL orxKeyboard_Exit()
orxSTATUS
Definition: orxType.h:243
#define orxDLLAPI
Definition: orxDecl.h:387

Generated for orx by doxygen 1.5.6