Lens Scripting API
    Preparing search index...

    Class FaceTextureProvider

    TextureProvider for face textures. See the Face Texture Guide for more information. Can be accessed using Texture.control on a face texture asset.

    Use FaceCropTextureProvider instead

    // Use this in "Frame Updated" to zoom in and out on a face texture over time
    //@input Asset.Texture faceTexture

    var faceTexProvider = script.faceTexture.control;
    var scaleAmount = .75 + Math.sin(getTime())*.25;
    faceTexProvider.scale = new vec2(scaleAmount, scaleAmount);

    Hierarchy (View Summary)

    Index

    Properties

    faceIndex inputTexture scale

    Methods

    ensureLoaded getAspect getHeight getLoadStatus getTypeName getTypeName getWidth isOfType isSame

    Properties

    faceIndex: number

    Index of the face to track.

    Lens Scripting Version 193

    0
    inputTexture: Texture

    The source texture being drawn. This is useful for controlling which effects are visible on the face texture, based on which camera output texture is being used.

    null
    scale: vec2

    The x and y scale used to draw the face within the texture region. A lower scale will be more zoomed in on the face, and a higher scale will be more zoomed out.

    (1, 1)

    Methods

    • Returns a Promise that resolves once this Provider has finished loading its resource.

      Returns Promise<void>

      If the Provider is already loaded when ensureLoaded() is called, the returned Promise resolves immediately. Otherwise it resolves once loading completes.

      Completion is determined by the Provider's load status (see Provider.getLoadStatus). Some Providers only become loaded once supporting runtime data is available — for example, a Provider whose resource depends on tracking will not report loaded until the relevant tracking data has arrived — so the returned Promise stays pending until that data is produced.

      This method is useful when Lens script needs to await a Provider before reading its data — for example, waiting for a remote-asset Provider to finish downloading before sampling it.

      Lens Scripting Version 370

      Fetch a Texture at runtime via RemoteMediaModule and wait for its Provider to finish loading before using it:

      const internetModule = require("LensStudio:InternetModule");
      const remoteMediaModule = require("LensStudio:RemoteMediaModule");

      function loadImageTexture(url) {
        const resource = internetModule.makeResourceFromUrl(url);
        return new Promise((resolve, reject) => {
          remoteMediaModule.loadResourceAsImageTexture(resource, resolve, reject);
        });
      }

      const texture = await loadImageTexture("https://example.com/image.png");

      // Wait until the fetched Texture's Provider has finished loading before using it.
      await texture.control.ensureLoaded();
      print("Texture ready, loadStatus: " + texture.control.getLoadStatus());

    • Returns the texture's aspect ratio, which is calculated as width / height.

      Returns number

    • Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

      Returns string

    • Returns the width of the texture in pixels.

      Returns number

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods