Home | History | Annotate | Download | only in html 
      1 <HTML
      2 ><HEAD
      3 ><TITLE
      4 >Event Functions.</TITLE
      5 ><META
      6 NAME="GENERATOR"
      7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
      8 "><LINK
      9 REL="HOME"
     10 TITLE="SDL Library Documentation"
     11 HREF="index.html"><LINK
     12 REL="UP"
     13 TITLE="Events"
     14 HREF="event.html"><LINK
     15 REL="PREVIOUS"
     16 TITLE="SDLKey"
     17 HREF="sdlkey.html"><LINK
     18 REL="NEXT"
     19 TITLE="SDL_PumpEvents"
     20 HREF="sdlpumpevents.html"></HEAD
     21 ><BODY
     22 CLASS="SECT1"
     23 BGCOLOR="#FFF8DC"
     24 TEXT="#000000"
     25 LINK="#0000ee"
     26 VLINK="#551a8b"
     27 ALINK="#ff0000"
     28 ><DIV
     29 CLASS="NAVHEADER"
     30 ><TABLE
     31 SUMMARY="Header navigation table"
     32 WIDTH="100%"
     33 BORDER="0"
     34 CELLPADDING="0"
     35 CELLSPACING="0"
     36 ><TR
     37 ><TH
     38 COLSPAN="3"
     39 ALIGN="center"
     40 >SDL Library Documentation</TH
     41 ></TR
     42 ><TR
     43 ><TD
     44 WIDTH="10%"
     45 ALIGN="left"
     46 VALIGN="bottom"
     47 ><A
     48 HREF="sdlkey.html"
     49 ACCESSKEY="P"
     50 >Prev</A
     51 ></TD
     52 ><TD
     53 WIDTH="80%"
     54 ALIGN="center"
     55 VALIGN="bottom"
     56 >Chapter 8. Events</TD
     57 ><TD
     58 WIDTH="10%"
     59 ALIGN="right"
     60 VALIGN="bottom"
     61 ><A
     62 HREF="sdlpumpevents.html"
     63 ACCESSKEY="N"
     64 >Next</A
     65 ></TD
     66 ></TR
     67 ></TABLE
     68 ><HR
     69 ALIGN="LEFT"
     70 WIDTH="100%"></DIV
     71 ><DIV
     72 CLASS="SECT1"
     73 ><H1
     74 CLASS="SECT1"
     75 ><A
     76 NAME="EVENTFUNCTIONS"
     77 ></A
     78 >Event Functions.</H1
     79 ><DIV
     80 CLASS="TOC"
     81 ><DL
     82 ><DT
     83 ><B
     84 >Table of Contents</B
     85 ></DT
     86 ><DT
     87 ><A
     88 HREF="sdlpumpevents.html"
     89 >SDL_PumpEvents</A
     90 >&nbsp;--&nbsp;Pumps the event loop, gathering events from the input devices.</DT
     91 ><DT
     92 ><A
     93 HREF="sdlpeepevents.html"
     94 >SDL_PeepEvents</A
     95 >&nbsp;--&nbsp;Checks the event queue for messages and optionally returns them.</DT
     96 ><DT
     97 ><A
     98 HREF="sdlpollevent.html"
     99 >SDL_PollEvent</A
    100 >&nbsp;--&nbsp;Polls for currently pending events.</DT
    101 ><DT
    102 ><A
    103 HREF="sdlwaitevent.html"
    104 >SDL_WaitEvent</A
    105 >&nbsp;--&nbsp;Waits indefinitely for the next available event.</DT
    106 ><DT
    107 ><A
    108 HREF="sdlpushevent.html"
    109 >SDL_PushEvent</A
    110 >&nbsp;--&nbsp;Pushes an event onto the event queue</DT
    111 ><DT
    112 ><A
    113 HREF="sdlseteventfilter.html"
    114 >SDL_SetEventFilter</A
    115 >&nbsp;--&nbsp;Sets up a filter to process all events before they are posted 
    116 to the event queue.</DT
    117 ><DT
    118 ><A
    119 HREF="sdlgeteventfilter.html"
    120 >SDL_GetEventFilter</A
    121 >&nbsp;--&nbsp;Retrieves a pointer to he event filter</DT
    122 ><DT
    123 ><A
    124 HREF="sdleventstate.html"
    125 >SDL_EventState</A
    126 >&nbsp;--&nbsp;This function allows you to set the state of processing certain events.</DT
    127 ><DT
    128 ><A
    129 HREF="sdlgetkeystate.html"
    130 >SDL_GetKeyState</A
    131 >&nbsp;--&nbsp;Get a snapshot of the current keyboard state</DT
    132 ><DT
    133 ><A
    134 HREF="sdlgetmodstate.html"
    135 >SDL_GetModState</A
    136 >&nbsp;--&nbsp;Get the state of modifier keys.</DT
    137 ><DT
    138 ><A
    139 HREF="sdlsetmodstate.html"
    140 >SDL_SetModState</A
    141 >&nbsp;--&nbsp;Set the current key modifier state</DT
    142 ><DT
    143 ><A
    144 HREF="sdlgetkeyname.html"
    145 >SDL_GetKeyName</A
    146 >&nbsp;--&nbsp;Get the name of an SDL virtual keysym</DT
    147 ><DT
    148 ><A
    149 HREF="sdlenableunicode.html"
    150 >SDL_EnableUNICODE</A
    151 >&nbsp;--&nbsp;Enable UNICODE translation</DT
    152 ><DT
    153 ><A
    154 HREF="sdlenablekeyrepeat.html"
    155 >SDL_EnableKeyRepeat</A
    156 >&nbsp;--&nbsp;Set keyboard repeat rate.</DT
    157 ><DT
    158 ><A
    159 HREF="sdlgetmousestate.html"
    160 >SDL_GetMouseState</A
    161 >&nbsp;--&nbsp;Retrieve the current state of the mouse</DT
    162 ><DT
    163 ><A
    164 HREF="sdlgetrelativemousestate.html"
    165 >SDL_GetRelativeMouseState</A
    166 >&nbsp;--&nbsp;Retrieve the current state of the mouse</DT
    167 ><DT
    168 ><A
    169 HREF="sdlgetappstate.html"
    170 >SDL_GetAppState</A
    171 >&nbsp;--&nbsp;Get the state of the application</DT
    172 ><DT
    173 ><A
    174 HREF="sdljoystickeventstate.html"
    175 >SDL_JoystickEventState</A
    176 >&nbsp;--&nbsp;Enable/disable joystick event polling</DT
    177 ></DL
    178 ></DIV
    179 ><DIV
    180 CLASS="INFORMALTABLE"
    181 ><A
    182 NAME="AEN5312"
    183 ></A
    184 ><P
    185 ></P
    186 ><TABLE
    187 BORDER="0"
    188 CLASS="CALSTABLE"
    189 ><TBODY
    190 ><TR
    191 ><TD
    192 ALIGN="LEFT"
    193 VALIGN="TOP"
    194 ><A
    195 HREF="sdlpumpevents.html"
    196 >SDL_PumpEvents</A
    197 ></TD
    198 ><TD
    199 ALIGN="LEFT"
    200 VALIGN="TOP"
    201 >Pumps the event loop, gathering events from the input devices</TD
    202 ></TR
    203 ><TR
    204 ><TD
    205 ALIGN="LEFT"
    206 VALIGN="TOP"
    207 ><A
    208 HREF="sdlpeepevents.html"
    209 >SDL_PeepEvents</A
    210 ></TD
    211 ><TD
    212 ALIGN="LEFT"
    213 VALIGN="TOP"
    214 >Checks the event queue for messages and optionally returns them</TD
    215 ></TR
    216 ><TR
    217 ><TD
    218 ALIGN="LEFT"
    219 VALIGN="TOP"
    220 ><A
    221 HREF="sdlpollevent.html"
    222 >SDL_PollEvent</A
    223 ></TD
    224 ><TD
    225 ALIGN="LEFT"
    226 VALIGN="TOP"
    227 >Polls for currently pending events</TD
    228 ></TR
    229 ><TR
    230 ><TD
    231 ALIGN="LEFT"
    232 VALIGN="TOP"
    233 ><A
    234 HREF="sdlwaitevent.html"
    235 >SDL_WaitEvent</A
    236 ></TD
    237 ><TD
    238 ALIGN="LEFT"
    239 VALIGN="TOP"
    240 >Waits indefinitely for the next available event</TD
    241 ></TR
    242 ><TR
    243 ><TD
    244 ALIGN="LEFT"
    245 VALIGN="TOP"
    246 ><A
    247 HREF="sdlpushevent.html"
    248 >SDL_PushEvent</A
    249 ></TD
    250 ><TD
    251 ALIGN="LEFT"
    252 VALIGN="TOP"
    253 >Pushes an event onto the event queue</TD
    254 ></TR
    255 ><TR
    256 ><TD
    257 ALIGN="LEFT"
    258 VALIGN="TOP"
    259 ><A
    260 HREF="sdlseteventfilter.html"
    261 >SDL_SetEventFilter</A
    262 ></TD
    263 ><TD
    264 ALIGN="LEFT"
    265 VALIGN="TOP"
    266 >Sets up a filter to process all events</TD
    267 ></TR
    268 ><TR
    269 ><TD
    270 ALIGN="LEFT"
    271 VALIGN="TOP"
    272 ><A
    273 HREF="sdleventstate.html"
    274 >SDL_EventState</A
    275 ></TD
    276 ><TD
    277 ALIGN="LEFT"
    278 VALIGN="TOP"
    279 >Allows you to set the state of processing certain events</TD
    280 ></TR
    281 ><TR
    282 ><TD
    283 ALIGN="LEFT"
    284 VALIGN="TOP"
    285 ><A
    286 HREF="sdlgetkeystate.html"
    287 >SDL_GetKeyState</A
    288 ></TD
    289 ><TD
    290 ALIGN="LEFT"
    291 VALIGN="TOP"
    292 >Get a snapshot of the current keyboard state</TD
    293 ></TR
    294 ><TR
    295 ><TD
    296 ALIGN="LEFT"
    297 VALIGN="TOP"
    298 ><A
    299 HREF="sdlgetmodstate.html"
    300 >SDL_GetModState</A
    301 ></TD
    302 ><TD
    303 ALIGN="LEFT"
    304 VALIGN="TOP"
    305 >Get the state of modifier keys</TD
    306 ></TR
    307 ><TR
    308 ><TD
    309 ALIGN="LEFT"
    310 VALIGN="TOP"
    311 ><A
    312 HREF="sdlsetmodstate.html"
    313 >SDL_SetModState</A
    314 ></TD
    315 ><TD
    316 ALIGN="LEFT"
    317 VALIGN="TOP"
    318 >Set the state of modifier keys</TD
    319 ></TR
    320 ><TR
    321 ><TD
    322 ALIGN="LEFT"
    323 VALIGN="TOP"
    324 ><A
    325 HREF="sdlgetkeyname.html"
    326 >SDL_GetKeyName</A
    327 ></TD
    328 ><TD
    329 ALIGN="LEFT"
    330 VALIGN="TOP"
    331 >Get the name of an SDL virtual keysym</TD
    332 ></TR
    333 ><TR
    334 ><TD
    335 ALIGN="LEFT"
    336 VALIGN="TOP"
    337 ><A
    338 HREF="sdlenableunicode.html"
    339 >SDL_EnableUNICODE</A
    340 ></TD
    341 ><TD
    342 ALIGN="LEFT"
    343 VALIGN="TOP"
    344 >Enable UNICODE translation</TD
    345 ></TR
    346 ><TR
    347 ><TD
    348 ALIGN="LEFT"
    349 VALIGN="TOP"
    350 ><A
    351 HREF="sdlenablekeyrepeat.html"
    352 >SDL_EnableKeyRepeat</A
    353 ></TD
    354 ><TD
    355 ALIGN="LEFT"
    356 VALIGN="TOP"
    357 >Set keyboard repeat rate</TD
    358 ></TR
    359 ><TR
    360 ><TD
    361 ALIGN="LEFT"
    362 VALIGN="TOP"
    363 ><A
    364 HREF="sdlgetmousestate.html"
    365 >SDL_GetMouseState</A
    366 ></TD
    367 ><TD
    368 ALIGN="LEFT"
    369 VALIGN="TOP"
    370 >Retrieve the current state of the mouse</TD
    371 ></TR
    372 ><TR
    373 ><TD
    374 ALIGN="LEFT"
    375 VALIGN="TOP"
    376 ><A
    377 HREF="sdlgetrelativemousestate.html"
    378 >SDL_GetRelativeMouseState</A
    379 ></TD
    380 ><TD
    381 ALIGN="LEFT"
    382 VALIGN="TOP"
    383 >Retrieve the current state of the mouse</TD
    384 ></TR
    385 ><TR
    386 ><TD
    387 ALIGN="LEFT"
    388 VALIGN="TOP"
    389 ><A
    390 HREF="sdlgetappstate.html"
    391 >SDL_GetAppState</A
    392 ></TD
    393 ><TD
    394 ALIGN="LEFT"
    395 VALIGN="TOP"
    396 >Get the state of the application</TD
    397 ></TR
    398 ><TR
    399 ><TD
    400 ALIGN="LEFT"
    401 VALIGN="TOP"
    402 ><A
    403 HREF="sdljoystickeventstate.html"
    404 >SDL_JoystickEventState</A
    405 ></TD
    406 ><TD
    407 ALIGN="LEFT"
    408 VALIGN="TOP"
    409 >Enable/disable joystick event polling</TD
    410 ></TR
    411 ></TBODY
    412 ></TABLE
    413 ><P
    414 ></P
    415 ></DIV
    416 ></DIV
    417 ><DIV
    418 CLASS="NAVFOOTER"
    419 ><HR
    420 ALIGN="LEFT"
    421 WIDTH="100%"><TABLE
    422 SUMMARY="Footer navigation table"
    423 WIDTH="100%"
    424 BORDER="0"
    425 CELLPADDING="0"
    426 CELLSPACING="0"
    427 ><TR
    428 ><TD
    429 WIDTH="33%"
    430 ALIGN="left"
    431 VALIGN="top"
    432 ><A
    433 HREF="sdlkey.html"
    434 ACCESSKEY="P"
    435 >Prev</A
    436 ></TD
    437 ><TD
    438 WIDTH="34%"
    439 ALIGN="center"
    440 VALIGN="top"
    441 ><A
    442 HREF="index.html"
    443 ACCESSKEY="H"
    444 >Home</A
    445 ></TD
    446 ><TD
    447 WIDTH="33%"
    448 ALIGN="right"
    449 VALIGN="top"
    450 ><A
    451 HREF="sdlpumpevents.html"
    452 ACCESSKEY="N"
    453 >Next</A
    454 ></TD
    455 ></TR
    456 ><TR
    457 ><TD
    458 WIDTH="33%"
    459 ALIGN="left"
    460 VALIGN="top"
    461 >SDLKey</TD
    462 ><TD
    463 WIDTH="34%"
    464 ALIGN="center"
    465 VALIGN="top"
    466 ><A
    467 HREF="event.html"
    468 ACCESSKEY="U"
    469 >Up</A
    470 ></TD
    471 ><TD
    472 WIDTH="33%"
    473 ALIGN="right"
    474 VALIGN="top"
    475 >SDL_PumpEvents</TD
    476 ></TR
    477 ></TABLE
    478 ></DIV
    479 ></BODY
    480 ></HTML
    481 >