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 | List of all members
UiCanvasManager Class Reference

Inherits UiCanvasManagerBus::Handler, UiCanvasOrderNotificationBus::Handler, UiCanvasEnabledStateNotificationBus::Handler, FontNotificationBus::Handler, and AzFramework::AssetCatalogEventBus::Handler.

Public Member Functions

 UiCanvasManager ()
 Constructor, constructed by the LyShine class.
 
AZ::EntityId CreateCanvas () override
 
AZ::EntityId LoadCanvas (const AZStd::string &canvasPathname) override
 
void UnloadCanvas (AZ::EntityId canvasEntityId) override
 
AZ::EntityId FindLoadedCanvasByPathName (const AZStd::string &canvasPathname, bool loadIfNotFound=false) override
 
CanvasEntityList GetLoadedCanvases () override
 
void SetLocalUserIdInputFilterForAllCanvases (AzFramework::LocalUserId localUserId) override
 
void OnCanvasDrawOrderChanged (AZ::EntityId canvasEntityId) override
 
void OnCanvasEnabledStateChanged (AZ::EntityId canvasEntityId, bool enabled) override
 
void OnFontsReloaded () override
 
void OnFontTextureUpdated (IFFont *font) override
 
void OnCatalogAssetChanged (const AZ::Data::AssetId &assetId) override
 
AZ::EntityId CreateCanvasInEditor (UiEntityContext *entityContext)
 
AZ::EntityId LoadCanvasInEditor (const AZStd::string &assetIdPathname, const AZStd::string &sourceAssetPathname, UiEntityContext *entityContext)
 
AZ::EntityId ReloadCanvasFromXml (const AZStd::string &xmlString, UiEntityContext *entityContext)
 
void ReleaseCanvas (AZ::EntityId canvas, bool forEditor)
 
void ReleaseCanvasDeferred (AZ::EntityId canvas)
 
AZ::EntityId FindCanvasById (LyShine::CanvasId id)
 
void SetTargetSizeForLoadedCanvases (AZ::Vector2 viewportSize)
 
void UpdateLoadedCanvases (float deltaTimeInSeconds)
 
void RenderLoadedCanvases ()
 
void DestroyLoadedCanvases (bool keepCrossLevelCanvases)
 
void OnLoadScreenUnloaded ()
 
bool HandleInputEventForLoadedCanvases (const AzFramework::InputChannel &inputChannel)
 
bool HandleTextEventForLoadedCanvases (const AZStd::string &textUTF8)
 
void GetRenderTargets (LyShine::AttachmentImagesAndDependencies &attachmentImagesAndDependencies)
 
void DebugDisplayCanvasData (int setting) const
 
void DebugDisplayDrawCallData () const
 
void DebugReportDrawCalls (const AZStd::string &name) const
 
void DebugDisplayElemBounds (int canvasIndexFilter) const
 
The documentation for this class was generated from the following file: