Secure contextThis feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The read-only XRWebGLLayer
property ignoreDepthValues
is a Boolean value which is true
if the session has been configured to ignore the values in the depth buffer while rendering the scene. If the depth buffer is being used to determine the position of vertices, this property is false
.
The value of ignoreDepthValues
can only be set when the XRWebGLLayer
is instantiated, by setting the corresponding value in the XRWebGLLayerInit
object specified as the constructor's layerInit
parameter. As a parameter you're likely to set yourself, it is unlikely you'll need to read it later, but it's available if the need arises.
Syntax
let ignoringDepthBuffer = xrWebGLLayer.ignoreDepthValues;
Value
A Boolean value which is true
if the WebGL context's depth buffer is being used while computing the locations of points in the 3D world. Otherwise, if this is true
, the depth buffer's values are being used to assist in placing objects in the scene. Since the XR compositor uses the depth buffer by default, this value is false
unless explicitly set otherwise when creating the XRWebGLLayer
using its constructor, XRWebGLLayer()
.
Usage notes
When the ignoreDepthValues
property is false
, the XR compositor uses the values found in the depth buffer, which should be accurate for the scene, in order to potentially improve the quality or the output as well as the comfort level for the viewer.
The depth buffer is framebufferWidth
entires wide and framebuffer
entries tall. Each entry in the buffer specifies the depth at which the corresponding pixel is located, and has a value between 0.0 and 1.0.
A depth buffer pixel value of 0.0 corresponds to the depth given by the session's depthNear
and a value of 1.0 corresponds to the depth given by depthFar
.
The depth, in tandem with the coordinates of each point being rendered, makes it possible to more accurately represent the scene in the 3D space.
Examples
If the Web application which is using WeXR is rendering its content without using a depth buffer—or if the depth buffer's contents are invalid—you should disable the use of the depth buffer for WebXR rendering by setting ignoreDepthValues
to true when creating the XRWebGLLayer
. This is demonstrated in the snippet of code below:
const glLayerOptions = {
ignoreDepthValues: true
};
let glLayer = new XRWebGLLayer(xrSession, gl, glLayerOptions);
Specifications
Specification | Status | Comment |
WebXR Device APIThe definition of 'XRWebGLLayer.ignoreDepthValues' in that specification. | Working Draft | Initial definition. |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
ignoreDepthValues
|
Chrome
Full support 79 |
Edge
Full support 79 |
Firefox
No support No |
IE
No support No |
Opera
No support No |
Safari
No support No |
WebView Android
No support No |
Chrome Android
Full support 79 |
Firefox Android
No support No |
Opera Android
No support No |
Safari iOS
No support No |
Samsung Internet Android
Full support 11.2 |
Legend
- Full support
- Full support
- No support
- No support
See also
- WebXR Device API
WebGLLayerInit
- WebGL depth buffer related methods:
depthFunc()
,clearDepth()
XRWebGLLayer.ignoreDepthValues by Mozilla Contributors is licensed under CC-BY-SA 2.5.