XRLightEstimate
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The XRLightEstimate
interface of the WebXR Device API provides the estimated lighting values for an XRLightProbe
at the time represented by an XRFrame
.
To get an XRLightEstimate
object, call the XRFrame.getLightEstimate()
method.
Instance properties
XRLightEstimate.primaryLightDirection
Read only Experimental-
A
DOMPointReadOnly
representing the direction to the primary light source from theprobeSpace
of anXRLightProbe
. XRLightEstimate.primaryLightIntensity
Read only Experimental-
A
DOMPointReadOnly
(with thex
,y
,z
values mapped to RGB) representing the intensity of the primary light source from theprobeSpace
of anXRLightProbe
. XRLightEstimate.sphericalHarmonicsCoefficients
Read only Experimental-
A
Float32Array
containing 9 spherical harmonics coefficients.
Instance methods
None.
Examples
Getting an XRLightProbe
object
First, use the XRSession.requestLightProbe()
method to get a light probe from a session.
Then, within an XRFrame
loop, the getLightEstimate()
method will return a XRLightEstimate
object containing the lighting values for each frame.
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;
}
Specifications
Specification |
---|
WebXR Lighting Estimation API Level 1 # xrlightestimate-interface |
Browser compatibility
BCD tables only load in the browser