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
JavaScript
Copy Code
void <var>gl</var>.clearDepth(<var>depth</var>);
Parameters
depth- A
GLclampfspecifying the depth value used when the depth buffer is cleared. Default value: 1.
Return value
None.
Examples
JavaScript
Copy Code
gl.clearDepth(0.5);
To get the current depth clear value, query the DEPTH_CLEAR_VALUE constant.
JavaScript
Copy Code
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
| Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|
| Basic support | 9 | 4.0 (2.0) | 11 | 12 | 5.1 |
| Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
|---|---|---|---|---|---|---|
| Basic support | ? | 25 | (Yes) | ? | 12 | 8.1 |
See also
WebGLRenderingContext.clear()WebGLRenderingContext.clearColor()WebGLRenderingContext.clearStencil()
License
© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/webglrenderingcontext/cleardepth