The WebGLRenderingContext.colorMask()
method of the WebGL API sets which color components to enable or to disable when drawing or rendering to a WebGLFramebuffer
.
WebGLRenderingContext.colorMask()
Syntax
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 |
---|
WebGL Specification # 5.14.3 |
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 | |
colorMask |
9
|
12
|
4
|
11
|
12
|
5.1
|
4.4.3
|
25
|
4
|
12
|
8
|
1.5
|
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/WebGLRenderingContext/colorMask