Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_GL_SetAttribute (3)

Name

SDL_GL_SetAttribute - Set a special SDL/OpenGL attribute

Synopsis

#include "SDL.h"

int SDL_GL_SetAttribute(SDL_GLattr attr, int value);

Description

SDL_GL_SetAttribute(3)         SDL API Reference        SDL_GL_SetAttribute(3)



NAME
       SDL_GL_SetAttribute - Set a special SDL/OpenGL attribute

SYNOPSIS
       #include "SDL.h"

       int SDL_GL_SetAttribute(SDL_GLattr attr, int value);

DESCRIPTION
       Sets  the  OpenGL attribute attr to value. The attributes you set don't
       take effect until after a call  to  SDL_SetVideoMode.  You  should  use
       SDL_GL_GetAttribute to check the values after a SDL_SetVideoMode call.

RETURN VALUE
       Returns 0 on success, or -1 on error.

EXAMPLE
       SDL_GL_SetAttribute( SDL_GL_RED_SIZE, 5 );
       SDL_GL_SetAttribute( SDL_GL_GREEN_SIZE, 5 );
       SDL_GL_SetAttribute( SDL_GL_BLUE_SIZE, 5 );
       SDL_GL_SetAttribute( SDL_GL_DEPTH_SIZE, 16 );
       SDL_GL_SetAttribute( SDL_GL_DOUBLEBUFFER, 1 );
       if ( (screen=SDL_SetVideoMode( 640, 480, 16, SDL_OPENGL )) == NULL ) {
         fprintf(stderr, "Couldn't set GL mode: %s
       ", SDL_GetError());
         SDL_Quit();
         return;
       }

              Note:

              The  SDL_DOUBLEBUF flag is not required to enable double buffer-
              ing when setting an  OpenGL  video  mode.  Double  buffering  is
              enabled or disabled using the SDL_GL_DOUBLEBUFFER attribute.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_GL_GetAttribute, GL Attributes



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source        was        downloaded        from        https://www.lib-
       sdl.org/release/SDL-1.2.15.tar.gz

       Further information about this software can be found on the open source
       community website at https://www.libsdl.org/.



SDL                         Tue 11 Sep 2001, 23:01      SDL_GL_SetAttribute(3)