diff docs/man3/SDL_PushEvent.3 @ 0:74212992fb08

Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man3/SDL_PushEvent.3	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,27 @@
+.TH "SDL_PushEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" 
+.SH "NAME"
+SDL_PushEvent\- Pushes an event onto the event queue
+.SH "SYNOPSIS"
+.PP
+\fB#include "SDL\&.h"
+.sp
+\fBint \fBSDL_PushEvent\fP\fR(\fBSDL_Event *event\fR);
+.SH "DESCRIPTION"
+.PP
+The event queue can actually be used as a two way communication channel\&. Not only can events be read from the queue, but the user can also push their own events onto it\&. \fBevent\fR is a pointer to the event structure you wish to push onto the queue\&.
+.PP
+.RS
+\fBNote:  
+.PP
+Pushing device input events onto the queue doesn\&'t modify the state of the device within SDL\&.
+.RE
+.SH "RETURN VALUE"
+.PP
+Returns \fB0\fR on success or \fB-1\fR if the event couldn\&'t be pushed\&.
+.SH "EXAMPLES"
+.PP
+See \fI\fBSDL_Event\fR\fR\&.
+.SH "SEE ALSO"
+.PP
+\fI\fBSDL_PollEvent\fP\fR, \fI\fBSDL_PeepEvents\fP\fR, \fI\fBSDL_Event\fR\fR
+...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03