docs/html/sdlgetkeystate.html
changeset 3352 6dc250ebdd80
parent 3351 8e0182c236d8
child 3353 6b14223dd5c7
     1.1 --- a/docs/html/sdlgetkeystate.html	Wed Oct 07 06:11:53 2009 +0000
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,253 +0,0 @@
     1.4 -<HTML
     1.5 -><HEAD
     1.6 -><TITLE
     1.7 ->SDL_GetKeyState</TITLE
     1.8 -><META
     1.9 -NAME="GENERATOR"
    1.10 -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
    1.11 -"><LINK
    1.12 -REL="HOME"
    1.13 -TITLE="SDL Library Documentation"
    1.14 -HREF="index.html"><LINK
    1.15 -REL="UP"
    1.16 -TITLE="Event Functions."
    1.17 -HREF="eventfunctions.html"><LINK
    1.18 -REL="PREVIOUS"
    1.19 -TITLE="SDL_EventState"
    1.20 -HREF="sdleventstate.html"><LINK
    1.21 -REL="NEXT"
    1.22 -TITLE="SDL_GetModState"
    1.23 -HREF="sdlgetmodstate.html"></HEAD
    1.24 -><BODY
    1.25 -CLASS="REFENTRY"
    1.26 -BGCOLOR="#FFF8DC"
    1.27 -TEXT="#000000"
    1.28 -LINK="#0000ee"
    1.29 -VLINK="#551a8b"
    1.30 -ALINK="#ff0000"
    1.31 -><DIV
    1.32 -CLASS="NAVHEADER"
    1.33 -><TABLE
    1.34 -SUMMARY="Header navigation table"
    1.35 -WIDTH="100%"
    1.36 -BORDER="0"
    1.37 -CELLPADDING="0"
    1.38 -CELLSPACING="0"
    1.39 -><TR
    1.40 -><TH
    1.41 -COLSPAN="3"
    1.42 -ALIGN="center"
    1.43 ->SDL Library Documentation</TH
    1.44 -></TR
    1.45 -><TR
    1.46 -><TD
    1.47 -WIDTH="10%"
    1.48 -ALIGN="left"
    1.49 -VALIGN="bottom"
    1.50 -><A
    1.51 -HREF="sdleventstate.html"
    1.52 -ACCESSKEY="P"
    1.53 ->Prev</A
    1.54 -></TD
    1.55 -><TD
    1.56 -WIDTH="80%"
    1.57 -ALIGN="center"
    1.58 -VALIGN="bottom"
    1.59 -></TD
    1.60 -><TD
    1.61 -WIDTH="10%"
    1.62 -ALIGN="right"
    1.63 -VALIGN="bottom"
    1.64 -><A
    1.65 -HREF="sdlgetmodstate.html"
    1.66 -ACCESSKEY="N"
    1.67 ->Next</A
    1.68 -></TD
    1.69 -></TR
    1.70 -></TABLE
    1.71 -><HR
    1.72 -ALIGN="LEFT"
    1.73 -WIDTH="100%"></DIV
    1.74 -><H1
    1.75 -><A
    1.76 -NAME="SDLGETKEYSTATE"
    1.77 -></A
    1.78 ->SDL_GetKeyState</H1
    1.79 -><DIV
    1.80 -CLASS="REFNAMEDIV"
    1.81 -><A
    1.82 -NAME="AEN5686"
    1.83 -></A
    1.84 -><H2
    1.85 ->Name</H2
    1.86 ->SDL_GetKeyState&nbsp;--&nbsp;Get a snapshot of the current keyboard state</DIV
    1.87 -><DIV
    1.88 -CLASS="REFSYNOPSISDIV"
    1.89 -><A
    1.90 -NAME="AEN5689"
    1.91 -></A
    1.92 -><H2
    1.93 ->Synopsis</H2
    1.94 -><DIV
    1.95 -CLASS="FUNCSYNOPSIS"
    1.96 -><A
    1.97 -NAME="AEN5690"
    1.98 -></A
    1.99 -><P
   1.100 -></P
   1.101 -><PRE
   1.102 -CLASS="FUNCSYNOPSISINFO"
   1.103 ->#include "SDL.h"</PRE
   1.104 -><P
   1.105 -><CODE
   1.106 -><CODE
   1.107 -CLASS="FUNCDEF"
   1.108 ->Uint8 *<B
   1.109 -CLASS="FSFUNC"
   1.110 ->SDL_GetKeyState</B
   1.111 -></CODE
   1.112 ->(int *numkeys);</CODE
   1.113 -></P
   1.114 -><P
   1.115 -></P
   1.116 -></DIV
   1.117 -></DIV
   1.118 -><DIV
   1.119 -CLASS="REFSECT1"
   1.120 -><A
   1.121 -NAME="AEN5696"
   1.122 -></A
   1.123 -><H2
   1.124 ->Description</H2
   1.125 -><P
   1.126 ->Gets a snapshot of the current keyboard state. The current state is return as a pointer to an array, the size of this array is stored in <TT
   1.127 -CLASS="PARAMETER"
   1.128 -><I
   1.129 ->numkeys</I
   1.130 -></TT
   1.131 ->. The array is indexed by the <A
   1.132 -HREF="sdlkey.html"
   1.133 -><TT
   1.134 -CLASS="LITERAL"
   1.135 ->SDLK_*</TT
   1.136 -></A
   1.137 -> symbols. A value of 1 means the key is pressed and a value of 0 means its not. The pointer returned is a pointer to an internal SDL array and should not be freed by the caller.</P
   1.138 -><DIV
   1.139 -CLASS="NOTE"
   1.140 -><BLOCKQUOTE
   1.141 -CLASS="NOTE"
   1.142 -><P
   1.143 -><B
   1.144 ->Note: </B
   1.145 ->Use <A
   1.146 -HREF="sdlpumpevents.html"
   1.147 -><TT
   1.148 -CLASS="FUNCTION"
   1.149 ->SDL_PumpEvents</TT
   1.150 -></A
   1.151 -> to update the state array.</P
   1.152 -></BLOCKQUOTE
   1.153 -></DIV
   1.154 -></DIV
   1.155 -><DIV
   1.156 -CLASS="REFSECT1"
   1.157 -><A
   1.158 -NAME="AEN5706"
   1.159 -></A
   1.160 -><H2
   1.161 ->Example</H2
   1.162 -><P
   1.163 -><PRE
   1.164 -CLASS="PROGRAMLISTING"
   1.165 ->Uint8 *keystate = SDL_GetKeyState(NULL);
   1.166 -if ( keystate[SDLK_RETURN] ) printf("Return Key Pressed.\n");</PRE
   1.167 -></P
   1.168 -></DIV
   1.169 -><DIV
   1.170 -CLASS="REFSECT1"
   1.171 -><A
   1.172 -NAME="AEN5710"
   1.173 -></A
   1.174 -><H2
   1.175 ->See Also</H2
   1.176 -><P
   1.177 -><A
   1.178 -HREF="sdlkey.html"
   1.179 -><TT
   1.180 -CLASS="LITERAL"
   1.181 ->SDL Key Symbols</TT
   1.182 -></A
   1.183 ->,
   1.184 -<A
   1.185 -HREF="sdlpumpevents.html"
   1.186 -><TT
   1.187 -CLASS="FUNCTION"
   1.188 ->SDL_PumpEvents</TT
   1.189 -></A
   1.190 -></P
   1.191 -></DIV
   1.192 -><DIV
   1.193 -CLASS="NAVFOOTER"
   1.194 -><HR
   1.195 -ALIGN="LEFT"
   1.196 -WIDTH="100%"><TABLE
   1.197 -SUMMARY="Footer navigation table"
   1.198 -WIDTH="100%"
   1.199 -BORDER="0"
   1.200 -CELLPADDING="0"
   1.201 -CELLSPACING="0"
   1.202 -><TR
   1.203 -><TD
   1.204 -WIDTH="33%"
   1.205 -ALIGN="left"
   1.206 -VALIGN="top"
   1.207 -><A
   1.208 -HREF="sdleventstate.html"
   1.209 -ACCESSKEY="P"
   1.210 ->Prev</A
   1.211 -></TD
   1.212 -><TD
   1.213 -WIDTH="34%"
   1.214 -ALIGN="center"
   1.215 -VALIGN="top"
   1.216 -><A
   1.217 -HREF="index.html"
   1.218 -ACCESSKEY="H"
   1.219 ->Home</A
   1.220 -></TD
   1.221 -><TD
   1.222 -WIDTH="33%"
   1.223 -ALIGN="right"
   1.224 -VALIGN="top"
   1.225 -><A
   1.226 -HREF="sdlgetmodstate.html"
   1.227 -ACCESSKEY="N"
   1.228 ->Next</A
   1.229 -></TD
   1.230 -></TR
   1.231 -><TR
   1.232 -><TD
   1.233 -WIDTH="33%"
   1.234 -ALIGN="left"
   1.235 -VALIGN="top"
   1.236 ->SDL_EventState</TD
   1.237 -><TD
   1.238 -WIDTH="34%"
   1.239 -ALIGN="center"
   1.240 -VALIGN="top"
   1.241 -><A
   1.242 -HREF="eventfunctions.html"
   1.243 -ACCESSKEY="U"
   1.244 ->Up</A
   1.245 -></TD
   1.246 -><TD
   1.247 -WIDTH="33%"
   1.248 -ALIGN="right"
   1.249 -VALIGN="top"
   1.250 ->SDL_GetModState</TD
   1.251 -></TR
   1.252 -></TABLE
   1.253 -></DIV
   1.254 -></BODY
   1.255 -></HTML
   1.256 ->
   1.257 \ No newline at end of file