XRLightEstimate

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

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 XRLightEstimateobject, call the XRFrame.getLightEstimate() method.

Properties

XRLightEstimate.primaryLightDirection Read only

A DOMPointReadOnly representing the direction to the primary light source from the probeSpace of an XRLightProbe.

XRLightEstimate.primaryLightIntensity Read only

A DOMPointReadOnly (with the x, y, z values mapped to RGB) representing the intensity of the primary light source from the probeSpace of an XRLightProbe.

XRLightEstimate.sphericalHarmonicsCoefficients Read only

A Float32Array containing 9 spherical harmonics coefficients.

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

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
XRLightEstimate
90
90
No
No
76
No
No
90
No
No
No
No
primaryLightDirection
90
90
No
No
76
No
No
90
No
No
No
No
primaryLightIntensity
90
90
No
No
76
No
No
90
No
No
No
No
sphericalHarmonicsCoefficients
90
90
No
No
76
No
No
90
No
No
No
No

See also

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/XRLightEstimate