WebXR Device API
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
NotSupportedErrorDOMException- : Thrown if
"depth-sensing"is not in the list of enabled features for this XRSession.
- : Thrown if
InvalidStateErrorDOMException- : Thrown if:
- the
XRFrameis not active nor animated. Obtaining depth information is only valid within the XRSession.requestAnimationFrame() callback. - the session's XRSession.depthUsage is not
"cpu-optimized".
- the
- : Thrown if:
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
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
