2 Simple DirectMedia Layer
3 Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
23 * \file SDL_keyboard.h
25 * Include file for SDL keyboard event handling
28 #ifndef SDL_keyboard_h_
29 #define SDL_keyboard_h_
31 #include "SDL_stdinc.h"
32 #include "SDL_error.h"
33 #include "SDL_keycode.h"
34 #include "SDL_video.h"
36 #include "begin_code.h"
37 /* Set up for C function definitions, even when using C++ */
43 * \brief The SDL keysym structure, used in key events.
45 * \note If you are looking for translated character input, see the ::SDL_TEXTINPUT event.
47 typedef struct SDL_Keysym
49 SDL_Scancode scancode
; /**< SDL physical key code - see ::SDL_Scancode for details */
50 SDL_Keycode sym
; /**< SDL virtual key code - see ::SDL_Keycode for details */
51 Uint16 mod
; /**< current key modifiers */
55 /* Function prototypes */
58 * Query the window which currently has keyboard focus.
60 * \returns the window with keyboard focus.
62 * \since This function is available since SDL 2.0.0.
64 extern DECLSPEC SDL_Window
* SDLCALL
SDL_GetKeyboardFocus(void);
67 * Get a snapshot of the current state of the keyboard.
69 * The pointer returned is a pointer to an internal SDL array. It will be
70 * valid for the whole lifetime of the application and should not be freed by
73 * A array element with a value of 1 means that the key is pressed and a value
74 * of 0 means that it is not. Indexes into this array are obtained by using
75 * SDL_Scancode values.
77 * Use SDL_PumpEvents() to update the state array.
79 * This function gives you the current state after all events have been
80 * processed, so if a key or button has been pressed and released before you
81 * process events, then the pressed state will never show up in the
82 * SDL_GetKeyboardState() calls.
84 * Note: This function doesn't take into account whether shift has been
87 * \param numkeys if non-NULL, receives the length of the returned array
88 * \returns a pointer to an array of key states.
90 * \since This function is available since SDL 2.0.0.
93 * \sa SDL_ResetKeyboard
95 extern DECLSPEC
const Uint8
*SDLCALL
SDL_GetKeyboardState(int *numkeys
);
98 * Clear the state of the keyboard
100 * This function will generate key up events for all pressed keys.
102 * \since This function is available since SDL 2.24.0.
104 * \sa SDL_GetKeyboardState
106 extern DECLSPEC
void SDLCALL
SDL_ResetKeyboard(void);
109 * Get the current key modifier state for the keyboard.
111 * \returns an OR'd combination of the modifier keys for the keyboard. See
112 * SDL_Keymod for details.
114 * \since This function is available since SDL 2.0.0.
116 * \sa SDL_GetKeyboardState
117 * \sa SDL_SetModState
119 extern DECLSPEC SDL_Keymod SDLCALL
SDL_GetModState(void);
122 * Set the current key modifier state for the keyboard.
124 * The inverse of SDL_GetModState(), SDL_SetModState() allows you to impose
125 * modifier key states on your application. Simply pass your desired modifier
126 * states into `modstate`. This value may be a bitwise, OR'd combination of
129 * This does not change the keyboard state, only the key modifier flags that
132 * \param modstate the desired SDL_Keymod for the keyboard
134 * \since This function is available since SDL 2.0.0.
136 * \sa SDL_GetModState
138 extern DECLSPEC
void SDLCALL
SDL_SetModState(SDL_Keymod modstate
);
141 * Get the key code corresponding to the given scancode according to the
142 * current keyboard layout.
144 * See SDL_Keycode for details.
146 * \param scancode the desired SDL_Scancode to query
147 * \returns the SDL_Keycode that corresponds to the given SDL_Scancode.
149 * \since This function is available since SDL 2.0.0.
152 * \sa SDL_GetScancodeFromKey
154 extern DECLSPEC SDL_Keycode SDLCALL
SDL_GetKeyFromScancode(SDL_Scancode scancode
);
157 * Get the scancode corresponding to the given key code according to the
158 * current keyboard layout.
160 * See SDL_Scancode for details.
162 * \param key the desired SDL_Keycode to query
163 * \returns the SDL_Scancode that corresponds to the given SDL_Keycode.
165 * \since This function is available since SDL 2.0.0.
167 * \sa SDL_GetKeyFromScancode
168 * \sa SDL_GetScancodeName
170 extern DECLSPEC SDL_Scancode SDLCALL
SDL_GetScancodeFromKey(SDL_Keycode key
);
173 * Get a human-readable name for a scancode.
175 * See SDL_Scancode for details.
177 * **Warning**: The returned name is by design not stable across platforms,
178 * e.g. the name for `SDL_SCANCODE_LGUI` is "Left GUI" under Linux but "Left
179 * Windows" under Microsoft Windows, and some scancodes like
180 * `SDL_SCANCODE_NONUSBACKSLASH` don't have any name at all. There are even
181 * scancodes that share names, e.g. `SDL_SCANCODE_RETURN` and
182 * `SDL_SCANCODE_RETURN2` (both called "Return"). This function is therefore
183 * unsuitable for creating a stable cross-platform two-way mapping between
184 * strings and scancodes.
186 * \param scancode the desired SDL_Scancode to query
187 * \returns a pointer to the name for the scancode. If the scancode doesn't
188 * have a name this function returns an empty string ("").
190 * \since This function is available since SDL 2.0.0.
192 * \sa SDL_GetScancodeFromKey
193 * \sa SDL_GetScancodeFromName
195 extern DECLSPEC
const char *SDLCALL
SDL_GetScancodeName(SDL_Scancode scancode
);
198 * Get a scancode from a human-readable name.
200 * \param name the human-readable scancode name
201 * \returns the SDL_Scancode, or `SDL_SCANCODE_UNKNOWN` if the name wasn't
202 * recognized; call SDL_GetError() for more information.
204 * \since This function is available since SDL 2.0.0.
206 * \sa SDL_GetKeyFromName
207 * \sa SDL_GetScancodeFromKey
208 * \sa SDL_GetScancodeName
210 extern DECLSPEC SDL_Scancode SDLCALL
SDL_GetScancodeFromName(const char *name
);
213 * Get a human-readable name for a key.
215 * See SDL_Scancode and SDL_Keycode for details.
217 * \param key the desired SDL_Keycode to query
218 * \returns a pointer to a UTF-8 string that stays valid at least until the
219 * next call to this function. If you need it around any longer, you
220 * must copy it. If the key doesn't have a name, this function
221 * returns an empty string ("").
223 * \since This function is available since SDL 2.0.0.
225 * \sa SDL_GetKeyFromName
226 * \sa SDL_GetKeyFromScancode
227 * \sa SDL_GetScancodeFromKey
229 extern DECLSPEC
const char *SDLCALL
SDL_GetKeyName(SDL_Keycode key
);
232 * Get a key code from a human-readable name.
234 * \param name the human-readable key name
235 * \returns key code, or `SDLK_UNKNOWN` if the name wasn't recognized; call
236 * SDL_GetError() for more information.
238 * \since This function is available since SDL 2.0.0.
240 * \sa SDL_GetKeyFromScancode
242 * \sa SDL_GetScancodeFromName
244 extern DECLSPEC SDL_Keycode SDLCALL
SDL_GetKeyFromName(const char *name
);
247 * Start accepting Unicode text input events.
249 * This function will start accepting Unicode text input events in the focused
250 * SDL window, and start emitting SDL_TextInputEvent (SDL_TEXTINPUT) and
251 * SDL_TextEditingEvent (SDL_TEXTEDITING) events. Please use this function in
252 * pair with SDL_StopTextInput().
254 * On some platforms using this function activates the screen keyboard.
256 * \since This function is available since SDL 2.0.0.
258 * \sa SDL_SetTextInputRect
259 * \sa SDL_StopTextInput
261 extern DECLSPEC
void SDLCALL
SDL_StartTextInput(void);
264 * Check whether or not Unicode text input events are enabled.
266 * \returns SDL_TRUE if text input events are enabled else SDL_FALSE.
268 * \since This function is available since SDL 2.0.0.
270 * \sa SDL_StartTextInput
272 extern DECLSPEC SDL_bool SDLCALL
SDL_IsTextInputActive(void);
275 * Stop receiving any text input events.
277 * \since This function is available since SDL 2.0.0.
279 * \sa SDL_StartTextInput
281 extern DECLSPEC
void SDLCALL
SDL_StopTextInput(void);
284 * Dismiss the composition window/IME without disabling the subsystem.
286 * \since This function is available since SDL 2.0.22.
288 * \sa SDL_StartTextInput
289 * \sa SDL_StopTextInput
291 extern DECLSPEC
void SDLCALL
SDL_ClearComposition(void);
294 * Returns if an IME Composite or Candidate window is currently shown.
296 * \since This function is available since SDL 2.0.22.
298 extern DECLSPEC SDL_bool SDLCALL
SDL_IsTextInputShown(void);
301 * Set the rectangle used to type Unicode text inputs.
303 * To start text input in a given location, this function is intended to be
304 * called before SDL_StartTextInput, although some platforms support moving
305 * the rectangle even while text input (and a composition) is active.
307 * Note: If you want to use the system native IME window, try setting hint
308 * **SDL_HINT_IME_SHOW_UI** to **1**, otherwise this function won't give you
311 * \param rect the SDL_Rect structure representing the rectangle to receive
312 * text (ignored if NULL)
314 * \since This function is available since SDL 2.0.0.
316 * \sa SDL_StartTextInput
318 extern DECLSPEC
void SDLCALL
SDL_SetTextInputRect(const SDL_Rect
*rect
);
321 * Check whether the platform has screen keyboard support.
323 * \returns SDL_TRUE if the platform has some screen keyboard support or
326 * \since This function is available since SDL 2.0.0.
328 * \sa SDL_StartTextInput
329 * \sa SDL_IsScreenKeyboardShown
331 extern DECLSPEC SDL_bool SDLCALL
SDL_HasScreenKeyboardSupport(void);
334 * Check whether the screen keyboard is shown for given window.
336 * \param window the window for which screen keyboard should be queried
337 * \returns SDL_TRUE if screen keyboard is shown or SDL_FALSE if not.
339 * \since This function is available since SDL 2.0.0.
341 * \sa SDL_HasScreenKeyboardSupport
343 extern DECLSPEC SDL_bool SDLCALL
SDL_IsScreenKeyboardShown(SDL_Window
*window
);
345 /* Ends C function definitions when using C++ */
349 #include "close_code.h"
351 #endif /* SDL_keyboard_h_ */
353 /* vi: set ts=4 sw=4 expandtab: */