XRSession: Methode requestLightProbe()

Limited availability

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

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.

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

Die requestLightProbe()-Methode der XRSession-Schnittstelle gibt ein Promise zurück, das mit einem XRLightProbe-Objekt aufgelöst wird, das Beleuchtungsinformationen an einem bestimmten Punkt in der Umgebung des Benutzers schätzt.

Syntax

js
requestLightProbe()
requestLightProbe(options)

Parameter

options Optional

Ein Objekt, das Konfigurationsoptionen enthält, insbesondere:

reflectionFormat

Das interne Reflexionsformat, das angibt, wie die Texturdaten dargestellt werden, entweder srgba8 (Standardwert) oder rgba16f. Siehe auch XRSession.preferredReflectionFormat.

Rückgabewert

Ein Promise, das mit einem XRLightProbe-Objekt aufgelöst wird.

Ausnahmen

Anstatt echte Ausnahmen zu werfen, verwirft requestLightProbe() das zurückgegebene Versprechen mit einer DOMException, insbesondere eine der folgenden:

NotSupportedError DOMException

Ausgelöst, wenn lighting-estimation keine aktivierte Funktion in XRSystem.requestSession() ist oder wenn das reflectionFormat nicht srgb8 oder das preferredReflectionFormat ist.

InvalidStateError DOMException

Ausgelöst, wenn die Sitzung bereits beendet ist.

Beispiele

Anfordern einer Lichtsonde mit dem bevorzugten Format des Systems

Das Standardformat ist srgb8, jedoch können einige Render-Engines andere (High Dynamic Range) Formate verwenden. Sie können die Lichtsonde mit XRSession.preferredReflectionFormat anfordern, das das bevorzugte interne Format angibt.

js
const lightProbe = await xrSession.requestLightProbe({
  reflectionFormat: xrSession.preferredReflectionFormat,
});

Spezifikationen

Specification
WebXR Lighting Estimation API Level 1
# dom-xrsession-requestlightprobe

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch