Mercurial > sdl-ios-xcode
annotate docs/man3/SDL_GL_SetAttribute.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_GL_SetAttribute" "3" "Tue 11 Sep 2001, 23:01" "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_GL_SetAttribute \- Set a special SDL/OpenGL attribute |
| 0 | 4 .SH "SYNOPSIS" |
| 5 .PP | |
| 6 \fB#include "SDL\&.h" | |
| 7 .sp | |
| 8 \fBint \fBSDL_GL_SetAttribute\fP\fR(\fBSDL_GLattr attr, int value\fR); | |
| 9 .SH "DESCRIPTION" | |
| 10 .PP | |
| 11 Sets the OpenGL \fIattribute\fR \fBattr\fR to \fBvalue\fR\&. The attributes you set don\&'t take effect until after a call to \fI\fBSDL_SetVideoMode\fP\fR\&. You should use \fI\fBSDL_GL_GetAttribute\fP\fR to check the values after a \fBSDL_SetVideoMode\fP call\&. | |
| 12 .SH "RETURN VALUE" | |
| 13 .PP | |
| 14 Returns \fB0\fR on success, or \fB-1\fR on error\&. | |
| 15 .SH "EXAMPLE" | |
| 16 .PP | |
| 17 .nf | |
| 18 \f(CWSDL_GL_SetAttribute( SDL_GL_RED_SIZE, 5 ); | |
| 19 SDL_GL_SetAttribute( SDL_GL_GREEN_SIZE, 5 ); | |
| 20 SDL_GL_SetAttribute( SDL_GL_BLUE_SIZE, 5 ); | |
| 21 SDL_GL_SetAttribute( SDL_GL_DEPTH_SIZE, 16 ); | |
| 22 SDL_GL_SetAttribute( SDL_GL_DOUBLEBUFFER, 1 ); | |
| 23 if ( (screen=SDL_SetVideoMode( 640, 480, 16, SDL_OPENGL )) == NULL ) { | |
| 24 fprintf(stderr, "Couldn\&'t set GL mode: %s | |
| 25 ", SDL_GetError()); | |
| 26 SDL_Quit(); | |
| 27 return; | |
| 28 }\fR | |
| 29 .fi | |
| 30 .PP | |
| 31 .PP | |
| 32 .RS | |
| 33 \fBNote: | |
| 34 .PP | |
| 35 The \fBSDL_DOUBLEBUF\fP flag is not required to enable double buffering when setting an OpenGL video mode\&. Double buffering is enabled or disabled using the SDL_GL_DOUBLEBUFFER attribute\&. | |
| 36 .RE | |
| 37 .SH "SEE ALSO" | |
| 38 .PP | |
| 39 \fI\fBSDL_GL_GetAttribute\fP\fR, \fIGL Attributes\fR | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
40 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 |