Menu
Lumberyard
Developer Guide (Version 1.12)

UIMaskComponent

You can add a mask component to an element to show only a part of the content of its child elements (for example, example, image or text).

UiMaskBus

Services messages for the UiMaskComponent.

GetDrawBehind

Returns whether the mask is drawn behind the child elements.

Syntax

bool GetDrawBehind()

GetDrawInFront

Returns whether the mask is drawn in front of child elements.

Syntax

bool GetDrawInFront()

GetIsMaskingEnabled

Returns whether masking is enabled.

Syntax

bool GetIsMaskingEnabled()

GetUseAlphaTest

Returns whether to use the alpha channel in the mask visual's texture to define the mask.

Syntax

bool GetUseAlphaTest()

SetDrawBehind

Sets whether the mask is drawn behind the child elements.

Syntax

void SetDrawBehind(bool drawMaskVisualBehindChildren)

SetDrawInFront

Sets whether the mask is drawn in front of child elements.

Syntax

void SetDrawInFront(bool drawMaskVisualInFrontOfChildren)

SetIsMaskingEnabled

Sets whether masking is enabled.

Syntax

void SetIsMaskingEnabled(bool enableMasking)

SetUseAlphaTest

Sets whether to use the alpha channel in the mask visual's texture to define the mask.

Syntax

void SetUseAlphaTest(bool useAlphaTest)

On this page: