Class XRFaceSubsystem

An abstract class that provides a generic API for low-level face tracking features.

Inheritance

Object

UnityEngine.SubsystemsImplementation.SubsystemWithProvider

UnityEngine.SubsystemsImplementation.SubsystemWithProvider<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>

TrackingSubsystem<XRFace, XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>

XRFaceSubsystem

Inherited Members

TrackingSubsystem<XRFace, XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>.GetChanges(Allocator)

UnityEngine.SubsystemsImplementation.SubsystemWithProvider<UnityEngine.XR.ARSubsystems.XRFaceSubsystem, UnityEngine.XR.ARSubsystems.XRFaceSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRFaceSubsystem.Provider>.OnCreate()

UnityEngine.SubsystemsImplementation.SubsystemWithProvider<UnityEngine.XR.ARSubsystems.XRFaceSubsystem, UnityEngine.XR.ARSubsystems.XRFaceSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRFaceSubsystem.Provider>.OnStart()

UnityEngine.SubsystemsImplementation.SubsystemWithProvider<UnityEngine.XR.ARSubsystems.XRFaceSubsystem, UnityEngine.XR.ARSubsystems.XRFaceSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRFaceSubsystem.Provider>.OnStop()

UnityEngine.SubsystemsImplementation.SubsystemWithProvider<UnityEngine.XR.ARSubsystems.XRFaceSubsystem, UnityEngine.XR.ARSubsystems.XRFaceSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRFaceSubsystem.Provider>.OnDestroy()

UnityEngine.SubsystemsImplementation.SubsystemWithProvider<UnityEngine.XR.ARSubsystems.XRFaceSubsystem, UnityEngine.XR.ARSubsystems.XRFaceSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRFaceSubsystem.Provider>.subsystemDescriptor

UnityEngine.SubsystemsImplementation.SubsystemWithProvider<UnityEngine.XR.ARSubsystems.XRFaceSubsystem, UnityEngine.XR.ARSubsystems.XRFaceSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRFaceSubsystem.Provider>.provider

UnityEngine.SubsystemsImplementation.SubsystemWithProvider.Start()

UnityEngine.SubsystemsImplementation.SubsystemWithProvider.OnStart()

UnityEngine.SubsystemsImplementation.SubsystemWithProvider.Stop()

UnityEngine.SubsystemsImplementation.SubsystemWithProvider.OnStop()

UnityEngine.SubsystemsImplementation.SubsystemWithProvider.Destroy()

UnityEngine.SubsystemsImplementation.SubsystemWithProvider.OnDestroy()

UnityEngine.SubsystemsImplementation.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 XRFaceSubsystem : TrackingSubsystem<XRFace, XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>, ISubsystem

Remarks

Use this class to access face tracking features in your app via accessing the generic API. You can also extend it to provide an implementation of a provider which provides the face tracking data to the higher-level code.

Constructors

XRFaceSubsystem()

Constructs a face subsystem. Do not invoked directly; call Create on the XRFaceSubsystemDescriptor instead.

Declaration

public XRFaceSubsystem()

Properties

currentMaximumFaceCount

Get the maximum number of faces the provider will simultaneously track.

Declaration

public int currentMaximumFaceCount { get; }

Property Value

Type	Description
Int32

requestedMaximumFaceCount

Get or set the maximum number of faces to track simultaneously.

Declaration

public int requestedMaximumFaceCount { get; set; }

Property Value

Type	Description
Int32

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown if the requested maximum face count is less than one. To stop face tracking, call Stop().
NotSupportedException	Thrown if the requested maximum face count is greater than one but the subsystem does not support tracking multiple faces.

supportedFaceCount

Get the number of faces the subsystem is able to track simultaneously in its current configuration.

Declaration

public int supportedFaceCount { get; }

Property Value

Type	Description
Int32

Methods

GetChanges(Allocator)

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

Declaration

public override TrackableChanges<XRFace> GetChanges(Allocator allocator)

Parameters

Type	Name	Description
Unity.Collections.Allocator	allocator	An Allocator to use when allocating the returned NativeArrays.

Returns

Type	Description
TrackableChanges<XRFace>	TrackableChanges<T> describing the faces 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.XRFace, UnityEngine.XR.ARSubsystems.XRFaceSubsystem, UnityEngine.XR.ARSubsystems.XRFaceSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRFaceSubsystem.Provider>.GetChanges(Unity.Collections.Allocator)

GetFaceMesh(TrackableId, Allocator, ref XRFaceMesh)

Get the mesh data associated with the face with faceId. The faceMesh is reused if it is the correct size; otherwise, it is disposed and reallocated using allocator.

Declaration

public virtual void GetFaceMesh(TrackableId faceId, Allocator allocator, ref XRFaceMesh faceMesh)

Parameters

Type	Name	Description
TrackableId	faceId	The TrackableId for a XRFace.
Unity.Collections.Allocator	allocator	The allocator to use for the returned data if a resize is necessary. Must be Allocator.TempJob or Allocator.Persistent.
XRFaceMesh	faceMesh	The container for the mesh data to either re-use or re-allocate.

Exceptions

Type	Condition
InvalidOperationException	Thrown if allocator is Allocator.Temp
InvalidOperationException	Thrown if allocator is Allocator.None