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

See also

• WebGLRenderingContext.clear()
• WebGLRenderingContext.clearColor()
• WebGLRenderingContext.clearStencil()