Class that can be used to generate text for rendering.
Caches vertices, character info, and line info for memory friendlyness.
using UnityEngine; using System.Collections;
public class ExampleClass : MonoBehaviour { public Font font; void Start() { TextGenerationSettings settings = new TextGenerationSettings(); settings.textAnchor = TextAnchor.MiddleCenter; settings.color = Color.red; settings.generationExtents = new Vector2(500.0F, 200.0F); settings.pivot = Vector2.zero; settings.richText = true; settings.font = font; settings.fontSize = 32; settings.fontStyle = FontStyle.Normal; settings.verticalOverflow = VerticalWrapMode.Overflow; TextGenerator generator = new TextGenerator(); generator.Populate("I am a string", settings); Debug.Log("I generated: " + generator.vertexCount + " verts!"); } }
characterCount | The number of characters that have been generated. |
characterCountVisible | The number of characters that have been generated and are included in the visible lines. |
characters | Array of generated characters. |
fontSizeUsedForBestFit | The size of the font that was found if using best fit mode. |
lineCount | Number of text lines generated. |
lines | Information about each generated text line. |
rectExtents | Extents of the generated text in rect format. |
vertexCount | Number of vertices generated. |
verts | Array of generated vertices. |
TextGenerator | Create a TextGenerator. |
GetCharacters | Populate the given List with UICharInfo. |
GetCharactersArray | Returns the current UICharInfo. |
GetLines | Populate the given list with UILineInfo. |
GetLinesArray | Returns the current UILineInfo. |
GetPreferredHeight | Given a string and settings, returns the preferred height for a container that would hold this text. |
GetPreferredWidth | Given a string and settings, returns the preferred width for a container that would hold this text. |
GetVertices | Populate the given list with generated Vertices. |
GetVerticesArray | Returns the current UIVertex array. |
Invalidate | Mark the text generator as invalid. This will force a full text generation the next time Populate is called. |
Populate | Will generate the vertices and other data for the given string with the given settings. |
PopulateWithErrors | Will generate the vertices and other data for the given string with the given settings. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.