The WebGLRenderingContext.depthFunc()
method of the WebGL API specifies a function that compares incoming pixel depth to the current depth buffer value.
WebGLRenderingContext.depthFunc()
Syntax
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 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 |
---|
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 | |
depthFunc |
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/depthFunc