XRSession: preferredReflectionFormat property

Limited availability

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

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.

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

Specifications

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

Browser compatibility

BCD tables only load in the browser

See also