29 lines
2.0 KiB
Markdown
29 lines
2.0 KiB
Markdown
|
---
|
||
|
|
uid: arkit-occlusion
|
||
|
|
---
|
||
|
|
# Occlusion
|
||
|
|
|
||
|
|
ARKit provides support for occlusion based on depth images it generates every frame.
|
||
|
|
|
||
|
|
There are three types of depth images that ARKit exposes through the provider's implementation of the [XROcclusionSubsystem](xref:UnityEngine.XR.ARSubsystems.XROcclusionSubsystem) implementation:
|
||
|
|
|
||
|
|
- **Environment depth**: distance from the device to any part of the environment in the camera field of view.
|
||
|
|
- **Human depth**: distance from the device to any part of a human recognized within the camera field of view.
|
||
|
|
- **Human stencil**: value that designates, for each pixel, whether that pixel is part of a recognized human.
|
||
|
|
|
||
|
|
## Environment Depth
|
||
|
|
|
||
|
|
The occlusion subsystem provides access to two types of environment depth: [raw](xref:UnityEngine.XR.ARSubsystems.XROcclusionSubsystem.TryAcquireRawEnvironmentDepthCpuImage(UnityEngine.XR.ARSubsystems.XRCpuImage@)) and [smoothed](xref:UnityEngine.XR.ARSubsystems.XROcclusionSubsystem.TryAcquireSmoothedEnvironmentDepthCpuImage(UnityEngine.XR.ARSubsystems.XRCpuImage@)). These correspond to the following ARKit APIs:
|
||
|
|
|
||
|
|
- **Raw:** [ARFrame.sceneDepth](https://developer.apple.com/documentation/arkit/arframe/3566299-scenedepth)
|
||
|
|
- **Smoothed:** [ARFrame.smoothedSceneDepth](https://developer.apple.com/documentation/arkit/arframe/3674209-smoothedscenedepth)
|
||
|
|
|
||
|
|
> [!NOTE]
|
||
|
|
> You must enable smoothed depth by setting [environmentDepthTemporalSmoothingRequested](xref:UnityEngine.XR.ARSubsystems.XROcclusionSubsystem.environmentDepthTemporalSmoothingRequested) to `true`. Otherwise, [TryAcquireSmoothedEnvironmentDepthCpuImage](xref:UnityEngine.XR.ARSubsystems.XROcclusionSubsystem.TryAcquireSmoothedEnvironmentDepthCpuImage(UnityEngine.XR.ARSubsystems.XRCpuImage@)) will return `false`.
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
Environment depth requires Xcode 12 or later, and it only works on iOS 14 devices with the LiDAR scanner, such as the new iPad Pro.
|
||
|
|
|
||
|
|
Human depth and human scencils requires Xcode 11 or later, and it only works on iOS 13+ devices with the A12 Bionic or higher.
|