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.

UI Canvas on Mesh

Component entity system is in preview release and is subject to change.

With the UI Canvas on Mesh component, you can place a UI canvas on a component entity in the 3D world that a player can interact with via ray casts. Use this component in conjunction with the UI Canvas Asset Ref component.

For more information about how to use the UI Canvas Asset Ref component, see Placing UI Canvases in the 3D World.

UI Canvas on Mesh Component Properties

The UI Canvas on Mesh component has the following properties:

Render target override

For simple cases, you can leave this property blank. The UI canvas specifies a render target, and that render target can be used as a texture name for the material on the 3D mesh.

You can use the Render target override property when you want to load two unique instances of the same UI canvas that the user can set to different states. This example case is demonstrated in the UiIn3DWorld level in the Samples Project.