StereoSurfaceEntity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

class StereoSurfaceEntity : BaseEntity

kotlin.Any
↳	androidx.xr.scenecore.BaseActivityPose
	↳	androidx.xr.scenecore.BaseEntity
		↳	androidx.xr.scenecore.StereoSurfaceEntity

StereoSurfaceEntity is a concrete implementation of Entity that hosts a StereoSurface Panel.

Summary

Nested types
`object StereoSurfaceEntity.StereoMode`

Public functions
`Surface`	`@MainThread getSurface()` Returns a surface into which the application can render stereo image content.

Public properties
`Dimensions`	`dimensions` Changes the width and height of the "spatial canvas" which the surface is mapped to.

Inherited functions

From androidx.xr.scenecore.ActivityPose

`abstract Pose`	`getActivitySpacePose()` Returns the activity space pose for this ActivityPose.
`abstract Pose`	`transformPoseTo(pose: Pose, destination: ActivityPose)` Returns a pose relative to this ActivityPose transformed into a pose relative to the destination.

From androidx.xr.scenecore.BaseEntity

`open Unit`	`addChild(child: Entity)` Sets an Entity to be represented in this coordinate space.
`open Boolean`	`addComponent(component: Component)` Adds a Component to this Entity.
`open Unit`	`dispose()` Disposes of any system resources held by this Entity, and transitively calls dispose() on all its children.
`open Float`	`getActivitySpaceAlpha()` Returns the global alpha of this entity computed by multiplying the parent's global alpha to this entity's local alpha.
`open Float`	`getAlpha()` Returns the alpha transparency set for this Entity.
`open List<Component>`	`getComponents()` Retrieves all components attached to this Entity.
`open List<T>`	`<T : Component> getComponentsOfType(type: Class<T>)` Retrieves all Components of the given type `T` and its sub-types attached to this Entity.
`open Entity?`	`getParent()` Returns the parent of this Entity.
`open Pose`	`getPose()` Returns the pose for this entity, relative to its parent.
`open Float`	`getScale()` Returns the local scale of this entity, not inclusive of the parent's scale.
`open Dimensions`	`getSize()` Returns the dimensions (in meters) for this Entity.
`open Float`	`getWorldSpaceScale()` Returns the accumulated scale of this Entity.
`open Boolean`	`isHidden(includeParents: Boolean)` Returns the hidden status of this Entity.
`open Unit`	`removeAllComponents()` Remove all components from this Entity.
`open Unit`	`removeComponent(component: Component)` Removes the given Component from this Entity.
`open Unit`	`setAlpha(alpha: Float)` Sets the alpha transparency of the Entity and its children.
`open Unit`	`setContentDescription(text: String)` Sets alternate text for this entity to be consumed by Accessibility systems.
`open Unit`	`setHidden(hidden: Boolean)` Sets the local hidden state of this Entity.
`open Unit`	`setParent(parent: Entity?)` Sets this Entity to be represented in the parent's coordinate space.
`open Unit`	`setPose(pose: Pose)` Sets the pose for this Entity, relative to its parent.
`open Unit`	`setScale(scale: Float)` Sets the scale of this entity relative to its parent.
`open Unit`	`setSize(dimensions: Dimensions)` Sets the dimensions in pixels for the Entity.

Public functions

getSurface

Added in 1.0.0-alpha01

@MainThread
fun getSurface(): Surface

Returns a surface into which the application can render stereo image content.

This method must be called from the main thread. https://developer.android.com/guide/components/processes-and-threads

Public properties

dimensions

Added in 1.0.0-alpha01

var dimensions: Dimensions

Changes the width and height of the "spatial canvas" which the surface is mapped to. (0,0,0) for this Entity is the canvas's center. (In unscaled ActivitySpace, this is 1 unit per meter) Width and height <= 0 are unsupported (Depth is ignored).

StereoSurfaceEntity

Summary

Nested types

Public functions

Public properties

Inherited functions

Public functions

getSurface

Public properties

dimensions