orx  1.14
Portable Game Engine
Enumerations | Functions
OrxKeyboard

Enumerations

enum  orxKEYBOARD_KEY {
  orxKEYBOARD_KEY_0 = 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_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_SPACE, orxKEYBOARD_KEY_QUOTE, orxKEYBOARD_KEY_COMMA, orxKEYBOARD_KEY_DASH,
  orxKEYBOARD_KEY_PERIOD, orxKEYBOARD_KEY_SLASH, orxKEYBOARD_KEY_SEMICOLON, orxKEYBOARD_KEY_EQUAL,
  orxKEYBOARD_KEY_LBRACKET, orxKEYBOARD_KEY_BACKSLASH, orxKEYBOARD_KEY_RBRACKET, orxKEYBOARD_KEY_BACKQUOTE,
  orxKEYBOARD_KEY_WORLD_1, orxKEYBOARD_KEY_WORLD_2, orxKEYBOARD_KEY_ESCAPE, orxKEYBOARD_KEY_ENTER,
  orxKEYBOARD_KEY_TAB, orxKEYBOARD_KEY_BACKSPACE, orxKEYBOARD_KEY_INSERT, orxKEYBOARD_KEY_DELETE,
  orxKEYBOARD_KEY_RIGHT, orxKEYBOARD_KEY_LEFT, orxKEYBOARD_KEY_DOWN, orxKEYBOARD_KEY_UP,
  orxKEYBOARD_KEY_PAGE_UP, orxKEYBOARD_KEY_PAGE_DOWN, orxKEYBOARD_KEY_HOME, orxKEYBOARD_KEY_END,
  orxKEYBOARD_KEY_CAPS_LOCK, orxKEYBOARD_KEY_SCROLL_LOCK, orxKEYBOARD_KEY_NUM_LOCK, orxKEYBOARD_KEY_PRINT_SCREEN,
  orxKEYBOARD_KEY_PAUSE, orxKEYBOARD_KEY_VOLUME_DOWN, orxKEYBOARD_KEY_VOLUME_UP, 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_F16, orxKEYBOARD_KEY_F17,
  orxKEYBOARD_KEY_F18, orxKEYBOARD_KEY_F19, orxKEYBOARD_KEY_F20, orxKEYBOARD_KEY_F21,
  orxKEYBOARD_KEY_F22, orxKEYBOARD_KEY_F23, orxKEYBOARD_KEY_F24, orxKEYBOARD_KEY_F25,
  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_DECIMAL, orxKEYBOARD_KEY_NUMPAD_DIVIDE,
  orxKEYBOARD_KEY_NUMPAD_MULTIPLY, orxKEYBOARD_KEY_NUMPAD_SUBTRACT, orxKEYBOARD_KEY_NUMPAD_ADD, orxKEYBOARD_KEY_NUMPAD_ENTER,
  orxKEYBOARD_KEY_NUMPAD_EQUAL, orxKEYBOARD_KEY_LSHIFT, orxKEYBOARD_KEY_LCTRL, orxKEYBOARD_KEY_LALT,
  orxKEYBOARD_KEY_LSYSTEM, orxKEYBOARD_KEY_RSHIFT, orxKEYBOARD_KEY_RCTRL, orxKEYBOARD_KEY_RALT,
  orxKEYBOARD_KEY_RSYSTEM, orxKEYBOARD_KEY_MENU, orxKEYBOARD_KEY_NUMBER, orxKEYBOARD_KEY_NONE = orxENUM_NONE
}
 

Functions

orxDLLAPI void orxFASTCALL orxKeyboard_ClearBuffer ()
 
orxDLLAPI void orxFASTCALL orxKeyboard_Exit ()
 
orxDLLAPI const orxSTRING orxFASTCALL orxKeyboard_GetKeyDisplayName (orxKEYBOARD_KEY _eKey)
 
orxDLLAPI const orxSTRING orxFASTCALL orxKeyboard_GetKeyName (orxKEYBOARD_KEY _eKey)
 
orxDLLAPI orxSTATUS orxFASTCALL orxKeyboard_Init ()
 
orxDLLAPI orxBOOL orxFASTCALL orxKeyboard_IsKeyPressed (orxKEYBOARD_KEY _eKey)
 
orxDLLAPI orxKEYBOARD_KEY orxFASTCALL orxKeyboard_ReadKey ()
 
orxDLLAPI const orxSTRING orxFASTCALL orxKeyboard_ReadString ()
 
orxDLLAPI void orxFASTCALL orxKeyboard_Setup ()
 
orxDLLAPI orxSTATUS orxFASTCALL orxKeyboard_Show (orxBOOL _bShow)
 

Detailed Description

Keyboard plugin module Plugin module that handles keyboard peripherals

Enumeration Type Documentation

enum orxKEYBOARD_KEY

Key enum

Enumerator
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_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_SPACE 
orxKEYBOARD_KEY_QUOTE 
orxKEYBOARD_KEY_COMMA 
orxKEYBOARD_KEY_DASH 
orxKEYBOARD_KEY_PERIOD 
orxKEYBOARD_KEY_SLASH 
orxKEYBOARD_KEY_SEMICOLON 
orxKEYBOARD_KEY_EQUAL 
orxKEYBOARD_KEY_LBRACKET 
orxKEYBOARD_KEY_BACKSLASH 
orxKEYBOARD_KEY_RBRACKET 
orxKEYBOARD_KEY_BACKQUOTE 
orxKEYBOARD_KEY_WORLD_1 
orxKEYBOARD_KEY_WORLD_2 
orxKEYBOARD_KEY_ESCAPE 
orxKEYBOARD_KEY_ENTER 
orxKEYBOARD_KEY_TAB 
orxKEYBOARD_KEY_BACKSPACE 
orxKEYBOARD_KEY_INSERT 
orxKEYBOARD_KEY_DELETE 
orxKEYBOARD_KEY_RIGHT 
orxKEYBOARD_KEY_LEFT 
orxKEYBOARD_KEY_DOWN 
orxKEYBOARD_KEY_UP 
orxKEYBOARD_KEY_PAGE_UP 
orxKEYBOARD_KEY_PAGE_DOWN 
orxKEYBOARD_KEY_HOME 
orxKEYBOARD_KEY_END 
orxKEYBOARD_KEY_CAPS_LOCK 
orxKEYBOARD_KEY_SCROLL_LOCK 
orxKEYBOARD_KEY_NUM_LOCK 
orxKEYBOARD_KEY_PRINT_SCREEN 
orxKEYBOARD_KEY_PAUSE 
orxKEYBOARD_KEY_VOLUME_DOWN 
orxKEYBOARD_KEY_VOLUME_UP 
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_F16 
orxKEYBOARD_KEY_F17 
orxKEYBOARD_KEY_F18 
orxKEYBOARD_KEY_F19 
orxKEYBOARD_KEY_F20 
orxKEYBOARD_KEY_F21 
orxKEYBOARD_KEY_F22 
orxKEYBOARD_KEY_F23 
orxKEYBOARD_KEY_F24 
orxKEYBOARD_KEY_F25 
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_DECIMAL 
orxKEYBOARD_KEY_NUMPAD_DIVIDE 
orxKEYBOARD_KEY_NUMPAD_MULTIPLY 
orxKEYBOARD_KEY_NUMPAD_SUBTRACT 
orxKEYBOARD_KEY_NUMPAD_ADD 
orxKEYBOARD_KEY_NUMPAD_ENTER 
orxKEYBOARD_KEY_NUMPAD_EQUAL 
orxKEYBOARD_KEY_LSHIFT 
orxKEYBOARD_KEY_LCTRL 
orxKEYBOARD_KEY_LALT 
orxKEYBOARD_KEY_LSYSTEM 
orxKEYBOARD_KEY_RSHIFT 
orxKEYBOARD_KEY_RCTRL 
orxKEYBOARD_KEY_RALT 
orxKEYBOARD_KEY_RSYSTEM 
orxKEYBOARD_KEY_MENU 
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 (both keys and chars)

orxDLLAPI void orxFASTCALL orxKeyboard_Exit ( )

Exits from the keyboard module

orxDLLAPI const orxSTRING orxFASTCALL orxKeyboard_GetKeyDisplayName ( orxKEYBOARD_KEY  _eKey)

Gets key display name, layout-dependent

Parameters
[in]_eKeyConcerned key
Returns
UTF-8 encoded key's name if valid, orxSTRING_EMPTY otherwise
orxDLLAPI const orxSTRING orxFASTCALL orxKeyboard_GetKeyName ( orxKEYBOARD_KEY  _eKey)

Gets key literal name

Parameters
[in]_eKeyConcerned key
Returns
Key's name
orxDLLAPI orxSTATUS orxFASTCALL orxKeyboard_Init ( )

Inits the keyboard module

orxDLLAPI orxBOOL orxFASTCALL orxKeyboard_IsKeyPressed ( orxKEYBOARD_KEY  _eKey)

Is key pressed?

Parameters
[in]_eKeyKey to check
Returns
orxTRUE if pressed / orxFALSE otherwise
orxDLLAPI orxKEYBOARD_KEY orxFASTCALL orxKeyboard_ReadKey ( )

Gets the next key from the keyboard buffer and removes it from there

Returns
orxKEYBOARD_KEY, orxKEYBOARD_KEY_NONE if the buffer is empty
orxDLLAPI const orxSTRING orxFASTCALL orxKeyboard_ReadString ( )

Gets the next UTF-8 encoded string from the keyboard buffer and removes it from there

Returns
UTF-8 encoded string
orxDLLAPI void orxFASTCALL orxKeyboard_Setup ( )

Keyboard module setup

orxDLLAPI orxSTATUS orxFASTCALL orxKeyboard_Show ( orxBOOL  _bShow)

Show/Hide the virtual keyboard

Parameters
[in]_bShowShow/hide virtual keyboard
Returns
orxSTATUS_SUCCESS if supported by platform, orxSTATUS_FAILURE otherwise
Generated for orx by doxygen 1.8.11