WebGL2RenderingContext.clearBuffer[fiuv]()

The WebGL2RenderingContext.clearBuffer[fiuv]() methods of the WebGL 2 API clear buffers from the currently bound framebuffer.

Syntax

void gl.clearBufferfv(buffer, drawbuffer, values, optional srcOffset);
void gl.clearBufferiv(buffer, drawbuffer, values, optional srcOffset);
void gl.clearBufferuiv(buffer, drawbuffer, values, optional srcOffset);
void gl.clearBufferfi(buffer, drawbuffer, depth, stencil);

Parameters

buffer

A GLenum specifying the buffer to clear. Possible values are:

  • gl.COLOR: Color buffer.
  • gl.DEPTH: Depth buffer.
  • gl.STENCIL: Stencil buffer.
  • gl.DEPTH_STENCIL: clears depth and stencil buffers (used with clearBufferfi).
drawBuffer

A GLint specifying the draw buffer to clear.

values

An Array of GLint, GLuint or GLfloat values or an Int32Array, Uint32Array or Float32Array specifying the values to clear to.

depth

A GLfloat specifying the value to clear a depth render buffer to.

stencil

A GLint specifying the value to clear the stencil render buffer to.

Return value

None.

Examples

gl.clearBufferiv(gl.COLOR, 0, new Int32Array([r, g, b, a]));
gl.clearBufferuiv(gl.COLOR, 0, new Uint32Array([r, g, b, a]));
gl.clearBufferfv(gl.COLOR, 0, new Float32Array([r, g, b, a]));
gl.clearBufferfv(gl.COLOR, 0, [0.0, 0.0, 0.0, 0.0]);
gl.clearBufferfi(gl.DEPTH_STENCIL, 0, 1.0, 0);

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
clearBuffer
56
79
51
No
43
15
58
58
51
43
15
7.0
SharedArrayBuffer_as_param
60
79
79
No
47
No
60
60
?
44
No
8.0

See also

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/clearBuffer