androidx.xr.compose.platform

Interfaces

SpatialCapabilities

Provides information and functionality related to the spatial capabilities of the application.

SpatialConfiguration

Provides information and functionality related to the spatial configuration of the application.

Top-level properties summary

ProvidableCompositionLocal<Session?>

A composition local that provides the current Jetpack XR Session.

ProvidableCompositionLocal<SpatialCapabilities>

Provides the current SpatialCapabilities that are currently available to the application.

ProvidableCompositionLocal<SpatialConfiguration>

Provides the current SpatialConfiguration.

Top-level properties

LocalSession

val LocalSessionProvidableCompositionLocal<Session?>

A composition local that provides the current Jetpack XR Session.

In non-XR environments, this composition local will return null.

LocalSpatialCapabilities

val LocalSpatialCapabilitiesProvidableCompositionLocal<SpatialCapabilities>

Provides the current SpatialCapabilities that are currently available to the application.

The SpatialCapabilities represents a set of inherent permissions that the application may have depending on the context. For example, in home space mode, the app may not have the ability to create spatial UI; however, in full space mode, the application may have this capability.

LocalSpatialConfiguration

val LocalSpatialConfigurationProvidableCompositionLocal<SpatialConfiguration>

Provides the current SpatialConfiguration.

The behavior of the configuration object will depend on whether the system XR Spatial feature is enabled. For example, if the feature is not enabled, attempting to request different mode types cause an exception.