androidx.xr.scenecore


Interfaces

ActivityPose

Interface for a ActivityPose.

Component

Base interface for all components.

Entity

Interface for a spatial Entity.

Image

Interface for image formats in SceneCore.

InputEventListener

Listener for InputEvents.

Model

Represents a 3D model in SceneCore.

MoveListener

Listener for move actions.

OnBoundsChangeListener

This interface is deprecated. Use addBoundsChangedListener(Consumer<Dimensions>)

OnSpaceUpdatedListener
OnStateChangedListener
PointerCaptureComponent.StateListener

Listener for pointer capture state changes.

ResizeListener

Listener for resize actions.

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 this Spatialized Activity.

AnchorEntity

An AnchorEntity is created to track a 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

Creates an AnchorPlacement for a MovableComponent.

BaseActivityPose

The BaseActivityPose is an implementation of ActivityPose interface that wraps a platformAdapter ActivityPose.

BaseEntity

The BaseEntity is an implementation of Entity interface that wraps a platform entity.

BasePanelEntity

Provides implementations for common Panel functionality.

CameraView

A ActivityPose which tracks a camera's position and view into physical space.

ContentlessEntity

An Entity that itself has no content.

CubeMapTexture

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

Dimensions

Dimensions of a 3D object.

ExrImage

ExrImage represents an EXR Image resource in SceneCore.

Fov

The angles (in radians) representing the sides of the view frustum.

GltfModel

GltfModel represents a glTF resource in SceneCore.

GltfModelEntity

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

Head

Head is a ActivityPose used to track the position of the user's head.

HitTestResult

Defines an intersection between a ray and the scene.

InputEvent

Defines input events for XRCore.

InputEvent.HitInfo

Information about the hit result of the ray.

InteractableComponent

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

Material

Represents a Material in SceneCore.

MovableComponent

Allows users to interactively move the Entity.

PanelEntity

PanelEntity creates a spatial panel in Android XR.

PerceptionSpace

PerceptionSpace is ActivityPose used to track the origin of the space used by ARCore for XR APIs.

PixelDimensions

Dimensions of a 2D surface in Pixels.

PointSourceParams

PointSourceParams is used to configure a sound be spatialized as a 3D point.

PointerCaptureComponent

Provides pointer capture capabilities for a given entity.

ResizableComponent

A Component which when attached to a PanelEntity provides a user-resize affordance.

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 session.

SpatialEnvironment

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

SpatialEnvironment.PassthroughMode

This class is deprecated. Use isSpatialEnvironmentPreferenceActive() instead.

SpatialEnvironment.SetPassthroughOpacityPreferenceChangeApplied

The call to setPassthroughOpacityPreference succeeded and should now be visible.

SpatialEnvironment.SetPassthroughOpacityPreferenceChangePending

The call to setPassthroughOpacityPreference successfully applied the preference, but it is not immediately visible due to requesting a state change while the activity does not have the SpatialCapabilities.SPATIAL_CAPABILITY_PASSTHROUGH_CONTROL capability to control the app passthrough state.

SpatialEnvironment.SetPassthroughOpacityPreferenceResult

Result values for calls to setPassthroughOpacityPreference

SpatialEnvironment.SetSpatialEnvironmentPreferenceChangeApplied

The call to setSpatialEnvironmentPreference succeeded and should now be visible.

SpatialEnvironment.SetSpatialEnvironmentPreferenceChangePending

The call to setSpatialEnvironmentPreference successfully applied the preference, but it is not immediately visible due to requesting a state change while the activity does not have the SpatialCapabilities.SPATIAL_CAPABILITY_APP_ENVIRONMENTS capability to control the app environment state.

SpatialEnvironment.SetSpatialEnvironmentPreferenceResult

Result values for calls to SpatialEnvironment.setSpatialEnvironmentPreference

SpatialEnvironment.SpatialEnvironmentPreference

Represents the preferred spatial environment for the application.

SpatialMediaPlayer
SpatialPointerComponent

Component that modifies the pointer icon.

SpatialPointerIcon

Specifies the pointer icon that is rendered in the spatialized scene.

SpatialSoundPool

Provides spatial audio extensions on the framework SoundPool class.

SpatialUser

The User object is used to retrieve information about the user.

SpatialVisibility

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

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
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

ActivityPose.HitTestFilter

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

AnchorEntity.State
GltfModelEntity.AnimationState
HitTestResult.SurfaceType
PlaneSemantic

Semantic plane types.

PlaneType

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

Space

Coordinate spaces in which to apply the transformation values.

SpatialPointerIconCircle

Renders the icon for the pointer as a circle.

SpatialPointerIconNone

Do not render an icon for the pointer; this option can be used to hide the pointer icon, either because the client wants it to be invisible or to implement custom icon rendering.

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.

Annotations

Enums

AnchorEntity.PersistState

Specifies the current persist state of the Anchor.

CameraView.CameraType

Describes the type of camera that this CameraView represents.

Extension properties summary

Extension properties