XRSession: Methode requestLightProbe()
Eingeschränkt verfügbar
Diese Funktion ist nicht Baseline, da sie in einigen der am weitesten verbreiteten Browser nicht funktioniert.
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 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
requestLightProbe()
requestLightProbe(options)
Parameter
optionsOptional-
Ein Objekt, das Konfigurationsoptionen enthält, insbesondere:
reflectionFormat-
Das interne Reflexionsformat, das angibt, wie die Texturdaten dargestellt werden, entweder
srgba8(Standardwert) oderrgba16f. Siehe auchXRSession.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:
NotSupportedErrorDOMException-
Ausgelöst, wenn
lighting-estimationkeine aktivierte Funktion inXRSystem.requestSession()ist oder wenn dasreflectionFormatnichtsrgb8oder daspreferredReflectionFormatist. InvalidStateErrorDOMException-
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.
const lightProbe = await xrSession.requestLightProbe({
reflectionFormat: xrSession.preferredReflectionFormat,
});
Spezifikationen
| Spezifikation |
|---|
| WebXR Lighting Estimation API Level 1 # dom-xrsession-requestlightprobe |