Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • FaceMeshLoader

Index

Constructors

constructor

Methods

load

  • load(options?: string | FaceMeshLoaderOptions, onLoad?: (i: FaceMesh) => void, onError?: (message?: unknown) => void): FaceMesh
  • Loads the data for a face mesh.

    Parameters

    • Optional options: string | FaceMeshLoaderOptions

      A URL or ArrayBuffer of the source mesh data or defines if some face features should be filled with polygons.

    • Optional onLoad: (i: FaceMesh) => void

      Callback which returns the FaceMesh once it's loaded.

    • Optional onError: (message?: unknown) => void

      Callback which is called if there's an error loading the mesh.

        • (message?: unknown): void
        • Parameters

          • Optional message: unknown

          Returns void

    Returns FaceMesh

    The FaceMesh.

loadFace

  • loadFace(options?: FaceMeshLoaderOptions, onLoad?: (i: FaceMesh) => void, onError?: (message?: unknown) => void): FaceMesh
  • Loads the default face mesh.

    Parameters

    • Optional options: FaceMeshLoaderOptions

      Defines if some face features should be filled with polygons.

    • Optional onLoad: (i: FaceMesh) => void

      Callback which returns the FaceMesh once it's loaded.

    • Optional onError: (message?: unknown) => void

      Callback which is called if there's an error loading the mesh.

        • (message?: unknown): void
        • Parameters

          • Optional message: unknown

          Returns void

    Returns FaceMesh

    The FaceMesh.

loadFullHeadSimplified

  • loadFullHeadSimplified(options?: FaceMeshLoaderOptions, onLoad?: (i: FaceMesh) => void, onError?: (message?: unknown) => void): FaceMesh
  • Loads The full head simplified mesh covers the whole of the user's head, including some neck. It's ideal for drawing into the depth buffer in order to mask out the back of 3D models placed on the user's head.

    Parameters

    • Optional options: FaceMeshLoaderOptions

      Defines if some face features should be filled with polygons.

    • Optional onLoad: (i: FaceMesh) => void

      Callback which returns the FaceMesh once it's loaded.

    • Optional onError: (message?: unknown) => void

      Callback which is called if there's an error loading the mesh.

        • (message?: unknown): void
        • Parameters

          • Optional message: unknown

          Returns void

    Returns FaceMesh

    The FaceMesh.

parse

  • parse(): void

Legend

  • Constructor
  • Property
  • Method

Generated using TypeDoc