Version: Unity 6 Preview (6000.0)
Language : English
Color gradients
Panel Text Settings assets

Advanced Text Generator

Advanced Text Generator is a text rendering module that employs Harfbuzz, ICU, and FreeType to deliver comprehensive Unicode support and text shaping capabilities.

With Advanced Text Generator, you can use a wide array of languages and scriptsA piece of code that allows you to create your own Components, trigger game events, modify Component properties over time and respond to user input in any way you like. More info
See in Glossary
, such as right-to-left (RTL) languages like Arabic and Hebrew.

Enable Advanced Text Generator

  1. From the menu, select Edit > Project Settings > UI Toolkit.
  2. Select the Enable Advanced Text Generator checkbox.

Use Advanced Text Generator

To use Advanced Text Generator, you must use a font asset that supports the language you want to use. For example, if you want to use Arabic, you must use a font asset that supports Arabic. Advanced Text Generator only supports dynamic font assets. Before using Advanced Text Generator in your project, you must import the font into your project and create a dynamic font asset from it.

In UI Builder

To use Advanced Text Generator in UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary
Builder, do the following:

  1. Select the 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 you want to apply to.
  2. In the InspectorA Unity window that displays information about the currently selected GameObject, asset or project settings, allowing you to inspect and edit the values. More info
    See in Glossary
    panel, select Text.
  3. From the Advanced Text Generator dropdown, select Advanced.

In USS

To use Advanced Text Generator in USS, set -unity-text-generator to advanced. For example:

.labelText {
    -unity-text-generator: advanced;
}

In C# scripts

To use Advanced Text Generator in C# scripts, set TextGeneratorType to Advanced. For example:

textElement.style.unityTextGenerator = new StyleEnum<TextGeneratorType>(TextGeneratorType.Advanced);

Limitations

Advanced Text Generator has the following limitations:

  • It only supports dynamic font assets
  • It doesn’t support customization of glyph metrics. The recommended workaround is to use FontEditing tools to customize the metrics or trim the font itself.

The present version lacks support for the following features; however, they are slated to be included in upcoming releases:

  • TextFields and selectable labels
  • Rich text tags
  • Spacing properties such as character, word, and paragraph
  • Ellipsis
  • Events
  • Emoji fallback
  • Parse escape sequence

When you use Advanced Text Generator, your project includes an icudt73l file that has a significant memory footprint of 4.8MB. This will be improved in future releases.

Additional resources

Color gradients
Panel Text Settings assets