This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_keyboard.h
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Simple DirectMedia Layer
Copyright (C) 1997-2011 Sam Lantinga <slouken@libsdl.org>
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
20
21
*/
23
24
25
* \file SDL_keyboard.h
*
* Include file for SDL keyboard event handling
27
28
29
30
#ifndef _SDL_keyboard_h
#define _SDL_keyboard_h
31
#include "SDL_stdinc.h"
32
#include "SDL_error.h"
33
#include "SDL_keycode.h"
34
#include "SDL_video.h"
35
36
37
38
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
39
/* *INDENT-OFF* */
40
extern "C" {
41
/* *INDENT-ON* */
42
43
#endif
45
* \brief The SDL keysym structure, used in key events.
46
*/
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 */
52
Uint32 unicode; /**< \deprecated use SDL_TextInputEvent instead */
54
55
/* Function prototypes */
58
* \brief Get the window which currently has keyboard focus.
60
extern DECLSPEC SDL_Window * SDLCALL SDL_GetKeyboardFocus(void);
63
* \brief Get a snapshot of the current state of the keyboard.
64
65
66
*
* \param numkeys if non-NULL, receives the length of the returned array.
*
67
* \return An array of key states. Indexes into this array are obtained by using ::SDL_Scancode values.
68
69
70
71
72
73
74
75
*
* \b Example:
* \code
* Uint8 *state = SDL_GetKeyboardState(NULL);
* if ( state[SDL_SCANCODE_RETURN] ) {
* printf("<RETURN> is pressed.\n");
* }
* \endcode
76
*/
77
extern DECLSPEC Uint8 *SDLCALL SDL_GetKeyboardState(int *numkeys);
80
* \brief Get the current key modifier state for the keyboard.
81
*/
82
extern DECLSPEC SDL_Keymod SDLCALL SDL_GetModState(void);
85
* \brief Set the current key modifier state for the keyboard.
86
87
*
* \note This does not change the keyboard state, only the key modifier flags.
88
*/
89
extern DECLSPEC void SDLCALL SDL_SetModState(SDL_Keymod modstate);
92
93
* \brief Get the key code corresponding to the given scancode according
* to the current keyboard layout.
95
* See ::SDL_Keycode for details.
96
97
*
* \sa SDL_GetKeyName()
99
extern DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromScancode(SDL_Scancode scancode);
100
101
/**
102
103
104
* \brief Get the scancode corresponding to the given key code according to the
* current keyboard layout.
*
105
* See ::SDL_Scancode for details.
106
107
*
* \sa SDL_GetScancodeName()
109
extern DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromKey(SDL_Keycode key);
112
113
114
115
116
117
118
* \brief Get a human-readable name for a scancode.
*
* \return A pointer to a UTF-8 string that stays valid at least until the next
* call to this function. If you need it around any longer, you must
* copy it. If the scancode doesn't have a name, this function returns
* an empty string ("").
*
119
* \sa SDL_Scancode
121
extern DECLSPEC const char *SDLCALL SDL_GetScancodeName(SDL_Scancode
122
123
124
scancode);
/**
125
126
127
128
129
130
131
* \brief Get a human-readable name for a key.
*
* \return A pointer to a UTF-8 string that stays valid at least until the next
* call to this function. If you need it around any longer, you must
* copy it. If the key doesn't have a name, this function returns an
* empty string ("").
*
132
* \sa SDL_Key
133
*/
134
extern DECLSPEC const char *SDLCALL SDL_GetKeyName(SDL_Keycode key);
137
138
139
140
* \brief Start accepting Unicode text input events.
*
* \sa SDL_StopTextInput()
* \sa SDL_SetTextInputRect()
141
142
143
144
*/
extern DECLSPEC void SDLCALL SDL_StartTextInput(void);
/**
145
146
147
* \brief Stop receiving any text input events.
*
* \sa SDL_StartTextInput()
148
149
150
151
*/
extern DECLSPEC void SDLCALL SDL_StopTextInput(void);
/**
152
153
154
* \brief Set the rectangle used to type Unicode text inputs.
*
* \sa SDL_StartTextInput()
155
156
157
*/
extern DECLSPEC void SDLCALL SDL_SetTextInputRect(SDL_Rect *rect);
158
159
160
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
161
/* *INDENT-OFF* */
162
}
163
/* *INDENT-ON* */
164
165
166
167
#endif
#include "close_code.h"
#endif /* _SDL_keyboard_h */
168
169
/* vi: set ts=4 sw=4 expandtab: */