Lumberyard
User Guide (Version 1.21)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

UICanvasManager

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)

On this page: