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

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
interactionMode
84
84
No
No
No
No
No
84
No
No
No
No

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/XRSession/interactionMode