XRFrame:getDepthInformation() 方法

实验性: 这是一个 实验性技术
在生产环境中使用此功能之前,请仔细查看 浏览器兼容性表

安全上下文:此功能仅在 安全上下文(HTTPS)中可用,在某些或所有 支持的浏览器 中。

getDepthInformation()XRFrame 接口的方法,它返回一个 XRCPUDepthInformation 对象,其中包含活动和动画帧的 CPU 深度信息。

语法

js
getDepthInformation(view)

参数

view

从查看器姿势获得的 XRView 对象。

返回值

一个 XRCPUDepthInformation 对象。

异常

NotSupportedError DOMException

如果 "depth-sensing" 不在此 XRSession 的已启用功能列表中,则抛出此异常。

InvalidStateError DOMException

如果

  • XRFrame 不处于活动状态或动画状态,则抛出此异常。获取深度信息仅在 requestAnimationFrame() 回调函数中有效。
  • 会话的 depthUsage 不是 "cpu-optimized"

示例

获取 CPU 深度信息

js
// 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);
      }
    }
  }
}

规范

规范
WebXR 深度感知模块
# dom-xrframe-getdepthinformation

浏览器兼容性

BCD 表仅在启用 JavaScript 的浏览器中加载。