WebGLRenderingContext.clearColor()

The WebGLRenderingContext.clearColor() method of the WebGL API specifies the color values used when clearing color buffers.

This specifies what color values to use when calling the clear() method. The values are clamped between 0 and 1.

Syntax

JavaScript
void <var>gl</var>.clearColor(<var>red, green, blue, alpha</var>);

Parameters

red
A GLclampf specifying the red color value used when the color buffers are cleared. Default value: 0.
green
A GLclampf specifying the green color value used when the color buffers are cleared. Default value: 0.
blue
A GLclampf specifying the blue color value used when the color buffers are cleared. Default value: 0.
alpha
A GLclampf specifying the alpha (transparency) value used when the color buffers are cleared. Default value: 0.

Return value

None.

Examples

JavaScript
gl.clearColor(1, 0.5, 0.5, 3);

To get the current clear color, query the COLOR_CLEAR_VALUE constant which returns a Float32Array.

JavaScript
gl.getParameter(gl.COLOR_CLEAR_VALUE);
// Float32Array[1, 0.5, 0.5, 1]

Specifications

Specification Status Comment
WebGL 1.0
The definition of 'clearColor' in that specification.
Recommendation Initial definition.
OpenGL ES 2.0
The definition of 'glClearColor' in that specification.
Standard Man page of the OpenGL API.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support 9 4.0 (2.0) 11 12 5.1
Feature Android Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support ? 25 (Yes) ? 12 8.1

See also

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/webglrenderingcontext/clearcolor

API Method Reference WebGL WebGLRenderingContext