Class AROcclusionManager
The manager for the occlusion subsystem.
Inheritance
Inherited Members
Namespace: UnityEngine.XR.ARFoundation
Syntax
[DisallowMultipleComponent]
[DefaultExecutionOrder(-2147483647)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.arfoundation@4.0/api/UnityEngine.XR.ARFoundation.AROcclusionManager.html")]
public sealed class AROcclusionManager : SubsystemLifecycleManager<XROcclusionSubsystem, XROcclusionSubsystemDescriptor>
Properties
currentHumanDepthMode
Get the current human segmentation depth mode in use by the subsystem.
Declaration
public HumanSegmentationDepthMode currentHumanDepthMode { get; }
Property Value
Type | Description |
---|---|
HumanSegmentationDepthMode |
currentHumanStencilMode
Get the current mode in use for generating the human segmentation stencil mode.
Declaration
public HumanSegmentationStencilMode currentHumanStencilMode { get; }
Property Value
Type | Description |
---|---|
HumanSegmentationStencilMode |
humanDepthTexture
The human segmentation depth texture.
Declaration
public Texture2D humanDepthTexture { get; }
Property Value
Type | Description |
---|---|
Texture2D | The human segmentation depth texture, if any. Otherwise, |
humanSegmentationDepthMode
The mode for generating the human segmentation depth texture. This method is obsolete. Use requestedHumanDepthMode or currentHumanDepthMode instead.
Declaration
[Obsolete("Use requestedSegmentationDepthMode or currentSegmentationDepthMode instead. (2020-01-15)")]
public HumanSegmentationDepthMode humanSegmentationDepthMode { get; set; }
Property Value
Type | Description |
---|---|
HumanSegmentationDepthMode |
humanSegmentationStencilMode
The mode for generating the human segmentation stencil texture. This method is obsolete. Use requestedHumanStencilMode or currentHumanStencilMode instead.
Declaration
[Obsolete("Use requestedSegmentationStencilMode or currentSegmentationStencilMode instead. (2020-01-14)")]
public HumanSegmentationStencilMode humanSegmentationStencilMode { get; set; }
Property Value
Type | Description |
---|---|
HumanSegmentationStencilMode |
humanStencilTexture
The human segmentation stencil texture.
Declaration
public Texture2D humanStencilTexture { get; }
Property Value
Type | Description |
---|---|
Texture2D | The human segmentation stencil texture, if any. Otherwise, |
requestedHumanDepthMode
Get or set the requested human segmentation depth mode.
Declaration
public HumanSegmentationDepthMode requestedHumanDepthMode { get; set; }
Property Value
Type | Description |
---|---|
HumanSegmentationDepthMode |
requestedHumanStencilMode
The requested mode for generating the human segmentation stencil texture.
Declaration
public HumanSegmentationStencilMode requestedHumanStencilMode { get; set; }
Property Value
Type | Description |
---|---|
HumanSegmentationStencilMode |
Methods
OnBeforeStart()
Callback before the subsystem is started (but after it is created).
Declaration
protected override void OnBeforeStart()
Overrides
OnDisable()
Callback when the manager is being disabled.
Declaration
protected override void OnDisable()
Overrides
TryAcquireHumanDepthCpuImage(out XRCpuImage)
Attempt to get the latest human depth CPU image. This provides directly access to the raw pixel data.
Declaration
public bool TryAcquireHumanDepthCpuImage(out XRCpuImage cpuImage)
Parameters
Type | Name | Description |
---|---|---|
XRCpuImage | cpuImage | If this method returns |
Returns
Type | Description |
---|---|
Boolean | Returns |
Remarks
The XRCpuImage
must be disposed to avoid resource leaks.
TryAcquireHumanStencilCpuImage(out XRCpuImage)
Attempt to get the latest human stencil CPU image. This provides directly access to the raw pixel data.
Declaration
public bool TryAcquireHumanStencilCpuImage(out XRCpuImage cpuImage)
Parameters
Type | Name | Description |
---|---|---|
XRCpuImage | cpuImage | If this method returns |
Returns
Type | Description |
---|---|
Boolean | Returns |
Remarks
The XRCpuImage
must be disposed to avoid resource leaks.
Update()
Callback as the manager is being updated.
Declaration
public void Update()
Events
frameReceived
An event which fires each time an occlusion camera frame is received.
Declaration
public event Action<AROcclusionFrameEventArgs> frameReceived
Event Type
Type | Description |
---|---|
Action<AROcclusionFrameEventArgs> |