Class AROcclusionManager
The manager for the occlusion subsystem.
Inheritance
Inherited Members
Namespace: UnityEngine.XR.ARFoundation
Assembly: solution.dll
Syntax
[DisallowMultipleComponent]
[DefaultExecutionOrder(-2147483647)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.arfoundation@4.2/api/UnityEngine.XR.ARFoundation.AROcclusionManager.html")]
public sealed class AROcclusionManager : SubsystemLifecycleManager<XROcclusionSubsystem, XROcclusionSubsystemDescriptor, XROcclusionSubsystem.Provider>Properties
| Name | Description |
|---|---|
| currentEnvironmentDepthMode | Get the current environment depth mode in use by the subsystem. |
| currentHumanDepthMode | Get the current human segmentation depth mode in use by the subsystem. |
| currentHumanStencilMode | Get the current mode in use for generating the human segmentation stencil mode. |
| currentOcclusionPreferenceMode | Get the current occlusion preference mode in use by the subsystem. |
| environmentDepthConfidenceTexture | The environment depth confidence texture. |
| environmentDepthTemporalSmoothingEnabled | Whether temporal smoothing is applied to the environment depth image. Query for support with environmentDepthTemporalSmoothingSupported. |
| environmentDepthTemporalSmoothingRequested | Whether temporal smoothing should be applied to the environment depth image. Query for support with environmentDepthTemporalSmoothingSupported. |
| environmentDepthTexture | The environment depth texture. |
| humanDepthTexture | The human segmentation depth texture. |
| humanSegmentationDepthMode | The mode for generating the human segmentation depth texture. This method is obsolete. Use requestedHumanDepthMode or currentHumanDepthMode instead. |
| humanSegmentationStencilMode | The mode for generating the human segmentation stencil texture. This method is obsolete. Use requestedHumanStencilMode or currentHumanStencilMode instead. |
| humanStencilTexture | The human segmentation stencil texture. |
| requestedEnvironmentDepthMode | Get or set the requested environment depth mode. |
| requestedHumanDepthMode | Get or set the requested human segmentation depth mode. |
| requestedHumanStencilMode | The requested mode for generating the human segmentation stencil texture. |
| requestedOcclusionPreferenceMode | Get or set the requested occlusion preference mode. |
Methods
| Name | Description |
|---|---|
| OnBeforeStart() | Callback before the subsystem is started (but after it is created). |
| OnDisable() | Callback when the manager is being disabled. |
| TryAcquireEnvironmentDepthConfidenceCpuImage(out XRCpuImage) | Attempt to get the latest environment depth confidence CPU image. This provides direct access to the raw pixel data. |
| TryAcquireEnvironmentDepthCpuImage(out XRCpuImage) | Attempt to get the latest environment depth CPU image. This provides direct access to the raw pixel data. |
| TryAcquireHumanDepthCpuImage(out XRCpuImage) | Attempt to get the latest human depth CPU image. This provides direct access to the raw pixel data. |
| TryAcquireHumanStencilCpuImage(out XRCpuImage) | Attempt to get the latest human stencil CPU image. This provides directly access to the raw pixel data. |
| TryAcquireRawEnvironmentDepthCpuImage(out XRCpuImage) | Attempt to get the latest raw environment depth CPU image. This provides direct access to the raw pixel data. |
| TryAcquireSmoothedEnvironmentDepthCpuImage(out XRCpuImage) | Attempt to get the latest smoothed environment depth CPU image. This provides direct access to the raw pixel data. |
| Update() | Callback as the manager is being updated. |
Events
| Name | Description |
|---|---|
| frameReceived | An event which fires each time an occlusion camera frame is received. |