androidx.xr.scenecore


Interfaces

Component

A Component adds functionality or behaviors to an Entity.

Entity

Interface for a spatial Entity.

EntityMoveListener

Listener for move actions.

ScenePose

A Pose in the Scene graph, which can be transformed into a Pose relative to another ScenePose.

SpatialModeChangeListener

The SpatialModeChangeListener is used to handle scenegraph updates when the spatial mode for the scene changes.

SpatializerConstants

Constants for spatialized audio.

Classes

ActivityPanelEntity

ActivityPanelEntity creates a spatial panel for embedding an Activity in Android XR.

ActivitySpace

ActivitySpace is an Entity used to track the system-managed pose and boundary of the volume associated with a spatialized Activity.

AnchorEntity

An AnchorEntity tracks a androidx.xr.runtime.math.Pose relative to some position or surface in the "Real World." Children of this Entity will remain positioned relative to that location in the real world, for the purposes of creating Augmented Reality experiences.

AnchorPlacement

AnchorPlacement for setting how an Entity should be anchored in a MovableComponent.

CameraView

An ScenePose which tracks a camera view's position and view into physical space.

CubeMapTexture

CubeMapTexture represents a cube map texture that can be used with materials.

ExrImage

Represents an EXR image in SceneCore.

GltfModel

GltfModel represents a glTF resource in SceneCore.

GltfModelEntity

GltfModelEntity is a concrete implementation of Entity that hosts a glTF model.

GroupEntity

An Entity that contains no content, but can have an arbitrary number of children.

Head

Head is an ScenePose used to track the position of the user's head.

HitTestResult

Specifies an intersection between a ray and the Scene.

InputEvent

Defines input events for SceneCore.

InputEvent.HitInfo

Information about the hit result of the input ray, originating from one of the InputEvent.Source, and intersecting with some Entity on the scene.

InteractableComponent

Provides access to raw InputEvents for given Entity, so a client can implement their own interaction logic.

MainPanelEntity

Represents the main spatialized panel in a Scene.

Material

Represents a Material in SceneCore.

MovableComponent

This Component can be attached to a single instance of an Entity.

PanelClippingConfig

Defines the clipping configuration for all panels within the Scene.

PanelEntity

PanelEntity contains an arbitrary 2D Android View, within a spatialized XR scene.

PerceivedResolutionResult

Represents the outcome of an attempt to calculate the perceived resolution of an entity.

PerceivedResolutionResult.EntityTooClose

Indicates that the perceived resolution could not be calculated because the entity is too close to the camera.

PerceivedResolutionResult.InvalidCameraView

Indicates that the perceived resolution could not be calculated because the required camera view information was invalid or insufficient for the calculation.

PerceivedResolutionResult.Success

Indicates that the perceived resolution was successfully calculated.

PerceptionSpace

PerceptionSpace is an ScenePose used to track the origin of the space used by ARCore for Jetpack XR APIs.

PointSourceParams

Configures a sound source to be spatialized at a 3D location.

PointerCaptureComponent

Provides pointer capture capabilities for a given Entity.

ResizableComponent

This Component can be attached to a single instance of an Entity.

ResizeEvent

A resize event which is sent in response to the User interacting with the ResizableComponent.

Scene

Scene is the primary interface to SceneCore functionality for the application.

SoundFieldAttributes

Configures ambisonics sound sources.

SpatialAudioTrack
SpatialAudioTrackBuilder

Provides spatial audio extensions on the platform AudioTrack.Builder class.

SpatialCapabilities

Representation of the spatial capabilities of the current Scene.

SpatialEnvironment

The SpatialEnvironment is used to manage the XR background and passthrough.

SpatialEnvironment.SpatialEnvironmentPreference

Represents the preferred spatial environment for the application.

SpatialMediaPlayer
SpatialPointerComponent

Component that modifies the pointer icon that is rendered on the component's Entity.

SpatialPointerIcon

Specifies the icon that is rendered at the pointer's location on entities in the spatialized scene.

SpatialSoundPool

Provides spatial audio extensions on the framework SoundPool class.

SpatialUser

SpatialUser represents the user in a spatialized Activity.

SurfaceEntity

SurfaceEntity is a concrete implementation of Entity that hosts a StereoSurface Canvas.

SurfaceEntity.CanvasShape

Represents the shape of the Canvas that backs a SurfaceEntity.

SurfaceEntity.CanvasShape.Quad
SurfaceEntity.CanvasShape.Vr180Hemisphere
SurfaceEntity.CanvasShape.Vr360Sphere
SurfaceEntity.EdgeFeatheringParams

Represents edge fading effects for a SurfaceEntity.

SurfaceEntity.EdgeFeatheringParams.SmoothFeather
SurfaceEntity.EdgeFeatheringParams.SolidEdge

Applies no edge fading to any canvas.

Texture

Texture represents a texture that can be used with materials.

TextureSampler

TextureSampler class used to define the way a texture gets sampled.

WaterMaterial

A Material which implements a water effect.

Objects

AnchorEntity.State
GltfModelEntity.AnimationState

Specifies the current animation state of the GltfModelEntity.

HitTestResult.SurfaceType
InputEvent.Action

Specifies the action (e.g. down, up, move, etc.) of the input event.

InputEvent.Pointer

Specifies the pointer type (e.g. left, right or default) of the input event.

InputEvent.Source

Specifies the source (e.g. hands, controller, head) of the input event.

PlaneOrientation

Type of plane based on orientation i.e. Horizontal or Vertical.

PlaneSemanticType

Semantic plane types.

PointerCaptureComponent.PointerCaptureState

Defines the possible states of a PointerCaptureComponent.

ResizeEvent.ResizeState
ScenePose.HitTestFilter

A filter for which Scenes to hit test with ScenePose.hitTest.

Space

Coordinate spaces in which to apply transformation values.

SpatialVisibility

Spatial Visibility states of content within the user's field of view.

SpatialWindow

Methods used to manage the Activity's main spatial window when it is displayed in Home Space Mode.

SurfaceEntity.StereoMode
TextureSampler.CompareFunc

Comparison functions for the depth sampler.

TextureSampler.CompareMode

Used for depth texture comparisons, determining how the sampled depth value is compared to a reference depth.

TextureSampler.MagFilter

Specifies how the texture is sampled when it's magnified (appears larger than its original size).

TextureSampler.MinFilter

Specifies how the texture is sampled when it's minified (appears smaller than its original size).

TextureSampler.WrapMode

Defines how texture coordinates outside the range 0, 1 are handled.

Enums

CameraView.CameraType

Describes the type of camera that this CameraView represents.

Extension properties summary

Scene

Gets the Scene associated with this Session.

Extension properties

val Session.sceneScene

Gets the Scene associated with this Session.

The Scene is the primary interface for creating and managing spatial content. There is a single Scene instance for each Session.

See also
Scene