docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class XRFaceSubsystem

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

    Inheritance
    object
    SubsystemWithProvider
    SubsystemWithProvider<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>
    TrackingSubsystem<XRFace, XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>
    XRFaceSubsystem
    Implements
    ISubsystem
    Inherited Members
    TrackingSubsystem<XRFace, XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>.GetChanges(Allocator)
    SubsystemWithProvider<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>.OnCreate()
    SubsystemWithProvider<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>.OnStart()
    SubsystemWithProvider<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>.OnStop()
    SubsystemWithProvider<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>.OnDestroy()
    SubsystemWithProvider<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>.subsystemDescriptor
    SubsystemWithProvider<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>.provider
    SubsystemWithProvider.Start()
    SubsystemWithProvider.OnStart()
    SubsystemWithProvider.Stop()
    SubsystemWithProvider.OnStop()
    SubsystemWithProvider.Destroy()
    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
    Assembly: solution.dll
    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

    Name Description
    XRFaceSubsystem()

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

    Properties

    Name Description
    currentMaximumFaceCount

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

    requestedMaximumFaceCount

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

    supportedFaceCount

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

    Methods

    Name Description
    GetChanges(Allocator)

    Get the changes to faces (added, updated, and removed) since the last call to GetChanges(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.


    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Constructors
    • Properties
    • Methods
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)