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.
requestLightProbe()
requestLightProbe(options)
A Promise
that resolves with an XRLightProbe
object.
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.
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,
});