[sdl_omap.git] / docs / html / sdluserevent.html

<HTML
><HEAD
><TITLE
>SDL_UserEvent</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="SDL Event Structures."
HREF="eventstructures.html"><LINK
REL="PREVIOUS"
TITLE="SDL_SysWMEvent"
HREF="sdlsyswmevent.html"><LINK
REL="NEXT"
TITLE="SDL_QuitEvent"
HREF="sdlquitevent.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>SDL Library Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="sdlsyswmevent.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlquitevent.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLUSEREVENT"
></A
>SDL_UserEvent</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4565"
></A
><H2
>Name</H2
>SDL_UserEvent&nbsp;--&nbsp;A user-defined event type</DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4568"
></A
><H2
>Structure Definition</H2
><PRE
CLASS="PROGRAMLISTING"
>typedef struct{
  Uint8 type;
  int code;
  void *data1;
  void *data2;
} SDL_UserEvent;</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4571"
></A
><H2
>Structure Data</H2
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN4573"
></A
><P
></P
><TABLE
BORDER="0"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="STRUCTFIELD"
><I
>type</I
></TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="LITERAL"
>SDL_USEREVENT</TT
> through to <TT
CLASS="LITERAL"
>SDL_NUMEVENTS-1</TT
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="STRUCTFIELD"
><I
>code</I
></TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>User defined event code</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="STRUCTFIELD"
><I
>data1</I
></TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>User defined data pointer</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="STRUCTFIELD"
><I
>data2</I
></TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>User defined data pointer</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4594"
></A
><H2
>Description</H2
><P
><SPAN
CLASS="STRUCTNAME"
>SDL_UserEvent</SPAN
> is in the <TT
CLASS="STRUCTFIELD"
><I
>user</I
></TT
> member of the structure <A
HREF="sdlevent.html"
><SPAN
CLASS="STRUCTNAME"
>SDL_Event</SPAN
></A
>. 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
HREF="sdlpushevent.html"
><TT
CLASS="FUNCTION"
>SDL_PushEvent</TT
></A
>. The contents of the structure members or completely up to the programmer, the only requirement is that <TT
CLASS="STRUCTFIELD"
><I
>type</I
></TT
> is a value from <TT
CLASS="LITERAL"
>SDL_USEREVENT</TT
> to <TT
CLASS="LITERAL"
>SDL_NUMEVENTS-1</TT
> (inclusive).</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4606"
></A
><H2
>Examples</H2
><P
><PRE
CLASS="PROGRAMLISTING"
>SDL_Event event;

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