This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_keyboard.h
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2011 Sam Lantinga
4
5
This library is free software; you can redistribute it and/or
6
modify it under the terms of the GNU Lesser General Public
7
License as published by the Free Software Foundation; either
8
version 2.1 of the License, or (at your option) any later version.
9
10
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
15
16
17
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
19
Sam Lantinga
20
slouken@libsdl.org
21
22
*/
24
25
26
* \file SDL_keyboard.h
*
* Include file for SDL keyboard event handling
28
29
30
31
#ifndef _SDL_keyboard_h
#define _SDL_keyboard_h
32
#include "SDL_stdinc.h"
33
#include "SDL_error.h"
34
#include "SDL_keycode.h"
35
#include "SDL_video.h"
36
37
38
39
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
40
/* *INDENT-OFF* */
41
extern "C" {
42
/* *INDENT-ON* */
43
44
#endif
46
* \brief The SDL keysym structure, used in key events.
47
*/
48
typedef struct SDL_Keysym
50
SDL_Scancode scancode; /**< SDL physical key code - see ::SDL_Scancode for details */
51
SDL_Keycode sym; /**< SDL virtual key code - see ::SDL_Keycode for details */
52
Uint16 mod; /**< current key modifiers */
53
Uint32 unicode; /**< \deprecated use SDL_TextInputEvent instead */
55
56
/* Function prototypes */
59
* \brief Get the window which currently has keyboard focus.
61
extern DECLSPEC SDL_Window * SDLCALL SDL_GetKeyboardFocus(void);
64
* \brief Get a snapshot of the current state of the keyboard.
65
66
67
*
* \param numkeys if non-NULL, receives the length of the returned array.
*
68
* \return An array of key states. Indexes into this array are obtained by using ::SDL_Scancode values.
69
70
71
72
73
74
75
76
*
* \b Example:
* \code
* Uint8 *state = SDL_GetKeyboardState(NULL);
* if ( state[SDL_SCANCODE_RETURN] ) {
* printf("<RETURN> is pressed.\n");
* }
* \endcode
77
*/
78
extern DECLSPEC Uint8 *SDLCALL SDL_GetKeyboardState(int *numkeys);
81
* \brief Get the current key modifier state for the keyboard.
82
*/
83
extern DECLSPEC SDL_Keymod SDLCALL SDL_GetModState(void);
86
* \brief Set the current key modifier state for the keyboard.
87
88
*
* \note This does not change the keyboard state, only the key modifier flags.
89
*/
90
extern DECLSPEC void SDLCALL SDL_SetModState(SDL_Keymod modstate);
93
94
* \brief Get the key code corresponding to the given scancode according
* to the current keyboard layout.
96
* See ::SDL_Keycode for details.
97
98
*
* \sa SDL_GetKeyName()
100
extern DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromScancode(SDL_Scancode scancode);
101
102
/**
103
104
105
* \brief Get the scancode corresponding to the given key code according to the
* current keyboard layout.
*
106
* See ::SDL_Scancode for details.
107
108
*
* \sa SDL_GetScancodeName()
110
extern DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromKey(SDL_Keycode key);
113
114
115
116
117
118
119
* \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 ("").
*
120
* \sa SDL_Scancode
122
extern DECLSPEC const char *SDLCALL SDL_GetScancodeName(SDL_Scancode
123
124
125
scancode);
/**
126
127
128
129
130
131
132
* \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 ("").
*
133
* \sa SDL_Key
134
*/
135
extern DECLSPEC const char *SDLCALL SDL_GetKeyName(SDL_Keycode key);
138
139
140
141
* \brief Start accepting Unicode text input events.
*
* \sa SDL_StopTextInput()
* \sa SDL_SetTextInputRect()
142
143
144
145
*/
extern DECLSPEC void SDLCALL SDL_StartTextInput(void);
/**
146
147
148
* \brief Stop receiving any text input events.
*
* \sa SDL_StartTextInput()
149
150
151
152
*/
extern DECLSPEC void SDLCALL SDL_StopTextInput(void);
/**
153
154
155
* \brief Set the rectangle used to type Unicode text inputs.
*
* \sa SDL_StartTextInput()
156
157
158
*/
extern DECLSPEC void SDLCALL SDL_SetTextInputRect(SDL_Rect *rect);
159
160
161
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
162
/* *INDENT-OFF* */
163
}
164
/* *INDENT-ON* */
165
166
167
168
#endif
#include "close_code.h"
#endif /* _SDL_keyboard_h */
169
170
/* vi: set ts=4 sw=4 expandtab: */