Web/API/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 a
GLint
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:
- Returns a
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 a
GLint
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:
- Returns a
gl.RENDERBUFFER_SAMPLES
- Returns a
GLint
indicating the number of samples of the image of the currently bound renderbuffer.
- Returns a
Return value
Depends on the requested information (as specified with pname
). Either a GLint
or a GLenum
.
Examples
gl.getRenderbufferParameter(gl.RENDERBUFFER, gl.RENDERBUFFER_WIDTH);
Specifications
Specification | Status | Comment |
WebGL 1.0The definition of 'getRenderbufferParameter' in that specification. | Recommendation | Initial definition for WebGL. |
OpenGL ES 2.0The definition of 'glGetRenderbufferParameteriv' in that specification. | Standard | Man page of the (similar) OpenGL API. |
WebGL 2.0The definition of 'getRenderbufferParameter' in that specification. | Editor's Draft | Updated definition for WebGL 2. |
OpenGL ES 3.0The definition of 'glGetRenderbufferParameteriv' in that specification. | Standard | Man page of the (similar) OpenGL ES 3 API.
Adds a new |
Browser compatibility
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.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
getRenderbufferParameter
|
Chrome
Full support 9 |
Edge
Full support 12 |
Firefox
Full support 4 |
IE
Full support 11 |
Opera
Full support 12 |
Safari
Full support 5.1 |
WebView Android
Full support Yes |
Chrome Android
Full support 25 |
Firefox Android
Full support Yes |
Opera Android
Full support 12 |
Safari iOS
Full support 8 |
Samsung Internet Android
Full support 1.5 |
WebGL2
|
Chrome
Full support 56 |
Edge
Full support 79 |
Firefox
Full support 51 |
IE
No support No |
Opera
Full support 43 |
Safari
No support No |
WebView Android
Full support 58 |
Chrome Android
Full support 58 |
Firefox Android
Full support 51 |
Opera Android
Full support 43 |
Safari iOS
No support No |
Samsung Internet Android
Full support 7.0 |
Legend
- Full support
- Full support
- No support
- No support
See also
WebGLRenderingContext.bindRenderbuffer()
WebGLRenderingContext.createRenderbuffer()
WebGLRenderingContext.deleteRenderbuffer()
WebGLRenderingContext.renderbufferStorage()
- Other buffers:
WebGLBuffer
,WebGLFramebuffer
WebGLRenderingContext.getRenderbufferParameter() by Mozilla Contributors is licensed under CC-BY-SA 2.5.