web api instance method
WebGLRenderingContext: getRenderbufferParameter() method
Available in workers
The WebGLRenderingContext.getRenderbufferParameter()
method of the WebGL API returns information
about the renderbuffer.
Syntax
getRenderbufferParameter(target, pname)
Parameters
-
target- : A
GLenumspecifying the target renderbuffer object. Possible values:gl.RENDERBUFFER- : Buffer data storage for single images in a renderable internal format.
- : A
-
pname-
: A
GLenumspecifying the information to query. Possible values:-
gl.RENDERBUFFER_WIDTH- : Returns a
GLintindicating the width of the image of the currently bound renderbuffer.
- : Returns a
-
gl.RENDERBUFFER_HEIGHT- : Returns a
GLintindicating the height of the image of the currently bound renderbuffer.
- : Returns a
-
gl.RENDERBUFFER_INTERNAL_FORMAT- : Returns a
GLenumindicating 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.
- : Returns a
-
gl.RENDERBUFFER_GREEN_SIZE- : Returns a
GLintthat is the resolution size (in bits) for the green color.
- : Returns a
-
gl.RENDERBUFFER_BLUE_SIZE- : Returns a
GLintthat is the resolution size (in bits) for the blue color.
- : Returns a
-
gl.RENDERBUFFER_RED_SIZE- : Returns a
GLintthat is the resolution size (in bits) for the red color.
- : Returns a
-
gl.RENDERBUFFER_ALPHA_SIZE- : Returns a
GLintthat is the resolution size (in bits) for the alpha component.
- : Returns a
-
gl.RENDERBUFFER_DEPTH_SIZE- : Returns a
GLintthat is the resolution size (in bits) for the depth component.
- : Returns a
-
gl.RENDERBUFFER_STENCIL_SIZE- : Returns a
GLintthat is the resolution size (in bits) for the stencil component.
- : Returns a
When using a
WebGL 2 context, the following value is available additionally:gl.RENDERBUFFER_SAMPLES- : Returns a
GLintindicating 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
SpecificationsStandards references are available on the canonical MDN page.
Browser compatibility
Browser compatibilityCompatibility data is available on the canonical MDN page.