XRFrame.getDepthInformation()

The getDepthInformation() method of the XRFrame interface returns an XRCPUDepthInformation object containing CPU depth information for the active and animated frame.

Syntax

getDepthInformation(view)

Parameters

view

An XRView object obtained from a viewer pose.

Return value

An XRCPUDepthInformation object.

Exceptions

  • Throws a NotSupportedError if "depth-sensing" is not in the list of enabled features for this XRSession.
  • Throws an InvalidStateError if the XRFrame is not active nor animated. Obtaining depth information is only valid within the requestAnimationFrame() callback.
  • Throws an InvalidStateError if the the session’s depthUsage is not "cpu-optimized".

Examples

Obtaining CPU depth information

// Make sure  to request a session with depth-sensing enabled
const session = navigator.xr.requestSession("immersive-ar", {
  requiredFeatures: ["depth-sensing"],
  depthSensing: {
    usagePreference: ["cpu-optimized", "gpu-optimized"],
    formatPreference: ["luminance-alpha", "float32"]
  }
});

// ...

// Obtain depth information in an active and animated frame
function rafCallback(time, frame) {
  session.requestAnimationFrame(rafCallback);
  const pose = frame.getViewerPose(referenceSpace);
  if (pose) {
    for (const view of pose.views) {
      const depthInformation = frame.getDepthInformation(view);
      if (depthInformation) {
        // Do something with the depth information
        renderDepth(depthInformation);
      }
    }
  }
}

Specifications

Specification
WebXR Depth Sensing Module (WebXR Depth Sensing)
# dom-xrframe-getdepthinformation

Browser compatibility

BCD tables only load in the browser