GramIO API Reference / @gramio/contexts/dist / MaskPosition
Class: MaskPosition
Defined in: contexts/index.d.ts:740
This object describes the position on faces where a mask should be placed by default.
Constructors
Constructor
new MaskPosition(
payload):MaskPosition
Defined in: contexts/index.d.ts:742
Parameters
| Parameter | Type |
|---|---|
payload | TelegramMaskPosition |
Returns
MaskPosition
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramMaskPosition | contexts/index.d.ts:741 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:744
Returns
string
point
Get Signature
get point():
TelegramMaskPositionPoint
Defined in: contexts/index.d.ts:749
The part of the face relative to which the mask should be placed. One of forehead, eyes, mouth, or chin.
Returns
scale
Get Signature
get scale():
number
Defined in: contexts/index.d.ts:763
Mask scaling coefficient. For example, 2.0 means double size.
Returns
number
xShift
Get Signature
get xShift():
number
Defined in: contexts/index.d.ts:755
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.
Returns
number
yShift
Get Signature
get yShift():
number
Defined in: contexts/index.d.ts:761
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.
Returns
number