W3cubDocs

/Web APIs

XRFrame: getLightEstimate() method

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

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

Syntax

js

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.

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
# dom-xrframe-getlightestimate

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
getLightEstimate 90 90 No No 76 No No 90 No 64 No 15.0

See also

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