Skip to main content

AlphaMask

Typeobject
Backlinks8

Define the alpha mask effect for the object, using some values of the mask to control the transparency of the object.

PropertyTypeRequired
classstringRequired
idstringRequired
alphaTypeintegerRequired
cropbooleanRequired

class​

Required

Type

string

Value

constant: the value of this property must be equal to:

"alphaMask"

id​

Required

Description

Object ID of the mask.

Type

string

alphaType​

Required

Description

The data type whose values are used to control the transparency of the object.

Type

integer

Value

enum: the value of this property must be equal to one of the following values:

ValueExplanation
0
alpha. Directly control the object's transparency using the values of the mask's Alpha channel.
1
luminosity. Control the object's transparency using the values of the mask's luminosity.
2
inverse-luminosity. Similar to luminosity, but with the opposite effect.

crop​

Required

Description

Whether to use the mask's boundary to crop the masked object.

Type

boolean