XRLightEstimate
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
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.primaryLightDirectionRead only-
A
DOMPointReadOnlyrepresenting the direction to the primary light source from theprobeSpaceof anXRLightProbe. XRLightEstimate.primaryLightIntensityRead only-
A
DOMPointReadOnly(with thex,y,zvalues mapped to RGB) representing the intensity of the primary light source from theprobeSpaceof anXRLightProbe. XRLightEstimate.sphericalHarmonicsCoefficientsRead only-
A
Float32Arraycontaining 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.
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
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
XRLightEstimate
|
|
|
|
|
|
|
|
|
|
|
|
|
primaryLightDirection
|
|
|
|
|
|
|
|
|
|
|
|
|
primaryLightIntensity
|
|
|
|
|
|
|
|
|
|
|
|
|
sphericalHarmonicsCoefficients
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- See implementation notes.