SDL_keyboard.h
上传用户:detong
上传日期:2022-06-22
资源大小:20675k
文件大小:4k
源码类别:

系统编程

开发平台:

Unix_Linux

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