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.
|
Inherits AZ::Component, UiCanvasUpdateNotificationBus::Handler, UiRenderControlBus::Handler, UiFaderBus::Handler, UiAnimateEntityBus::Handler, UiElementNotificationBus::Handler, and UiTransformChangeNotificationBus::Handler.
Public Member Functions | |
AZ_COMPONENT (UiFaderComponent, LyShine::UiFaderComponentUuid, AZ::Component) | |
void | Update (float deltaTime) override |
void | Render (LyShine::IRenderGraph *renderGraph, UiElementInterface *elementInterface, UiRenderInterface *renderInterface, int numChildren, bool isInGame) override |
float | GetFadeValue () override |
void | SetFadeValue (float fade) override |
void | Fade (float targetValue, float speed) override |
bool | IsFading () override |
bool | GetUseRenderToTexture () override |
void | SetUseRenderToTexture (bool useRenderToTexture) override |
void | PropertyValuesChanged () override |
void | OnUiElementFixup (AZ::EntityId canvasEntityId, AZ::EntityId parentEntityId) override |
void | OnCanvasSpaceRectChanged (AZ::EntityId entityId, const UiTransformInterface::Rect &oldRect, const UiTransformInterface::Rect &newRect) override |
void | OnTransformToViewportChanged () override |
Protected Member Functions | |
void | Activate () override |
void | Deactivate () override |
void | CompleteFade () |
Called when the fade animation completes. | |
void | OnFadeValueChanged () |
Called when the fade property changed in property pane. | |
void | OnRenderTargetChange () |
Called when something changed that invalidates render target. | |
void | MarkRenderGraphDirty () |
Mark the render graph as dirty, this should be done when any change is made affects the structure of the graph. | |
void | CreateOrResizeRenderTarget (const AZ::Vector2 &pixelAlignedTopLeft, const AZ::Vector2 &pixelAlignedBottomRight) |
When m_useRenderToTexture is true this is used to create the render target and depth surface or resize them if they exist. | |
void | DestroyRenderTarget () |
Destroy the render target and depth surface that are used when m_useRenderToTexture is true. | |
void | UpdateCachedPrimitive (const AZ::Vector2 &pixelAlignedTopLeft, const AZ::Vector2 &pixelAlignedBottomRight) |
Update cached primitive vertices. | |
void | ComputePixelAlignedBounds (AZ::Vector2 &pixelAlignedTopLeft, AZ::Vector2 &pixelAlignedBottomRight) |
void | RenderStandardFader (LyShine::IRenderGraph *renderGraph, UiElementInterface *elementInterface, UiRenderInterface *renderInterface, int numChildren, bool isInGame) |
void | RenderRttFader (LyShine::IRenderGraph *renderGraph, UiElementInterface *elementInterface, UiRenderInterface *renderInterface, int numChildren, bool isInGame) |
void | RenderElementAndChildren (LyShine::IRenderGraph *renderGraph, UiElementInterface *elementInterface, UiRenderInterface *renderInterface, int numChildren, bool isInGame) |
AZ_DISABLE_COPY_MOVE (UiFaderComponent) | |