XRFrame: getLightEstimate() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

See full compatibility

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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

The getLightEstimate() method of the XRFrame interface returns an XRLightEstimate object containing estimated lighting values for a given XRLightProbe.

Syntax

getLightEstimate(lightProbe)

Parameters

lightProbe: An XRLightProbe object containing the current lighting state for the frame.

Return value

An XRLightEstimate object or null if the device cannot estimate lighting for this frame.

Examples

Getting light estimates for each frame

Given a session's XRLightProbe, the getLightEstimate() method gets an 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 # dom-xrframe-getlightestimate

Browser compatibility

	desktop					mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on iOS	Samsung Internet	WebView Android	WebView on iOS
`getLightEstimate` Experimental	Chrome – Full support Chrome 90 (Release date: 2021-04-13) footnote Full support	Edge – Full support Edge 90 (Release date: 2021-04-15) footnote Full support	Firefox – No support Firefox footnote No support	Opera – Full support Opera 76 (Release date: 2021-04-28) footnote Full support	Safari – No support Safari footnote No support	Chrome Android – Full support Chrome Android 90 (Release date: 2021-04-13) footnote Full support	Firefox for Android – No support Firefox for Android footnote No support	Opera Android – Full support Opera Android 64 (Release date: 2021-05-25) footnote Full support	Safari on iOS – No support Safari on iOS footnote No support	Samsung Internet – Full support Samsung Internet 15 (Release date: 2021-08-13) footnote Full support	WebView Android – No support WebView Android footnote No support	WebView on iOS – No support WebView on iOS footnote No support

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.

XRFrame: getLightEstimate() method

Legend