Firefox Tomorrow

web api instance method

WebGLRenderingContext: colorMask() method

View on MDN ↗

Available in 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

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

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

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.

See also