Xenko

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • Manual
  • API
  • Release notes
    Show / Hide Table of Contents

    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.

    UI editor

    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:

    • @'SiliconStudio.Xenko.UI.Controls.ImageElement'
    • @'SiliconStudio.Xenko.UI.Controls.ContentControl'
      • @'SiliconStudio.Xenko.UI.Controls.ScrollViewer'
      • @'SiliconStudio.Xenko.UI.Controls.Button'
        • @'SiliconStudio.Xenko.UI.Controls.ToggleButton'
      • @'SiliconStudio.Xenko.UI.Controls.ContentDecorator'
    • @'SiliconStudio.Xenko.UI.Controls.TextBlock'
      • @'SiliconStudio.Xenko.UI.Controls.ScrollingText'
    • @'SiliconStudio.Xenko.UI.Controls.EditText' (displays soft keyboard on mobile devices)
    • @'SiliconStudio.Xenko.UI.Panels.Panel'
      • @'SiliconStudio.Xenko.UI.Panels.StackPanel' (supports virtualization)
      • @'SiliconStudio.Xenko.UI.Panels.Grid'
      • @'SiliconStudio.Xenko.UI.Panels.UniformGrid'
      • @'SiliconStudio.Xenko.UI.Panels.Canvas'
    • @'SiliconStudio.Xenko.UI.Controls.ScrollBar'
    • @'SiliconStudio.Xenko.UI.Controls.ModalElement'

    You 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.

    Sample UI project

    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
    • Improve this Doc

    Back to top

    Copyright © 2016 Silicon Studio
    Generated by DocFX