Class XRFaceSubsystemDescriptor

The descriptor of the XRFaceSubsystem that shows which face tracking features are available on that XRSubsystem.

Inheritance

object

SubsystemDescriptorWithProvider

SubsystemDescriptorWithProvider<XRFaceSubsystem, XRFaceSubsystem.Provider>

XRFaceSubsystemDescriptor

Implements

ISubsystemDescriptor

Inherited Members

SubsystemDescriptorWithProvider<XRFaceSubsystem, XRFaceSubsystem.Provider>.Create()

SubsystemDescriptorWithProvider.id

SubsystemDescriptorWithProvider.providerType

SubsystemDescriptorWithProvider.subsystemTypeOverride

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.XR.ARSubsystems

Assembly: Unity.XR.ARSubsystems.dll

Syntax

public class XRFaceSubsystemDescriptor : SubsystemDescriptorWithProvider<XRFaceSubsystem, XRFaceSubsystem.Provider>, ISubsystemDescriptor

Remarks

Use the Create factory method along with XRFaceSubsystemDescriptor.Cinfo struct to construct and register one of these from each face tracking data provider.

Properties

supportsEyeTracking

Whether the subsystem supports eye tracking for each detected face.

Declaration

public bool supportsEyeTracking { get; }

Property Value

Type	Description
bool

supportsFaceMeshNormals

Whether the subsystem supports normals for each face mesh.

Declaration

public bool supportsFaceMeshNormals { get; }

Property Value

Type	Description
bool

supportsFaceMeshUVs

Whether the subsystem supports texture coordinates for each face mesh.

Declaration

public bool supportsFaceMeshUVs { get; }

Property Value

Type	Description
bool

supportsFaceMeshVerticesAndIndices

Whether the subsystem supports face meshes and can produce vertices and triangle indices that represent a face mesh.

Declaration

public bool supportsFaceMeshVerticesAndIndices { get; }

Property Value

Type	Description
bool

supportsFacePose

Whether the subsystem can produce a Pose for each detected face.

Declaration

public bool supportsFacePose { get; }

Property Value

Type	Description
bool

Methods

Create(FaceSubsystemParams)

Creates a subsystem descriptor. Used to register an implementation of the XRFaceSubsystem.

Declaration

[Obsolete("Create(FaceSubsystemParams) has been deprecated in AR Foundation version 6.0. Use Register(XRFaceSubsystemDescriptor.Cinfo) instead (UnityUpgradable) -> Register(*)", false)]
public static void Create(FaceSubsystemParams descriptorParams)

Parameters

Type	Name	Description
FaceSubsystemParams	descriptorParams	Parameters describing the XRFaceSubsystem.

Register(Cinfo)

Creates a subsystem descriptor. Used to register an implementation of the XRFaceSubsystem.

Declaration

public static void Register(XRFaceSubsystemDescriptor.Cinfo cinfo)

Parameters

Type	Name	Description
XRFaceSubsystemDescriptor.Cinfo	cinfo	Parameters describing the XRFaceSubsystem.

Implements

ISubsystemDescriptor