Mercurial > sdl-ios-xcode
annotate docs/man3/SDL_PollEvent.3 @ 4107:4e3b250c950e SDL-1.2
Erik Heckers fixed bug #493
Searching the installed man pages for SDL functions fails, e.g.
man -k SDL_ |grep Video
After investigating this I found that "makewhatis", the tool that generates
the "whatis" database, reads the SDL_* man pages, but doesn't produce
entries in the "whatis" database for the SDL_* man pages.
After some more debugging I found the reason is a missing space.
After editing SDL_Init.3(.gz) and replacing
SDL_Init\- Initializes SDL
with
SDL_Init \- Initializes SDL
everything works fine.
After running "makewhatis" I can successfully do a
man -k SDL_
and SDL_Init is listed in the output.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Sat, 29 Dec 2007 02:34:53 +0000 |
| parents | e5bc29de3f0a |
| children | 1238da4a7112 |
| rev | line source |
|---|---|
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
1 .TH "SDL_PollEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" |
| 0 | 2 .SH "NAME" |
|
4107
4e3b250c950e
Erik Heckers fixed bug #493
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
3 SDL_PollEvent \- Polls for currently pending events\&. |
| 0 | 4 .SH "SYNOPSIS" |
| 5 .PP | |
| 6 \fB#include "SDL\&.h" | |
| 7 .sp | |
| 8 \fBint \fBSDL_PollEvent\fP\fR(\fBSDL_Event *event\fR); | |
| 9 .SH "DESCRIPTION" | |
| 10 .PP | |
| 11 Polls for currently pending events, and returns \fB1\fR if there are any pending events, or \fB0\fR if there are none available\&. | |
| 12 .PP | |
| 13 If \fBevent\fR is not \fBNULL\fP, the next event is removed from the queue and stored in that area\&. | |
| 14 .SH "EXAMPLES" | |
| 15 .PP | |
| 16 .PP | |
| 17 .nf | |
| 18 \f(CWSDL_Event event; /* Event structure */ | |
| 19 | |
| 20 \&. | |
| 21 \&. | |
| 22 \&. | |
| 23 /* Check for events */ | |
| 24 while(SDL_PollEvent(&event)){ /* Loop until there are no events left on the queue */ | |
| 25 switch(event\&.type){ /* Process the appropiate event type */ | |
| 26 case SDL_KEYDOWN: /* Handle a KEYDOWN event */ | |
| 27 printf("Oh! Key press | |
| 28 "); | |
| 29 break; | |
| 30 case SDL_MOUSEMOTION: | |
| 31 \&. | |
| 32 \&. | |
| 33 \&. | |
| 34 default: /* Report an unhandled event */ | |
| 35 printf("I don\&'t know what this event is! | |
| 36 "); | |
| 37 } | |
| 38 }\fR | |
| 39 .fi | |
| 40 .PP | |
| 41 .SH "SEE ALSO" | |
| 42 .PP | |
| 43 \fI\fBSDL_Event\fR\fR, \fI\fBSDL_WaitEvent\fP\fR, \fI\fBSDL_PeepEvents\fP\fR | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
44 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 |