To render UI and react to input from the users in the Game view, connect the UI Document assets to a Panel Settings asset by a UI Document component.
Every UI Document component references a UI Document asset (.uxml
file) that defines the UI and a Panel Settings asset that renders it. You can connect more than one UI Document asset to a single Panel Settings asset.
A Panel Settings asset defines a panel in the Scene. The panel provides the root visual elementA node of a visual tree that instantiates or derives from the C# VisualElement
class. You can style the look, define the behaviour, and display it on screen as part of the UI. More info
See in Glossary that UI hierarchies are attached to, and draws the UI in the Scene at runtime. How you configure the Panel Settings asset determines how the UI is rendered. It also determines how the UI reacts to input. For example, the panel that’s visually in the front intercepts clicks from the user before the panels that are visually in the back.
You can configure the Panel Settings asset to do the following:
To configure a panel:
A panel can display UI from more than one UI Document asset. Each UI Document has a Sort Order property that sets the UI Document rendering order:
To connect more than one UI Document asset to a panel:
Select or create a GameObject to host the UI.
Select Component > UI Toolkit > UI Document to add a UI Document component.
In the Inspector window of the UIDocument, do the following:
.uxml
file) asset that contains the UI you want to display.Repeat the process for each UI Document asset.
Note: If there are multiple UI documents attached to the same Panel Settings asset, all these documents have a common focus navigation context. If they have distinct Panel Settings, navigation won’t jump automatically from one to the other even if they’re arranged side by side.