# androidx.xr.scenecore

*** ** * ** ***

## Annotations

|---|---|
| `https://developer.android.com/reference/androidx/xr/scenecore/ExperimentalGltfAnimationApi` | Marks the GltfAnimation APIs as experimental. |
| `https://developer.android.com/reference/androidx/xr/scenecore/ExperimentalSurfaceEntityPixelDimensionsApi` | Marks the SurfaceEntity.getPixelDimensions() method as experimental. |

## Interfaces

|---|---|
| `https://developer.android.com/reference/androidx/xr/scenecore/EntityMoveListener` | Listener for move actions. |
| `https://developer.android.com/reference/androidx/xr/scenecore/Material` | Represents a `https://developer.android.com/reference/androidx/xr/scenecore/Material` in SceneCore. |
| `https://developer.android.com/reference/androidx/xr/scenecore/ScenePose` | A `https://developer.android.com/reference/androidx/xr/runtime/math/Pose` in the Scene graph, which can be transformed into a Pose relative to another ScenePose. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SoundEffectPlayer` | Provides playback control for instances of `https://developer.android.com/reference/androidx/xr/scenecore/SoundEffect`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SoundEffectPool.LoadCompleteListener` | Callback interface for receiving notification when a sound effect has finished loading. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpatializerConstants` | Constants for spatialized audio. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.Shape` | Represents the shape of the Canvas that backs a SurfaceEntity. |

## Classes

|---|---|
| `https://developer.android.com/reference/androidx/xr/scenecore/ActivityPanelEntity` | ActivityPanelEntity creates a spatial panel for embedding an `https://developer.android.com/reference/android/app/Activity.html` in Android XR. |
| `https://developer.android.com/reference/androidx/xr/scenecore/ActivitySpace` | ActivitySpace is a `https://developer.android.com/reference/androidx/xr/scenecore/SpaceEntity` used to track the system-managed pose and boundary of the volume associated with a spatialized Activity. |
| `https://developer.android.com/reference/androidx/xr/scenecore/AlphaMode` | Defines the constants for a `https://developer.android.com/reference/androidx/xr/scenecore/Material`'s alpha mode, which corresponds to the [glTF specification](https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html). |
| `https://developer.android.com/reference/androidx/xr/scenecore/AnchorPlacement` | AnchorPlacement for setting how an `https://developer.android.com/reference/androidx/xr/scenecore/Entity` should be anchored in a `https://developer.android.com/reference/androidx/xr/scenecore/MovableComponent`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/AnchorSpace` | An AnchorSpace is a `https://developer.android.com/reference/androidx/xr/scenecore/SpaceEntity` tracks a `https://developer.android.com/reference/androidx/xr/runtime/math/Pose` relative to some position or surface in the "Real World." Children of this `https://developer.android.com/reference/androidx/xr/scenecore/SpaceEntity` will remain positioned relative to that location in the real world. |
| `https://developer.android.com/reference/androidx/xr/scenecore/AnchorSpace.State` |   |
| `https://developer.android.com/reference/androidx/xr/scenecore/BaseScenePose` | The BaseScenePose implements the `https://developer.android.com/reference/androidx/xr/scenecore/ScenePose` interface. |
| `https://developer.android.com/reference/androidx/xr/scenecore/BoundsComponent` | A component that monitors the bounds of an entity and notifies registered listeners of changes. |
| `https://developer.android.com/reference/androidx/xr/scenecore/ByteBufferRegion` | A container holding a reference to a `https://developer.android.com/reference/java/nio/ByteBuffer.html`, along with an offset and size. |
| `https://developer.android.com/reference/androidx/xr/scenecore/Component` | A Component adds functionality or behaviors to an `https://developer.android.com/reference/androidx/xr/scenecore/Entity`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/CustomMesh` | A resource that defines the structure of a renderable mesh. |
| `https://developer.android.com/reference/androidx/xr/scenecore/CustomMesh.BuilderFromMeshBuffer` | Builder for `https://developer.android.com/reference/androidx/xr/scenecore/CustomMesh` using an existing `https://developer.android.com/reference/androidx/xr/scenecore/MeshBuffer`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/CustomMesh.BuilderFromMeshData` | Builder for `https://developer.android.com/reference/androidx/xr/scenecore/CustomMesh` providing raw data directly. |
| `https://developer.android.com/reference/androidx/xr/scenecore/Entity` | An Entity is the fundamental building block of a SceneCore `https://developer.android.com/reference/androidx/xr/scenecore/Scene`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/GltfAnimation` | `https://developer.android.com/reference/androidx/xr/scenecore/GltfAnimation` represents an animation in a `https://developer.android.com/reference/androidx/xr/scenecore/GltfModelEntity`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/GltfAnimation.AnimationState` | Specifies the current animation state of this `https://developer.android.com/reference/androidx/xr/scenecore/GltfAnimation`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/GltfAnimationStartOptions` | **This class is deprecated.** Use GltfAnimation.loop and GltfAnimation.speed properties with parameterless start() instead. |
| `https://developer.android.com/reference/androidx/xr/scenecore/GltfModel` | GltfModel represents a [glTF](https://www.khronos.org/Gltf) resource in SceneCore. |
| `https://developer.android.com/reference/androidx/xr/scenecore/GltfModelEntity` | GltfModelEntity is a concrete implementation of Entity that hosts a glTF model. |
| `https://developer.android.com/reference/androidx/xr/scenecore/GltfModelNode` | `https://developer.android.com/reference/androidx/xr/scenecore/GltfModelNode` represents a node in a `https://developer.android.com/reference/androidx/xr/scenecore/GltfModelEntity`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/HitTestResult` | Specifies an intersection between a ray and the Scene. |
| `https://developer.android.com/reference/androidx/xr/scenecore/ImageBasedLightingAsset` | Represents an image based lighting asset which contains lighting information for the scene. |
| `https://developer.android.com/reference/androidx/xr/scenecore/InputEvent` | Defines input events for SceneCore. |
| `https://developer.android.com/reference/androidx/xr/scenecore/InputEvent.Action` | Specifies the action (e.g. down, up, move, etc.) of the input event. |
| `https://developer.android.com/reference/androidx/xr/scenecore/InputEvent.HitInfo` | Information about the hit result of the input ray, originating from one of the `https://developer.android.com/reference/androidx/xr/scenecore/InputEvent.Source`, and intersecting with some `https://developer.android.com/reference/androidx/xr/scenecore/Entity` on the scene. |
| `https://developer.android.com/reference/androidx/xr/scenecore/InputEvent.Pointer` | Specifies the pointer type (e.g. left, right or default) of the input event. |
| `https://developer.android.com/reference/androidx/xr/scenecore/InputEvent.Source` | Specifies the source (e.g. hands, controller, head) of the input event. |
| `https://developer.android.com/reference/androidx/xr/scenecore/InteractableComponent` | Provides access to raw `https://developer.android.com/reference/androidx/xr/scenecore/InputEvent`s for given `https://developer.android.com/reference/androidx/xr/scenecore/Entity`, so a client can implement their own interaction logic. |
| `https://developer.android.com/reference/androidx/xr/scenecore/KhronosPbrMaterial` | Represents a lit PBR (Physically-Based Rendering) material, which defines the visual appearance of a surface by simulating its interaction with light. |
| `https://developer.android.com/reference/androidx/xr/scenecore/KhronosUnlitMaterial` | Represents an unlit material, which is not affected by scene lighting. |
| `https://developer.android.com/reference/androidx/xr/scenecore/LaunchUtils` |   |
| `https://developer.android.com/reference/androidx/xr/scenecore/MainPanelEntity` | Represents the main spatialized panel in a `https://developer.android.com/reference/androidx/xr/scenecore/Scene`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/MeshBuffer` | Container holding raw vertex and index data for custom meshes. |
| `https://developer.android.com/reference/androidx/xr/scenecore/MeshBuffer.MeshUsage` | Describes the intended usage and mutability of a `https://developer.android.com/reference/androidx/xr/scenecore/MeshBuffer`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/MeshEntity` | A renderable entity in the scene graph that renders a `https://developer.android.com/reference/androidx/xr/scenecore/CustomMesh`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/MeshSubset` | Defines a subset of the mesh to draw. |
| `https://developer.android.com/reference/androidx/xr/scenecore/MeshSubsetTopology` | Defines the topology of the indices in a `https://developer.android.com/reference/androidx/xr/scenecore/MeshSubset`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/MovableComponent` | This `https://developer.android.com/reference/androidx/xr/scenecore/Component` can be attached to a single instance of an `https://developer.android.com/reference/androidx/xr/scenecore/Entity`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/PanelClippingConfig` | Defines the clipping configuration for all panels within the `https://developer.android.com/reference/androidx/xr/scenecore/Scene`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/PanelEntity` | PanelEntity contains an arbitrary 2D Android `https://developer.android.com/reference/android/view/View.html`, within a spatialized XR scene. |
| `https://developer.android.com/reference/androidx/xr/scenecore/PerceivedResolutionResult` | Represents the outcome of an attempt to calculate the perceived resolution of an entity. |
| `https://developer.android.com/reference/androidx/xr/scenecore/PerceivedResolutionResult.EntityTooClose` | Indicates that the perceived resolution could not be calculated because the entity is too close to the camera. |
| `https://developer.android.com/reference/androidx/xr/scenecore/PerceivedResolutionResult.InvalidRenderViewpoint` | Indicates that the perceived resolution could not be calculated because the required camera view information was invalid or insufficient for the calculation. |
| `https://developer.android.com/reference/androidx/xr/scenecore/PerceivedResolutionResult.Success` | Indicates that the perceived resolution was successfully calculated. |
| `https://developer.android.com/reference/androidx/xr/scenecore/PerceptionSpace` | PerceptionSpace is an `https://developer.android.com/reference/androidx/xr/scenecore/ScenePose` used to track the origin of the space used by ARCore for Jetpack XR APIs. |
| `https://developer.android.com/reference/androidx/xr/scenecore/PixelDensity` | Represents a pixel density, analogous to the pixel density of a physical display like a computer monitor or TV. |
| `https://developer.android.com/reference/androidx/xr/scenecore/PlaneOrientation` | Orientation of a plane, to specify valid surfaces for anchoring. |
| `https://developer.android.com/reference/androidx/xr/scenecore/PlaneSemanticType` | The detected semantic type of a plane, to specify valid surfaces for anchoring. |
| `https://developer.android.com/reference/androidx/xr/scenecore/PointSourceParams` | Configures a sound source to be spatialized at a 3D location. |
| `https://developer.android.com/reference/androidx/xr/scenecore/PointerCaptureComponent` | Provides pointer capture capabilities for a given `https://developer.android.com/reference/androidx/xr/scenecore/Entity`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/PointerCaptureComponent.PointerCaptureState` | Defines the possible states of a `https://developer.android.com/reference/androidx/xr/scenecore/PointerCaptureComponent`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/PositionalAudioComponent` | A Component that provides positional spatial audio playback for an `https://developer.android.com/reference/androidx/xr/scenecore/Entity`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/ResizableComponent` | This `https://developer.android.com/reference/androidx/xr/scenecore/Component` can be attached to a single instance of an `https://developer.android.com/reference/androidx/xr/scenecore/Entity`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/ResizeEvent` | A resize event which is sent in response to the User interacting with the `https://developer.android.com/reference/androidx/xr/scenecore/ResizableComponent`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/ResizeEvent.ResizeState` |   |
| `https://developer.android.com/reference/androidx/xr/scenecore/Scene` | Scene is the primary interface to SceneCore functionality for the application. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SessionExt` |   |
| `https://developer.android.com/reference/androidx/xr/scenecore/SoundEffect` | Represents a handle to a single sound effect loaded into memory. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SoundEffectPool` | Manages the loading and unloading of sound assets into memory. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SoundEffectPoolComponent` | Provides positional sound pool audio playback for an `https://developer.android.com/reference/androidx/xr/scenecore/Entity`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SoundFieldAttributes` | Configures a sound source to be played as an ambisonics sound field. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SoundFieldAudioComponent` | Provides spatial audio playback for a sound field associated with an `https://developer.android.com/reference/androidx/xr/scenecore/Entity`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/Space` | Coordinate spaces in which to apply transformation values. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpaceChangeEvent` | An event that is dispatched when the space for the scene has changed, such as from Home Space to Full Space |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpaceEntity` | A SpaceEntity is a special Entity subtype whose position is independent of other SpaceEntity. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpatialCapability` | Constants representing the spatial capabilities of a `https://developer.android.com/reference/androidx/xr/scenecore/Scene`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpatialEnvironment` | The SpatialEnvironment is used to manage the XR background and passthrough. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpatialEnvironment.SpatialEnvironmentPreference` | Represents the preferred spatial environment for the application. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpatialPointerComponent` | `https://developer.android.com/reference/androidx/xr/scenecore/Component` that modifies the pointer icon that is rendered on the component's `https://developer.android.com/reference/androidx/xr/scenecore/Entity`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpatialPointerIcon` | Specifies the icon that is rendered at the pointer's location on entities in the spatialized scene. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpatialVisibility` | Spatial Visibility states of content within the user's field of view. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpatializerConstants.AmbisonicsOrder` | Specifies the Ambisonics order of a `https://developer.android.com/reference/androidx/xr/scenecore/SoundFieldAttributes` |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpatializerConstants.SourceType` | Represents the type of spatialization for an audio source. |
| `https://developer.android.com/reference/androidx/xr/scenecore/Stream` | Represents the handle of a `https://developer.android.com/reference/androidx/xr/scenecore/SoundEffect` that was returned by `https://developer.android.com/reference/androidx/xr/scenecore/SoundEffectPlayer#play(androidx.xr.scenecore.SoundEffect,kotlin.Float,kotlin.Int,kotlin.Boolean)`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity` | SurfaceEntity is an `https://developer.android.com/reference/androidx/xr/scenecore/Entity` that hosts a `https://developer.android.com/reference/android/view/Surface.html`, which will be texture mapped onto the `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.Shape`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.EdgeFeatheringParams` | Represents edge fading effects for a SurfaceEntity. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.EdgeFeatheringParams.NoFeathering` | Applies no edge fading to any canvas. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.EdgeFeatheringParams.RectangleFeather` |   |
| `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.Shape.Hemisphere` | An inwards-facing hemisphere-shaped canvas, where (0,0,0) is the center of the base of the hemisphere. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.Shape.Quad` | A Quadrilateral-shaped canvas. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.Shape.Sphere` | cal An inwards-facing sphere-shaped mesh, centered at (0,0,0) in the local coordinate space. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.StereoMode` | Specifies how the surface content will be routed for stereo viewing. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.SuperSampling` | Specifies whether super sampling should be enabled for this surface. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SurfaceEntity.SurfaceProtection` | Specifies whether the `https://developer.android.com/reference/android/view/Surface.html` which backs this `https://developer.android.com/reference/androidx/xr/scenecore/Entity` should be backed by `https://developer.android.com/reference/android/hardware/HardwareBuffer.html`s with the USAGE_PROTECTED_CONTENT flag set. |
| `https://developer.android.com/reference/androidx/xr/scenecore/Texture` | Represents a `https://developer.android.com/reference/androidx/xr/scenecore/Texture` in SceneCore. |
| `https://developer.android.com/reference/androidx/xr/scenecore/TextureSampler` | Defines the sampling behavior for a texture. |
| `https://developer.android.com/reference/androidx/xr/scenecore/TextureSampler.MagnificationFilter` | Defines the constants for texture magnification filters. |
| `https://developer.android.com/reference/androidx/xr/scenecore/TextureSampler.MinificationFilter` | Defines the constants for texture minification filters. |
| `https://developer.android.com/reference/androidx/xr/scenecore/TextureSampler.WrapMode` | Defines the constants for texture wrap modes. |
| `https://developer.android.com/reference/androidx/xr/scenecore/VertexAttribute` | Defines the attribute of a vertex. |
| `https://developer.android.com/reference/androidx/xr/scenecore/VertexAttributeDescriptor` | Descriptor for a single vertex attribute. |
| `https://developer.android.com/reference/androidx/xr/scenecore/VertexAttributeType` | Defines the type of data for a vertex attribute. |
| `https://developer.android.com/reference/androidx/xr/scenecore/VertexBufferLayout` | Layout of a vertex buffer, composed of multiple attribute descriptors. |
| `https://developer.android.com/reference/androidx/xr/scenecore/VertexLayout` | Layout of a vertex, composed of multiple buffer layouts. |
| `https://developer.android.com/reference/androidx/xr/scenecore/VertexLayout.Builder` | Builder for `https://developer.android.com/reference/androidx/xr/scenecore/VertexLayout`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/HitTestResult.SurfaceType` |   |
| `https://developer.android.com/reference/androidx/xr/scenecore/ScenePose.HitTestFilter` | A filter for which Scenes to hit test with `https://developer.android.com/reference/androidx/xr/scenecore/ScenePose#hitTest(androidx.xr.runtime.math.Vector3,androidx.xr.runtime.math.Vector3)`. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpatialAudioTrack` | Provides spatial audio extensions on the framework `https://developer.android.com/reference/android/media/AudioTrack.html` class. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpatialAudioTrackBuilder` | Provides spatial audio extensions on the platform `https://developer.android.com/reference/android/media/AudioTrack.Builder.html` class. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpatialMediaPlayer` | Provides spatial audio extensions on the framework `https://developer.android.com/reference/android/media/MediaPlayer.html` class. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpatialSoundPool` | Provides spatial audio extensions on the framework `https://developer.android.com/reference/android/media/SoundPool.html` class. |
| `https://developer.android.com/reference/androidx/xr/scenecore/SpatialWindow` | Methods used to manage the `https://developer.android.com/reference/android/app/Activity.html`'s main spatial window when it is displayed in Home Space Mode. |