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
GLbooleanspecifying whether or not the red color component can be written into the frame buffer. Default value:true. green- A
GLbooleanspecifying whether or not the green color component can be written into the frame buffer. Default value:true. blue- A
GLbooleanspecifying whether or not the blue color component can be written into the frame buffer. Default value:true. alpha- A
GLbooleanspecifying 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.
| Feature | Chrome | Edge | Firefox | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|---|
| Basic support | 9 | 12 | 4 | 11 | 12 | 5.1 |
| Feature | Android webview | Chrome for Android | Edge mobile | Firefox for Android | Opera Android | iOS Safari | Samsung Internet |
|---|---|---|---|---|---|---|---|
| Basic support | Yes | 25 | Yes | Yes | 12 | 8.1 | Yes |