WebGLRenderingContext.depthMask()

The WebGLRenderingContext.depthMask() method of the WebGL API sets whether writing into the depth buffer is enabled or disabled.

Syntax

JavaScript
void <var>gl</var>.depthMask(<var>flag</var>);

Parameters

flag
A GLboolean specifying whether or not writing into the depth buffer is enabled. Default value: true, meaning that writing is enabled.

Return value

None.

Examples

JavaScript
gl.depthMask(false);

To get the current depth mask, query the DEPTH_WRITEMASK constant which returns a Boolean.

JavaScript
gl.getParameter(gl.DEPTH_WRITEMASK);
// false

Specifications

Specification Status Comment
WebGL 1.0
The definition of 'depthMask' in that specification.
Recommendation Initial definition.
OpenGL ES 2.0
The definition of 'glDepthMask' 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/depthmask

API Method Reference WebGL WebGLRenderingContext