docs/man3/SDL_SetModState.3
author Sam Lantinga <slouken@libsdl.org>
Wed, 08 Mar 2006 18:30:12 +0000
changeset 1486 9d77fc9d0ace
parent 181 e5bc29de3f0a
child 2283 546f7c1eb755
permissions -rw-r--r--
Re-added C runtime support for Visual C++ 5,6
     1 .TH "SDL_SetModState" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" 
     2 .SH "NAME"
     3 SDL_SetModState\- Set the current key modifier state
     4 .SH "SYNOPSIS"
     5 .PP
     6 \fB#include "SDL\&.h"
     7 .sp
     8 \fBvoid \fBSDL_SetModState\fP\fR(\fBSDLMod modstate\fR);
     9 .SH "DESCRIPTION"
    10 .PP
    11 The inverse of \fI\fBSDL_GetModState\fP\fR, \fBSDL_SetModState\fP allows you to impose modifier key states on your application\&.
    12 .PP
    13 Simply pass your desired modifier states into \fBmodstate\fR\&. This value my be a logical OR\&'d combination of the following:
    14 .PP
    15 .nf
    16 \f(CWtypedef enum {
    17   KMOD_NONE  = 0x0000,
    18   KMOD_LSHIFT= 0x0001,
    19   KMOD_RSHIFT= 0x0002,
    20   KMOD_LCTRL = 0x0040,
    21   KMOD_RCTRL = 0x0080,
    22   KMOD_LALT  = 0x0100,
    23   KMOD_RALT  = 0x0200,
    24   KMOD_LMETA = 0x0400,
    25   KMOD_RMETA = 0x0800,
    26   KMOD_NUM   = 0x1000,
    27   KMOD_CAPS  = 0x2000,
    28   KMOD_MODE  = 0x4000,
    29 } SDLMod;\fR
    30 .fi
    31 .PP
    32 .SH "SEE ALSO"
    33 .PP
    34 \fI\fBSDL_GetModState\fP\fR
    35 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00