XRFrame: getLightEstimate() Methode

Limited availability

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

We’d love to hear your thoughts on the next set of proposals for the JavaScript language. You can find a description of the proposals here.
Please take two minutes to fill out our short survey.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Die getLightEstimate() Methode der XRFrame Schnittstelle gibt ein XRLightEstimate Objekt zurück, das geschätzte Beleuchtungswerte für eine gegebene XRLightProbe enthält.

Syntax

js
getLightEstimate(lightProbe)

Parameter

lightProbe

Ein XRLightProbe Objekt, das den aktuellen Beleuchtungszustand für den Frame enthält.

Rückgabewert

Ein XRLightEstimate Objekt oder null, wenn das Gerät das Licht für diesen Frame nicht schätzen kann.

Beispiele

Beleuchtungsschätzungen für jeden Frame erhalten

Anhand einer Sitzung's XRLightProbe erhält die getLightEstimate() Methode ein XRLightEstimate Objekt, das die Beleuchtungswerte für jeden Frame enthält.

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;
}

Spezifikationen

Specification
WebXR Lighting Estimation API Level 1
# dom-xrframe-getlightestimate

Browser-Kompatibilität

Siehe auch