Class XRDepthSubsystem.IDepthApi

The interface that each derived class must implement.

Inheritance

Object

XRDepthSubsystem.IDepthApi

Namespace: UnityEngine.XR.ARSubsystems

Syntax

protected class IDepthApi

Methods

Destroy()

Called when the subsystem is destroyed. Stop() will be called first if the subsystem is running.

Declaration

public virtual void Destroy()

GetChanges(XRPointCloud, Allocator)

Get the changes (added, updated, and removed) planes since the last call to .

Declaration

public virtual TrackableChanges<XRPointCloud> GetChanges(XRPointCloud defaultPointCloud, Allocator allocator)

Parameters

Type	Name	Description
XRPointCloud	defaultPointCloud	The default reference point. This should be used to initialize the returned NativeArrays for backwards compatibility. See TrackableChanges(Void*, Int32, Void*, Int32, Void*, Int32, T, Int32, Allocator).
Allocator	allocator	An Allocator to use when allocating the returned NativeArrays.

Returns

Type	Description
TrackableChanges<XRPointCloud>	TrackableChanges<T> describing the reference points that have been added, updated, and removed since the last call to . The changes should be allocated using allocator.

GetPointCloudData(TrackableId, Allocator)

Declaration

public virtual XRPointCloudData GetPointCloudData(TrackableId trackableId, Allocator allocator)

Parameters

Type	Name	Description
TrackableId	trackableId
Allocator	allocator

Returns

Type	Description
XRPointCloudData

Start()

Called when the subsystem is started. Will not be called again until Stop().

Declaration

public virtual void Start()

Stop()

Called when the subsystem is stopped. Will not be called before Start().

Declaration

public virtual void Stop()