Skip to content

Latest commit

 

History

History
27 lines (27 loc) · 954 Bytes

SDL_PushEvent.3

File metadata and controls

27 lines (27 loc) · 954 Bytes
 
1
.TH "SDL_PushEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
2
.SH "NAME"
3
SDL_PushEvent \- Pushes an event onto the event queue
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
.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
27
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59