Enumerations |
| enum | orxKEYBOARD_KEY {
orxKEYBOARD_KEY_A = 0,
orxKEYBOARD_KEY_B,
orxKEYBOARD_KEY_C,
orxKEYBOARD_KEY_D,
orxKEYBOARD_KEY_E,
orxKEYBOARD_KEY_F,
orxKEYBOARD_KEY_G,
orxKEYBOARD_KEY_H,
orxKEYBOARD_KEY_I,
orxKEYBOARD_KEY_J,
orxKEYBOARD_KEY_K,
orxKEYBOARD_KEY_L,
orxKEYBOARD_KEY_M,
orxKEYBOARD_KEY_N,
orxKEYBOARD_KEY_O,
orxKEYBOARD_KEY_P,
orxKEYBOARD_KEY_Q,
orxKEYBOARD_KEY_R,
orxKEYBOARD_KEY_S,
orxKEYBOARD_KEY_T,
orxKEYBOARD_KEY_U,
orxKEYBOARD_KEY_V,
orxKEYBOARD_KEY_W,
orxKEYBOARD_KEY_X,
orxKEYBOARD_KEY_Y,
orxKEYBOARD_KEY_Z,
orxKEYBOARD_KEY_0,
orxKEYBOARD_KEY_1,
orxKEYBOARD_KEY_2,
orxKEYBOARD_KEY_3,
orxKEYBOARD_KEY_4,
orxKEYBOARD_KEY_5,
orxKEYBOARD_KEY_6,
orxKEYBOARD_KEY_7,
orxKEYBOARD_KEY_8,
orxKEYBOARD_KEY_9,
orxKEYBOARD_KEY_NUMPAD_0,
orxKEYBOARD_KEY_NUMPAD_1,
orxKEYBOARD_KEY_NUMPAD_2,
orxKEYBOARD_KEY_NUMPAD_3,
orxKEYBOARD_KEY_NUMPAD_4,
orxKEYBOARD_KEY_NUMPAD_5,
orxKEYBOARD_KEY_NUMPAD_6,
orxKEYBOARD_KEY_NUMPAD_7,
orxKEYBOARD_KEY_NUMPAD_8,
orxKEYBOARD_KEY_NUMPAD_9,
orxKEYBOARD_KEY_NUMPAD_RETURN,
orxKEYBOARD_KEY_NUMPAD_DECIMAL,
orxKEYBOARD_KEY_NUM_LOCK,
orxKEYBOARD_KEY_SCROLL_LOCK,
orxKEYBOARD_KEY_CAPS_LOCK,
orxKEYBOARD_KEY_F1,
orxKEYBOARD_KEY_F2,
orxKEYBOARD_KEY_F3,
orxKEYBOARD_KEY_F4,
orxKEYBOARD_KEY_F5,
orxKEYBOARD_KEY_F6,
orxKEYBOARD_KEY_F7,
orxKEYBOARD_KEY_F8,
orxKEYBOARD_KEY_F9,
orxKEYBOARD_KEY_F10,
orxKEYBOARD_KEY_F11,
orxKEYBOARD_KEY_F12,
orxKEYBOARD_KEY_F13,
orxKEYBOARD_KEY_F14,
orxKEYBOARD_KEY_F15,
orxKEYBOARD_KEY_UP,
orxKEYBOARD_KEY_RIGHT,
orxKEYBOARD_KEY_DOWN,
orxKEYBOARD_KEY_LEFT,
orxKEYBOARD_KEY_ESCAPE,
orxKEYBOARD_KEY_SPACE,
orxKEYBOARD_KEY_RETURN,
orxKEYBOARD_KEY_BACKSPACE,
orxKEYBOARD_KEY_TAB,
orxKEYBOARD_KEY_PAGEUP,
orxKEYBOARD_KEY_PAGEDOWN,
orxKEYBOARD_KEY_END,
orxKEYBOARD_KEY_HOME,
orxKEYBOARD_KEY_INSERT,
orxKEYBOARD_KEY_DELETE,
orxKEYBOARD_KEY_ADD,
orxKEYBOARD_KEY_SUBTRACT,
orxKEYBOARD_KEY_MULTIPLY,
orxKEYBOARD_KEY_DIVIDE,
orxKEYBOARD_KEY_PAUSE,
orxKEYBOARD_KEY_RALT,
orxKEYBOARD_KEY_RCTRL,
orxKEYBOARD_KEY_RSHIFT,
orxKEYBOARD_KEY_RSYSTEM,
orxKEYBOARD_KEY_LALT,
orxKEYBOARD_KEY_LCTRL,
orxKEYBOARD_KEY_LSHIFT,
orxKEYBOARD_KEY_LSYSTEM,
orxKEYBOARD_KEY_MENU,
orxKEYBOARD_KEY_LBRACKET,
orxKEYBOARD_KEY_RBRACKET,
orxKEYBOARD_KEY_SEMICOLON,
orxKEYBOARD_KEY_COMMA,
orxKEYBOARD_KEY_PERIOD,
orxKEYBOARD_KEY_QUOTE,
orxKEYBOARD_KEY_SLASH,
orxKEYBOARD_KEY_BACKSLASH,
orxKEYBOARD_KEY_TILDE,
orxKEYBOARD_KEY_EQUAL,
orxKEYBOARD_KEY_DASH,
orxKEYBOARD_KEY_NUMBER,
orxKEYBOARD_KEY_NONE = orxENUM_NONE
} |
Functions |
| orxDLLAPI void orxFASTCALL | orxKeyboard_ClearBuffer () |
| orxDLLAPI void orxFASTCALL | orxKeyboard_Exit () |
orxDLLAPI const orxSTRING
orxFASTCALL | orxKeyboard_GetKeyName (orxKEYBOARD_KEY _eKey) |
| orxDLLAPI orxBOOL orxFASTCALL | orxKeyboard_Hit () |
| orxDLLAPI orxSTATUS orxFASTCALL | orxKeyboard_Init () |
| orxDLLAPI orxBOOL orxFASTCALL | orxKeyboard_IsKeyPressed (orxKEYBOARD_KEY _eKey) |
orxDLLAPI orxKEYBOARD_KEY
orxFASTCALL | orxKeyboard_Read () |
| orxDLLAPI void orxFASTCALL | orxKeyboard_Setup () |
Detailed Description
Keyboard plugin module Plugin module that handles keyboard peripherals
Enumeration Type Documentation
Key enum
- Enumerator:
| orxKEYBOARD_KEY_A |
|
| orxKEYBOARD_KEY_B |
|
| orxKEYBOARD_KEY_C |
|
| orxKEYBOARD_KEY_D |
|
| orxKEYBOARD_KEY_E |
|
| orxKEYBOARD_KEY_F |
|
| orxKEYBOARD_KEY_G |
|
| orxKEYBOARD_KEY_H |
|
| orxKEYBOARD_KEY_I |
|
| orxKEYBOARD_KEY_J |
|
| orxKEYBOARD_KEY_K |
|
| orxKEYBOARD_KEY_L |
|
| orxKEYBOARD_KEY_M |
|
| orxKEYBOARD_KEY_N |
|
| orxKEYBOARD_KEY_O |
|
| orxKEYBOARD_KEY_P |
|
| orxKEYBOARD_KEY_Q |
|
| orxKEYBOARD_KEY_R |
|
| orxKEYBOARD_KEY_S |
|
| orxKEYBOARD_KEY_T |
|
| orxKEYBOARD_KEY_U |
|
| orxKEYBOARD_KEY_V |
|
| orxKEYBOARD_KEY_W |
|
| orxKEYBOARD_KEY_X |
|
| orxKEYBOARD_KEY_Y |
|
| orxKEYBOARD_KEY_Z |
|
| orxKEYBOARD_KEY_0 |
|
| orxKEYBOARD_KEY_1 |
|
| orxKEYBOARD_KEY_2 |
|
| orxKEYBOARD_KEY_3 |
|
| orxKEYBOARD_KEY_4 |
|
| orxKEYBOARD_KEY_5 |
|
| orxKEYBOARD_KEY_6 |
|
| orxKEYBOARD_KEY_7 |
|
| orxKEYBOARD_KEY_8 |
|
| orxKEYBOARD_KEY_9 |
|
| orxKEYBOARD_KEY_NUMPAD_0 |
|
| orxKEYBOARD_KEY_NUMPAD_1 |
|
| orxKEYBOARD_KEY_NUMPAD_2 |
|
| orxKEYBOARD_KEY_NUMPAD_3 |
|
| orxKEYBOARD_KEY_NUMPAD_4 |
|
| orxKEYBOARD_KEY_NUMPAD_5 |
|
| orxKEYBOARD_KEY_NUMPAD_6 |
|
| orxKEYBOARD_KEY_NUMPAD_7 |
|
| orxKEYBOARD_KEY_NUMPAD_8 |
|
| orxKEYBOARD_KEY_NUMPAD_9 |
|
| orxKEYBOARD_KEY_NUMPAD_RETURN |
|
| orxKEYBOARD_KEY_NUMPAD_DECIMAL |
|
| orxKEYBOARD_KEY_NUM_LOCK |
|
| orxKEYBOARD_KEY_SCROLL_LOCK |
|
| orxKEYBOARD_KEY_CAPS_LOCK |
|
| orxKEYBOARD_KEY_F1 |
|
| orxKEYBOARD_KEY_F2 |
|
| orxKEYBOARD_KEY_F3 |
|
| orxKEYBOARD_KEY_F4 |
|
| orxKEYBOARD_KEY_F5 |
|
| orxKEYBOARD_KEY_F6 |
|
| orxKEYBOARD_KEY_F7 |
|
| orxKEYBOARD_KEY_F8 |
|
| orxKEYBOARD_KEY_F9 |
|
| orxKEYBOARD_KEY_F10 |
|
| orxKEYBOARD_KEY_F11 |
|
| orxKEYBOARD_KEY_F12 |
|
| orxKEYBOARD_KEY_F13 |
|
| orxKEYBOARD_KEY_F14 |
|
| orxKEYBOARD_KEY_F15 |
|
| orxKEYBOARD_KEY_UP |
|
| orxKEYBOARD_KEY_RIGHT |
|
| orxKEYBOARD_KEY_DOWN |
|
| orxKEYBOARD_KEY_LEFT |
|
| orxKEYBOARD_KEY_ESCAPE |
|
| orxKEYBOARD_KEY_SPACE |
|
| orxKEYBOARD_KEY_RETURN |
|
| orxKEYBOARD_KEY_BACKSPACE |
|
| orxKEYBOARD_KEY_TAB |
|
| orxKEYBOARD_KEY_PAGEUP |
|
| orxKEYBOARD_KEY_PAGEDOWN |
|
| orxKEYBOARD_KEY_END |
|
| orxKEYBOARD_KEY_HOME |
|
| orxKEYBOARD_KEY_INSERT |
|
| orxKEYBOARD_KEY_DELETE |
|
| orxKEYBOARD_KEY_ADD |
|
| orxKEYBOARD_KEY_SUBTRACT |
|
| orxKEYBOARD_KEY_MULTIPLY |
|
| orxKEYBOARD_KEY_DIVIDE |
|
| orxKEYBOARD_KEY_PAUSE |
|
| orxKEYBOARD_KEY_RALT |
|
| orxKEYBOARD_KEY_RCTRL |
|
| orxKEYBOARD_KEY_RSHIFT |
|
| orxKEYBOARD_KEY_RSYSTEM |
|
| orxKEYBOARD_KEY_LALT |
|
| orxKEYBOARD_KEY_LCTRL |
|
| orxKEYBOARD_KEY_LSHIFT |
|
| orxKEYBOARD_KEY_LSYSTEM |
|
| orxKEYBOARD_KEY_MENU |
|
| orxKEYBOARD_KEY_LBRACKET |
|
| orxKEYBOARD_KEY_RBRACKET |
|
| orxKEYBOARD_KEY_SEMICOLON |
|
| orxKEYBOARD_KEY_COMMA |
|
| orxKEYBOARD_KEY_PERIOD |
|
| orxKEYBOARD_KEY_QUOTE |
|
| orxKEYBOARD_KEY_SLASH |
|
| orxKEYBOARD_KEY_BACKSLASH |
|
| orxKEYBOARD_KEY_TILDE |
|
| orxKEYBOARD_KEY_EQUAL |
|
| orxKEYBOARD_KEY_DASH |
|
| orxKEYBOARD_KEY_NUMBER |
|
| orxKEYBOARD_KEY_NONE |
|
Definition at line 52 of file orxKeyboard.h.
Function Documentation
| orxDLLAPI void orxFASTCALL orxKeyboard_ClearBuffer |
( |
) |
|
Empties the keyboard buffer.
| orxDLLAPI void orxFASTCALL orxKeyboard_Exit |
( |
) |
|
Exits from the keyboard module
| orxDLLAPI const orxSTRING orxFASTCALL orxKeyboard_GetKeyName |
( |
orxKEYBOARD_KEY |
_eKey ) |
|
Gets key literal name
- Parameters:
-
- Returns:
- Key's name
| orxDLLAPI orxBOOL orxFASTCALL orxKeyboard_Hit |
( |
) |
|
Returns orxTRUE if there are keypresses waiting in the input buffer.
- Returns:
- orxTRUE if keys have been pressed, else orxFALSE
| orxDLLAPI orxSTATUS orxFASTCALL orxKeyboard_Init |
( |
) |
|
Inits the keyboard module
| orxDLLAPI orxBOOL orxFASTCALL orxKeyboard_IsKeyPressed |
( |
orxKEYBOARD_KEY |
_eKey ) |
|
Is key pressed?
- Parameters:
-
- Returns:
- orxTRUE if pressed / orxFALSE otherwise
Gets the next character from the keyboard buffer
- Returns:
- orxKEYBOARD_KEY
| orxDLLAPI void orxFASTCALL orxKeyboard_Setup |
( |
) |
|
