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-2006 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
*/
23
24
25
26
27
/**
* \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
35
36
37
38
#include "SDL_keysym.h"
#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
44
45
46
47
/**
* \struct SDL_keysym
*
* \brief The SDL keysym structure, used in key events.
48
*/
49
50
typedef struct SDL_keysym
{
51
SDL_scancode scancode; /**< SDL physical key code - see ::SDL_scancode for details */
52
SDLKey sym; /**< SDL virtual key code - see ::SDLKey for details */
53
54
Uint16 mod; /**< current key modifiers */
Uint32 unicode; /**< OBSOLETE, use SDL_TextInputEvent instead */
55
56
57
} SDL_keysym;
/* Function prototypes */
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/**
* \fn int SDL_GetNumKeyboards(void)
*
* \brief Get the number of keyboard input devices available.
*
* \sa SDL_SelectKeyboard()
*/
extern DECLSPEC int SDLCALL SDL_GetNumKeyboards(void);
/**
* \fn int SDL_SelectKeyboard(int index)
*
* \brief Set the index of the currently selected keyboard.
*
* \return The index of the previously selected keyboard.
*
* \note You can query the currently selected keyboard by passing an index of -1.
*
* \sa SDL_GetNumKeyboards()
*/
extern DECLSPEC int SDLCALL SDL_SelectKeyboard(int index);
/**
82
* \fn Uint8 *SDL_GetKeyboardState(int *numkeys)
83
84
85
*
* \brief Get a snapshot of the current state of the selected keyboard.
*
86
87
* \param numkeys if non-NULL, receives the length of the returned array.
*
88
* \return An array of key states. Indexes into this array are obtained by using ::SDL_scancode values.
89
90
*
* Example:
91
92
* Uint8 *state = SDL_GetKeyboardState(NULL);
* if ( state[SDL_SCANCODE_RETURN)] ) ... <RETURN> is pressed.
93
*/
94
extern DECLSPEC Uint8 *SDLCALL SDL_GetKeyboardState(int *numkeys);
96
97
98
99
/**
* \fn SDLMod SDL_GetModState(void)
*
* \brief Get the current key modifier state for the selected keyboard.
100
*/
101
extern DECLSPEC SDLMod SDLCALL SDL_GetModState(void);
103
104
105
106
107
108
/**
* \fn void SDL_SetModState(SDLMod modstate)
*
* \brief Set the current key modifier state for the selected keyboard.
*
* \note This does not change the keyboard state, only the key modifier flags.
109
*/
110
extern DECLSPEC void SDLCALL SDL_SetModState(SDLMod modstate);
113
* \fn SDLKey SDL_GetKeyFromScancode(SDL_scancode scancode)
115
* \brief Get the key code corresponding to the given scancode according to the current keyboard layout.
116
117
118
119
120
*
* See ::SDLKey for details.
*
* \sa SDL_GetKeyName()
*/
121
extern DECLSPEC SDLKey SDLCALL SDL_GetKeyFromScancode(SDL_scancode scancode);
122
123
/**
124
* \fn SDL_scancode SDL_GetScancodeFromKey(SDLKey key)
126
127
128
* \brief Get the scancode corresponding to the given key code according to the current keyboard layout.
*
* See ::SDL_scancode for details.
130
131
132
133
134
135
136
137
138
139
* \sa SDL_GetScancodeName()
*/
extern DECLSPEC SDL_scancode SDLCALL SDL_GetScancodeFromKey(SDLKey key);
/**
* \fn const char *SDL_GetScancodeName(SDL_scancode scancode)
*
* \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 "".
141
142
143
144
145
146
147
148
149
* \sa SDL_scancode
*/
extern DECLSPEC const char *SDLCALL SDL_GetScancodeName(SDL_scancode
scancode);
/**
* \fn const char *SDL_GetKeyName(SDLKey key)
*
* \brief Get a human-readable name for a key.
151
* \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 "".
152
153
*
* \sa SDLKey
154
*/
155
extern DECLSPEC const char *SDLCALL SDL_GetKeyName(SDLKey key);
156
157
158
159
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
160
/* *INDENT-OFF* */
161
}
162
/* *INDENT-ON* */
163
164
165
166
#endif
#include "close_code.h"
#endif /* _SDL_keyboard_h */
167
168
/* vi: set ts=4 sw=4 expandtab: */