XRSession: preferredReflectionFormat property

Limited availability

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

See full compatibility

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The read-only preferredReflectionFormat property of the XRSession interface returns this session's preferred reflection format used for lighting estimation texture data.

Value

A string representing the reflection format. Possible values:

XRReflectionFormat	WebGL Format	WebGL Internal Format	WebGPU Format	HDR
"srgba8"	RGBA	SRGB8_ALPHA8	"rgba8unorm-srgb"
"rgba16f"	RGBA	RGBA16F	"rgba16float"	✓

Examples

Requesting a light probe with the system's preferred format

You can request a light probe with XRSession.requestLightProbe() and specify the system's preferred format by setting the reflectionFormat option equal to XRSession.preferredReflectionFormat.

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

Specifications

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

Browser compatibility

	desktop					mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on iOS	Samsung Internet	WebView Android	WebView on iOS
`preferredReflectionFormat` Experimental	Chrome – Full support Chrome 90 (Release date: 2021-04-13) footnote Full support	Edge – Full support Edge 90 (Release date: 2021-04-15) footnote Full support	Firefox – No support Firefox footnote No support	Opera – Full support Opera 76 (Release date: 2021-04-28) footnote Full support	Safari – No support Safari footnote No support	Chrome Android – Full support Chrome Android 90 (Release date: 2021-04-13) footnote Full support	Firefox for Android – No support Firefox for Android footnote No support	Opera Android – Full support Opera Android 64 (Release date: 2021-05-25) footnote Full support	Safari on iOS – No support Safari on iOS footnote No support	Samsung Internet – Full support Samsung Internet 15 (Release date: 2021-08-13) footnote Full support	WebView Android – No support WebView Android footnote No support	WebView on iOS – No support WebView on iOS footnote No support

Tip: you can click/tap on a cell for more information.

Full support: Full support
No support: No support
: Experimental. Expect behavior to change in the future.