How Sprite's borders should be processed. It is a reduced set of Image.Type values.

Errors encountered during SoftMask diagnostics. Mostly intended to use in Unity Editor.

Source of the mask's image.

Checks for errors and returns them as flags. It is used in the editor to determine which warnings should be displayed.

Specifies weights of the color channels of the mask. The color sampled from the mask texture is multiplied by this value, after what all components are summed up together. That is, the final mask value is calculated as: color = pixel-from-mask * channelWeights value = color.r + color.g + color.b + color.a The value is a number by which the resulting pixel's alpha is multiplied. As you can see, the result value isn't normalized, so, you should account it while defining custom values for this property. Static class MaskChannel contains some useful predefined values. You can use they as example of how mask calculation works. The default value is MaskChannel.alpha.

Specifies a Shader that should be used as a replacement of the Unity's default UI shader with ETC1 (alpha-split) support. If you use ETC1 textures in UI and add SoftMask in play-time by AddComponent(), you should set this property manually.

Specifies a Shader that should be used as a replacement of the Unity's default UI shader. If you add SoftMask in play-time by AddComponent(), you should set this property manually.

If set, mask values inside the mask rectangle will be inverted. In this case mask's zero value (taking channelWeights into account) will be treated as one and vice versa. The mask rectangle is the RectTransform of the GameObject this component is attached to or separateMask if it's not null. The default value is false.

See also

invertOutsides

If set, mask values outside the mask rectangle will be inverted. By default, everything outside the mask rectangle has zero mask value. When this property is set, the mask outsides will have value one, which means that everything outside the mask will be visible. The mask rectangle is the RectTransform of the GameObject this component is attached to or separateMask if it's not null. The default value is false.

See also

invertMask

Returns true if masking is currently active.

Returns true if Soft Mask does raycast filtering, that is if the masked areas are transparent to input.

Specifies the minimum mask value that the point should have for an input event to pass. If the value sampled from the mask is greater or equal this value, the input event is considered 'hit'. The mask value is compared with raycastThreshold after channelWeights applied. The default value is 0, which means that any pixel belonging to RectTransform is considered in input events. If you specify the value greater than 0, the mask's texture should be readable. Accepts values in range [0..1].

Specifies a RectTransform that defines the bounds of the mask. Use of a separate RectTransform allows to move or resize mask bounds not affecting children. When null, the RectTransform of the current object is used. Default value is null.

Determines from where the mask image should be taken.

Specifies a Sprite that should be used as the mask image. This property takes effect only when the source is MaskSource.Sprite.

Specifies the draw mode of sprite borders. This property takes effect only when the source is MaskSource.Sprite.

Specifies a Texture2D that should be used as the mask image. This property takes effect only when the source is MaskSource.Texture.

Specifies a normalized UV-space rectangle defining the image part that should be used as the mask image. This property takes effect only when the source is MaskSource.Texture. A value is set in normalized coordinates. The default value is (0, 0, 1, 1), which means that the whole texture is used.