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
XRViewobject obtained from a viewer pose.
Return value
An XRCPUDepthInformation object.
Exceptions
-
NotSupportedErrorDOMException -
Thrown if
"depth-sensing"is not in the list of enabled features for thisXRSession. -
InvalidStateErrorDOMException -
Thrown if:
- the
XRFrameis not active nor animated. Obtaining depth information is only valid within therequestAnimationFrame()callback. - the session's
depthUsageis not"cpu-optimized".
- the
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
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 | |
getDepthInformation |
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/XRFrame/getDepthInformation