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) orrgba16f. See also XRSession.preferredReflectionFormat.
- : The internal reflection format indicating how the texture data is represented, either
- : An object containing configuration options, specifically:
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:
NotSupportedErrorDOMException- : Thrown if
lighting-estimationis not an enabled feature in XRSystem.requestSession() or if thereflectionFormatis notsrgb8or thepreferredReflectionFormat.
- : Thrown if
InvalidStateErrorDOMException- : 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。离线整理了版式、链接和媒体显示。
