androidx.xr.compose.spatial

@Composable
@ComposableOpenTarget(index = -1)
fun ApplicationSubspace(
    constraints: VolumeConstraints = SubspaceDefaults.fallbackFieldOfViewConstraints,
    constraintsBehavior: ConstraintsBehavior = ConstraintsBehavior.FieldOfView,
    content: @Composable @SubspaceComposable SpatialBoxScope.() -> Unit
): Unit

Create a 3D area that the app can render spatial content into with optional VolumeConstraints.

ApplicationSubspace should be used to create the topmost Subspace in your application's spatial UI hierarchy. This composable will throw an IllegalStateException if it is used to create a Subspace that is nested within another Subspace or ApplicationSubspace. For nested 3D content areas, use the Subspace composable.

This composable is a no-op and does not render anything in non-XR environments (i.e., Phone and Tablet).

@Composable
@ComposableOpenTarget(index = -1)
fun Orbiter(
    position: OrbiterEdge.Horizontal,
    offset: Dp = 0.dp,
    alignment: Alignment.Horizontal = Alignment.CenterHorizontally,
    settings: OrbiterSettings = OrbiterDefaults.Settings,
    shape: SpatialShape = OrbiterDefaults.Shape,
    elevation: SpatialElevationLevel = OrbiterDefaults.Elevation,
    content: @Composable @UiComposable () -> Unit
): Unit

A composable that creates an orbiter along the top or bottom edges of a view.

Orbiters are floating elements that contain controls for spatial content. They allow the content to have more space and give users quick access to features like navigation without obstructing the main content.

In non-spatial environments, orbiters may be configured using OrbiterSettings.shouldRenderInNonSpatial to render their content as if the orbiter wrapper was not present or be removed from the flow entirely.

Orbiter(position = OrbiterEdge.Top, offset = 10.dp) {
  Text("This is a top edge Orbiter")
}

@Composable
@ComposableOpenTarget(index = -1)
fun Orbiter(
    position: OrbiterEdge.Horizontal,
    offset: EdgeOffset,
    alignment: Alignment.Horizontal = Alignment.CenterHorizontally,
    settings: OrbiterSettings = OrbiterDefaults.Settings,
    shape: SpatialShape = OrbiterDefaults.Shape,
    elevation: SpatialElevationLevel = OrbiterDefaults.Elevation,
    content: @Composable @UiComposable () -> Unit
): Unit

A composable that creates an orbiter along the top or bottom edges of a view.

Orbiters are floating elements that contain controls for spatial content. They allow the content to have more space and give users quick access to features like navigation without obstructing the main content.

In non-spatial environments, orbiters may be configured using OrbiterSettings.shouldRenderInNonSpatial to render their content as if the orbiter wrapper was not present or be removed from the flow entirely.

Orbiter(position = OrbiterEdge.Top, offset = outer(10.dp)) {
  Text("This is a top edge Orbiter")
}

@Composable
@ComposableOpenTarget(index = -1)
fun Orbiter(
    position: OrbiterEdge.Vertical,
    offset: Dp = 0.dp,
    alignment: Alignment.Vertical = Alignment.CenterVertically,
    settings: OrbiterSettings = OrbiterDefaults.Settings,
    shape: SpatialShape = OrbiterDefaults.Shape,
    elevation: SpatialElevationLevel = OrbiterDefaults.Elevation,
    content: @Composable @UiComposable () -> Unit
): Unit

A composable that creates an orbiter along the start or end edges of a view.

Orbiters are floating elements that contain controls for spatial content. They allow the content to have more space and give users quick access to features like navigation without obstructing the main content.

In non-spatial environments, orbiters may be configured using OrbiterSettings.shouldRenderInNonSpatial to render their content as if the orbiter wrapper was not present or be removed from the flow entirely.

Orbiter(position = OrbiterEdge.Start, offset = 10.dp) {
  Text("This is a start edge Orbiter")
}

@Composable
@ComposableOpenTarget(index = -1)
fun Orbiter(
    position: OrbiterEdge.Vertical,
    offset: EdgeOffset,
    alignment: Alignment.Vertical = Alignment.CenterVertically,
    settings: OrbiterSettings = OrbiterDefaults.Settings,
    shape: SpatialShape = OrbiterDefaults.Shape,
    elevation: SpatialElevationLevel = OrbiterDefaults.Elevation,
    content: @Composable @UiComposable () -> Unit
): Unit

A composable that creates an orbiter along the start or end edges of a view.

Orbiters are floating elements that contain controls for spatial content. They allow the content to have more space and give users quick access to features like navigation without obstructing the main content.

In non-spatial environments, orbiters may be configured using OrbiterSettings.shouldRenderInNonSpatial to render their content as if the orbiter wrapper was not present or be removed from the flow entirely.

Orbiter(position = OrbiterEdge.Start, offset = outer(10.dp)) {
  Text("This is a start edge Orbiter")
}

@Composable
fun SpatialDialog(
    onDismissRequest: () -> Unit,
    properties: SpatialDialogProperties = SpatialDialogProperties(),
    content: @Composable () -> Unit
): Unit

SpatialDialog is a dialog that is elevated above the activity.

When spatial dialogs are displayed the existing app content is pushed back and the dialog appears on top of the content at the base elevation level. When the dialog is dismissed the reverse happens with the dialog going away and the app content elevating back into place towards the user.

@Composable
fun SpatialElevation(
    spatialElevationLevel: SpatialElevationLevel = SpatialElevationLevel.Level0,
    content: @Composable () -> Unit
): Unit

Composable that creates a panel in 3D space when spatialization is enabled.

SpatialElevation elevates content in-place. It uses the source position and constraints to determine the size and placement of the elevated panel while reserving space for the original element within the layout.

In non-spatial environments, the content is rendered normally without elevation.

SpatialElevation does not support a content lambda that has a width or height of zero.

@Composable
fun SpatialPopup(
    alignment: Alignment = Alignment.TopStart,
    offset: IntOffset = IntOffset(0, 0),
    onDismissRequest: (() -> Unit)? = null,
    properties: SpatialPopupProperties = SpatialPopupProperties(),
    content: @Composable () -> Unit
): Unit

A composable that creates a panel in 3D space to hoist Popup based composables.

@Composable
@ComposableOpenTarget(index = -1)
fun Subspace(content: @Composable @SubspaceComposable SpatialBoxScope.() -> Unit): Unit

Create a 3D area that the app can render spatial content into.

If this is the topmost Subspace in the compose hierarchy then this will expand to fill all of the available space bounded by the SpatialUser's field of view in width and height and will not be bound by its containing window. In case the field of view width and height cannot be determined, the default field of view width and height values will be used.

If this is nested within another Subspace then it will lay out its content in the X and Y directions according to the layout logic of its parent in 2D space. It will be constrained in the Z direction according to the constraints imposed by its containing Subspace.

This is a no-op and does not render anything in non-XR environments (i.e. Phone and Tablet).

Subspace attempts to use the SpatialUser's field of view as width/height constraints for the subspace being created. If the calculation fails or if the HEAD_TRACKING Android permission is not granted, the default field of view width/height values will be used.