XRFrame: getDepthInformation() 方法

可用性有限

此特性不是基線特性,因為它在一些最廣泛使用的瀏覽器中不起作用。

實驗性: 這是一項實驗性技術
在生產中使用此技術之前,請仔細檢查瀏覽器相容性表格

安全上下文: 此功能僅在安全上下文(HTTPS)中可用,且支援此功能的瀏覽器數量有限。

XRFrame 介面的 getDepthInformation() 方法返回一個 XRCPUDepthInformation 物件,其中包含當前活動和正在動畫的幀的 CPU 深度資訊。

語法

js
getDepthInformation(view)

引數

view

從檢視器姿勢獲取的 XRView 物件。

返回值

一個 XRCPUDepthInformation 物件。

異常

NotSupportedError DOMException

如果 "depth-sensing" 不在此 XRSession 的已啟用功能列表中,則丟擲此異常。

InvalidStateError DOMException

在以下情況下丟擲

示例

獲取 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 Depth Sensing 模組
# dom-xrframe-getdepthinformation

瀏覽器相容性