orx: include/io/orxKeyboard.h Source File

Go to the documentation of this file.
00001 /* Orx - Portable Game Engine
00002  *
00003  * Copyright (c) 2008-2011 Orx-Project
00004  *
00005  * This software is provided 'as-is', without any express or implied
00006  * warranty. In no event will the authors be held liable for any damages
00007  * arising from the use of this software.
00008  *
00009  * Permission is granted to anyone to use this software for any purpose,
00010  * including commercial applications, and to alter it and redistribute it
00011  * freely, subject to the following restrictions:
00012  *
00013  *    1. The origin of this software must not be misrepresented; you must not
00014  *    claim that you wrote the original software. If you use this software
00015  *    in a product, an acknowledgment in the product documentation would be
00016  *    appreciated but is not required.
00017  *
00018  *    2. Altered source versions must be plainly marked as such, and must not be
00019  *    misrepresented as being the original software.
00020  *
00021  *    3. This notice may not be removed or altered from any source
00022  *    distribution.
00023  */
00024 
00043 #ifndef _orxKEYBOARD_H_
00044 #define _orxKEYBOARD_H_
00045 
00046 #include "orxInclude.h"
00047 #include "plugin/orxPluginCore.h"
00048 
00049 
00052 typedef enum __orxKEYBOARD_KEY_t
00053 {
00054   orxKEYBOARD_KEY_A = 0,
00055   orxKEYBOARD_KEY_B,
00056   orxKEYBOARD_KEY_C,
00057   orxKEYBOARD_KEY_D,
00058   orxKEYBOARD_KEY_E,
00059   orxKEYBOARD_KEY_F,
00060   orxKEYBOARD_KEY_G,
00061   orxKEYBOARD_KEY_H,
00062   orxKEYBOARD_KEY_I,
00063   orxKEYBOARD_KEY_J,
00064   orxKEYBOARD_KEY_K,
00065   orxKEYBOARD_KEY_L,
00066   orxKEYBOARD_KEY_M,
00067   orxKEYBOARD_KEY_N,
00068   orxKEYBOARD_KEY_O,
00069   orxKEYBOARD_KEY_P,
00070   orxKEYBOARD_KEY_Q,
00071   orxKEYBOARD_KEY_R,
00072   orxKEYBOARD_KEY_S,
00073   orxKEYBOARD_KEY_T,
00074   orxKEYBOARD_KEY_U,
00075   orxKEYBOARD_KEY_V,
00076   orxKEYBOARD_KEY_W,
00077   orxKEYBOARD_KEY_X,
00078   orxKEYBOARD_KEY_Y,
00079   orxKEYBOARD_KEY_Z,
00080   orxKEYBOARD_KEY_0,
00081   orxKEYBOARD_KEY_1,
00082   orxKEYBOARD_KEY_2,
00083   orxKEYBOARD_KEY_3,
00084   orxKEYBOARD_KEY_4,
00085   orxKEYBOARD_KEY_5,
00086   orxKEYBOARD_KEY_6,
00087   orxKEYBOARD_KEY_7,
00088   orxKEYBOARD_KEY_8,
00089   orxKEYBOARD_KEY_9,
00090   orxKEYBOARD_KEY_NUMPAD_0,
00091   orxKEYBOARD_KEY_NUMPAD_1,
00092   orxKEYBOARD_KEY_NUMPAD_2,
00093   orxKEYBOARD_KEY_NUMPAD_3,
00094   orxKEYBOARD_KEY_NUMPAD_4,
00095   orxKEYBOARD_KEY_NUMPAD_5,
00096   orxKEYBOARD_KEY_NUMPAD_6,
00097   orxKEYBOARD_KEY_NUMPAD_7,
00098   orxKEYBOARD_KEY_NUMPAD_8,
00099   orxKEYBOARD_KEY_NUMPAD_9,
00100   orxKEYBOARD_KEY_NUMPAD_RETURN,
00101   orxKEYBOARD_KEY_NUMPAD_DECIMAL,
00102   orxKEYBOARD_KEY_NUM_LOCK,
00103   orxKEYBOARD_KEY_SCROLL_LOCK,
00104   orxKEYBOARD_KEY_CAPS_LOCK,
00105   orxKEYBOARD_KEY_F1,
00106   orxKEYBOARD_KEY_F2,
00107   orxKEYBOARD_KEY_F3,
00108   orxKEYBOARD_KEY_F4,
00109   orxKEYBOARD_KEY_F5,
00110   orxKEYBOARD_KEY_F6,
00111   orxKEYBOARD_KEY_F7,
00112   orxKEYBOARD_KEY_F8,
00113   orxKEYBOARD_KEY_F9,
00114   orxKEYBOARD_KEY_F10,
00115   orxKEYBOARD_KEY_F11,
00116   orxKEYBOARD_KEY_F12,
00117   orxKEYBOARD_KEY_F13,
00118   orxKEYBOARD_KEY_F14,
00119   orxKEYBOARD_KEY_F15,
00120   orxKEYBOARD_KEY_UP,
00121   orxKEYBOARD_KEY_RIGHT,
00122   orxKEYBOARD_KEY_DOWN,
00123   orxKEYBOARD_KEY_LEFT,
00124   orxKEYBOARD_KEY_ESCAPE,
00125   orxKEYBOARD_KEY_SPACE,
00126   orxKEYBOARD_KEY_RETURN,
00127   orxKEYBOARD_KEY_BACKSPACE,
00128   orxKEYBOARD_KEY_TAB,
00129   orxKEYBOARD_KEY_PAGEUP,
00130   orxKEYBOARD_KEY_PAGEDOWN,
00131   orxKEYBOARD_KEY_END,
00132   orxKEYBOARD_KEY_HOME,
00133   orxKEYBOARD_KEY_INSERT,
00134   orxKEYBOARD_KEY_DELETE,
00135   orxKEYBOARD_KEY_ADD,
00136   orxKEYBOARD_KEY_SUBTRACT,
00137   orxKEYBOARD_KEY_MULTIPLY,
00138   orxKEYBOARD_KEY_DIVIDE,
00139   orxKEYBOARD_KEY_PAUSE,
00140   orxKEYBOARD_KEY_RALT,
00141   orxKEYBOARD_KEY_RCTRL,
00142   orxKEYBOARD_KEY_RSHIFT,
00143   orxKEYBOARD_KEY_RSYSTEM,
00144   orxKEYBOARD_KEY_LALT,
00145   orxKEYBOARD_KEY_LCTRL,
00146   orxKEYBOARD_KEY_LSHIFT,
00147   orxKEYBOARD_KEY_LSYSTEM,
00148   orxKEYBOARD_KEY_MENU,
00149   orxKEYBOARD_KEY_LBRACKET,
00150   orxKEYBOARD_KEY_RBRACKET,
00151   orxKEYBOARD_KEY_SEMICOLON,
00152   orxKEYBOARD_KEY_COMMA,
00153   orxKEYBOARD_KEY_PERIOD,
00154   orxKEYBOARD_KEY_QUOTE,
00155   orxKEYBOARD_KEY_SLASH,
00156   orxKEYBOARD_KEY_BACKSLASH,
00157   orxKEYBOARD_KEY_TILDE,
00158   orxKEYBOARD_KEY_EQUAL,
00159   orxKEYBOARD_KEY_DASH,
00160   orxKEYBOARD_KEY_NUMBER,
00161 
00162   orxKEYBOARD_KEY_NONE = orxENUM_NONE
00163 
00164 } orxKEYBOARD_KEY;
00165 
00166 
00167 /***************************************************************************
00168  * Functions directly implemented by orx core
00169  ***************************************************************************/
00170 
00173 extern orxDLLAPI void orxFASTCALL             orxKeyboard_Setup();
00174 
00175 
00176 /***************************************************************************
00177  * Functions extended by plugins
00178  ***************************************************************************/
00179 
00182 extern orxDLLAPI orxSTATUS orxFASTCALL        orxKeyboard_Init();
00183 
00186 extern orxDLLAPI void orxFASTCALL             orxKeyboard_Exit();
00187 
00192 extern orxDLLAPI orxBOOL orxFASTCALL          orxKeyboard_IsKeyPressed(orxKEYBOARD_KEY _eKey);
00193 
00197 extern orxDLLAPI orxBOOL orxFASTCALL          orxKeyboard_Hit();
00198 
00202 extern orxDLLAPI orxKEYBOARD_KEY orxFASTCALL  orxKeyboard_Read();
00203 
00206 extern orxDLLAPI void orxFASTCALL             orxKeyboard_ClearBuffer();
00207 
00212 extern orxDLLAPI const orxSTRING orxFASTCALL  orxKeyboard_GetKeyName(orxKEYBOARD_KEY _eKey);
00213 
00214 #endif /* _orxKEYBOARD_H_ */
00215