Version: 2022.3
Get started with runtime UI
Panel Settings properties reference

Render UI in the Game view

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.

Configure a panel

A Panel Settings asset defines a panel in the Scene. The panel provides the root visual element 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:

  • Control scale and resolution
  • Apply default styles
  • Display UI on Render Textures
  • Set the panel’s sort order

To configure a panel:

  1. In your project, select Assets > Create > UI Toolkit > Panel Settings Asset to create a Panel Settings asset if you don’t have it.
  2. In the Inspector window of the Panel Settings, configure the Panel Settings properties.

Connect the UI to 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:

  • Child UI Document components are drawn on top of their parent UI Document components.
  • UI Documents components that are at the same level of the hierarchy are rendered in sequence according to their Sort Order.

To connect more than one UI Document asset to a panel:

  1. Select or create a GameObject to host the UI.

  2. Select Component > UI Toolkit > UI Document to add a UI Document component.

  3. In the Inspector window of the UIDocument, do the following:

    • Set the Panel Settings to the Panel Settings asset to display the UI.
    • Set the Source Asset to the UI Document (.uxml file) asset that contains the UI you want to display.
    • set the Sort Order. UI Document with a smaller number rendered first.
  4. 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.

其他资源

Get started with runtime UI
Panel Settings properties reference