1<HTML 2><HEAD 3><TITLE 4>SDL_GetModState</TITLE 5><META 6NAME="GENERATOR" 7CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ 8"><LINK 9REL="HOME" 10TITLE="SDL Library Documentation" 11HREF="index.html"><LINK 12REL="UP" 13TITLE="Event Functions." 14HREF="eventfunctions.html"><LINK 15REL="PREVIOUS" 16TITLE="SDL_GetKeyState" 17HREF="sdlgetkeystate.html"><LINK 18REL="NEXT" 19TITLE="SDL_SetModState" 20HREF="sdlsetmodstate.html"></HEAD 21><BODY 22CLASS="REFENTRY" 23BGCOLOR="#FFF8DC" 24TEXT="#000000" 25LINK="#0000ee" 26VLINK="#551a8b" 27ALINK="#ff0000" 28><DIV 29CLASS="NAVHEADER" 30><TABLE 31SUMMARY="Header navigation table" 32WIDTH="100%" 33BORDER="0" 34CELLPADDING="0" 35CELLSPACING="0" 36><TR 37><TH 38COLSPAN="3" 39ALIGN="center" 40>SDL Library Documentation</TH 41></TR 42><TR 43><TD 44WIDTH="10%" 45ALIGN="left" 46VALIGN="bottom" 47><A 48HREF="sdlgetkeystate.html" 49ACCESSKEY="P" 50>Prev</A 51></TD 52><TD 53WIDTH="80%" 54ALIGN="center" 55VALIGN="bottom" 56></TD 57><TD 58WIDTH="10%" 59ALIGN="right" 60VALIGN="bottom" 61><A 62HREF="sdlsetmodstate.html" 63ACCESSKEY="N" 64>Next</A 65></TD 66></TR 67></TABLE 68><HR 69ALIGN="LEFT" 70WIDTH="100%"></DIV 71><H1 72><A 73NAME="SDLGETMODSTATE" 74></A 75>SDL_GetModState</H1 76><DIV 77CLASS="REFNAMEDIV" 78><A 79NAME="AEN5721" 80></A 81><H2 82>Name</H2 83>SDL_GetModState -- Get the state of modifier keys.</DIV 84><DIV 85CLASS="REFSYNOPSISDIV" 86><A 87NAME="AEN5724" 88></A 89><H2 90>Synopsis</H2 91><DIV 92CLASS="FUNCSYNOPSIS" 93><A 94NAME="AEN5725" 95></A 96><P 97></P 98><PRE 99CLASS="FUNCSYNOPSISINFO" 100>#include "SDL.h"</PRE 101><P 102><CODE 103><CODE 104CLASS="FUNCDEF" 105>SDLMod <B 106CLASS="FSFUNC" 107>SDL_GetModState</B 108></CODE 109>(void);</CODE 110></P 111><P 112></P 113></DIV 114></DIV 115><DIV 116CLASS="REFSECT1" 117><A 118NAME="AEN5731" 119></A 120><H2 121>Description</H2 122><P 123>Returns the current state of the modifier keys (CTRL, ALT, etc.).</P 124></DIV 125><DIV 126CLASS="REFSECT1" 127><A 128NAME="AEN5734" 129></A 130><H2 131>Return Value</H2 132><P 133>The return value can be an OR'd combination of the SDLMod enum.</P 134><P 135><A 136NAME="AEN5738" 137></A 138><BLOCKQUOTE 139CLASS="BLOCKQUOTE" 140><P 141><B 142>SDLMod</B 143></P 144><PRE 145CLASS="PROGRAMLISTING" 146>typedef enum { 147 KMOD_NONE = 0x0000, 148 KMOD_LSHIFT= 0x0001, 149 KMOD_RSHIFT= 0x0002, 150 KMOD_LCTRL = 0x0040, 151 KMOD_RCTRL = 0x0080, 152 KMOD_LALT = 0x0100, 153 KMOD_RALT = 0x0200, 154 KMOD_LMETA = 0x0400, 155 KMOD_RMETA = 0x0800, 156 KMOD_NUM = 0x1000, 157 KMOD_CAPS = 0x2000, 158 KMOD_MODE = 0x4000, 159} SDLMod;</PRE 160></BLOCKQUOTE 161> 162SDL also defines the following symbols for convenience: 163<A 164NAME="AEN5741" 165></A 166><BLOCKQUOTE 167CLASS="BLOCKQUOTE" 168><PRE 169CLASS="PROGRAMLISTING" 170>#define KMOD_CTRL (KMOD_LCTRL|KMOD_RCTRL) 171#define KMOD_SHIFT (KMOD_LSHIFT|KMOD_RSHIFT) 172#define KMOD_ALT (KMOD_LALT|KMOD_RALT) 173#define KMOD_META (KMOD_LMETA|KMOD_RMETA)</PRE 174></BLOCKQUOTE 175></P 176></DIV 177><DIV 178CLASS="REFSECT1" 179><A 180NAME="AEN5743" 181></A 182><H2 183>See Also</H2 184><P 185><A 186HREF="sdlgetkeystate.html" 187><TT 188CLASS="FUNCTION" 189>SDL_GetKeyState</TT 190></A 191></P 192></DIV 193><DIV 194CLASS="NAVFOOTER" 195><HR 196ALIGN="LEFT" 197WIDTH="100%"><TABLE 198SUMMARY="Footer navigation table" 199WIDTH="100%" 200BORDER="0" 201CELLPADDING="0" 202CELLSPACING="0" 203><TR 204><TD 205WIDTH="33%" 206ALIGN="left" 207VALIGN="top" 208><A 209HREF="sdlgetkeystate.html" 210ACCESSKEY="P" 211>Prev</A 212></TD 213><TD 214WIDTH="34%" 215ALIGN="center" 216VALIGN="top" 217><A 218HREF="index.html" 219ACCESSKEY="H" 220>Home</A 221></TD 222><TD 223WIDTH="33%" 224ALIGN="right" 225VALIGN="top" 226><A 227HREF="sdlsetmodstate.html" 228ACCESSKEY="N" 229>Next</A 230></TD 231></TR 232><TR 233><TD 234WIDTH="33%" 235ALIGN="left" 236VALIGN="top" 237>SDL_GetKeyState</TD 238><TD 239WIDTH="34%" 240ALIGN="center" 241VALIGN="top" 242><A 243HREF="eventfunctions.html" 244ACCESSKEY="U" 245>Up</A 246></TD 247><TD 248WIDTH="33%" 249ALIGN="right" 250VALIGN="top" 251>SDL_SetModState</TD 252></TR 253></TABLE 254></DIV 255></BODY 256></HTML 257>