MadelineProtoDocs/old_docs/API_docs_v97/constructors/maskCoords.md

56 lines
1.6 KiB
Markdown
Raw Normal View History

2019-05-03 21:10:09 +02:00
---
title: maskCoords
2019-12-27 17:48:04 +01:00
description: Position on a photo where a mask should be placed
The `n` position indicates where the mask should be placed:
- 0 => Relative to the forehead
- 1 => Relative to the eyes
- 2 => Relative to the mouth
- 3 => Relative to the chin
2019-05-03 21:10:09 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Constructor: maskCoords
[Back to constructors index](index.md)
2019-12-27 17:48:04 +01:00
Position on a photo where a mask should be placed
The `n` position indicates where the mask should be placed:
- 0 => Relative to the forehead
- 1 => Relative to the eyes
- 2 => Relative to the mouth
- 3 => Relative to the chin
2019-05-03 21:10:09 +02:00
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2019-12-27 17:48:04 +01:00
|n|[int](../types/int.md) | Yes|Part of the face, relative to which the mask should be placed|
|x|[double](../types/double.md) | Yes|Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. (For example, -1.0 will place the mask just to the left of the default mask position)|
|y|[double](../types/double.md) | Yes|Shift by Y-axis measured in widths of the mask scaled to the face size, from left to right. (For example, -1.0 will place the mask just to the left of the default mask position)|
|zoom|[double](../types/double.md) | Yes|Mask scaling coefficient. (For example, 2.0 means a doubled size)|
2019-05-03 21:10:09 +02:00
### Type: [MaskCoords](../types/MaskCoords.md)
### Example:
```php
$maskCoords = ['_' => 'maskCoords', 'n' => int, 'x' => double, 'y' => double, 'zoom' => double];
```
Or, if you're into Lua:
```lua
maskCoords={_='maskCoords', n=int, x=double, y=double, zoom=double}
```