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

Syntax

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

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.

js
gl.enable(gl.DEPTH_TEST);
gl.depthFunc(gl.NEVER);

To check the current depth function, query the DEPTH_FUNC constant.

js
gl.getParameter(gl.DEPTH_FUNC) === gl.NEVER;
// true

Specifications

Specification
WebGL Specification
# 5.14.3

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
depthFunc

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support

See also