Open 3D Engine LyShine Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
UiMaskInterface Class Referenceabstract

Inherits AZ::ComponentBus.

Public Member Functions

virtual bool GetIsMaskingEnabled ()=0
 Get whether masking is enabled.
 
virtual void SetIsMaskingEnabled (bool enableMasking)=0
 Set whether masking is enabled.
 
virtual bool GetIsInteractionMaskingEnabled ()=0
 Get whether interaction masking is enabled.
 
virtual void SetIsInteractionMaskingEnabled (bool enableInteractionMasking)=0
 Set whether interaction masking is enabled.
 
virtual bool GetDrawBehind ()=0
 Get whether mask visual is drawn to color buffer behind child elements.
 
virtual void SetDrawBehind (bool drawMaskVisualBehindChildren)=0
 Set whether mask visual is drawn to color buffer behind child elements.
 
virtual bool GetDrawInFront ()=0
 Get whether mask visual is drawn to color buffer in front of child elements.
 
virtual void SetDrawInFront (bool drawMaskVisualInFrontOfChildren)=0
 Set whether mask visual is drawn to color buffer in front of child elements.
 
virtual bool GetUseAlphaTest ()=0
 Get whether to use alpha test when drawing mask visual to stencil.
 
virtual void SetUseAlphaTest (bool useAlphaTest)=0
 Set whether to use alpha test when drawing mask visual to stencil.
 
virtual bool GetUseRenderToTexture ()=0
 Get the flag that indicates whether the mask should use render to texture.
 
virtual void SetUseRenderToTexture (bool useRenderToTexture)=0
 Set the flag that indicates whether the mask should use render to texture.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 Only one component on a entity can implement the events.
 

The documentation for this class was generated from the following file: