SDL_GL_GetAttribute

Use this function to get the actual value for an attribute from the current context.

Syntax

int SDL_GL_GetAttribute(SDL_GLattr attr,
                        int*       value)

Function Parameters

attr

the SDL_GLattr structure to query

value

a pointer filled in with the current value of attr

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Code Examples

You can add your code example here

Remarks

attr may be one of the following:

SDL_GL_RED_SIZE

the minimum number of bits for the red channel of the color buffer; defaults to 3

SDL_GL_GREEN_SIZE

the minimum number of bits for the green channel of the color buffer; defaults to 3

SDL_GL_BLUE_SIZE

the minimum number of bits for the blue channel of the color buffer; defaults to 2

SDL_GL_ALPHA_SIZE

the minimum number of bits for the alpha channel of the color buffer; defaults to 0

SDL_GL_BUFFER_SIZE

defaults to 0

SDL_GL_DOUBLEBUFFER

whether the output is single or double buffered; defaults to double buffering on

SDL_GL_DEPTH_SIZE

the minimum number of bits in the depth buffer; defaults to 16

SDL_GL_STENCIL_SIZE

the minimum number of bits in the stencil buffer; defaults to 0

SDL_GL_ACCUM_RED_SIZE

the minimum number of bits for the red channel of the accumulation buffer; defaults to 0

SDL_GL_ACCUM_GREEN_SIZE

the minimum number of bits for the green channel of the accumulation buffer; defaults to 0

SDL_GL_ACCUM_BLUE_SIZE

the minimum number of bits for the blue channel of the accumulation buffer; defaults to 0

SDL_GL_ACCUM_ALPHA_SIZE

the minimum number of bits for the alpha channel of the accumulation buffer; defaults to 0

SDL_GL_STEREO

whether the output is stereo 3D; defaults to off

SDL_GL_MULTISAMPLEBUFFERS

the number of buffers used for multisample anti-aliasing; defaults to 0; see Remarks for details

SDL_GL_MULTISAMPLESAMPLES

the number of samples used around the current pixel used for multisample anti-aliasing; defaults to 0; see Remarks for details

SDL_GL_ACCELERATED_VISUAL

set to 1 to require hardware acceleration, set to 0 to force software rendering; defaults to allow either

SDL_GL_RETAINED_BACKING

not used (deprecated)

SDL_GL_CONTEXT_MAJOR_VERSION

OpenGL context major version; see Remarks for details

SDL_GL_CONTEXT_MINOR_VERSION

OpenGL context minor version; see Remarks for details


CategoryAPI, CategoryVideo

SDL_GL_GetAttribute (last edited 2011-01-04 19:21:27 by SheenaSmith)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit