XRFrame: getLightEstimate() method

{{APIRef("WebXR Device API")}}{{SeeCompatTable}}{{SecureContext_Header}}

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

Syntax

getLightEstimate(lightProbe)

Parameters

• lightProbe
  • : An {{domxref("XRLightProbe")}} object containing the current lighting state for the frame.

Return value

An {{domxref("XRLightEstimate")}} object or null if the device cannot estimate lighting for this frame.

Examples

Getting light estimates for each frame

Given a session's {{domxref("XRLightProbe")}}, the getLightEstimate() method gets an {{domxref("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

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{domxref("XRLightEstimate")}}
• {{domxref("XRLightProbe")}}