WebGLRenderingContext: colorMask() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

Note: This feature is available in Web Workers.

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

js
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 (undefined).

Examples

js
gl.colorMask(true, true, true, false);

To get the current color mask, query the COLOR_WRITEMASK constant which returns an Array.

js
gl.getParameter(gl.COLOR_WRITEMASK);
// [true, true, true, false]

Specifications

Specification
WebGL Specification
# 5.14.3

Browser compatibility

BCD tables only load in the browser

See also