WebGLRenderingContext.colorMask()
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
JavaScript
Copy Code
void <var>gl</var>.colorMask(<var>red, green, blue, alpha</var>);
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
JavaScript
Copy Code
gl.colorMask(true, true, true, false);
To get the current color mask, query the COLOR_WRITEMASK
constant which returns an Array
.
JavaScript
Copy Code
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
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/colormask