e14743d1 |
1 | .TH "SDL_GetModState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" |
2 | .SH "NAME" |
3 | SDL_GetModState \- Get the state of modifier keys\&. |
4 | .SH "SYNOPSIS" |
5 | .PP |
6 | \fB#include "SDL\&.h" |
7 | .sp |
8 | \fBSDLMod \fBSDL_GetModState\fP\fR(\fBvoid\fR); |
9 | .SH "DESCRIPTION" |
10 | .PP |
11 | Returns the current state of the modifier keys (CTRL, ALT, etc\&.)\&. |
12 | .SH "RETURN VALUE" |
13 | .PP |
14 | The return value can be an OR\&'d combination of the SDLMod enum\&. |
15 | .PP |
16 | .PP |
17 | .RS |
18 | \fBSDLMod\fR |
19 | .PP |
20 | .PP |
21 | .nf |
22 | \f(CWtypedef enum { |
23 | KMOD_NONE = 0x0000, |
24 | KMOD_LSHIFT= 0x0001, |
25 | KMOD_RSHIFT= 0x0002, |
26 | KMOD_LCTRL = 0x0040, |
27 | KMOD_RCTRL = 0x0080, |
28 | KMOD_LALT = 0x0100, |
29 | KMOD_RALT = 0x0200, |
30 | KMOD_LMETA = 0x0400, |
31 | KMOD_RMETA = 0x0800, |
32 | KMOD_NUM = 0x1000, |
33 | KMOD_CAPS = 0x2000, |
34 | KMOD_MODE = 0x4000, |
35 | } SDLMod;\fR |
36 | .fi |
37 | .PP |
38 | .RE |
39 | SDL also defines the following symbols for convenience: |
40 | .PP |
41 | .RS |
42 | .PP |
43 | .nf |
44 | \f(CW#define KMOD_CTRL (KMOD_LCTRL|KMOD_RCTRL) |
45 | #define KMOD_SHIFT (KMOD_LSHIFT|KMOD_RSHIFT) |
46 | #define KMOD_ALT (KMOD_LALT|KMOD_RALT) |
47 | #define KMOD_META (KMOD_LMETA|KMOD_RMETA)\fR |
48 | .fi |
49 | .PP |
50 | .RE |
51 | .SH "SEE ALSO" |
52 | .PP |
53 | \fI\fBSDL_GetKeyState\fP\fR |
54 | .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 |