The WebGLRenderingContext.colorMask()
method of the WebGL API sets which color components to enable or to disable when drawing or rendering to a WebGLFramebuffer
.
Syntax
void gl.colorMask(red, green, blue, alpha);
Parameters
red
- A
GLboolean
specifying whether or not the red color component can be written into the frame buffer. Default value:true
. green
- A
GLboolean
specifying whether or not the green color component can be written into the frame buffer. Default value:true
. blue
- A
GLboolean
specifying whether or not the blue color component can be written into the frame buffer. Default value:true
. alpha
- A
GLboolean
specifying whether or not the alpha (transparency) component can be written into the frame buffer. Default value:true
.
Return value
None.
Examples
gl.colorMask(true, true, true, false);
To get the current color mask, query the COLOR_WRITEMASK
constant which returns an Array
.
gl.getParameter(gl.COLOR_WRITEMASK); // [true, true, true, false]
Specifications
Specification | Status | Comment |
---|---|---|
WebGL 1.0 The definition of 'colorMask' in that specification. |
Recommendation | Initial definition. |
OpenGL ES 2.0 The definition of 'glColorMask' in that specification. |
Standard | Man page of the OpenGL API. |
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.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
colorMask | 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 |
Legend
- Full support
- Full support