docs/html/eventfunctions.html
changeset 3352 6dc250ebdd80
parent 3351 8e0182c236d8
child 3353 6b14223dd5c7
     1.1 --- a/docs/html/eventfunctions.html	Wed Oct 07 06:11:53 2009 +0000
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,481 +0,0 @@
     1.4 -<HTML
     1.5 -><HEAD
     1.6 -><TITLE
     1.7 ->Event Functions.</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="Events"
    1.17 -HREF="event.html"><LINK
    1.18 -REL="PREVIOUS"
    1.19 -TITLE="SDLKey"
    1.20 -HREF="sdlkey.html"><LINK
    1.21 -REL="NEXT"
    1.22 -TITLE="SDL_PumpEvents"
    1.23 -HREF="sdlpumpevents.html"></HEAD
    1.24 -><BODY
    1.25 -CLASS="SECT1"
    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="sdlkey.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 ->Chapter 8. Events</TD
    1.60 -><TD
    1.61 -WIDTH="10%"
    1.62 -ALIGN="right"
    1.63 -VALIGN="bottom"
    1.64 -><A
    1.65 -HREF="sdlpumpevents.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 -><DIV
    1.75 -CLASS="SECT1"
    1.76 -><H1
    1.77 -CLASS="SECT1"
    1.78 -><A
    1.79 -NAME="EVENTFUNCTIONS"
    1.80 -></A
    1.81 ->Event Functions.</H1
    1.82 -><DIV
    1.83 -CLASS="TOC"
    1.84 -><DL
    1.85 -><DT
    1.86 -><B
    1.87 ->Table of Contents</B
    1.88 -></DT
    1.89 -><DT
    1.90 -><A
    1.91 -HREF="sdlpumpevents.html"
    1.92 ->SDL_PumpEvents</A
    1.93 ->&nbsp;--&nbsp;Pumps the event loop, gathering events from the input devices.</DT
    1.94 -><DT
    1.95 -><A
    1.96 -HREF="sdlpeepevents.html"
    1.97 ->SDL_PeepEvents</A
    1.98 ->&nbsp;--&nbsp;Checks the event queue for messages and optionally returns them.</DT
    1.99 -><DT
   1.100 -><A
   1.101 -HREF="sdlpollevent.html"
   1.102 ->SDL_PollEvent</A
   1.103 ->&nbsp;--&nbsp;Polls for currently pending events.</DT
   1.104 -><DT
   1.105 -><A
   1.106 -HREF="sdlwaitevent.html"
   1.107 ->SDL_WaitEvent</A
   1.108 ->&nbsp;--&nbsp;Waits indefinitely for the next available event.</DT
   1.109 -><DT
   1.110 -><A
   1.111 -HREF="sdlpushevent.html"
   1.112 ->SDL_PushEvent</A
   1.113 ->&nbsp;--&nbsp;Pushes an event onto the event queue</DT
   1.114 -><DT
   1.115 -><A
   1.116 -HREF="sdlseteventfilter.html"
   1.117 ->SDL_SetEventFilter</A
   1.118 ->&nbsp;--&nbsp;Sets up a filter to process all events before they are posted 
   1.119 -to the event queue.</DT
   1.120 -><DT
   1.121 -><A
   1.122 -HREF="sdlgeteventfilter.html"
   1.123 ->SDL_GetEventFilter</A
   1.124 ->&nbsp;--&nbsp;Retrieves a pointer to he event filter</DT
   1.125 -><DT
   1.126 -><A
   1.127 -HREF="sdleventstate.html"
   1.128 ->SDL_EventState</A
   1.129 ->&nbsp;--&nbsp;This function allows you to set the state of processing certain events.</DT
   1.130 -><DT
   1.131 -><A
   1.132 -HREF="sdlgetkeystate.html"
   1.133 ->SDL_GetKeyState</A
   1.134 ->&nbsp;--&nbsp;Get a snapshot of the current keyboard state</DT
   1.135 -><DT
   1.136 -><A
   1.137 -HREF="sdlgetmodstate.html"
   1.138 ->SDL_GetModState</A
   1.139 ->&nbsp;--&nbsp;Get the state of modifier keys.</DT
   1.140 -><DT
   1.141 -><A
   1.142 -HREF="sdlsetmodstate.html"
   1.143 ->SDL_SetModState</A
   1.144 ->&nbsp;--&nbsp;Set the current key modifier state</DT
   1.145 -><DT
   1.146 -><A
   1.147 -HREF="sdlgetkeyname.html"
   1.148 ->SDL_GetKeyName</A
   1.149 ->&nbsp;--&nbsp;Get the name of an SDL virtual keysym</DT
   1.150 -><DT
   1.151 -><A
   1.152 -HREF="sdlenableunicode.html"
   1.153 ->SDL_EnableUNICODE</A
   1.154 ->&nbsp;--&nbsp;Enable UNICODE translation</DT
   1.155 -><DT
   1.156 -><A
   1.157 -HREF="sdlenablekeyrepeat.html"
   1.158 ->SDL_EnableKeyRepeat</A
   1.159 ->&nbsp;--&nbsp;Set keyboard repeat rate.</DT
   1.160 -><DT
   1.161 -><A
   1.162 -HREF="sdlgetmousestate.html"
   1.163 ->SDL_GetMouseState</A
   1.164 ->&nbsp;--&nbsp;Retrieve the current state of the mouse</DT
   1.165 -><DT
   1.166 -><A
   1.167 -HREF="sdlgetrelativemousestate.html"
   1.168 ->SDL_GetRelativeMouseState</A
   1.169 ->&nbsp;--&nbsp;Retrieve the current state of the mouse</DT
   1.170 -><DT
   1.171 -><A
   1.172 -HREF="sdlgetappstate.html"
   1.173 ->SDL_GetAppState</A
   1.174 ->&nbsp;--&nbsp;Get the state of the application</DT
   1.175 -><DT
   1.176 -><A
   1.177 -HREF="sdljoystickeventstate.html"
   1.178 ->SDL_JoystickEventState</A
   1.179 ->&nbsp;--&nbsp;Enable/disable joystick event polling</DT
   1.180 -></DL
   1.181 -></DIV
   1.182 -><DIV
   1.183 -CLASS="INFORMALTABLE"
   1.184 -><A
   1.185 -NAME="AEN5312"
   1.186 -></A
   1.187 -><P
   1.188 -></P
   1.189 -><TABLE
   1.190 -BORDER="0"
   1.191 -CLASS="CALSTABLE"
   1.192 -><TBODY
   1.193 -><TR
   1.194 -><TD
   1.195 -ALIGN="LEFT"
   1.196 -VALIGN="TOP"
   1.197 -><A
   1.198 -HREF="sdlpumpevents.html"
   1.199 ->SDL_PumpEvents</A
   1.200 -></TD
   1.201 -><TD
   1.202 -ALIGN="LEFT"
   1.203 -VALIGN="TOP"
   1.204 ->Pumps the event loop, gathering events from the input devices</TD
   1.205 -></TR
   1.206 -><TR
   1.207 -><TD
   1.208 -ALIGN="LEFT"
   1.209 -VALIGN="TOP"
   1.210 -><A
   1.211 -HREF="sdlpeepevents.html"
   1.212 ->SDL_PeepEvents</A
   1.213 -></TD
   1.214 -><TD
   1.215 -ALIGN="LEFT"
   1.216 -VALIGN="TOP"
   1.217 ->Checks the event queue for messages and optionally returns them</TD
   1.218 -></TR
   1.219 -><TR
   1.220 -><TD
   1.221 -ALIGN="LEFT"
   1.222 -VALIGN="TOP"
   1.223 -><A
   1.224 -HREF="sdlpollevent.html"
   1.225 ->SDL_PollEvent</A
   1.226 -></TD
   1.227 -><TD
   1.228 -ALIGN="LEFT"
   1.229 -VALIGN="TOP"
   1.230 ->Polls for currently pending events</TD
   1.231 -></TR
   1.232 -><TR
   1.233 -><TD
   1.234 -ALIGN="LEFT"
   1.235 -VALIGN="TOP"
   1.236 -><A
   1.237 -HREF="sdlwaitevent.html"
   1.238 ->SDL_WaitEvent</A
   1.239 -></TD
   1.240 -><TD
   1.241 -ALIGN="LEFT"
   1.242 -VALIGN="TOP"
   1.243 ->Waits indefinitely for the next available event</TD
   1.244 -></TR
   1.245 -><TR
   1.246 -><TD
   1.247 -ALIGN="LEFT"
   1.248 -VALIGN="TOP"
   1.249 -><A
   1.250 -HREF="sdlpushevent.html"
   1.251 ->SDL_PushEvent</A
   1.252 -></TD
   1.253 -><TD
   1.254 -ALIGN="LEFT"
   1.255 -VALIGN="TOP"
   1.256 ->Pushes an event onto the event queue</TD
   1.257 -></TR
   1.258 -><TR
   1.259 -><TD
   1.260 -ALIGN="LEFT"
   1.261 -VALIGN="TOP"
   1.262 -><A
   1.263 -HREF="sdlseteventfilter.html"
   1.264 ->SDL_SetEventFilter</A
   1.265 -></TD
   1.266 -><TD
   1.267 -ALIGN="LEFT"
   1.268 -VALIGN="TOP"
   1.269 ->Sets up a filter to process all events</TD
   1.270 -></TR
   1.271 -><TR
   1.272 -><TD
   1.273 -ALIGN="LEFT"
   1.274 -VALIGN="TOP"
   1.275 -><A
   1.276 -HREF="sdleventstate.html"
   1.277 ->SDL_EventState</A
   1.278 -></TD
   1.279 -><TD
   1.280 -ALIGN="LEFT"
   1.281 -VALIGN="TOP"
   1.282 ->Allows you to set the state of processing certain events</TD
   1.283 -></TR
   1.284 -><TR
   1.285 -><TD
   1.286 -ALIGN="LEFT"
   1.287 -VALIGN="TOP"
   1.288 -><A
   1.289 -HREF="sdlgetkeystate.html"
   1.290 ->SDL_GetKeyState</A
   1.291 -></TD
   1.292 -><TD
   1.293 -ALIGN="LEFT"
   1.294 -VALIGN="TOP"
   1.295 ->Get a snapshot of the current keyboard state</TD
   1.296 -></TR
   1.297 -><TR
   1.298 -><TD
   1.299 -ALIGN="LEFT"
   1.300 -VALIGN="TOP"
   1.301 -><A
   1.302 -HREF="sdlgetmodstate.html"
   1.303 ->SDL_GetModState</A
   1.304 -></TD
   1.305 -><TD
   1.306 -ALIGN="LEFT"
   1.307 -VALIGN="TOP"
   1.308 ->Get the state of modifier keys</TD
   1.309 -></TR
   1.310 -><TR
   1.311 -><TD
   1.312 -ALIGN="LEFT"
   1.313 -VALIGN="TOP"
   1.314 -><A
   1.315 -HREF="sdlsetmodstate.html"
   1.316 ->SDL_SetModState</A
   1.317 -></TD
   1.318 -><TD
   1.319 -ALIGN="LEFT"
   1.320 -VALIGN="TOP"
   1.321 ->Set the state of modifier keys</TD
   1.322 -></TR
   1.323 -><TR
   1.324 -><TD
   1.325 -ALIGN="LEFT"
   1.326 -VALIGN="TOP"
   1.327 -><A
   1.328 -HREF="sdlgetkeyname.html"
   1.329 ->SDL_GetKeyName</A
   1.330 -></TD
   1.331 -><TD
   1.332 -ALIGN="LEFT"
   1.333 -VALIGN="TOP"
   1.334 ->Get the name of an SDL virtual keysym</TD
   1.335 -></TR
   1.336 -><TR
   1.337 -><TD
   1.338 -ALIGN="LEFT"
   1.339 -VALIGN="TOP"
   1.340 -><A
   1.341 -HREF="sdlenableunicode.html"
   1.342 ->SDL_EnableUNICODE</A
   1.343 -></TD
   1.344 -><TD
   1.345 -ALIGN="LEFT"
   1.346 -VALIGN="TOP"
   1.347 ->Enable UNICODE translation</TD
   1.348 -></TR
   1.349 -><TR
   1.350 -><TD
   1.351 -ALIGN="LEFT"
   1.352 -VALIGN="TOP"
   1.353 -><A
   1.354 -HREF="sdlenablekeyrepeat.html"
   1.355 ->SDL_EnableKeyRepeat</A
   1.356 -></TD
   1.357 -><TD
   1.358 -ALIGN="LEFT"
   1.359 -VALIGN="TOP"
   1.360 ->Set keyboard repeat rate</TD
   1.361 -></TR
   1.362 -><TR
   1.363 -><TD
   1.364 -ALIGN="LEFT"
   1.365 -VALIGN="TOP"
   1.366 -><A
   1.367 -HREF="sdlgetmousestate.html"
   1.368 ->SDL_GetMouseState</A
   1.369 -></TD
   1.370 -><TD
   1.371 -ALIGN="LEFT"
   1.372 -VALIGN="TOP"
   1.373 ->Retrieve the current state of the mouse</TD
   1.374 -></TR
   1.375 -><TR
   1.376 -><TD
   1.377 -ALIGN="LEFT"
   1.378 -VALIGN="TOP"
   1.379 -><A
   1.380 -HREF="sdlgetrelativemousestate.html"
   1.381 ->SDL_GetRelativeMouseState</A
   1.382 -></TD
   1.383 -><TD
   1.384 -ALIGN="LEFT"
   1.385 -VALIGN="TOP"
   1.386 ->Retrieve the current state of the mouse</TD
   1.387 -></TR
   1.388 -><TR
   1.389 -><TD
   1.390 -ALIGN="LEFT"
   1.391 -VALIGN="TOP"
   1.392 -><A
   1.393 -HREF="sdlgetappstate.html"
   1.394 ->SDL_GetAppState</A
   1.395 -></TD
   1.396 -><TD
   1.397 -ALIGN="LEFT"
   1.398 -VALIGN="TOP"
   1.399 ->Get the state of the application</TD
   1.400 -></TR
   1.401 -><TR
   1.402 -><TD
   1.403 -ALIGN="LEFT"
   1.404 -VALIGN="TOP"
   1.405 -><A
   1.406 -HREF="sdljoystickeventstate.html"
   1.407 ->SDL_JoystickEventState</A
   1.408 -></TD
   1.409 -><TD
   1.410 -ALIGN="LEFT"
   1.411 -VALIGN="TOP"
   1.412 ->Enable/disable joystick event polling</TD
   1.413 -></TR
   1.414 -></TBODY
   1.415 -></TABLE
   1.416 -><P
   1.417 -></P
   1.418 -></DIV
   1.419 -></DIV
   1.420 -><DIV
   1.421 -CLASS="NAVFOOTER"
   1.422 -><HR
   1.423 -ALIGN="LEFT"
   1.424 -WIDTH="100%"><TABLE
   1.425 -SUMMARY="Footer navigation table"
   1.426 -WIDTH="100%"
   1.427 -BORDER="0"
   1.428 -CELLPADDING="0"
   1.429 -CELLSPACING="0"
   1.430 -><TR
   1.431 -><TD
   1.432 -WIDTH="33%"
   1.433 -ALIGN="left"
   1.434 -VALIGN="top"
   1.435 -><A
   1.436 -HREF="sdlkey.html"
   1.437 -ACCESSKEY="P"
   1.438 ->Prev</A
   1.439 -></TD
   1.440 -><TD
   1.441 -WIDTH="34%"
   1.442 -ALIGN="center"
   1.443 -VALIGN="top"
   1.444 -><A
   1.445 -HREF="index.html"
   1.446 -ACCESSKEY="H"
   1.447 ->Home</A
   1.448 -></TD
   1.449 -><TD
   1.450 -WIDTH="33%"
   1.451 -ALIGN="right"
   1.452 -VALIGN="top"
   1.453 -><A
   1.454 -HREF="sdlpumpevents.html"
   1.455 -ACCESSKEY="N"
   1.456 ->Next</A
   1.457 -></TD
   1.458 -></TR
   1.459 -><TR
   1.460 -><TD
   1.461 -WIDTH="33%"
   1.462 -ALIGN="left"
   1.463 -VALIGN="top"
   1.464 ->SDLKey</TD
   1.465 -><TD
   1.466 -WIDTH="34%"
   1.467 -ALIGN="center"
   1.468 -VALIGN="top"
   1.469 -><A
   1.470 -HREF="event.html"
   1.471 -ACCESSKEY="U"
   1.472 ->Up</A
   1.473 -></TD
   1.474 -><TD
   1.475 -WIDTH="33%"
   1.476 -ALIGN="right"
   1.477 -VALIGN="top"
   1.478 ->SDL_PumpEvents</TD
   1.479 -></TR
   1.480 -></TABLE
   1.481 -></DIV
   1.482 -></BODY
   1.483 -></HTML
   1.484 ->
   1.485 \ No newline at end of file