Mercurial > sdl-ios-xcode
view docs/man3/SDL_PushEvent.3 @ 55:55f1f1b3e27d
Added new docs for SDL 1.2.1
author | Sam Lantinga <slouken@lokigames.com> |
---|---|
date | Sun, 10 Jun 2001 19:31:57 +0000 |
parents | 74212992fb08 |
children | e5bc29de3f0a |
line wrap: on
line source
.TH "SDL_PushEvent" "3" "Sun 10 Jun 2001, 19:40" "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, Sun 10 Jun 2001, 19:40