Open 3D Engine LyShine Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
UiMaskComponent Class Reference

Inherits AZ::Component, UiRenderControlBus::Handler, UiMaskBus::Handler, UiInteractionMaskBus::Handler, and UiTransformChangeNotificationBus::Handler.

Public Member Functions

 AZ_COMPONENT (UiMaskComponent, LyShine::UiMaskComponentUuid, AZ::Component)
 
void Render (LyShine::IRenderGraph *renderGraph, UiElementInterface *elementInterface, UiRenderInterface *renderInterface, int numChildren, bool isInGame) override
 
bool GetIsMaskingEnabled () override
 
void SetIsMaskingEnabled (bool enableMasking) override
 
bool GetIsInteractionMaskingEnabled () override
 
void SetIsInteractionMaskingEnabled (bool enableMasking) override
 
bool GetDrawBehind () override
 
void SetDrawBehind (bool drawMaskVisualBehindChildren) override
 
bool GetDrawInFront () override
 
void SetDrawInFront (bool drawMaskVisualInFrontOfChildren) override
 
bool GetUseAlphaTest () override
 
void SetUseAlphaTest (bool useAlphaTest) override
 
bool GetUseRenderToTexture () override
 
void SetUseRenderToTexture (bool useRenderToTexture) override
 
bool IsPointMasked (AZ::Vector2 point) override
 
void OnCanvasSpaceRectChanged (AZ::EntityId entityId, const UiTransformInterface::Rect &oldRect, const UiTransformInterface::Rect &newRect) override
 
void OnTransformToViewportChanged () override
 

Static Public Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

void Activate () override
 
void Deactivate () override
 
 AZ_DISABLE_COPY_MOVE (UiMaskComponent)
 
The documentation for this class was generated from the following file: