XRProjectionLayer: ignoreDepthValues property

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The read-only ignoreDepthValues property of the XRProjectionLayer interface is a boolean indicating if the XR compositor is not making use of depth buffer values when rendering the layer.

Value

A boolean. true indicates the XR compositor doesn't make use of depth buffer values; false indicates the content of the depth buffer will be used when rendering the layer.

Examples

Ignoring depth values

If the depthFormat option is 0 when creating a projection layer, the ignoreDepthValues property will be true. See also XRWebGLBinding.createProjectionLayer().

js
let glProjectionLayer = xrGLBinding.createProjectionLayer({
  depthFormat: 0,
});

glProjectionLayer.ignoreDepthValues; // true

Specifications

Specification
WebXR Layers API Level 1
# dom-xrprojectionlayer-ignoredepthvalues

Browser compatibility

BCD tables only load in the browser

See also