ARKit is a handheld augmented reality platform from Apple that is supported in Unreal Engine. This page describes how ARKit is supported in Unreal Engine, and how to set up your environment to develop with ARKit. Refer to Supported XR Devices for the full list of which devices and which SDK versions Unreal Engine supports.
Developing with the ARKit APIs
To develop for ARKit in Unreal Engine you must set up the following:
- Updated hardware and software. Refer to iOS Development Requirements.
- Xcode 12 or later installed.
- iOS 14 or later installed
- A supported, configured, and connected handheld iOS device with an A12 Bionic chip or greater.
- Apple ARKit plugin enabled in your project.
Once you're set up for developing with ARKit, you can use the unique ARKit functionality to develop for your iOS devices. Refer to Handheld AR Features for what features are supported in Unreal Engine.
Getting Started with Development
After setting up your project with the Apple ARKit plugin, follow these guides to get started developing for ARKit devices.
Profiling
The following guides show how to profile your XR application and what to consider when you need to improve performance.
- XR Performance and Profiling in Unreal Engine
- Testing and Optimizing Your Content in Unreal Engine
- Debugging iOS and tvOS Projects
Known Limitations
The following are known limitations of features in ARKit:
- Candidate images for image detection must have unique friendly names. If multiple candidate images share the same friendly name, only the image with the first instance of the friendly name will be recognized.