XRFrame: getLightEstimate() 方法

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

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

getLightEstimate()XRFrame 接口的方法,它返回一个 XRLightEstimate 对象,其中包含给定 XRLightProbe 的估计照明值。

语法

js
getLightEstimate(lightProbe)

参数

lightProbe

一个 XRLightProbe 对象,其中包含当前帧的照明状态。

返回值

一个 XRLightEstimate 对象,如果设备无法估计此帧的照明,则返回 null

示例

获取每帧的照明估计值

给定会话的 XRLightProbegetLightEstimate() 方法会获取一个 XRLightEstimate 对象,其中包含每帧的照明值。

js
const lightProbe = await xrSession.requestLightProbe();

// frame loop
function onXRFrame(time, xrFrame) {
  let lightEstimate = xrFrame.getLightEstimate(lightProbe);

  // Use light estimate data to light the scene

  // Available properties
  lightEstimate.sphericalHarmonicsCoefficients;
  lightEstimate.primaryLightDirection;
  lightEstimate.primaryLightIntensity;
}

规范

规范
WebXR 照明估计 API 第 1 级
# dom-xrframe-getlightestimate

浏览器兼容性

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

另请参阅