XRSession.depthUsage

The read-only depthUsage property of an immersive-ar XRSession describes which depth-sensing usage is used.

Value

This property can return the following values:

cpu-optimized

The depth data is intended to be used on the CPU; see the XRCPUDepthInformation interface.

gpu-optimized

The depth data is intended to be used on the GPU; see the XRWebGLDepthInformation interface.

Examples

To request the desired usage method, you need to specify a usagePreference when requesting a session using XRSystem.requestSession(). Here, the caller is able to handle both CPU- and GPU-optimized usage. The order indicates preference for CPU:

navigator.xr.requestSession("immersive-ar", {
  requiredFeatures: ["depth-sensing"],
  depthSensing: {
    usagePreference: ["cpu-optimized", "gpu-optimized"],
    formatPreference: ["luminance-alpha", "float32"]
  }
});

To check which usage was selected by the user agent, you can call the depthUsage property:

console.log(session.depthUsage); // either "cpu-optimized" or "gpu-optimized"

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
depthUsage
90
90
No
No
No
No
No
90
No
No
No
No

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/XRSession/depthUsage