The WebGLRenderingContext.depthFunc()
method of the WebGL API specifies a function that compares incoming pixel depth to the current depth buffer value.
Syntax
void gl.depthFunc(func);
Parameters
func
- A
GLenum
specifying the depth comparison function, which sets the conditions under which the pixel will be drawn. The default value isgl.LESS
. Possible values are:gl.NEVER
(never pass)gl.LESS
(pass if the incoming value is less than the depth buffer value)gl.EQUAL
(pass if the incoming value equals the the depth buffer value)gl.LEQUAL
(pass if the incoming value is less than or equal to the depth buffer value)gl.GREATER
(pass if the incoming value is greater than the depth buffer value)gl.NOTEQUAL
(pass if the incoming value is not equal to the depth buffer value)gl.GEQUAL
(pass if the incoming value is greater than or equal to the depth buffer value)gl.ALWAYS
(always pass)
Return value
None.
Examples
The depth testing is disabled by default. To enable or disable depth testing, use the enable()
and disable()
methods with the argument gl.DEPTH_TEST
.
gl.enable(gl.DEPTH_TEST); gl.depthFunc(gl.NEVER);
To check the current depth function, query the DEPTH_FUNC
constant.
gl.getParameter(gl.DEPTH_FUNC) === gl.NEVER; // true
Specifications
Specification | Status | Comment |
---|---|---|
WebGL 1.0 The definition of 'depthFunc' in that specification. |
Recommendation | Initial definition. |
OpenGL ES 2.0 The definition of 'glDepthFunc' in that specification. |
Standard | Man page of the OpenGL API. |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Feature | Chrome | Firefox | Edge | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|---|
Basic Support | 9 | 4.0 | 12 | 11 | 12 | 5.1 |
Feature | Android | Chrome for Android | Edge mobile | Firefox for Android | IE mobile | Opera Android | iOS Safari |
---|---|---|---|---|---|---|---|
Basic Support | (Yes) | 25 | (Yes) | (Yes) | 11 | 12 | 8.1 |