RealityFoundation

Entities and Scene Queries 10

Core protocols and types for organizing entities, defining systems, and querying a scene's component graph.

• Pr
  ComponentiOS 13.0+

  A representation of a geometry or a behavior that you apply to an entity.
• Pr
  SystemiOS 15.0+

  An object that affects multiple entities in every update of a RealityKit
• Pr
  TransientComponentiOS 15.0+

  An interface for components that aren’t saved to file or cloned.
• Pr
  EntityCollectioniOS 18.0+

  An ordered, mutable collection of entities.
• St
  EntityQueryiOS 15.0+

  An object that retrieves entities from a scene.
• St
  QueryPredicateiOS 15.0+

  An object that defines the criteria for an entity query.
• St
  QueryResultiOS 15.0+

  An object that returns the results of an entity query.
• St
  ReferenceComponentiOS 18.0+

  A component that can load another entity from a file.
• St
  AccessibilityComponentiOS 17.0+

  A component that stores accessibility information for an entity.
• St
  AttachedTransformComponentiOS 26.0+

  A component that stores an optional source pin owned by this entity and

Anchoring and Spatial Tracking 8

Components and sessions that anchor content to real-world surfaces and track spatial input and body pose.

• St
  AnchoringComponentiOS 13.0+

  A component that anchors virtual content to a real world target.
• Cl
  SpatialTrackingSession

  An object that incorporates spatial tracking capabilities into your RealityKit apps.
• St
  InputTargetComponentiOS 18.0+

  A component that gives an entity the ability to receive system input.
• St
  GestureComponentiOS 26.0+

  A component attaching a UI gesture to an entity.
• St
  HoverEffectComponent

  A component that applies a visual effect to a hierarchy of entities when a person looks at or selects an entity.
• St
  BodyTrackingComponent

  A component for tracking people in an AR session.
• Pr
  RealityCoordinateSpaceiOS 18.0+

  A 3D coordinate space that exists within a RealityKit hierarchy.
• St
  CameraRealityCoordinateSpace

  The coordinate space that represents the scene's active camera.

Animation 17

Definitions, groups, and timing types for driving keyframed, action-based, and orbital animation on entities.

• Pr
  AnimationDefinitioniOS 15.0+

  The configuration, including target object, timeframe, and visual semantics,
• Pr
  AnimatableDataiOS 15.0+

  A functionality specification that animatable data types adopt.
• Pr
  BindableDataiOS 15.0+

  An opaque base protocol for bindable data objects.
• St
  ActionAnimationiOS 18.0+

  Defines an an action animation.
• St
  AnimationGroupiOS 15.0+

  A collection of animations that play simultaneously.
• St
  FromToByAnimationiOS 15.0+

  An animation that starts, stops, or increments by a specific value.
• St
  OrbitAnimationiOS 15.0+

  An animation that revolves an entity around its origin.
• St
  BlendTreeAnimationiOS 15.0+

  A collection of animations on the same property that the framework blends to
• St
  AnimationFillModeiOS 15.0+

  Options that determine which animation frames display outside of the normal
• St
  AnimationTimingFunctioniOS 13.0+

  The pacing of an animation transition.
• St
  AnimationHandoffTypeiOS 18.0+

  The type of handoff the play animation method performs between a current animation and a new animation.
• St
  AnimationViewiOS 15.0+

  An animation that represents a variation of another animation.
• Cl
  AnimationGraphResourceiOS 27.0+

  A compiled animation graph resource that drives skeletal animation on an entity.
• St
  AnimationGraphComponentiOS 27.0+

  A component that drives skeletal animation on an entity using a node-based animation graph.
• St
  AnimationLibraryComponentiOS 18.0+

  A component that represents a collection of animations that an entity can play.
• St
  AnimationStateiOS 18.0+

  The concretely typed animation state structure.
• Pr
  AnimationStateProtocoliOS 18.0+

  The protocol representing the current animation state of an action animation.

Blend Trees and Bindings 9

Blend-tree nodes and data bindings that combine and parameterize animation graphs.

• Pr
  BlendTreeNodeiOS 15.0+

  An interface for a node that's a member of a blend tree.
• St
  BlendTreeBlendNodeiOS 15.0+

  A source node for an animation that mixes several animations to form a
• St
  BlendTreeSourceNodeiOS 15.0+

  A blend node that contains an animation.
• St
  BlendTreeInvalidNodeiOS 15.0+

  A blend tree node that's internal only or sources from an invalid
• St
  BindableValueiOS 15.0+

  The value of a bindable target.
• St
  BindableValuesReferenceiOS 15.0+

  A reference to a bindable value of an animation.
• St
  BindPathiOS 15.0+

  The components of a target's path that refer to the animation properties of
• St
  InternalBindPath

  A bind target for framework-provided properties.
• St
  ParameterSetiOS 15.0+

  A reference to general-purpose entity parameters for animations.

Entity Actions and Events 15

Action types and the event system for scheduling behavior and responding to what happens in a scene.

• Pr
  EntityActioniOS 18.0+

  A protocol that defines an action for an entity.
• Pr
  ActionHandlerProtocoliOS 18.0+

  The base protocol for action handlers.
• St
  ActionEventiOS 18.0+

  The structure returned to all action event handlers.
• St
  ActionEventDefinitioniOS 18.0+

  Defines an action event interval, and any associated parameters.
• St
  ActionEventTypeiOS 18.0+

  A set of events that an action responds to.
• St
  BillboardActioniOS 18.0+

  An action that animates the blend factor of an entity's billboard component.
• St
  EmphasizeActioniOS 18.0+

  An action that performs an animation to call attention to an entity.
• St
  FromToByActioniOS 18.0+

  An action that starts, stops, or increments by a specific value.
• St
  ImpulseActioniOS 18.0+

  An action that applies an impulse to the physics body at its center of mass when
• St
  OrbitEntityActioniOS 18.0+

  An action which animates the transform of an entity to revolve around a specified pivot entity.
• St
  PlayAnimationActioniOS 18.0+

  An action that plays an animation on the given target entity with a range of playback options.
• St
  PlayAudioActioniOS 18.0+

  An action which plays an audio resource on the given target entity.
• Pr
  EventiOS 13.0+

  A type that can be sent as an event.
• Pr
  EventSourceiOS 13.0+

  A type on which events can be published and subscribed.
• St
  EventSubscriptioniOS 18.0+

  A subscription to an event.

Behavior Trees 4

Resources, components, and protocols for authoring and running behavior-tree logic.

• Cl
  BehaviorTreeResourceiOS 27.0+

  An immutable representation of a behavior tree.
• St
  BehaviorTreeComponentiOS 27.0+

  A component that runs a behavior tree to drive an entity's logic.
• Pr
  BehaviorTreeActioniOS 27.0+

  A protocol for actions that a behavior tree can execute.
• Pr
  BehaviorTreeActionHandleriOS 27.0+

  A protocol for objects that run custom behavior-tree actions.

Audio 7

Components and configuration that attach spatial, ambient, and channel-based audio to entities.

• St
  AmbientAudioComponentiOS 18.0+

  A component that configures the ambient rendering of sounds from an entity.
• St
  ChannelAudioComponentiOS 18.0+

  A component that configures channel-based rendering of sounds from an entity.
• St
  AudioLibraryComponentiOS 18.0+

  A container for audio resources that you can look up by user-defined names.
• St
  AudioGeneratorConfigurationiOS 18.0+

  A container for various settings for preparing and playing an AudioGeneratorController.
• St
  AudioMixGroupiOS 18.0+

  A group that manages the playback properties of multiple playing sounds.
• St
  AudioMixGroupsComponentiOS 18.0+

  A component that provides functionality for controlling the playback of audio you assign to mix groups in a scene.
• Cl
  ReverbMeshResourceiOS 27.0+

  A resource describing room geometry used to compute spatial audio reverb.

Materials and Lighting Models 10

Material protocols and concrete material and lighting-model types for surfacing rendered geometry.

• Pr
  MaterialiOS 13.0+

  A type that describes the material aspects of a mesh, like color and
• Pr
  MaterialFunctioniOS 15.0+

  The abstract superclass for objects representing compute functions for RealityKit custom materials .
• St
  MaterialParametersiOS 15.0+

  A type that holds the set of parameters configuring a material.
• St
  MaterialParameterTypesiOS 15.0+

  A set of types that material parameters can use.
• St
  CustomMaterial

  A material that works with custom Metal shader functions.
• St
  PhysicallyBasedMaterialiOS 15.0+

  A material that simulates the appearance of real-world objects.
• St
  OcclusionMaterialiOS 13.0+

  An invisible material that hides objects rendered behind it.
• St
  PortalMaterialiOS 18.0+

  A material that makes the mesh part a portal to a different world.
• St
  LitLightingModeliOS 27.0+

  Configuration for RealityKit's physically based lighting model.
• St
  HairLightingModeliOS 27.0+

  Configuration for RealityKit's hair lighting model.

Lighting and Image-Based Lighting 12

Components and resources for direct lights, image-based lighting, light probes, and shadows.

• St
  DirectionalLightComponentiOS 13.0+

  A component that defines a directional light source.
• St
  PointLightComponentiOS 13.0+

  A component that defines a point light source.
• St
  ImageBasedLightComponentiOS 18.0+

  A component that lights an entity using an image-based light source.
• St
  ImageBasedLightReceiverComponentiOS 18.0+

  A component that lets an entity receive image-based lighting.
• Cl
  DiffuseProbeResourceiOS 27.0+

  A resource containing baked diffuse lighting data organized as a tetrahedral probe mesh.
• St
  DiffuseLightProbeGroupComponentiOS 27.0+

  A component that stores diffuse probe data for a spatial region.
• St
  DiffuseLightProbeReceiverComponentiOS 27.0+

  A component that receives diffuse lighting from a referenced probe group.
• St
  EnvironmentLightingConfigurationComponentiOS 18.0+

  A component that scales the amount of light that an entity receives from its environment.
• St
  DynamicLightShadowComponentiOS 18.0+

  A component that controls an entity's shadow from dynamic (virtual) lights.
• St
  GroundingShadowComponentiOS 18.0+

  A component that controls an entity's grounding shadow.
• Cl
  LightmapResourceiOS 27.0+

  A resource containing references to lightmap texture atlases
• St
  LightmapComponentiOS 27.0+

  A component that applies precomputed lightmap data to an entity.

Meshes and Geometry 16

Descriptors, buffers, and collections that define mesh geometry, instancing, and skeletons.

• St
  MeshDescriptoriOS 15.0+

  Defines a 3D mesh's structure and data.
• St
  MeshBufferiOS 15.0+

  Mesh buffer containing elements of any type.
• St
  AnyMeshBufferiOS 15.0+

  Mesh buffer stored in the container.
• Pr
  MeshBufferContaineriOS 15.0+

  Conforming objects contain a table of mesh buffers.
• Pr
  MeshBufferSemanticiOS 15.0+

  A protocol that holds an identifier value for mesh buffers.
• St
  MeshScopeiOS 27.0+

  The elements of a mesh resource that a deformation stack applies to.
• St
  MeshInstanceCollectioniOS 15.0+

  An object that holds a collection of mesh resource instances.
• St
  MeshInstancesComponentiOS 26.0+

  A component that performs GPU instancing on the model of the same entity.
• St
  MeshModelCollectioniOS 15.0+

  An object that holds a collection of mesh models.
• St
  MeshPartCollectioniOS 15.0+

  An object that holds a collection of mesh parts.
• St
  MeshSkeletonCollectioniOS 18.0+

  An object that holds a collection of skeletons used by a mesh resource.
• St
  MeshJointInfluenceiOS 18.0+

  A binding to a joint, which consists of the joint's index and the weight of that joint's
• Cl
  SkeletonResourceiOS 27.0+

  Represents a skeleton asset with joint hierarchy and animation capabilities.
• St
  JointTransformsiOS 15.0+

  A set of animatable transform values for joints that collectively represent
• St
  ModelComponentiOS 13.0+

  A component that contains a mesh and materials for the visual appearance of an entity.
• St
  ModelDebugOptionsComponentiOS 14.0+

  A component that changes how RealityKit renders its entity to help with

Mesh Deformation and Blend Shapes 14

Deformers and blend-shape types that animate and reshape mesh vertices at runtime.

• Pr
  MeshDeformeriOS 27.0+

  An interface for all deformation types in a deformation definition, both built-in and custom.
• St
  MeshDeformerComponentiOS 27.0+

  The component that applies mesh deformations to an `Entity`.
• St
  MeshDeformerOptionsiOS 27.0+

  Specifies constant options for `MeshDeformer`
• St
  MeshDeformerVertexOptionsiOS 27.0+

  MeshDeformerVertexOptions allows developers to specify which vertex types in the mesh to allocate in the input and output buffers for mesh deformations.
• St
  MeshDeformParameteriOS 27.0+

  Base class for GPU and CPU custom deform function input
• St
  MeshDeformationStackiOS 27.0+

  A set of `MeshDeformer`s to apply in order to a mesh, or a proper subset of the mesh specified by `Target`s.
• St
  BlendShapeDeformeriOS 27.0+

  A blend-shape deformation that interpolates between N meshes according to a weighted sum.
• St
  CalculateBoundingBoxDeformeriOS 27.0+

  Calculates a bounding box based on the current state of the deformed positions.
• St
  OpenSubdivisionDeformeriOS 27.0+

  OpenSubdiv surface deformation
• St
  BlendShapeWeightsiOS 18.0+

  A set of animatable weight values that collectively represent
• St
  BlendShapeWeightsComponentiOS 18.0+

  A component that provides access to the current weights associated with all blend shape meshes on an entity.
• St
  BlendShapeWeightsDataiOS 18.0+

  A structure that encapsulates the blend shape name, blend shape weights and the names
• St
  BlendShapeWeightsSetiOS 18.0+

  A custom collection of named blend shape weights.
• Cl
  BlendShapeWeightsMappingiOS 18.0+

  A mapping of blend weights to the target meshes that those weights affect.

Inverse Kinematics 4

Resources and components that solve inverse kinematics for skeletal rigs.

• Cl
  IKResourceiOS 18.0+

  A reference counted immutable resource which contains one or more inverse kinematics solver rigs.
• St
  IKComponentiOS 18.0+

  A component that allows you to procedurally animate a skeletal model using a full body inverse kinematics solver.
• St
  IKRigiOS 18.0+

  A full body inverse kinematics rig definition for a single skeleton.
• St
  IKSolverDefinitioniOS 18.0+

  A container describing a solver instance.

Physics and Collision 14

Components and parameters that simulate rigid-body physics, collisions, and character movement.

• St
  PhysicsBodyComponentiOS 13.0+

  A component that defines an entity’s behavior in physics body simulations.
• St
  PhysicsBodyParameterTypesiOS 18.0+

  Defines which rigid body inputs are required by a force effect's update handler.
• St
  PhysicsMotionComponentiOS 13.0+

  A component that controls the motion of the body in physics simulations.
• St
  PhysicsMassPropertiesiOS 13.0+

  Mass properties of a physics body.
• St
  PhysicsSimulationComponentiOS 18.0+

  A component that controls localized physics simulations.
• St
  CollisionComponentiOS 13.0+

  A component that gives an entity the ability to collide with other entities
• St
  CollisionFilteriOS 13.0+

  A set of masks that determine whether entities can collide during
• St
  CollisionGroupiOS 13.0+

  A bitmask used to define the collision group to which an entity belongs.
• St
  CollisionCastHitiOS 13.0+

  A hit result of a collision cast.
• St
  PixelCastHit

  A type describing a hit result from a per-pixel cast into a scene.
• St
  ContactiOS 18.0+

  Events associated with collisions.
• St
  OrientedBoundingBox

  Representation for an oriented bounding box.
• St
  CharacterControllerComponentiOS 15.0+

  A component that manages character movement.
• St
  CharacterControllerStateComponentiOS 15.0+

  A component that represents the state of a character controller.

Physics Joints and Pins 11

Joint and pin types that constrain how physically simulated bodies connect and move.

• Pr
  PhysicsJointiOS 18.0+

  A type that describes physics joints.
• St
  PhysicsJointsiOS 18.0+

  A collection of physics joints.
• St
  PhysicsJointsComponentiOS 18.0+

  A component that stores physics joints which RealityKit simulates.
• St
  PhysicsCustomJointiOS 18.0+

  A joint with six degrees of freedom that can be individually specified.
• St
  PhysicsDistanceJointiOS 18.0+

  A joint that maintains a minimum and maximum distance between two entity pins.
• St
  PhysicsFixedJointiOS 18.0+

  A joint that rigidly connects two entity pins, with zero degrees of freedom.
• St
  PhysicsPrismaticJointiOS 18.0+

  A joint that allows movement along a straight line, similar to a sliding drawer.
• St
  PhysicsRevoluteJointiOS 18.0+

  A joint that allows one degree of rotational freedom between two entity pins,
• St
  PhysicsSphericalJointiOS 18.0+

  A spherical joint that allows free rotational movement between two entities' pins.
• St
  GeometricPiniOS 18.0+

  A structure that identifies a local transform relative to an entity or entity's animating skeletal joint.
• St
  GeometricPinsComponentiOS 18.0+

  A component that stores a sequence of geometric pins.

Force Effects 10

Force-effect protocols and types that apply directional, radial, and drag forces to entities.

• St
  ForceEffectiOS 18.0+

  Defines a force effect's system, and type specific properties.
• Pr
  ForceEffectBaseiOS 18.0+

  The base protocol for the wrapping force effect structure containing
• Pr
  ForceEffectProtocoliOS 18.0+

  A protocol that defines a custom force effect.
• St
  ForceEffectComponentiOS 18.0+

  A component that defines the forces that affect an entity, including custom forces that you define.
• St
  ForceEffectEventiOS 18.0+

  A struct that defines the arguments to the custom force effect update closure.
• St
  ForceEffectParametersiOS 18.0+

  The force effect input data to the effect's update handler or closure.
• St
  ConstantForceEffectiOS 18.0+

  A force effect that exerts a constant force in a direction relative to the effect's transform.
• St
  ConstantRadialForceEffectiOS 18.0+

  A force effect that pulls objects toward its center with a constant strength.
• St
  RadialForceEffectiOS 18.0+

  A force effect that pulls objects toward its center with a spring-like (distance dependent) force.
• St
  DragForceEffectiOS 18.0+

  A force effect that slows bodies within its area of effect

Cameras and Rendering Layers 13

Camera components, controls, and render-layer types that frame and order what gets drawn.

• St
  PerspectiveCameraComponentiOS 13.0+

  A component that defines a virtual camera and its controls.
• St
  OrthographicCameraComponentiOS 18.0+

  A component that defines an orthographic virtual camera and its settings.
• St
  ProjectiveTransformCameraComponentiOS 18.0+

  A component that defines a virtual camera with a custom projection matrix.
• St
  CameraControls

  A type that configures interactive camera control behavior.
• St
  LensDistortionData

  A description of estimated lens distortion that can be used to rectify images.
• St
  RenderLayeriOS 27.0+

  A structured representation of render layers that provides type safety and clear semantics.
• St
  RenderLayerComponentiOS 27.0+

  A component that defines which layers an entity participates in.
• St
  ModelSortGroupiOS 18.0+

  A group that you assign to multiple entities to tell the renderer what
• St
  ModelSortGroupComponentiOS 18.0+

  A component that configures the rendering order for an entity's model.
• St
  AdaptiveResolutionComponentiOS 18.0+

  A component that provides the suggested pixels per meter necessary to render an object.
• St
  LevelOfDetailComponentiOS 27.0+

  A component that enables Level of Detail (LOD) optimization for entities with multiple detail levels.
• St
  OcclusionCullingComponentiOS 27.0+

  A component that controls whether the system performs occlusion
• Cl
  RealityRendereriOS 18.0+

  A renderer that displays a RealityKit scene in an existing Metal workflow.

Visual Effects and Rendering Components 13

Components and effects for portals, clipping, opacity, decals, particles, and post-processing.

• St
  PortalComponentiOS 18.0+

  A component that turns mesh surfaces into portals to a different world.
• St
  PortalCrossingComponentiOS 18.0+

  A component that allows entities to cross portal boundaries.
• St
  ClippingComponentiOS 27.0+

  A component that clips entities and their children to a customizable bounding box volume with feathered edges.
• St
  ClippingPrimitiveComponent

  Use ClippingComponent instead
• St
  OpacityComponentiOS 18.0+

  A component that controls the opacity of an entity and its descendants.
• St
  BillboardComponentiOS 18.0+

  A component that orients an entity instance so that it continuously points toward
• St
  PhysicallyBasedDecalComponentiOS 27.0+

  A component that projects a physically based decal onto surfaces.
• St
  ParticleEmitterComponentiOS 18.0+

  A component that emits particles.
• St
  BloomComponentiOS 27.0+

  The `BloomComponent` adds a luminous glow effect around bright objects in the scene
• St
  BloomOptionsComponentiOS 27.0+

  A component that sets the properties for the bloom post-processing effects.
• St
  BloomSettingsComponent

  A component that sets the properties for the bloom post-processing effects.
• Pr
  PostProcessEffect

  A protocol that defines hooks for custom post processing effects.
• St
  PostProcessEffectContext

  An object RealityKit passes data to a post process effect method.

Navigation 4

Resources and components that build navigation meshes and move entities along paths.

• Cl
  NavigationMeshResourceiOS 27.0+

  A resource describing a navigation mesh that entities can path across.
• St
  NavigationMeshComponentiOS 27.0+

  A component that associates a navigation mesh with an entity.
• St
  NavigationComponentiOS 27.0+

  A component that lets an entity navigate along a navigation mesh.
• St
  NavigationControlleriOS 27.0+

  A type that controls an entity's movement along navigation paths.

Loading and Low-Level Resources 4

Requests and low-level device buffers for loading and supplying GPU resource data.

• Cl
  LoadRequest

  A resource loader that acts as a publisher.
• Cl
  LowLevelBufferiOS 26.0+

  A class that provides direct access to a GPU buffer's underlying memory.
• Cl
  LowLevelDeviceResourceiOS 27.0+

  Encapsulates a GPU device resource created by the application.
• Cl
  LowLevelInstanceDataiOS 26.0+

  A class that supplies low-level per-instance data for instanced rendering.

Object Capture and Photogrammetry 2

Session and sample types that reconstruct 3D models from photographs.

• Cl
  PhotogrammetrySession

  Manages the creation of a 3D model from a set of images.
• St
  PhotogrammetrySample

  An object that represents one image and its corresponding metadata.

Multipeer Synchronization 3

Services and identifiers that synchronize entity state across networked peers.

• Pr
  SynchronizationServiceiOS 13.0+

  An interface that enables entity synchronization among a group of local
• Pr
  SynchronizationPeerIDiOS 13.0+

  A type that represents a peer among a group of networked devices.
• Cl
  NetworkCompatibilityToken

  An opaque token used to check the networking compatibility between two peers

Classes 28

• Cl
  AnchorEntityiOS 13.0+

  An anchor that tethers entities to a scene.
• Cl
  AnimationPlaybackControlleriOS 13.0+

  A controller that manages animation playback.
• Cl
  AnimationResourceiOS 13.0+

  An animation for the properties of scenes or entities.
• Cl
  AudioBufferResourceiOS 15.0+

  An audio resource that you load from an <doc://com.apple.documentation/documentation/avfaudio/avaudiobuffer>.
• Cl
  AudioFileGroupResourceiOS 18.0+

  An audio file group.
• Cl
  AudioFileResourceiOS 13.0+

  An audio resource that you load from a file or from a URL.
• Cl
  AudioGeneratorControlleriOS 18.0+

  A controller that manages the playback of a real-time audio stream.
• Cl
  AudioPlaybackControlleriOS 13.0+

  A controller that manages an audio playback instance.
• Cl
  AudioPlaybackGroupControlleriOS 27.0+

  A controller that manages synchronized playback for a group of audio resources.
• Cl
  AudioResourceiOS 13.0+

  A playable audio resource
• Cl
  BodyTrackedEntity

  An entity used to animate a virtual character in an AR scene by tracking a
• Cl
  DirectionalLightiOS 13.0+

  An entity that casts a virtual light in a particular direction.
• Cl
  EntityiOS 13.0+

  An element of a RealityKit scene to which you attach components that provide
• Cl
  EnvironmentResourceiOS 13.0+

  An environmental resource that contains background and lighting information for a scene.
• Cl
  LowLevelMeshiOS 18.0+

  A container for vertex data that you can use to create and update meshes using your own format.
• Cl
  LowLevelTextureiOS 18.0+

  A container for texture data allowing you to create and update textures using your own format.

Structures 35

• St
  BoundingBoxiOS 13.0+

  An axis-aligned bounding box (AABB).
• St
  EntityGeometricPinsiOS 18.0+

  A structure that wraps all geometric pins an entity owns.
• St
  RenormalizationDeformeriOS 27.0+

  Recalculates tangent frame based on current state of positions
• St
  ReverbiOS 18.0+

  The reverberation RealityKit applies to spatial audio sources.
• St
  ReverbComponentiOS 18.0+

  A component that defines the reverberation of spatial audio sources.
• St
  SampledAnimationiOS 15.0+

  An animation that cycles through a series of frames at a constant interval.
• St
  SceneRealityCoordinateSpaceiOS 18.0+

  The coordinate space that represents the center of a RealityKit scene.
• St
  SceneUnderstandingComponent

  A component that specifies an entity is participating in the system's scene-understanding features.
• St
  SceneUpdateContextiOS 15.0+

  An object that contains information about the scene to update.
• St
  SetEntityEnabledActioniOS 18.0+

  An action that enables or disables the targeted entity and its descendants when played as an animation.
• St
  ShaderGraphMaterialiOS 18.0+

  A material that comes from a shader graph in a Reality Composer Pro project, or a MaterialX shader.
• St
  SimpleMaterialiOS 13.0+

  A basic material that responds to lights in the scene.
• St
  SkeletalPoseiOS 18.0+

  A container that holds the position and orientation of each joint in a single animation skeleton.
• St
  SkeletalPoseSetiOS 18.0+

  A collection of named skeletal poses.
• St
  SkeletalPosesComponentiOS 18.0+

  A component that exposes the collection of named animation skeletal poses.
• St
  SkinningDeformeriOS 27.0+

  A deformation that binds a 3D mesh to an underlying skeleton.

Enumerations 31

• En
  ActionEntityResolutioniOS 18.0+

  Options available to determine the resolution method for a target entity in an action.
• En
  ActionResultiOS 27.0+

  Status values that an action can report back to the animation system.
• En
  AnchorStateEventsiOS 26.0+

  Events that trigger on an entity to indicate a change in anchor state.
• En
  AnimationEventsiOS 13.0+

  Notable milestones that the framework signals during animation playback.
• En
  AnimationRepeatModeiOS 15.0+

  Options that determine whether an animation replays after completion.
• En
  AntialiasingModeiOS 18.0+

  The rendering technique used to smooth edges of virtual content.
• En
  AudioiOS 18.0+

  A namespace for types that are used commonly in audio.
• En
  AudioEventsiOS 13.0+

  Events associated with audio playback.
• En
  BindTargetiOS 15.0+

  A reference to a particular scene, entity, or property that animates.
• En
  BlendWeightiOS 15.0+

  A numerical representation of the impact an animation has on a scene or
• En
  CameraFieldOfViewOrientationiOS 18.0+

  The orientations that a camera's field-of-view degrees can apply.
• En
  CollisionCastQueryTypeiOS 13.0+

  The kinds of ray and convex shape cast queries that you can make.
• En
  CollisionEventsiOS 13.0+
• En
  ComponentEventsiOS 15.0+

  Provides the events related to components.
• En
  CustomMaterialError

  Errors generated when loading custom material functions.
• En
  CustomShaderStage

Protocols 16

• Pr
  HasAnchoringiOS 13.0+

  An interface that enables anchoring of virtual content to a real-world
• Pr
  HasBodyTracking

  An interface that enables the animation of a virtual character by tracking a
• Pr
  HasCollisioniOS 13.0+

  An interface used for ray casting and collision detection.
• Pr
  HasDirectionalLightiOS 13.0+

  An interface that defines a directional light source component.
• Pr
  HasHierarchyiOS 13.0+

  An interface that provides access to a parent entity and child entities.
• Pr
  HasModeliOS 13.0+

  An interface that provides meshes and materials to define the visual
• Pr
  HasPerspectiveCameraiOS 13.0+

  An interface that enables you to configure a virtual camera that you can use
• Pr
  HasPhysicsiOS 13.0+

  An interface that combines the physics body and physics motion interfaces.
• Pr
  HasPhysicsBodyiOS 13.0+

  An interface that enables physics simulations based on the rules of
• Pr
  HasPhysicsMotioniOS 13.0+

  An interface that provides velocity properties for physics simulations.
• Pr
  HasPointLightiOS 13.0+

  An interface that defines a point light source component.
• Pr
  HasSceneUnderstanding

  A specification that detects and reacts to features of the physical
• Pr
  HasSpotLightiOS 13.0+

  An interface that defines a spot light source component.
• Pr
  HasSynchronizationiOS 13.0+

  An interface that enables an entity to be synchronized between processes and
• Pr
  HasTransformiOS 13.0+

  An interface that enables manipulating the scale, rotation, and translation
• Pr
  ResourceiOS 13.0+

  A shared resource you use to configure a component, like a material, mesh,

Type Aliases 8

• Ty
  MeshDeformCPUBufferInput

  The underlying type of deformer input data buffers for the CPU functions.
• Ty
  MeshDeformCPUBufferOutput

  The underlying type of deformer output data buffers for the CPU functions.
• Ty
  MeshDeformGPUBufferInput

  The underlying type of deformer input data buffers for the GPU functions.
• Ty
  MeshDeformGPUBufferOutput

  The underlying type of deformer input data buffers for the GPU functions.
• Ty
  MeshDeformParameterCPU

  convenience alias
• Ty
  MeshDeformParameterGPU

  convenience alias
• Ty
  MeshDeformParametersCPU

  convenience alias
• Ty
  MeshDeformParametersGPU

  convenience alias

Extends 13