XRFrame: getLightEstimate() method
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();
function onXRFrame(time, xrFrame) {
let lightEstimate = xrFrame.getLightEstimate(lightProbe);
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 |
getLightEstimate |
90 |
90 |
No |
No |
76 |
No |
No |
90 |
No |
64 |
No |
15.0 |
See also