Interface MaskPosition

This object describes the position on faces where a mask should be placed by default.

interface MaskPosition {
    point:
        | "forehead"
        | "eyes"
        | "mouth"
        | "chin";
    scale: number;
    x_shift: number;
    y_shift: number;
}

Properties

point:
    | "forehead"
    | "eyes"
    | "mouth"
    | "chin"

The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.

scale: number

Mask scaling coefficient. For example, 2.0 means double size.

x_shift: number

Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.

y_shift: number

Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.