UI

Xenko features a UI editor and layout system you can use to build sophisticated user interfaces. It supports 2D and 3D independently of resolution.

Xenko uses two types of UI asset: UIPageAsset and UILibraryAsset. Their runtime counterparts are UIPage and UILibrary respectively.

To reduce the number of draw calls, Xenko draws multiple elements using a sprite batch renderer.

Controls

Xenko features many UI control components, including:

• ImageElement
• ContentControl
  • ScrollViewer
  • Button
    • ToggleButton
  • ContentDecorator
• TextBlock
  • ScrollingText
• EditText (displays soft keyboard on mobile devices)
• Panel
  • StackPanel (supports virtualization)
  • Grid
  • UniformGrid
  • Canvas
• ScrollBar
• ModalElementYou can also create your own.

Sample project

Without scripts, UIs are simply non-interactive images. To make them interactive, add a script.

For an example of a UI implemented in Xenko, see the game menu UI sample included with Xenko.

In this section

• UI pages
• UI libraries
• UI editor
• Add a UI to a scene
• Layout system

See also

• VR — Display a UI in an overlay