Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

TextGenerationSettings

struct in UnityEngine

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

A struct that stores the settings for TextGeneration.

Variables

colorThe base color for the text generation.
fontFont to use for generation.
fontSizeFont size.
fontStyleFont style.
generateOutOfBoundsContinue to generate characters even if the text runs out of bounds.
generationExtentsExtents that the generator will attempt to fit the text in.
horizontalOverflowWhat happens to text when it reaches the horizontal generation bounds.
lineSpacingThe line spacing multiplier.
pivotGenerated vertices are offset by the pivot.
resizeTextForBestFitShould the text be resized to fit the configured bounds?
resizeTextMaxSizeMaximum size for resized text.
resizeTextMinSizeMinimum size for resized text.
richTextAllow rich text markup in generation.
scaleFactorA scale factor for the text. This is useful if the Text is on a Canvas and the canvas is scaled.
textAnchorHow is the generated text anchored.
updateBoundsShould the text generator update the bounds from the generated text.
verticalOverflowWhat happens to text when it reaches the bottom generation bounds.