Class XRDepthSubsystem

An abstract class that provides a generic API for low-level depth detection features.

Inheritance

UnityEngine.SubsystemsImplementation.SubsystemWithProvider<XRDepthSubsystem, XRDepthSubsystemDescriptor, XRDepthSubsystem.Provider>

TrackingSubsystem<XRPointCloud, XRDepthSubsystem, XRDepthSubsystemDescriptor, XRDepthSubsystem.Provider>

XRDepthSubsystem

Inherited Members

TrackingSubsystem<XRPointCloud, XRDepthSubsystem, XRDepthSubsystemDescriptor, XRDepthSubsystem.Provider>.GetChanges(Allocator)

UnityEngine.SubsystemsImplementation.SubsystemWithProvider<UnityEngine.XR.ARSubsystems.XRDepthSubsystem, UnityEngine.XR.ARSubsystems.XRDepthSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRDepthSubsystem.Provider>.OnCreate()

SubsystemWithProvider.Start()

UnityEngine.SubsystemsImplementation.SubsystemWithProvider.OnStart()

SubsystemWithProvider.Stop()

UnityEngine.SubsystemsImplementation.SubsystemWithProvider.OnStop()

SubsystemWithProvider.Destroy()

UnityEngine.SubsystemsImplementation.SubsystemWithProvider.OnDestroy()

SubsystemWithProvider.running

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: UnityEngine.XR.ARSubsystems

Syntax

public class XRDepthSubsystem : TrackingSubsystem<XRPointCloud, XRDepthSubsystem, XRDepthSubsystemDescriptor, XRDepthSubsystem.Provider>, ISubsystem

Remarks

This class can be used to access depth detection features in your app via accessing the generic API. It can also be extended to provide an implementation of a provider which provides the depth detection data to the higher level code.

Methods

GetChanges(Allocator)

Get the changes to point clouds (added, updated, and removed) since the last call to GetChanges(Allocator).

Declaration

public override TrackableChanges<XRPointCloud> GetChanges(Allocator allocator)

Parameters

Type	Name	Description
Allocator	allocator	An `Allocator` to use when allocating the returned `NativeArray`s.

Returns

Type	Description
TrackableChanges<XRPointCloud>	TrackableChanges<T> describing the point clouds that have been added, updated, and removed since the last call to GetChanges(Allocator). The caller owns the memory allocated with `Allocator`.

Overrides

UnityEngine.XR.ARSubsystems.TrackingSubsystem<UnityEngine.XR.ARSubsystems.XRPointCloud, UnityEngine.XR.ARSubsystems.XRDepthSubsystem, UnityEngine.XR.ARSubsystems.XRDepthSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRDepthSubsystem.Provider>.GetChanges(Unity.Collections.Allocator)

GetPointCloudData(TrackableId, Allocator)

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

Declaration

public 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 `NativeArray`s in the returned XRPointCloudData. `Allocator.Temp` is not supported; use `Allocator.TempJob` if you need temporary memory.

Returns

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