GLGETRENDERBUFFERPAR

Section: [FIXME: manual] (3G)
Updated: 01/26/2021
Page Index
 

NAME

glGetRenderbufferParameteriv, glGetNamedRenderbufferParameteriv - query a named parameter of a renderbuffer object  

C SPECIFICATION

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

PARAMETERS

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

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 or GL_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 or GL_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

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

 OpenGL Version
Function / Feature Name 2.0 2.1 3.0 3.1 3.2 3.3 4.0 4.1 4.2 4.3 4.4 4.5
glGetNamedRenderbufferParameteriv - - - - - - - - - - - ✔
glGetRenderbufferParameteriv - - ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔

 

SEE ALSO

glGenRenderbuffers(), glFramebufferRenderbuffer(), glBindRenderbuffer(), glRenderbufferStorage(), glRenderbufferStorageMultisample()  

COPYRIGHT

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. m[blue]http://opencontent.org/openpub/m[].  

COPYRIGHT


Copyright © 2010-2014 Khronos Group

 

Index

NAME
C SPECIFICATION
PARAMETERS
DESCRIPTION
ERRORS
VERSION SUPPORT
SEE ALSO
COPYRIGHT
COPYRIGHT