JxrPlatformAdapter.StereoSurfaceEntity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

interface JxrPlatformAdapter.StereoSurfaceEntity : JxrPlatformAdapter.Entity

Interface for a surface which images can be rendered into.

Summary

Nested types
`interface JxrPlatformAdapter.StereoSurfaceEntity.CanvasShape` Represents the shape of the spatial canvas which the surface is texture mapped to.
`class JxrPlatformAdapter.StereoSurfaceEntity.CanvasShape.Quad : JxrPlatformAdapter.StereoSurfaceEntity.CanvasShape` A 2D rectangle-shaped canvas.
`class JxrPlatformAdapter.StereoSurfaceEntity.CanvasShape.Vr180Hemisphere : JxrPlatformAdapter.StereoSurfaceEntity.CanvasShape` A hemisphere-shaped canvas.
`class JxrPlatformAdapter.StereoSurfaceEntity.CanvasShape.Vr360Sphere : JxrPlatformAdapter.StereoSurfaceEntity.CanvasShape` A sphere-shaped canvas.

Public functions
`JxrPlatformAdapter.Dimensions`	`getDimensions()` Retrieves the dimensions of the "spatial canvas" which the surface is mapped to.
`Int`	`getStereoMode()` Retrieves the StereoMode for this Entity.
`Surface`	`getSurface()` Retrieves the surface that the Entity will display.
`Unit`	`setCanvasShape( canvasShape: JxrPlatformAdapter.StereoSurfaceEntity.CanvasShape )` Specifies the shape of the spatial canvas which the surface is texture mapped to.
`Unit`	`setStereoMode(mode: Int)` Specifies how the surface content will be routed for stereo viewing.

Inherited functions

From androidx.xr.scenecore.JxrPlatformAdapter.ActivityPose

`Pose`	`getActivitySpacePose()` Returns the pose for this entity, relative to the activity space root.
`Vector3`	`getActivitySpaceScale()` Returns the scale of this WorldPose relative to the activity space.
`Vector3`	`getWorldSpaceScale()` Returns the scale of this ActivityPose.
`Pose`	`transformPoseTo(pose: Pose, destination: JxrPlatformAdapter.ActivityPose)` Returns a pose relative to this entity transformed into a pose relative to the destination.

From androidx.xr.scenecore.JxrPlatformAdapter.Entity

`Unit`	`addChild(child: JxrPlatformAdapter.Entity)` Add given Entity as child.
`Unit`	`addChildren(children: (Mutable)List<JxrPlatformAdapter.Entity!>)` Sets the provided Entities to be children of the Entity.
`Boolean`	`addComponent(component: JxrPlatformAdapter.Component)` Add these components to entity.
`Unit`	`addInputEventListener( executor: Executor, listener: JxrPlatformAdapter.InputEventListener )` Adds the listener to the set of active input listeners, for input events targeted to this entity or its child entities.
`Unit`	`dispose()` Dispose any system resources held by this entity, and transitively calls dispose() on all the children.
`Float`	`getActivitySpaceAlpha()` Returns the total alpha transparency level for this Entity.
`Float`	`getAlpha()` Returns the set alpha transparency level for this Entity.
`(Mutable)List<JxrPlatformAdapter.Entity!>`	`getChildren()` Returns the all child entities of this Entity.
`JxrPlatformAdapter.Entity?`	`getParent()` Returns the parent entity for this Entity.
`Pose`	`getPose()` Returns the pose for this entity, relative to its parent.
`Vector3`	`getScale()` Returns the scale of this entity, relative to its parent.
`Boolean`	`isHidden(includeParents: Boolean)` Returns the hidden status of this Entity.
`Unit`	`removeAllComponents()` Remove all components from this entity.
`Unit`	`removeComponent(component: JxrPlatformAdapter.Component)` Remove the given component from the entity.
`Unit`	`removeInputEventListener( listener: JxrPlatformAdapter.InputEventListener )` Removes the given listener from the set of active input listeners.
`Unit`	`setAlpha(alpha: Float)` Sets the alpha transparency for the given Entity.
`Unit`	`setContentDescription(text: String)` Sets context-text for this entity to be consumed by Accessibility systems.
`Unit`	`setHidden(hidden: Boolean)` Sets the local hidden state of this Entity.
`Unit`	`setParent(parent: JxrPlatformAdapter.Entity?)` Sets the parent Entity for this Entity.
`Unit`	`setPose(pose: Pose)` Updates the pose (position and rotation) of the Entity relative to its parent.
`Unit`	`setScale(scale: Vector3)` Sets the scale of this entity relative to its parent.
`Unit`	`setSize(dimensions: JxrPlatformAdapter.Dimensions)` Sets the size for the given Entity.

Public functions

getDimensions

Added in 1.0.0-alpha02

fun getDimensions(): JxrPlatformAdapter.Dimensions

Retrieves the dimensions of the "spatial canvas" which the surface is mapped to. These values are not impacted by scale.

Returns
`JxrPlatformAdapter.Dimensions`	The canvas [Dimensions].

getStereoMode

Added in 1.0.0-alpha02

fun getStereoMode(): Int

Retrieves the StereoMode for this Entity.

Returns
`Int`	An int StereoMode

getSurface

Added in 1.0.0-alpha02

fun getSurface(): Surface

Retrieves the surface that the Entity will display. The app can write into this surface however it wants, i.e. MediaPlayer, ExoPlayer, or custom rendering.

Returns
`Surface`	an Android [Surface]

setCanvasShape

Added in 1.0.0-alpha02

fun setCanvasShape(
    canvasShape: JxrPlatformAdapter.StereoSurfaceEntity.CanvasShape
): Unit

Specifies the shape of the spatial canvas which the surface is texture mapped to.

Parameters
`canvasShape: JxrPlatformAdapter.StereoSurfaceEntity.CanvasShape`	A concrete instance of [CanvasShape].

setStereoMode

Added in 1.0.0-alpha02

fun setStereoMode(mode: Int): Unit

Specifies how the surface content will be routed for stereo viewing. Applications must render into the surface in accordance with what is specified here in order for the compositor to correctly produce a stereoscopic view to the user.

Parameters
`mode: Int`	An int StereoMode

JxrPlatformAdapter.StereoSurfaceEntity

Summary

Nested types

Public functions

Inherited functions

Public functions

getDimensions

getStereoMode

getSurface

setCanvasShape

setStereoMode