WebGLRenderingContext.clearDepth()

The WebGLRenderingContext.clearDepth() method of the WebGL API specifies the clear value for the depth buffer.

This specifies what depth value to use when calling the clear() method. The value is clamped between 0 and 1.

Syntax

void gl.clearDepth(depth);

Parameters

depth
A GLclampf specifying the depth value used when the depth buffer is cleared. Default value: 1.

Return value

None.

Examples

gl.clearDepth(0.5);

To get the current depth clear value, query the DEPTH_CLEAR_VALUE constant.

gl.getParameter(gl.DEPTH_CLEAR_VALUE);
// 0.5

Specifications

Specification Status Comment
WebGL 1.0
The definition of 'clearDepth' in that specification.
Recommendation Initial definition.
OpenGL ES 2.0
The definition of 'glClearDepthf' in that specification.
Standard Man page of the OpenGL API.

Browser compatibility

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
clearDepthChrome Full support 9Edge Full support 12Firefox Full support 4IE Full support 11Opera Full support 12Safari Full support 5.1WebView Android Full support YesChrome Android Full support 25Firefox Android Full support YesOpera Android Full support 12Safari iOS Full support 8Samsung Internet Android Full support 1.5

Legend

Full support
Full support

See also