Mercurial > sdl-ios-xcode
annotate include/SDL_keyboard.h @ 563:04dcaf3da918
Massive Quartz input enhancements from Darrell Walisser. His email:
Enclosed is a patch that addresses the following:
--Various minor cleanups.
Removed dead/obsolete code, made some style cleanups
--Mouse Events
Now keep track of what button(s) were pressed so we know when to send
the mouse up event. This fixes the case where the mouse is dragged
outside of the game window and released (in which case we want to send
the mouse up event even though the mouse is outside the game window).
--Input Grabbing
Here is my take on the grabbing situation, which is the basis for the
new implementation.
There are 3 grab states, ungrabbed (UG), visible (VG), and invisible
(IG). Both VG and IG keep the mouse constrained to the window and
produce relative motion events. In VG the cursor is visible (duh), in
IG it is not. In VG, absolute motion events also work.
There are 6 actions that can affect grabbing:
1. Set Fullscreen/Window (F/W). In fullscreen, a visible grab should do
nothing. However, a fullscreen visible grab can be treated just like a
windowed visible grab, which is what I have done to help simplify
things.
2. Cursor hide/show (H/S). If the cursor is hidden when grabbing, the
grab is an invisible grab. If the cursor is visible, the grab should
just constrain the mouse to the window.
3. Input grab/ungrab(G/U). If grabbed, the cursor should be confined to
the window as should the keyboard input. On Mac OS X, the keyboard
input is implicitly grabbed by confining the cursor, except for
command-tab which can switch away from the application. Should the
window come to the foreground if the application is deactivated and
grab input is called? This isn't necessary in this implementation
because the grab state will be asserted upon activation.
Using my notation, these are all the cases that need to be handled
(state + action = new state).
UG+U = UG
UG+G = VG or IG, if cursor is visible or not
UG+H = UG
UG+S = UG
VG+U = UG
VG+G = VG
VG+H = IG
VG+S = VG
IG+U = UG
IG+G = IG
IG+H = IG
IG+S = VG
The cases that result in the same state can be ignored in the code,
which cuts it down to just 5 cases.
Another issue is what happens when the app loses/gains input focus from
deactivate/activate or iconify/deiconify. I think that if input focus
is ever lost (outside of SDL's control), the grab state should be
suspended and the cursor should become visible and active again. When
regained, the cursor should reappear in its original location and/or
grab state. This way, when reactivating the cursor is still in the same
position as before so apps shouldn't get confused when the next motion
event comes in. This is what I've done in this patch.
author | Ryan C. Gordon <icculus@icculus.org> |
---|---|
date | Fri, 27 Dec 2002 20:52:41 +0000 |
parents | 9154ec9ca3d2 |
children | b8d311d90021 |
rev | line source |
---|---|
0 | 1 /* |
2 SDL - Simple DirectMedia Layer | |
297
f6ffac90895c
Updated copyright information for 2002
Sam Lantinga <slouken@libsdl.org>
parents:
251
diff
changeset
|
3 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002 Sam Lantinga |
0 | 4 |
5 This library is free software; you can redistribute it and/or | |
6 modify it under the terms of the GNU Library General Public | |
7 License as published by the Free Software Foundation; either | |
8 version 2 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 Library General Public License for more details. | |
14 | |
15 You should have received a copy of the GNU Library General Public | |
16 License along with this library; if not, write to the Free | |
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
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 #ifdef SAVE_RCSID | |
24 static char rcsid = | |
25 "@(#) $Id$"; | |
26 #endif | |
27 | |
28 /* Include file for SDL keyboard event handling */ | |
29 | |
30 #ifndef _SDL_keyboard_h | |
31 #define _SDL_keyboard_h | |
32 | |
33 #include "SDL_types.h" | |
34 #include "SDL_keysym.h" | |
35 | |
36 #include "begin_code.h" | |
37 /* Set up for C function definitions, even when using C++ */ | |
38 #ifdef __cplusplus | |
39 extern "C" { | |
40 #endif | |
41 | |
42 /* Keysym structure | |
43 - The scancode is hardware dependent, and should not be used by general | |
44 applications. If no hardware scancode is available, it will be 0. | |
45 | |
46 - The 'unicode' translated character is only available when character | |
47 translation is enabled by the SDL_EnableUNICODE() API. If non-zero, | |
48 this is a UNICODE character corresponding to the keypress. If the | |
49 high 9 bits of the character are 0, then this maps to the equivalent | |
50 ASCII character: | |
51 char ch; | |
52 if ( (keysym.unicode & 0xFF80) == 0 ) { | |
53 ch = keysym.unicode & 0x7F; | |
54 } else { | |
55 An international character.. | |
56 } | |
57 */ | |
58 typedef struct { | |
59 Uint8 scancode; /* hardware specific scancode */ | |
60 SDLKey sym; /* SDL virtual keysym */ | |
61 SDLMod mod; /* current key modifiers */ | |
62 Uint16 unicode; /* translated character */ | |
63 } SDL_keysym; | |
64 | |
65 /* This is the mask which refers to all hotkey bindings */ | |
66 #define SDL_ALL_HOTKEYS 0xFFFFFFFF | |
67 | |
68 /* Function prototypes */ | |
69 /* | |
70 * Enable/Disable UNICODE translation of keyboard input. | |
71 * This translation has some overhead, so translation defaults off. | |
72 * If 'enable' is 1, translation is enabled. | |
73 * If 'enable' is 0, translation is disabled. | |
74 * If 'enable' is -1, the translation state is not changed. | |
75 * It returns the previous state of keyboard translation. | |
76 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
77 extern DECLSPEC int SDLCALL SDL_EnableUNICODE(int enable); |
0 | 78 |
79 /* | |
80 * Enable/Disable keyboard repeat. Keyboard repeat defaults to off. | |
81 * 'delay' is the initial delay in ms between the time when a key is | |
82 * pressed, and keyboard repeat begins. | |
83 * 'interval' is the time in ms between keyboard repeat events. | |
84 */ | |
85 #define SDL_DEFAULT_REPEAT_DELAY 500 | |
86 #define SDL_DEFAULT_REPEAT_INTERVAL 30 | |
87 /* | |
88 * If 'delay' is set to 0, keyboard repeat is disabled. | |
89 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
90 extern DECLSPEC int SDLCALL SDL_EnableKeyRepeat(int delay, int interval); |
0 | 91 |
92 /* | |
93 * Get a snapshot of the current state of the keyboard. | |
94 * Returns an array of keystates, indexed by the SDLK_* syms. | |
95 * Used: | |
96 * Uint8 *keystate = SDL_GetKeyState(NULL); | |
97 * if ( keystate[SDLK_RETURN] ) ... <RETURN> is pressed. | |
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 Uint8 * SDLCALL SDL_GetKeyState(int *numkeys); |
0 | 100 |
101 /* | |
102 * Get the current key modifier state | |
103 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
104 extern DECLSPEC SDLMod SDLCALL SDL_GetModState(void); |
0 | 105 |
106 /* | |
107 * Set the current key modifier state | |
108 * This does not change the keyboard state, only the key modifier flags. | |
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 void SDLCALL SDL_SetModState(SDLMod modstate); |
0 | 111 |
112 /* | |
113 * Get the name of an SDL virtual keysym | |
114 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
115 extern DECLSPEC char * SDLCALL SDL_GetKeyName(SDLKey key); |
0 | 116 |
117 | |
118 /* Ends C function definitions when using C++ */ | |
119 #ifdef __cplusplus | |
120 } | |
121 #endif | |
122 #include "close_code.h" | |
123 | |
124 #endif /* _SDL_keyboard_h */ |