androidx.xr.scenecore


Annotations

ExperimentalCustomMeshApi

Marks the CustomMesh and related APIs as experimental.

ExperimentalSurfaceEntityPixelDimensionsApi

Marks the SurfaceEntity.getPixelDimensions() method as experimental.

Interfaces

Entity

Interface for a spatial Entity.

EntityMoveListener

Listener for move actions.

Material

Represents a Material in SceneCore.

ScenePose

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

SoundEffectPlayer

Provides playback control for instances of SoundEffect.

SoundEffectPool.LoadCompleteListener

Callback interface for receiving notification when a sound effect has finished loading.

SpatializerConstants

Constants for spatialized audio.

SurfaceEntity.Shape

Represents the shape of the Canvas that backs a SurfaceEntity.

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.

AlphaMode

Defines the constants for a Material's alpha mode, which corresponds to the glTF specification.

AnchorEntity

An AnchorEntity tracks 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.

AnchorEntity.State
AnchorPlacement

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

BaseEntity

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

BaseScenePose

The BaseScenePose implements the ScenePose interface.

BoundsComponent

A component that monitors the bounds of an entity and notifies registered listeners of changes.

ByteBufferRegion

A container holding a reference to a ByteBuffer, along with an offset and size.

Component

A Component adds functionality or behaviors to an Entity.

CustomMesh

An immutable resource that defines the structure of a renderable mesh.

CustomMesh.FromMeshBufferBuilder

Builder for CustomMesh using an existing MeshBuffer.

CustomMesh.FromMeshDataBuilder

Builder for CustomMesh providing raw data directly.

ExrImage

Represents an EXR image in SceneCore.

GltfAnimation

GltfAnimation represents an animation in a GltfModelEntity.

GltfAnimation.AnimationState

Specifies the current animation state of this GltfAnimation.

GltfAnimationStartOptions

Animation options for starting a GltfAnimation.

GltfModel

GltfModel represents a glTF resource in SceneCore.

GltfModelEntity

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

GltfModelNode

GltfModelNode represents a node in a GltfModelEntity.

GroupEntity

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

HitTestResult

Specifies an intersection between a ray and the Scene.

InputEvent

Defines input events for SceneCore.

InputEvent.Action

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

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.

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.

InteractableComponent

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

KhronosPbrMaterial

Represents a lit PBR (Physically-Based Rendering) material, which defines the visual appearance of a surface by simulating its interaction with light.

KhronosUnlitMaterial

Represents an unlit material, which is not affected by scene lighting.

LaunchUtils
MainPanelEntity

Represents the main spatialized panel in a Scene.

MeshBuffer

A container holding raw vertex and index data for custom meshes.

MeshEntity

A renderable entity in the scene graph that renders a CustomMesh.

MeshSubset

Defines a subset of the mesh to draw.

MeshSubsetTopology

Defines the topology of the indices in a MeshSubset.

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

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.

PlaneOrientation

Orientation of a plane, to specify valid surfaces for anchoring.

PlaneSemanticType

The detected semantic type of a plane, to specify valid surfaces for anchoring.

PointSourceParams

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

PointerCaptureComponent

Provides pointer capture capabilities for a given Entity.

PointerCaptureComponent.PointerCaptureState

Defines the possible states of a PointerCaptureComponent.

PositionalAudioComponent

A Component that provides positional spatial audio playback for an 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.

ResizeEvent.ResizeState
Scene

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

SessionExt
SoundEffect

Represents a handle to a single sound effect loaded into memory.

SoundEffectPool

Manages the loading and unloading of sound assets into memory.

SoundEffectPoolComponent

Provides positional sound pool audio playback for an Entity.

SoundFieldAttributes

Configures a sound source to be played as an ambisonics sound field.

SoundFieldAudioComponent

Provides spatial audio playback for a sound field associated with an Entity.

Space

Coordinate spaces in which to apply transformation values.

SpatialCapability

Constants representing the spatial capabilities of a Scene.

SpatialEnvironment

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

SpatialEnvironment.SpatialEnvironmentPreference

Represents the preferred spatial environment for the application.

SpatialModeChangeEvent

An event that is dispatched when the spatial mode for the scene has changed.

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.

SpatialVisibility

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

SpatializerConstants.AmbisonicsOrder

Specifies the Ambisonics order of a SoundFieldAttributes

SpatializerConstants.SourceType

Represents the type of spatialization for an audio source.

Stream

Represents the handle of a SoundEffect that was returned by SoundEffectPlayer.play.

SurfaceEntity

SurfaceEntity is an Entity that hosts a Surface, which will be texture mapped onto the Shape.

SurfaceEntity.EdgeFeatheringParams

Represents edge fading effects for a SurfaceEntity.

SurfaceEntity.EdgeFeatheringParams.NoFeathering

Applies no edge fading to any canvas.

SurfaceEntity.EdgeFeatheringParams.RectangleFeather
SurfaceEntity.Shape.Hemisphere

An inwards-facing hemisphere-shaped canvas, where (0,0,0) is the center of the base of the hemisphere.

SurfaceEntity.Shape.Quad

A Quadrilateral-shaped canvas.

SurfaceEntity.Shape.Sphere

cal An inwards-facing sphere-shaped mesh, centered at (0,0,0) in the local coordinate space.

SurfaceEntity.StereoMode

Specifies how the surface content will be routed for stereo viewing.

SurfaceEntity.SuperSampling

Specifies whether super sampling should be enabled for this surface.

SurfaceEntity.SurfaceProtection

Specifies whether the Surface which backs this Entity should be backed by android.hardware.HardwareBuffers with the USAGE_PROTECTED_CONTENT flag set.

Texture

Represents a Texture in SceneCore.

TextureSampler

Defines the sampling behavior for a texture.

TextureSampler.MagnificationFilter

Defines the constants for texture magnification filters.

TextureSampler.MinificationFilter

Defines the constants for texture minification filters.

TextureSampler.WrapMode

Defines the constants for texture wrap modes.

VertexAttribute

Defines the attribute of a vertex.

VertexAttributeDescriptor

Descriptor for a single vertex attribute.

VertexAttributeType

Defines the type of data for a vertex attribute.

VertexLayout

Layout of a vertex, composed of multiple attribute descriptors.

HitTestResult.SurfaceType
ScenePose.HitTestFilter

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

SpatialAudioTrack

Provides spatial audio extensions on the framework AudioTrack class.

SpatialAudioTrackBuilder

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

SpatialMediaPlayer

Provides spatial audio extensions on the framework MediaPlayer class.

SpatialSoundPool

Provides spatial audio extensions on the framework SoundPool class.

SpatialWindow

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