| 1 | .TH "SDL_GL_SetAttribute" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" |
| 2 | .SH "NAME" |
| 3 | SDL_GL_SetAttribute \- Set a special SDL/OpenGL attribute |
| 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 |
| 40 | .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 |