XRSession.interactionMode

The XRSession interface's read-only interactionMode property describes the best space (according to the user agent) for the application to draw an interactive UI for the current session.

Value

A string describing the best space (according to the user agent) for the application to draw an interactive UI for the current session.

Possible values are:

  • screen-space: indicating that the UI should be drawn directly to the screen without projection. This is typically the mode reported from handheld devices.
  • world-space: indicating that the UI should be drawn in the world, some distance from the user, so that they may interact with it using controllers. This is typically the mode reported from headworn devices.

Examples

if (xrSession.interactionMode == "world-space") {
  // draw UI in the world
} else {
  // draw UI directly to the screen
}

Specifications

Specification
WebXR Augmented Reality Module - Level 1 (WebXR Augmented Reality 1)
# dom-xrsession-interactionmode

Browser compatibility

BCD tables only load in the browser