• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_UserEvent</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="SDL Event Structures."
14HREF="eventstructures.html"><LINK
15REL="PREVIOUS"
16TITLE="SDL_SysWMEvent"
17HREF="sdlsyswmevent.html"><LINK
18REL="NEXT"
19TITLE="SDL_QuitEvent"
20HREF="sdlquitevent.html"></HEAD
21><BODY
22CLASS="REFENTRY"
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="sdlsyswmevent.html"
49ACCESSKEY="P"
50>Prev</A
51></TD
52><TD
53WIDTH="80%"
54ALIGN="center"
55VALIGN="bottom"
56></TD
57><TD
58WIDTH="10%"
59ALIGN="right"
60VALIGN="bottom"
61><A
62HREF="sdlquitevent.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLUSEREVENT"
74></A
75>SDL_UserEvent</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN4565"
80></A
81><H2
82>Name</H2
83>SDL_UserEvent&nbsp;--&nbsp;A user-defined event type</DIV
84><DIV
85CLASS="REFSECT1"
86><A
87NAME="AEN4568"
88></A
89><H2
90>Structure Definition</H2
91><PRE
92CLASS="PROGRAMLISTING"
93>typedef struct{
94  Uint8 type;
95  int code;
96  void *data1;
97  void *data2;
98} SDL_UserEvent;</PRE
99></DIV
100><DIV
101CLASS="REFSECT1"
102><A
103NAME="AEN4571"
104></A
105><H2
106>Structure Data</H2
107><DIV
108CLASS="INFORMALTABLE"
109><A
110NAME="AEN4573"
111></A
112><P
113></P
114><TABLE
115BORDER="0"
116CLASS="CALSTABLE"
117><TBODY
118><TR
119><TD
120ALIGN="LEFT"
121VALIGN="TOP"
122><TT
123CLASS="STRUCTFIELD"
124><I
125>type</I
126></TT
127></TD
128><TD
129ALIGN="LEFT"
130VALIGN="TOP"
131><TT
132CLASS="LITERAL"
133>SDL_USEREVENT</TT
134> through to <TT
135CLASS="LITERAL"
136>SDL_NUMEVENTS-1</TT
137></TD
138></TR
139><TR
140><TD
141ALIGN="LEFT"
142VALIGN="TOP"
143><TT
144CLASS="STRUCTFIELD"
145><I
146>code</I
147></TT
148></TD
149><TD
150ALIGN="LEFT"
151VALIGN="TOP"
152>User defined event code</TD
153></TR
154><TR
155><TD
156ALIGN="LEFT"
157VALIGN="TOP"
158><TT
159CLASS="STRUCTFIELD"
160><I
161>data1</I
162></TT
163></TD
164><TD
165ALIGN="LEFT"
166VALIGN="TOP"
167>User defined data pointer</TD
168></TR
169><TR
170><TD
171ALIGN="LEFT"
172VALIGN="TOP"
173><TT
174CLASS="STRUCTFIELD"
175><I
176>data2</I
177></TT
178></TD
179><TD
180ALIGN="LEFT"
181VALIGN="TOP"
182>User defined data pointer</TD
183></TR
184></TBODY
185></TABLE
186><P
187></P
188></DIV
189></DIV
190><DIV
191CLASS="REFSECT1"
192><A
193NAME="AEN4594"
194></A
195><H2
196>Description</H2
197><P
198><SPAN
199CLASS="STRUCTNAME"
200>SDL_UserEvent</SPAN
201> is in the <TT
202CLASS="STRUCTFIELD"
203><I
204>user</I
205></TT
206> member of the structure <A
207HREF="sdlevent.html"
208><SPAN
209CLASS="STRUCTNAME"
210>SDL_Event</SPAN
211></A
212>. This event is unique, it is never created by SDL but only by the user. The event can be pushed onto the event queue using <A
213HREF="sdlpushevent.html"
214><TT
215CLASS="FUNCTION"
216>SDL_PushEvent</TT
217></A
218>. The contents of the structure members or completely up to the programmer, the only requirement is that <TT
219CLASS="STRUCTFIELD"
220><I
221>type</I
222></TT
223> is a value from <TT
224CLASS="LITERAL"
225>SDL_USEREVENT</TT
226> to <TT
227CLASS="LITERAL"
228>SDL_NUMEVENTS-1</TT
229> (inclusive).</P
230></DIV
231><DIV
232CLASS="REFSECT1"
233><A
234NAME="AEN4606"
235></A
236><H2
237>Examples</H2
238><P
239><PRE
240CLASS="PROGRAMLISTING"
241>SDL_Event event;
242
243event.type = SDL_USEREVENT;
244event.user.code = my_event_code;
245event.user.data1 = significant_data;
246event.user.data2 = 0;
247SDL_PushEvent(&#38;event);</PRE
248></P
249></DIV
250><DIV
251CLASS="REFSECT1"
252><A
253NAME="AEN4610"
254></A
255><H2
256>See Also</H2
257><P
258><A
259HREF="sdlevent.html"
260><SPAN
261CLASS="STRUCTNAME"
262>SDL_Event</SPAN
263></A
264>,
265<A
266HREF="sdlpushevent.html"
267><TT
268CLASS="FUNCTION"
269>SDL_PushEvent</TT
270></A
271></P
272></DIV
273><DIV
274CLASS="NAVFOOTER"
275><HR
276ALIGN="LEFT"
277WIDTH="100%"><TABLE
278SUMMARY="Footer navigation table"
279WIDTH="100%"
280BORDER="0"
281CELLPADDING="0"
282CELLSPACING="0"
283><TR
284><TD
285WIDTH="33%"
286ALIGN="left"
287VALIGN="top"
288><A
289HREF="sdlsyswmevent.html"
290ACCESSKEY="P"
291>Prev</A
292></TD
293><TD
294WIDTH="34%"
295ALIGN="center"
296VALIGN="top"
297><A
298HREF="index.html"
299ACCESSKEY="H"
300>Home</A
301></TD
302><TD
303WIDTH="33%"
304ALIGN="right"
305VALIGN="top"
306><A
307HREF="sdlquitevent.html"
308ACCESSKEY="N"
309>Next</A
310></TD
311></TR
312><TR
313><TD
314WIDTH="33%"
315ALIGN="left"
316VALIGN="top"
317>SDL_SysWMEvent</TD
318><TD
319WIDTH="34%"
320ALIGN="center"
321VALIGN="top"
322><A
323HREF="eventstructures.html"
324ACCESSKEY="U"
325>Up</A
326></TD
327><TD
328WIDTH="33%"
329ALIGN="right"
330VALIGN="top"
331>SDL_QuitEvent</TD
332></TR
333></TABLE
334></DIV
335></BODY
336></HTML
337>