XRSession: interactionMode 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 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-
Indicates that the UI should be drawn directly to the screen without projection. This is typically the mode reported from handheld devices.
world-space-
Indicates 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 # dom-xrsession-interactionmode |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
interactionMode
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.