Struct FaceSubsystemParams

This struct is an initializer for the creation of a XRFaceSubsystemDescriptor.

Implements

IEquatable<FaceSubsystemParams>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.ARSubsystems

Assembly: Unity.XR.ARSubsystems.dll

Syntax

public struct FaceSubsystemParams : IEquatable<FaceSubsystemParams>

Remarks

During InitializeOnLoad, the Face Tracking data provider should create a descriptor using the parameters here to specify which of the XRFaceSubsystem features it supports.

Properties

id

The string identifier for a specific implementation.

Declaration

public string id { readonly get; set; }

Property Value

Type	Description
string

providerType

Specifies the provider implementation type to use for instantiation.

Declaration

public Type providerType { readonly get; set; }

Property Value

Type	Description
Type	The provider implementation type to use for instantiation.

subsystemImplementationType

The concrete Type which will be instantiated if Create is called on this subsystem descriptor.

Declaration

[Obsolete("XRFaceSubsystem no longer supports the deprecated set of base classes for subsystems as of Unity 2020.2. Use providerType and, optionally, subsystemTypeOverride instead.", true)]
public Type subsystemImplementationType { readonly get; set; }

Property Value

Type	Description
Type

subsystemTypeOverride

Specifies the XRFaceSubsystem-derived type that forwards casted calls to its provider.

Declaration

public Type subsystemTypeOverride { readonly get; set; }

Property Value

Type	Description
Type	The type of the subsystem to use for instantiation. If null, XRFaceSubsystem will be instantiated.

supportsEyeTracking

Whether the subsystem supports eye tracking for each detected face.

Declaration

public bool supportsEyeTracking { get; set; }

Property Value

Type	Description
bool

supportsFaceMeshNormals

Whether the subsystem supports normals for the face mesh.

Declaration

public bool supportsFaceMeshNormals { get; set; }

Property Value

Type	Description
bool

supportsFaceMeshUVs

Whether the subsystem supports texture coordinates for the face mesh.

Declaration

public bool supportsFaceMeshUVs { get; set; }

Property Value

Type	Description
bool

supportsFaceMeshVerticesAndIndices

Whether the subsystem supports getting vertices and triangle indices describing a face mesh.

Declaration

public bool supportsFaceMeshVerticesAndIndices { get; set; }

Property Value

Type	Description
bool

supportsFacePose

Whether the subsystem supports getting a pose for the face.

Declaration

public bool supportsFacePose { get; set; }

Property Value

Type	Description
bool

Methods

Equals(object)

Tests for equality.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare against.

Returns

Type	Description
bool	True if obj is of type FaceSubsystemParams and Equals(FaceSubsystemParams) also returns true; otherwise false.

Overrides

ValueType.Equals(object)

Equals(FaceSubsystemParams)

Tests for equality.

Declaration

public bool Equals(FaceSubsystemParams other)

Parameters

Type	Name	Description
FaceSubsystemParams	other	The other FaceSubsystemParams to compare against.

Returns

Type	Description
bool	True if every field in other is equal to this FaceSubsystemParams, otherwise false.

GetHashCode()

Generates a hash suitable for use with containers like HashSet and Dictionary.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code generated from this object's fields.

Overrides

ValueType.GetHashCode()

Operators

operator ==(FaceSubsystemParams, FaceSubsystemParams)

Tests for equality. Same as Equals(FaceSubsystemParams).

Declaration

public static bool operator ==(FaceSubsystemParams lhs, FaceSubsystemParams rhs)

Parameters

Type	Name	Description
FaceSubsystemParams	lhs	The left-hand side of the comparison.
FaceSubsystemParams	rhs	The right-hand side of the comparison.

Returns

Type	Description
bool	True if lhs is equal to rhs, otherwise false.

operator !=(FaceSubsystemParams, FaceSubsystemParams)

Tests for inequality. Same as !Equals(FaceSubsystemParams).

Declaration

public static bool operator !=(FaceSubsystemParams lhs, FaceSubsystemParams rhs)

Parameters

Type	Name	Description
FaceSubsystemParams	lhs	The left-hand side of the comparison.
FaceSubsystemParams	rhs	The right-hand side of the comparison.

Returns

Type	Description
bool	True if lhs is not equal to rhs, otherwise false.

Implements

IEquatable<T>