comparison docs/html/eventfunctions.html @ 803:355632dca928

Updated SDL HTML documentation
author Sam Lantinga <slouken@libsdl.org>
date Tue, 10 Feb 2004 15:15:40 +0000
parents e5bc29de3f0a
children
comparison
equal deleted inserted replaced
802:3c609d54f100 803:355632dca928
2 ><HEAD 2 ><HEAD
3 ><TITLE 3 ><TITLE
4 >Event Functions.</TITLE 4 >Event Functions.</TITLE
5 ><META 5 ><META
6 NAME="GENERATOR" 6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64 7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8 "><LINK 8 "><LINK
9 REL="HOME" 9 REL="HOME"
10 TITLE="SDL Library Documentation" 10 TITLE="SDL Library Documentation"
11 HREF="index.html"><LINK 11 HREF="index.html"><LINK
12 REL="UP" 12 REL="UP"
26 VLINK="#551a8b" 26 VLINK="#551a8b"
27 ALINK="#ff0000" 27 ALINK="#ff0000"
28 ><DIV 28 ><DIV
29 CLASS="NAVHEADER" 29 CLASS="NAVHEADER"
30 ><TABLE 30 ><TABLE
31 SUMMARY="Header navigation table"
31 WIDTH="100%" 32 WIDTH="100%"
32 BORDER="0" 33 BORDER="0"
33 CELLPADDING="0" 34 CELLPADDING="0"
34 CELLSPACING="0" 35 CELLSPACING="0"
35 ><TR 36 ><TR
43 WIDTH="10%" 44 WIDTH="10%"
44 ALIGN="left" 45 ALIGN="left"
45 VALIGN="bottom" 46 VALIGN="bottom"
46 ><A 47 ><A
47 HREF="sdlkey.html" 48 HREF="sdlkey.html"
49 ACCESSKEY="P"
48 >Prev</A 50 >Prev</A
49 ></TD 51 ></TD
50 ><TD 52 ><TD
51 WIDTH="80%" 53 WIDTH="80%"
52 ALIGN="center" 54 ALIGN="center"
56 WIDTH="10%" 58 WIDTH="10%"
57 ALIGN="right" 59 ALIGN="right"
58 VALIGN="bottom" 60 VALIGN="bottom"
59 ><A 61 ><A
60 HREF="sdlpumpevents.html" 62 HREF="sdlpumpevents.html"
63 ACCESSKEY="N"
61 >Next</A 64 >Next</A
62 ></TD 65 ></TD
63 ></TR 66 ></TR
64 ></TABLE 67 ></TABLE
65 ><HR 68 ><HR
69 CLASS="SECT1" 72 CLASS="SECT1"
70 ><H1 73 ><H1
71 CLASS="SECT1" 74 CLASS="SECT1"
72 ><A 75 ><A
73 NAME="EVENTFUNCTIONS" 76 NAME="EVENTFUNCTIONS"
74 >Event Functions.</A 77 ></A
75 ></H1 78 >Event Functions.</H1
76 ><DIV 79 ><DIV
77 CLASS="TOC" 80 CLASS="TOC"
78 ><DL 81 ><DL
79 ><DT 82 ><DT
80 ><B 83 ><B
82 ></DT 85 ></DT
83 ><DT 86 ><DT
84 ><A 87 ><A
85 HREF="sdlpumpevents.html" 88 HREF="sdlpumpevents.html"
86 >SDL_PumpEvents</A 89 >SDL_PumpEvents</A
87 > &#8212; Pumps the event loop, gathering events from the input devices.</DT 90 >&nbsp;--&nbsp;Pumps the event loop, gathering events from the input devices.</DT
88 ><DT 91 ><DT
89 ><A 92 ><A
90 HREF="sdlpeepevents.html" 93 HREF="sdlpeepevents.html"
91 >SDL_PeepEvents</A 94 >SDL_PeepEvents</A
92 > &#8212; Checks the event queue for messages and optionally returns them.</DT 95 >&nbsp;--&nbsp;Checks the event queue for messages and optionally returns them.</DT
93 ><DT 96 ><DT
94 ><A 97 ><A
95 HREF="sdlpollevent.html" 98 HREF="sdlpollevent.html"
96 >SDL_PollEvent</A 99 >SDL_PollEvent</A
97 > &#8212; Polls for currently pending events.</DT 100 >&nbsp;--&nbsp;Polls for currently pending events.</DT
98 ><DT 101 ><DT
99 ><A 102 ><A
100 HREF="sdlwaitevent.html" 103 HREF="sdlwaitevent.html"
101 >SDL_WaitEvent</A 104 >SDL_WaitEvent</A
102 > &#8212; Waits indefinitely for the next available event.</DT 105 >&nbsp;--&nbsp;Waits indefinitely for the next available event.</DT
103 ><DT 106 ><DT
104 ><A 107 ><A
105 HREF="sdlpushevent.html" 108 HREF="sdlpushevent.html"
106 >SDL_PushEvent</A 109 >SDL_PushEvent</A
107 > &#8212; Pushes an event onto the event queue</DT 110 >&nbsp;--&nbsp;Pushes an event onto the event queue</DT
108 ><DT 111 ><DT
109 ><A 112 ><A
110 HREF="sdlseteventfilter.html" 113 HREF="sdlseteventfilter.html"
111 >SDL_SetEventFilter</A 114 >SDL_SetEventFilter</A
112 > &#8212; Sets up a filter to process all events before they are posted 115 >&nbsp;--&nbsp;Sets up a filter to process all events before they are posted
113 to the event queue.</DT 116 to the event queue.</DT
114 ><DT 117 ><DT
115 ><A 118 ><A
116 HREF="sdlgeteventfilter.html" 119 HREF="sdlgeteventfilter.html"
117 >SDL_GetEventFilter</A 120 >SDL_GetEventFilter</A
118 > &#8212; Retrieves a pointer to he event filter</DT 121 >&nbsp;--&nbsp;Retrieves a pointer to he event filter</DT
119 ><DT 122 ><DT
120 ><A 123 ><A
121 HREF="sdleventstate.html" 124 HREF="sdleventstate.html"
122 >SDL_EventState</A 125 >SDL_EventState</A
123 > &#8212; This function allows you to set the state of processing certain events.</DT 126 >&nbsp;--&nbsp;This function allows you to set the state of processing certain events.</DT
124 ><DT 127 ><DT
125 ><A 128 ><A
126 HREF="sdlgetkeystate.html" 129 HREF="sdlgetkeystate.html"
127 >SDL_GetKeyState</A 130 >SDL_GetKeyState</A
128 > &#8212; Get a snapshot of the current keyboard state</DT 131 >&nbsp;--&nbsp;Get a snapshot of the current keyboard state</DT
129 ><DT 132 ><DT
130 ><A 133 ><A
131 HREF="sdlgetmodstate.html" 134 HREF="sdlgetmodstate.html"
132 >SDL_GetModState</A 135 >SDL_GetModState</A
133 > &#8212; Get the state of modifier keys.</DT 136 >&nbsp;--&nbsp;Get the state of modifier keys.</DT
134 ><DT 137 ><DT
135 ><A 138 ><A
136 HREF="sdlsetmodstate.html" 139 HREF="sdlsetmodstate.html"
137 >SDL_SetModState</A 140 >SDL_SetModState</A
138 > &#8212; Set the current key modifier state</DT 141 >&nbsp;--&nbsp;Set the current key modifier state</DT
139 ><DT 142 ><DT
140 ><A 143 ><A
141 HREF="sdlgetkeyname.html" 144 HREF="sdlgetkeyname.html"
142 >SDL_GetKeyName</A 145 >SDL_GetKeyName</A
143 > &#8212; Get the name of an SDL virtual keysym</DT 146 >&nbsp;--&nbsp;Get the name of an SDL virtual keysym</DT
144 ><DT 147 ><DT
145 ><A 148 ><A
146 HREF="sdlenableunicode.html" 149 HREF="sdlenableunicode.html"
147 >SDL_EnableUNICODE</A 150 >SDL_EnableUNICODE</A
148 > &#8212; Enable UNICODE translation</DT 151 >&nbsp;--&nbsp;Enable UNICODE translation</DT
149 ><DT 152 ><DT
150 ><A 153 ><A
151 HREF="sdlenablekeyrepeat.html" 154 HREF="sdlenablekeyrepeat.html"
152 >SDL_EnableKeyRepeat</A 155 >SDL_EnableKeyRepeat</A
153 > &#8212; Set keyboard repeat rate.</DT 156 >&nbsp;--&nbsp;Set keyboard repeat rate.</DT
154 ><DT 157 ><DT
155 ><A 158 ><A
156 HREF="sdlgetmousestate.html" 159 HREF="sdlgetmousestate.html"
157 >SDL_GetMouseState</A 160 >SDL_GetMouseState</A
158 > &#8212; Retrieve the current state of the mouse</DT 161 >&nbsp;--&nbsp;Retrieve the current state of the mouse</DT
159 ><DT 162 ><DT
160 ><A 163 ><A
161 HREF="sdlgetrelativemousestate.html" 164 HREF="sdlgetrelativemousestate.html"
162 >SDL_GetRelativeMouseState</A 165 >SDL_GetRelativeMouseState</A
163 > &#8212; Retrieve the current state of the mouse</DT 166 >&nbsp;--&nbsp;Retrieve the current state of the mouse</DT
164 ><DT 167 ><DT
165 ><A 168 ><A
166 HREF="sdlgetappstate.html" 169 HREF="sdlgetappstate.html"
167 >SDL_GetAppState</A 170 >SDL_GetAppState</A
168 > &#8212; Get the state of the application</DT 171 >&nbsp;--&nbsp;Get the state of the application</DT
169 ><DT 172 ><DT
170 ><A 173 ><A
171 HREF="sdljoystickeventstate.html" 174 HREF="sdljoystickeventstate.html"
172 >SDL_JoystickEventState</A 175 >SDL_JoystickEventState</A
173 > &#8212; Enable/disable joystick event polling</DT 176 >&nbsp;--&nbsp;Enable/disable joystick event polling</DT
174 ></DL 177 ></DL
175 ></DIV 178 ></DIV
176 ><DIV 179 ><DIV
177 CLASS="INFORMALTABLE" 180 CLASS="INFORMALTABLE"
178 ><A 181 ><A
179 NAME="AEN4928" 182 NAME="AEN5312"
180 ></A 183 ></A
181 ><P 184 ><P
182 ></P 185 ></P
183 ><TABLE 186 ><TABLE
184 BORDER="0" 187 BORDER="0"
414 ><DIV 417 ><DIV
415 CLASS="NAVFOOTER" 418 CLASS="NAVFOOTER"
416 ><HR 419 ><HR
417 ALIGN="LEFT" 420 ALIGN="LEFT"
418 WIDTH="100%"><TABLE 421 WIDTH="100%"><TABLE
422 SUMMARY="Footer navigation table"
419 WIDTH="100%" 423 WIDTH="100%"
420 BORDER="0" 424 BORDER="0"
421 CELLPADDING="0" 425 CELLPADDING="0"
422 CELLSPACING="0" 426 CELLSPACING="0"
423 ><TR 427 ><TR
425 WIDTH="33%" 429 WIDTH="33%"
426 ALIGN="left" 430 ALIGN="left"
427 VALIGN="top" 431 VALIGN="top"
428 ><A 432 ><A
429 HREF="sdlkey.html" 433 HREF="sdlkey.html"
434 ACCESSKEY="P"
430 >Prev</A 435 >Prev</A
431 ></TD 436 ></TD
432 ><TD 437 ><TD
433 WIDTH="34%" 438 WIDTH="34%"
434 ALIGN="center" 439 ALIGN="center"
435 VALIGN="top" 440 VALIGN="top"
436 ><A 441 ><A
437 HREF="index.html" 442 HREF="index.html"
443 ACCESSKEY="H"
438 >Home</A 444 >Home</A
439 ></TD 445 ></TD
440 ><TD 446 ><TD
441 WIDTH="33%" 447 WIDTH="33%"
442 ALIGN="right" 448 ALIGN="right"
443 VALIGN="top" 449 VALIGN="top"
444 ><A 450 ><A
445 HREF="sdlpumpevents.html" 451 HREF="sdlpumpevents.html"
452 ACCESSKEY="N"
446 >Next</A 453 >Next</A
447 ></TD 454 ></TD
448 ></TR 455 ></TR
449 ><TR 456 ><TR
450 ><TD 457 ><TD
456 WIDTH="34%" 463 WIDTH="34%"
457 ALIGN="center" 464 ALIGN="center"
458 VALIGN="top" 465 VALIGN="top"
459 ><A 466 ><A
460 HREF="event.html" 467 HREF="event.html"
468 ACCESSKEY="U"
461 >Up</A 469 >Up</A
462 ></TD 470 ></TD
463 ><TD 471 ><TD
464 WIDTH="33%" 472 WIDTH="33%"
465 ALIGN="right" 473 ALIGN="right"