大网数据广告活动
Web 标准与前端开发

XRSession: requestLightProbe() method

· 52CE 我爱测

The **`requestLightProbe()`** method of the XRSession interface returns a Promise that resolves with an XRLightProbe object that estimates lighting information at a given point in the user's environment.

WebXR Device API

The requestLightProbe() method of the XRSession interface returns a Promise that resolves with an XRLightProbe object that estimates lighting information at a given point in the user's environment.

Syntax

requestLightProbe()
requestLightProbe(options)

Parameters

  • options
    • : An object containing configuration options, specifically:
      • reflectionFormat
        • : The internal reflection format indicating how the texture data is represented, either srgba8 (default value) or rgba16f. See also XRSession.preferredReflectionFormat.

Return value

A Promise that resolves with an XRLightProbe object.

Exceptions

Rather than throwing true exceptions, requestLightProbe() rejects the returned promise with a DOMException, specifically, one of the following:

  • NotSupportedError DOMException
    • : Thrown if lighting-estimation is not an enabled feature in XRSystem.requestSession() or if the reflectionFormat is not srgb8 or the preferredReflectionFormat.
  • InvalidStateError DOMException
    • : Thrown if the session has already ended.

Examples

Requesting a light probe with the system's preferred format

The default format is srgb8, however, some rendering engines may use other (high dynamic range) formats. You can request the light probe with XRSession.preferredReflectionFormat which reports the preferred internal format.

const lightProbe = await xrSession.requestLightProbe({
  reflectionFormat: xrSession.preferredReflectionFormat,
});

Specifications

Browser compatibility

See also

  • XRSession.preferredReflectionFormat

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。