glGetRenderbufferParameter

From OpenGL Reference
Jump to navigation Jump to search

Query a named parameter of a renderbuffer object.

C Specification[edit]

void glGetRenderbufferParameteriv( GLenum target, GLenum pname, GLint * params );
void glGetNamedRenderbufferParameteriv( GLuint renderbuffer, GLenum pname, GLint * params );


Parameters[edit]

target - Specifies the target to which the renderbuffer object is bound for glGetRenderbufferParameteriv . target must be GL_RENDERBUFFER .
renderbuffer - Specifies the name of the renderbuffer object for glGetNamedRenderbufferParameteriv .
pname - Specifies the parameter of the renderbuffer object to query.
params - Returns the value of parameter pname for the renderbuffer object.


Description[edit]

 glGetRenderbufferParameteriv and glGetNamedRenderbufferParameteriv query parameters of a specified renderbuffer object.

For glGetRenderbufferParameteriv , the renderbuffer object is that bound to target , which must be GL_RENDERBUFFER .

For glGetNamedRenderbufferParameteriv , renderbuffer is the name of the renderbuffer object.

Upon successful return, param will contain the value of the renderbuffer parameter specified by pname , as described below.


GL_RENDERBUFFER_WIDTH ,GL_RENDERBUFFER_HEIGHT ,GL_RENDERBUFFER_INTERNAL_FORMAT orGL_RENDERBUFFER_SAMPLES  -  params returns the width in pixels, the height in pixels, internal format, or the number of samples, respectively, of the image of the specified renderbuffer object.
GL_RENDERBUFFER_RED_SIZE ,GL_RENDERBUFFER_GREEN_SIZE ,GL_RENDERBUFFER_BLUE_SIZE ,GL_RENDERBUFFER_ALPHA_SIZE ,GL_RENDERBUFFER_DEPTH_SIZE orGL_RENDERBUFFER_STENCIL_SIZE  -  params returns the actual resolution in bits (not the resolution specified when the image was defined) for the red, green, blue, alpha, depth or stencil components, respectively, of the image of the renderbuffer object.


Errors[edit]

 GL_INVALID_ENUM is generated by glGetRenderbufferParameteriv if target is not GL_RENDERBUFFER .

 GL_INVALID_OPERATION is generated by glGetRenderbufferParameteriv if zero is bound to target .

 GL_INVALID_OPERATION is generated by glGetNamedRenderbufferParameteriv if renderbuffer is not the name of an existing renderbuffer object.

 GL_INVALID_ENUM is generated if pname is not one of the accepted parameter names described above.


Version Support[edit]

 glGetNamedRenderbufferParameteriv  4.5+
 glGetRenderbufferParameteriv  3.0+

See Also[edit]

 glGenRenderbuffers , glFramebufferRenderbuffer , glBindRenderbuffer , glRenderbufferStorage , glRenderbufferStorageMultisample 


Copyright[edit]

Copyright© 2010-2014 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/.