GLAPI/glGetRenderbufferParameter

From OpenGL.org
Jump to: navigation, search
glGetRenderbufferParameteriv
Core in version 4.4
Core since version 3.0

glGetRenderbufferParameteriv: retrieve information about a bound renderbuffer object

Function Definition

 void glGetRenderbufferParameteriv(GLenum target​, GLenum pname​, GLint *params​);
target
Specifies the target of the query operation. target​ must be GL_RENDERBUFFER​.
pname
Specifies the parameter whose value to retrieve from the renderbuffer bound to target​.
params
Specifies the address of an array to receive the value of the queried parameter.

Description

glGetRenderbufferParameteriv retrieves information about a bound renderbuffer object. target​ specifies the target of the query operation and must be GL_RENDERBUFFER​. pname​ specifies the parameter whose value to query and must be one of GL_RENDERBUFFER_WIDTH​, GL_RENDERBUFFER_HEIGHT​, GL_RENDERBUFFER_INTERNAL_FORMAT​, GL_RENDERBUFFER_RED_SIZE​, GL_RENDERBUFFER_GREEN_SIZE​, GL_RENDERBUFFER_BLUE_SIZE​, GL_RENDERBUFFER_ALPHA_SIZE​, GL_RENDERBUFFER_DEPTH_SIZE​, GL_RENDERBUFFER_DEPTH_SIZE​, GL_RENDERBUFFER_STENCIL_SIZE​, or GL_RENDERBUFFER_SAMPLES​.

Upon a successful return from glGetRenderbufferParameteriv, if pname​ is GL_RENDERBUFFER_WIDTH​, GL_RENDERBUFFER_HEIGHT​, GL_RENDERBUFFER_INTERNAL_FORMAT​, or GL_RENDERBUFFER_SAMPLES​, then params​ will contain the width in pixels, the height in pixels, the internal format, or the number of samples, respectively, of the image of the renderbuffer currently bound to target​.

If pname​ is GL_RENDERBUFFER_RED_SIZE​, GL_RENDERBUFFER_GREEN_SIZE​, GL_RENDERBUFFER_BLUE_SIZE​, GL_RENDERBUFFER_ALPHA_SIZE​, GL_RENDERBUFFER_DEPTH_SIZE​, or GL_RENDERBUFFER_STENCIL_SIZE​, then params​ will contain the actual resolutions (not the resolutions specified when the image array was defined) for the red, green, blue, alpha depth, or stencil components, respectively, of the image of the renderbuffer currently bound to target​.

Errors

GL_INVALID_ENUM​ is generated if pname​ is not one of the accepted tokens.

See Also

glBindRenderbuffer, glFramebufferRenderbuffer,

Copyright

Copyright © 2010 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.