XRSession: preferredReflectionFormat property

{{APIRef("WebXR Device API")}}{{SeeCompatTable}}{{SecureContext_Header}}

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

Value

A string representing the reflection format. Possible values:

Examples

Requesting a light probe with the system's preferred format

You can request a light probe with {{domxref("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

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{domxref("XRSession.requestLightProbe()")}}