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