UICanvasManager - Lumberyard User Guide

UICanvasManager

Open 3D Engine (O3DE), the successor to Lumberyard, is now available in Developer Preview. Download O3DE or visit the AWS Game Tech blog to learn more.

Contains functions for loading, unloading, and finding UI canvases.

UiCanvasManagerBus

Services messages for the UiCanvasManager component.

FindLoadedCanvasByPathName

Returns the entity ID of the loaded canvas that has the specified canvas pathname.

Syntax

AZ::EntityId FindLoadedCanvasByPathName(const AZStd::string& canvasPathname)

LoadCanvas

Loads a canvas and returns the entity ID of the loaded canvas.

Syntax

AZ::EntityId LoadCanvas(const AZStd::string& canvasPathname)

UnloadCanvas

Unloads a UI canvas.

Syntax

void UnloadCanvas(AZ::EntityId canvasEntityId)