Mercurial > sdl-ios-xcode
annotate include/SDL_keyboard.h @ 1312:c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
I batch edited these files, so please let me know if I've accidentally removed anybody's
credit here.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Wed, 01 Feb 2006 06:32:25 +0000 |
| parents | 04a403e4ccf5 |
| children | 67114343400d |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 SDL - Simple DirectMedia Layer | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
3 Copyright (C) 1997-2006 Sam Lantinga |
| 0 | 4 |
| 5 This library is free software; you can redistribute it and/or | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
6 modify it under the terms of the GNU Lesser General Public |
| 0 | 7 License as published by the Free Software Foundation; either |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
8 version 2.1 of the License, or (at your option) any later version. |
| 0 | 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 | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
13 Lesser General Public License for more details. |
| 0 | 14 |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
15 You should have received a copy of the GNU Lesser General Public |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
16 License along with this library; if not, write to the Free Software |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 0 | 18 |
| 19 Sam Lantinga | |
|
251
b8688cfdc232
Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
0
diff
changeset
|
20 slouken@libsdl.org |
| 0 | 21 */ |
| 22 | |
| 23 /* Include file for SDL keyboard event handling */ | |
| 24 | |
| 25 #ifndef _SDL_keyboard_h | |
| 26 #define _SDL_keyboard_h | |
| 27 | |
| 28 #include "SDL_types.h" | |
| 29 #include "SDL_keysym.h" | |
| 30 | |
| 31 #include "begin_code.h" | |
| 32 /* Set up for C function definitions, even when using C++ */ | |
| 33 #ifdef __cplusplus | |
| 34 extern "C" { | |
| 35 #endif | |
| 36 | |
| 37 /* Keysym structure | |
| 38 - The scancode is hardware dependent, and should not be used by general | |
| 39 applications. If no hardware scancode is available, it will be 0. | |
| 40 | |
| 41 - The 'unicode' translated character is only available when character | |
| 42 translation is enabled by the SDL_EnableUNICODE() API. If non-zero, | |
| 43 this is a UNICODE character corresponding to the keypress. If the | |
| 44 high 9 bits of the character are 0, then this maps to the equivalent | |
| 45 ASCII character: | |
| 46 char ch; | |
| 47 if ( (keysym.unicode & 0xFF80) == 0 ) { | |
| 48 ch = keysym.unicode & 0x7F; | |
| 49 } else { | |
| 50 An international character.. | |
| 51 } | |
| 52 */ | |
|
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
53 typedef struct SDL_keysym { |
| 0 | 54 Uint8 scancode; /* hardware specific scancode */ |
| 55 SDLKey sym; /* SDL virtual keysym */ | |
| 56 SDLMod mod; /* current key modifiers */ | |
| 57 Uint16 unicode; /* translated character */ | |
| 58 } SDL_keysym; | |
| 59 | |
| 60 /* This is the mask which refers to all hotkey bindings */ | |
| 61 #define SDL_ALL_HOTKEYS 0xFFFFFFFF | |
| 62 | |
| 63 /* Function prototypes */ | |
| 64 /* | |
| 65 * Enable/Disable UNICODE translation of keyboard input. | |
| 66 * This translation has some overhead, so translation defaults off. | |
| 67 * If 'enable' is 1, translation is enabled. | |
| 68 * If 'enable' is 0, translation is disabled. | |
| 69 * If 'enable' is -1, the translation state is not changed. | |
| 70 * It returns the previous state of keyboard translation. | |
| 71 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
72 extern DECLSPEC int SDLCALL SDL_EnableUNICODE(int enable); |
| 0 | 73 |
| 74 /* | |
| 75 * Enable/Disable keyboard repeat. Keyboard repeat defaults to off. | |
| 76 * 'delay' is the initial delay in ms between the time when a key is | |
| 77 * pressed, and keyboard repeat begins. | |
| 78 * 'interval' is the time in ms between keyboard repeat events. | |
| 79 */ | |
| 80 #define SDL_DEFAULT_REPEAT_DELAY 500 | |
| 81 #define SDL_DEFAULT_REPEAT_INTERVAL 30 | |
| 82 /* | |
| 83 * If 'delay' is set to 0, keyboard repeat is disabled. | |
| 84 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
85 extern DECLSPEC int SDLCALL SDL_EnableKeyRepeat(int delay, int interval); |
| 0 | 86 |
| 87 /* | |
| 88 * Get a snapshot of the current state of the keyboard. | |
| 89 * Returns an array of keystates, indexed by the SDLK_* syms. | |
| 90 * Used: | |
| 91 * Uint8 *keystate = SDL_GetKeyState(NULL); | |
| 92 * if ( keystate[SDLK_RETURN] ) ... <RETURN> is pressed. | |
| 93 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
94 extern DECLSPEC Uint8 * SDLCALL SDL_GetKeyState(int *numkeys); |
| 0 | 95 |
| 96 /* | |
| 97 * Get the current key modifier state | |
| 98 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
99 extern DECLSPEC SDLMod SDLCALL SDL_GetModState(void); |
| 0 | 100 |
| 101 /* | |
| 102 * Set the current key modifier state | |
| 103 * This does not change the keyboard state, only the key modifier flags. | |
| 104 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
105 extern DECLSPEC void SDLCALL SDL_SetModState(SDLMod modstate); |
| 0 | 106 |
| 107 /* | |
| 108 * Get the name of an SDL virtual keysym | |
| 109 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
110 extern DECLSPEC char * SDLCALL SDL_GetKeyName(SDLKey key); |
| 0 | 111 |
| 112 | |
| 113 /* Ends C function definitions when using C++ */ | |
| 114 #ifdef __cplusplus | |
| 115 } | |
| 116 #endif | |
| 117 #include "close_code.h" | |
| 118 | |
| 119 #endif /* _SDL_keyboard_h */ |