WebXRInterface Properties

On an AR interface, true if anchor detection is enabled.

The vertices of a polygon which defines the boundaries of the user's play area.

This will only be available if ReferenceSpaceType is "bounded-floor" and only on certain browsers and devices that support it.

The reference_space_reset signal may indicate when this changes.

true if this interface been initialized.

true if this is the primary interface.

A comma-seperated list of optional features used by Initialize when setting up the WebXR session.

If a user's browser or device doesn't support one of the given features, initialization will continue, but you won't be able to use the requested feature.

This doesn't have any effect on the interface when already initialized.

Possible values come from WebXR's XRReferenceSpaceType. If you want to use a particular reference space type, it must be listed in either RequiredFeatures or OptionalFeatures.

The reference space type (from the list of requested types set in the RequestedReferenceSpaceTypes property), that was ultimately used by Initialize when setting up the WebXR session.

Possible values come from WebXR's XRReferenceSpaceType. If you want to use a particular reference space type, it must be listed in either RequiredFeatures or OptionalFeatures.

A comma-seperated list of reference space types used by Initialize when setting up the WebXR session.

The reference space types are requested in order, and the first on supported by the users device or browser will be used. The ReferenceSpaceType property contains the reference space type that was ultimately used.

This doesn't have any effect on the interface when already initialized.

Possible values come from WebXR's XRReferenceSpaceType. If you want to use a particular reference space type, it must be listed in either RequiredFeatures or OptionalFeatures.

A comma-seperated list of required features used by Initialize when setting up the WebXR session.

If a user's browser or device doesn't support one of the given features, initialization will fail and session_failed will be emitted.

This doesn't have any effect on the interface when already initialized.

Possible values come from WebXR's XRReferenceSpaceType. If you want to use a particular reference space type, it must be listed in either RequiredFeatures or OptionalFeatures.

The session mode used by Initialize when setting up the WebXR session.

This doesn't have any effect on the interface when already initialized.

Possible values come from WebXR's XRSessionMode, including: "immersive-vr", "immersive-ar", and "inline".

Indicates if the WebXR session's imagery is visible to the user.

Possible values come from WebXR's XRVisibilityState, including "hidden", "visible", and "visible-blurred".