fun Immersion(@IntRange(from = 0, to = 100) default: Int, @IntRange(from = 0, to = 100) min: Int = 0, @IntRange(from = 0, to = 100) max: Int = 100): Immersion

The range of Stage's immersion.

launch

fun Application.launch(block: SpatialAppScope.() -> Unit)

Extension function for android platform, use Application as receiver to start a spatial app context so we can create dsl like this.

registerComponent

inline fun <T : Component> registerComponent()

Registers custom Component type.

registerSystem

inline fun <T : System> registerSystem()

Extensions for System to easily register new system type.

Stage

fun SpatialAppScope.Stage(id: String, immersion: Immersion? = null, brightness: Brightness? = null, upperLimbRenderMode: UpperLimbRenderMode? = null, targetActivity: Class<out ComponentActivity>? = null, content: @Composable StageScope.() -> Unit)

Declares a Stage with unique id. The id is used to execute open/close operations.

unregisterComponent

inline fun <T : Component> unregisterComponent()

Unregisters previously registered custom Component type.

unregisterSystem

inline fun <T : System> unregisterSystem()

Unregisters System by type.

WindowContainer

fun SpatialAppScope.WindowContainer(id: String, form: Form? = null, properties: ContainerProperties.() -> Unit = {}, content: @Composable WindowContainerScope.() -> Unit)

fun SpatialAppScope.WindowContainer(id: String, form: Form? = null, defaultSize: WindowContainerSize? = null, resizeType: ContainerResizeType? = null, defaultResizeRestriction: ContainerResizeRestriction? = null, enableMaterialBackground: Boolean? = null, volumeAlignment: VolumeAlignment? = null, defaultVolumeBasePanelType: VolumeBasePanelType? = null, defaultCaptionBarType: CaptionBarType? = null, placement: PlacementContext.() -> Placement? = null, targetActivity: Class<out ComponentActivity>? = null, worldScale: WorldScale? = null, content: @Composable WindowContainerScope.() -> Unit)

Declares a WindowContainer with unique id. The id is used to open/close the WindowContainer.