Lens Scripting API

    Class FaceCropTextureProvider

    Texture Provider giving a cropped region of the input texture, calculated based on face position. Can be accessed using Texture.control on a FaceCropTexture asset. For more information, see the Crop Textures guide.

    //@input Asset.Texture faceCropTexture
    //@input Asset.Texture deviceCameraTexture

    var cropProvider = script.faceCropTexture.control;
    cropProvider.inputTexture = script.deviceCameraTexture;
    cropProvider.faceIndex = 0;
    cropProvider.textureScale = new vec2(1.25, 1.25);
    cropProvider.faceCenterMouthWeight = 0.0;

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    faceCenterMouthWeight faceIndex inputTexture textureScale trackingScope

    Methods

    getAspect getHeight getLoadStatus getTypeName getWidth isOfType isSame

    Constructors

    Properties

    faceCenterMouthWeight: number

    Ratio of the mouth position on the cropped texture. Value ranges from 0 to 1, with 0 having no effect and 1 centering the image on the mouth.

    faceIndex: number

    Index of the face being tracked.

    inputTexture: Texture

    Input texture to crop.

    textureScale: vec2

    Scaling of the cropped texture.

    trackingScope: PersonTrackingScope | TextureTrackingScope | FaceTrackingScope

    The tracking context this effect is being applied to.

    Methods

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

      Returns number

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

      Parameters

      • type: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR