Newer
Older
sample / sdl-d / import / sdl / c / sdl_keyboard.d
  1. /*
  2. SDL - Simple DirectMedia Layer
  3. Copyright (C) 1997-2006 Sam Lantinga
  4.  
  5. This library is free software; you can redistribute it and/or
  6. modify it under the terms of the GNU Lesser General Public
  7. License as published by the Free Software Foundation; either
  8. version 2.1 of the License, or (at your option) any later version.
  9.  
  10. This library is distributed in the hope that it will be useful,
  11. but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  13. Lesser General Public License for more details.
  14.  
  15. You should have received a copy of the GNU Lesser General Public
  16. License along with this library; if not, write to the Free Software
  17. Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18.  
  19. Sam Lantinga
  20. slouken@libsdl.org
  21. */
  22. module sdl.c.sdl_keyboard;
  23.  
  24. /* Include file for SDL keyboard event handling */
  25. public
  26. {
  27. import sdl.c.sdl_stdinc;
  28. import sdl.c.sdl_error;
  29. import sdl.c.sdl_keysym;
  30. }
  31.  
  32. extern(C):
  33.  
  34. /* Keysym structure
  35. - The scancode is hardware dependent, and should not be used by general
  36. applications. If no hardware scancode is available, it will be 0.
  37.  
  38. - The 'unicode' translated character is only available when character
  39. translation is enabled by the SDL_EnableUNICODE() API. If non-zero,
  40. this is a UNICODE character corresponding to the keypress. If the
  41. high 9 bits of the character are 0, then this maps to the equivalent
  42. ASCII character:
  43. char ch;
  44. if ( (keysym.unicode & 0xFF80) == 0 ) {
  45. ch = keysym.unicode & 0x7F;
  46. } else {
  47. An international character..
  48. }
  49. */
  50. struct SDL_keysym {
  51. Uint8 scancode; /* hardware specific scancode */
  52. SDLKey sym; /* SDL virtual keysym */
  53. SDLMod mod; /* current key modifiers */
  54. Uint16 unicode; /* translated character */
  55. }
  56.  
  57. /* This is the mask which refers to all hotkey bindings */
  58. const uint SDL_ALL_HOTKEYS = 0xFFFFFFFF;
  59.  
  60. /* Function prototypes */
  61. /*
  62. * Enable/Disable UNICODE translation of keyboard input.
  63. * This translation has some overhead, so translation defaults off.
  64. * If 'enable' is 1, translation is enabled.
  65. * If 'enable' is 0, translation is disabled.
  66. * If 'enable' is -1, the translation state is not changed.
  67. * It returns the previous state of keyboard translation.
  68. */
  69. int SDL_EnableUNICODE(int enable);
  70.  
  71. /*
  72. * Enable/Disable keyboard repeat. Keyboard repeat defaults to off.
  73. * 'delay' is the initial delay in ms between the time when a key is
  74. * pressed, and keyboard repeat begins.
  75. * 'interval' is the time in ms between keyboard repeat events.
  76. */
  77. const
  78. {
  79. uint SDL_DEFAULT_REPEAT_DELAY = 500;
  80. uint SDL_DEFAULT_REPEAT_INTERVAL = 30;
  81. }
  82.  
  83. /*
  84. * If 'delay' is set to 0, keyboard repeat is disabled.
  85. */
  86. int SDL_EnableKeyRepeat(int delay, int interval);
  87. void SDL_GetKeyRepeat(int *delay, int *interval);
  88.  
  89. /*
  90. * Get a snapshot of the current state of the keyboard.
  91. * Returns an array of keystates, indexed by the SDLK_* syms.
  92. * Used:
  93. * Uint8 *keystate = SDL_GetKeyState(NULL);
  94. * if ( keystate[SDLK_RETURN] ) ... <RETURN> is pressed.
  95. */
  96. Uint8 * SDL_GetKeyState(int *numkeys);
  97.  
  98. /*
  99. * Get the current key modifier state
  100. */
  101. SDLMod SDL_GetModState();
  102.  
  103. /*
  104. * Set the current key modifier state
  105. * This does not change the keyboard state, only the key modifier flags.
  106. */
  107. void SDL_SetModState(SDLMod modstate);
  108.  
  109. /*
  110. * Get the name of an SDL virtual keysym
  111. */
  112. char * SDL_GetKeyName(SDLKey key);
  113.