About ARKit XR Plugin

Use the ARKit XR Plugin package enable ARKit support via Unity's multi-platform XR API. This package implements the following XR Subsystems:

This version of ARKit XR Plugin supports the following features:

  • Device Localization
  • Horizontal Plane Detection
  • Vertical Plane Detection
  • Point Clouds
  • Pass-through Camera View
  • Light Estimation
  • Reference Points
  • Hit Testing
  • Session Management

Installing ARKit XR Plugin

To install this package, follow the instructions in the Package Manager documentation.

In addition, you will likely want to also install the AR Utilities package which makes use of ARKit XR Plugin package and provides many useful scripts and prefabs.

Using ARKit XR Plugin

The ARKit XR Plugin implements the native iOS endpoints required for building Handheld AR apps using Unity's multi-platform XR API. However, this package does not expose any public scripting interface of its own and most developers should use the scripts, prefabs, and assets provided by AR Utilities as the basis for their Handheld AR apps.

Inclusion of the ARKit XR Plugin will result in the inclusion of source files, static libraries, shader files, and plugin metadata to be included in the XCode project generated as part of the Unity's standard iOS build process.

Technical details

Requirements

This version of ARKit XR Plugin is compatible with the following versions of the Unity Editor:

  • 2018.1 and later (recommended)

Known limitations

  • The following ARKit features are not yet supported in this package:
    • Face Tracking
    • 2D Image Recognition
    • 2D Image Tracking
    • 3D Object Recognition
    • ARWorldMap
    • Color Correction as an RGB Value
  • If you tick the "Symlink Unity libraries" checkbox in the iOS Build Settings, then the trampoline Xcode project will not be able to find UnityARKit.m

Package contents

This version of ARKit XR Plugin includes:

  • A static library which provides implementation of the XR Subsystems listed above
  • An Objective-C source file
  • A shader used for rendering the camera image
  • A plugin metadata file

Document revision history

Date Reason
April 19, 2018 Documentation update. Added support for vertical planes and boundary points for all planes.