Class XRDepthSubsystem.Provider

The interface that each derived class must implement.

Inheritance

Object

XRDepthSubsystem.Provider

XRDepthSubsystemImpl.TestProvider

Namespace: UnityEngine.XR.ARSubsystems

Syntax

public abstract class Provider

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 GetChanges(XRPointCloud, Allocator).

Declaration

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

Parameters

Type	Name	Description
XRPointCloud	defaultPointCloud	The default point cloud. 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 GetChanges(XRPointCloud, Allocator). The changes should be allocated using allocator.

GetPointCloudData(TrackableId, Allocator)

Generate point cloud data (positions, confidence values, and identifiers) for the point cloud with the given trackableId.

Declaration

public abstract XRPointCloudData GetPointCloudData(TrackableId trackableId, Allocator allocator)

Parameters

Type	Name	Description
TrackableId	trackableId	The point cloud for which to retrieve data.
Allocator	allocator	The allocator to use when creating the NativeArrays in the returned XRPointCloudData.

Returns

Type	Description
XRPointCloudData	A new XRPointCloudData with newly allocated NativeArrays using allocator. The caller owns the memory and is responsible for calling Dispose() on it.

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()