WebGLRenderingContext.getRenderbufferParameter()
The WebGLRenderingContext.getRenderbufferParameter()
method of the WebGL API returns information
about the renderbuffer.
Syntax
any gl.getRenderbufferParameter(target, pname);
Parameters
- target
- A
Glenum
specifying the target renderbuffer object. Possible values:gl.RENDERBUFFER
: Buffer data storage for single images in a renderable internal format.
- pname
- A
Glenum
specifying the information to query. Possible values:gl.RENDERBUFFER_WIDTH
: Returns aGLint
indicating the width of the image of the currently bound renderbuffer.gl.RENDERBUFFER_HEIGHT
: Returns aGLint
indicating the height of the image of the currently bound renderbuffer.gl.RENDERBUFFER_INTERNAL_FORMAT
: Returns aGLenum
indicating the internal format of the currently bound renderbuffer. The default isgl.RGBA4
. Possible return values:gl.RGBA4
: 4 red bits, 4 green bits, 4 blue bits 4 alpha bits.gl.RGB565
: 5 red bits, 6 green bits, 5 blue bits.gl.RGB5_A1
: 5 red bits, 5 green bits, 5 blue bits, 1 alpha bit.gl.DEPTH_COMPONENT16
: 16 depth bits.gl.STENCIL_INDEX8
: 8 stencil bits.
gl.RENDERBUFFER_GREEN_SIZE
: Returns aGLint
that is the resolution size (in bits) for the green color.gl.RENDERBUFFER_BLUE_SIZE
: Returns aGLint
that is the resolution size (in bits) for the blue color.gl.RENDERBUFFER_RED_SIZE
: Returns aGLint
that is the resolution size (in bits) for the red color.gl.RENDERBUFFER_ALPHA_SIZE
: Returns aGLint
that is the resolution size (in bits) for the alpha component.gl.RENDERBUFFER_DEPTH_SIZE
: Returns aGLint
that is the resolution size (in bits) for the depth component.gl.RENDERBUFFER_STENCIL_SIZE
: Returns aGLint
that is the resolution size (in bits) for the stencil component.- When using a WebGL 2 context,
the following value is available additionally:
gl.RENDERBUFFER_SAMPLES
: Returns aGLint
indicating the number of samples of the image of the currently bound renderbuffer.
Return value
Examples
gl.getRenderbufferParameter(gl.RENDERBUFFER, gl.RENDERBUFFER_WIDTH);
Specifications
Specification | Status | Comment |
---|---|---|
WebGL 1.0 The definition of 'getRenderbufferParameter' in that specification. |
Recommendation | Initial definition for WebGL. |
OpenGL ES 2.0 The definition of 'glGetRenderbufferParameteriv' in that specification. |
Standard | Man page of the (similar) OpenGL API. |
WebGL 2.0 The definition of 'getRenderbufferParameter' in that specification. |
Editor's Draft | Updated definition for WebGL 2. |
OpenGL ES 3.0 The definition of 'glGetRenderbufferParameteriv' in that specification. |
Standard | Man page of the (similar) OpenGL ES 3 API. Adds a new pname value:gl.RENDERBUFFER_SAMPLES
|
Browser compatibility
BCD tables only load in the browser
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.