aboutsummaryrefslogtreecommitdiffstats
path: root/distrib/sdl-1.2.15/docs/man3/SDL_UserEvent.3
diff options
context:
space:
mode:
authorSteve Kondik <shade@chemlab.org>2012-11-18 15:47:18 -0800
committerSteve Kondik <shade@chemlab.org>2012-11-18 15:47:18 -0800
commita546c7006355a7bd1df4267ee53d0bfa2c017c8c (patch)
tree01be0bf6c0d6968e1468ec9661fd52110f9b05a7 /distrib/sdl-1.2.15/docs/man3/SDL_UserEvent.3
parentbaf3d7830396202df5cc47bd7bcee109c319cdb3 (diff)
parent0f809250987b64f491bd3b4b73c0f0d33036a786 (diff)
downloadexternal_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.zip
external_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.tar.gz
external_qemu-a546c7006355a7bd1df4267ee53d0bfa2c017c8c.tar.bz2
Merge branch 'jb-mr1-release' of https://android.googlesource.com/platform/external/qemu into mr1-staging
Change-Id: I8a4a71ac65b08e6e17f26c942f67a15b85211115
Diffstat (limited to 'distrib/sdl-1.2.15/docs/man3/SDL_UserEvent.3')
-rw-r--r--distrib/sdl-1.2.15/docs/man3/SDL_UserEvent.347
1 files changed, 47 insertions, 0 deletions
diff --git a/distrib/sdl-1.2.15/docs/man3/SDL_UserEvent.3 b/distrib/sdl-1.2.15/docs/man3/SDL_UserEvent.3
new file mode 100644
index 0000000..d92ec53
--- /dev/null
+++ b/distrib/sdl-1.2.15/docs/man3/SDL_UserEvent.3
@@ -0,0 +1,47 @@
+.TH "SDL_UserEvent" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
+.SH "NAME"
+SDL_UserEvent \- A user-defined event type
+.SH "STRUCTURE DEFINITION"
+.PP
+.nf
+\f(CWtypedef struct{
+ Uint8 type;
+ int code;
+ void *data1;
+ void *data2;
+} SDL_UserEvent;\fR
+.fi
+.PP
+.SH "STRUCTURE DATA"
+.TP 20
+\fBtype\fR
+\fBSDL_USEREVENT\fP through to \fBSDL_NUMEVENTS-1\fP
+.TP 20
+\fBcode\fR
+User defined event code
+.TP 20
+\fBdata1\fR
+User defined data pointer
+.TP 20
+\fBdata2\fR
+User defined data pointer
+.SH "DESCRIPTION"
+.PP
+\fBSDL_UserEvent\fR is in the \fBuser\fR member of the structure \fI\fBSDL_Event\fR\fR\&. 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 \fI\fBSDL_PushEvent\fP\fR\&. The contents of the structure members or completely up to the programmer, the only requirement is that \fBtype\fR is a value from \fBSDL_USEREVENT\fP to \fBSDL_NUMEVENTS-1\fP (inclusive)\&.
+.SH "EXAMPLES"
+.PP
+.PP
+.nf
+\f(CWSDL_Event event;
+
+event\&.type = SDL_USEREVENT;
+event\&.user\&.code = my_event_code;
+event\&.user\&.data1 = significant_data;
+event\&.user\&.data2 = 0;
+SDL_PushEvent(&event);\fR
+.fi
+.PP
+.SH "SEE ALSO"
+.PP
+\fI\fBSDL_Event\fR\fR, \fI\fBSDL_PushEvent\fP\fR
+.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00