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
Exceptions
NotSupportedError
DOMException
-
Thrown if "depth-sensing"
is not in the list of enabled features for this XRSession
.
InvalidStateError
DOMException
-
Thrown if:
- the
XRFrame
is not active nor animated. Obtaining depth information is only valid within the requestAnimationFrame()
callback.
- the session's
depthUsage
is not "cpu-optimized"
.
Examples
const session = navigator.xr.requestSession("immersive-ar", {
requiredFeatures: ["depth-sensing"],
depthSensing: {
usagePreference: ["cpu-optimized", "gpu-optimized"],
formatPreference: ["luminance-alpha", "float32"],
},
});
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) {
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 |
76 |
No |
No |
90 |
No |
64 |
No |
15.0 |