TextGenerationSettings
A struct that stores the settings for the Advanced Text Generator.
Read time 1 minuteLast updated 9 days ago
Definition
- Type: Struct
- Namespace: UnityEngine.TextCore.Generation
- Assembly: UnityEngine.TextCoreTextEngineModule
public struct TextGenerationSettings
Fields
Value | Description |
|---|---|
| autoSize | Automatic font sizing, which shrinks or grows the font size so the text fits the extents. |
| color | The base color for the text generation. |
| extents | The layout area, in pixels. Text is aligned within it and lines wrap at a positive horizontal extent when _wrapMode allows it. A zero or negative axis is unconstrained. |
| font | Font to use for generation. |
| fontSize | Font size, in pixels. |
| fontStyle | Font style. |
| fontWeight | Font weight. |
| horizontalAlignment | Horizontal alignment of the text within the extents. |
| languageDirection | The base direction paragraphs are laid out in. |
| richText | Allow rich text markup in generation. |
| text | The text to generate. |
| verticalAlignment | Vertical alignment of the text within the extents. Takes effect when the vertical extent is positive. |
| whitespaceCollapse | How sequences of white space are handled. |
| wrapMode | Whether lines wrap at the horizontal extent. |
Static Properties
Property | Description |
|---|---|
| Default | A set of settings initialized to sensible defaults. |