RealityKit renders and simulates 3D augmented reality content on iOS, macOS, tvOS, and visionOS using an entity-component model with physics and audio. You assemble scenes from entities and components such as ARKitAnchorComponent, then present and configure them through RealityView types like RealityViewEntityCollection, RealityViewCamera, RealityViewEnvironment, and RealityViewPostProcessEffect. Materials are described with values like MaterialColorParameter, interaction is handled through EntityGestureRecognizer, and shared experiences are coordinated with MultipeerConnectivityService.
RealityView Content 3
Types that supply and organize the entities a RealityView presents.
- PrRealityViewContentProtocolA protocol representing the content of a reality view.
- StRealityViewEntityCollectionA collection of entities in a RealityView.
- StRealityViewLayoutOptionOptions that specify the frame sizing and content alignment option for `RealityView`.
Camera and Environment 4
Types that configure the viewpoint, lighting, and dynamic range of a RealityView scene.
- StRealityViewCameraA camera for reality view scenes, that can be world tracking or virtual.
- StRealityViewCameraContentThe content of a reality view that is displayed through a camera.
- StRealityViewEnvironmentA struct that determines the background and default lighting properties for a reality view.
- StRealityViewDynamicRangeOptions that determine the state of high dynamic range rendering for virtual content.
Rendering Effects 3
Types that apply post-process and rendering effects to RealityView output.
- StRealityViewPostProcessEffectA struct for enabling or disabling post processing effects for all content a reality view contains.
- StRealityViewRenderingEffectModeA mode that determines whether a rendering effect is enabled or disabled.
- StRealityViewRenderingEffectsA struct for enabling and disabling rendering effects for RealityKit content.
Anchors and Components 1
Entity-component types that bind content to ARKit-tracked anchors.
- StARKitAnchorComponentA component that exposes the backing ARKit data of an anchored entity.
Materials and Appearance 1
Values that describe how surfaces are colored and shaded.
- EnMaterialColorParameteriOS 13.0+The color parameter applied to a material.
Interaction and Coordinate Spaces 2
Protocols for handling gestures and projecting between RealityKit coordinate spaces.
- PrEntityGestureRecognizerA gesture recognizer that works on entities.
- PrRealityCoordinateSpaceProjectingA protocol for coordinate spaces that can project 2D points to and from 3D.
Shared Experiences 2
Services and events for coordinating multiuser sessions and accessibility.
- ClMultipeerConnectivityServiceA service that provides scene synchronization among all peers in a multipeer
- EnAccessibilityEventsiOS 17.0+An enumeration of accessibility events delivered to RealityKit content.
Classes 5
- ClARViewA view that enables you to display an AR experience with RealityKit.
- ClEntityRotationGestureRecognizerA gesture recognizer that uses rotation gestures involving two touches to rotate a given entity.
- ClEntityScaleGestureRecognizerA gesture recognizer that uses a pinch gesture to scale or zoom an entity.
- ClEntityTranslationGestureRecognizerA gesture recognizer that uses a pan gesture to move an entity.
- ClObjectCaptureSessionA session object that monitors and controls image capture for photogrammetry.
Structures 5
- StEntityTargetValueA value containing an original gesture value along with a targeted entity.
- StObjectCapturePointCloudViewRenders the current state of the point cloud from an object capture session.
- StObjectCaptureViewA view that guides a user through capturing images for object capture.
- StRealityViewA view that contains RealityKit content.
- StRealityViewDefaultPlaceholderA view that represents the default placeholder for a RealityView.
Type Aliases 1
- TyARViewBaseThe platform-specific base class for the view into which RealityKit renders