view docs/man3/SDL_GetModState.3 @ 3896:1a327643e741 SDL-1.2

X11 backend: tell app that mouse focus has been obtained when grabbing the input. This allows us to enable DGA mode, even when the system cursor was outside of the window when the grab was initiated. Fixes Bugzilla #299, which has a more detailed explanation of the issue.
author Ryan C. Gordon <icculus@icculus.org>
date Mon, 13 Nov 2006 03:58:22 +0000
parents e5bc29de3f0a
children 546f7c1eb755
line wrap: on
line source

.TH "SDL_GetModState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_GetModState\- Get the state of modifier keys\&.
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBSDLMod \fBSDL_GetModState\fP\fR(\fBvoid\fR);
.SH "DESCRIPTION"
.PP
Returns the current state of the modifier keys (CTRL, ALT, etc\&.)\&.
.SH "RETURN VALUE"
.PP
The return value can be an OR\&'d combination of the SDLMod enum\&.
.PP
.PP
.RS
\fBSDLMod\fR
.PP
.PP
.nf
\f(CWtypedef enum {
  KMOD_NONE  = 0x0000,
  KMOD_LSHIFT= 0x0001,
  KMOD_RSHIFT= 0x0002,
  KMOD_LCTRL = 0x0040,
  KMOD_RCTRL = 0x0080,
  KMOD_LALT  = 0x0100,
  KMOD_RALT  = 0x0200,
  KMOD_LMETA = 0x0400,
  KMOD_RMETA = 0x0800,
  KMOD_NUM   = 0x1000,
  KMOD_CAPS  = 0x2000,
  KMOD_MODE  = 0x4000,
} SDLMod;\fR
.fi
.PP
.RE
 SDL also defines the following symbols for convenience: 
.PP
.RS
.PP
.nf
\f(CW#define KMOD_CTRL (KMOD_LCTRL|KMOD_RCTRL)
#define KMOD_SHIFT  (KMOD_LSHIFT|KMOD_RSHIFT)
#define KMOD_ALT  (KMOD_LALT|KMOD_RALT)
#define KMOD_META (KMOD_LMETA|KMOD_RMETA)\fR
.fi
.PP
.RE
.SH "SEE ALSO"
.PP
\fI\fBSDL_GetKeyState\fP\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59