SpaceMode
value class SpaceMode
Represents immersion level capabilities of the current application environment.
In XR environments, there are a few different modes that an application can run in:
-
Home Space Mode - the application can run side-by-side with other applications for multitasking; however, spatialization (e.g. Orbiters, Panels, 3D objects, etc.) is not allowed.
-
Full Space Mode - the application is given the entire space and has access to spatialization. It may render multiple panels and 3D objects.
Summary
Public companion properties |
|
|---|---|
SpaceMode |
The XR application is currently in Full Space Mode. |
SpaceMode |
The XR application is currently in Home Space Mode. |
SpaceMode |
Space mode is not applicable to the current system. |
SpaceMode |
Current space mode or capabilities unknown. |
Public companion properties
Full
val Full: SpaceMode
The XR application is currently in Full Space Mode.
In Full Space Mode, the application is given the entire space for its own content. It has access to spatialization and may render multiple panels and 3D objects.
Home
val Home: SpaceMode
The XR application is currently in Home Space Mode.
In Home Space Mode, the application does not have access to spatialization. It may not render multiple panels, orbiters, or 3D objects. However, it may run side-by-side with other applications for multitasking.
NotApplicable
val NotApplicable: SpaceMode
Space mode is not applicable to the current system. This indicates that the current system is not XR (e.g. Phone, Tablet, etc.)
Unspecified
val Unspecified: SpaceMode
Current space mode or capabilities unknown. Awaiting checks to complete to indicate the proper space mode.