docs/man3/SDL_PushEvent.3
author Sam Lantinga <slouken@libsdl.org>
Wed, 08 Mar 2006 18:30:12 +0000
changeset 1486 9d77fc9d0ace
parent 181 e5bc29de3f0a
child 2283 546f7c1eb755
permissions -rw-r--r--
Re-added C runtime support for Visual C++ 5,6
slouken@181
     1
.TH "SDL_PushEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
slouken@0
     2
.SH "NAME"
slouken@0
     3
SDL_PushEvent\- Pushes an event onto the event queue
slouken@0
     4
.SH "SYNOPSIS"
slouken@0
     5
.PP
slouken@0
     6
\fB#include "SDL\&.h"
slouken@0
     7
.sp
slouken@0
     8
\fBint \fBSDL_PushEvent\fP\fR(\fBSDL_Event *event\fR);
slouken@0
     9
.SH "DESCRIPTION"
slouken@0
    10
.PP
slouken@0
    11
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\&.
slouken@0
    12
.PP
slouken@0
    13
.RS
slouken@0
    14
\fBNote:  
slouken@0
    15
.PP
slouken@0
    16
Pushing device input events onto the queue doesn\&'t modify the state of the device within SDL\&.
slouken@0
    17
.RE
slouken@0
    18
.SH "RETURN VALUE"
slouken@0
    19
.PP
slouken@0
    20
Returns \fB0\fR on success or \fB-1\fR if the event couldn\&'t be pushed\&.
slouken@0
    21
.SH "EXAMPLES"
slouken@0
    22
.PP
slouken@0
    23
See \fI\fBSDL_Event\fR\fR\&.
slouken@0
    24
.SH "SEE ALSO"
slouken@0
    25
.PP
slouken@0
    26
\fI\fBSDL_PollEvent\fP\fR, \fI\fBSDL_PeepEvents\fP\fR, \fI\fBSDL_Event\fR\fR
slouken@181
    27
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59