C# Class UnityEngine.TextGenerationSettings

Show file Open project: CarlosHBC/UnityDecompiled Class Usage Examples

Public Properties

Property	Type	Description
alignByGeometry	bool
color	Color
font	Font
fontSize	int
fontStyle	FontStyle
generateOutOfBounds	bool
generationExtents	Vector2
horizontalOverflow	HorizontalWrapMode
lineSpacing	float
pivot	Vector2
resizeTextForBestFit	bool
resizeTextMaxSize	int
resizeTextMinSize	int
richText	bool
scaleFactor	float
textAnchor	TextAnchor
updateBounds	bool
verticalOverflow	VerticalWrapMode

Public Methods

Method	Description
Equals ( TextGenerationSettings other ) : bool

Private Methods

Method	Description
CompareColors ( Color left, Color right ) : bool
CompareVector2 ( Vector2 left, Vector2 right ) : bool

Method Details

Equals() public method

public Equals ( TextGenerationSettings other ) : bool
other	TextGenerationSettings
return	bool

Property Details

alignByGeometry public property

Use the extents of glyph geometry to perform horizontal alignment rather than glyph metrics.

public bool alignByGeometry
return	bool

color public property

The base color for the text generation.

public Color color
return	Color

font public property

Font to use for generation.

public Font,UnityEngine font
return	Font

fontSize public property

Font size.

public int fontSize
return	int

fontStyle public property

Font style.

public FontStyle fontStyle
return	FontStyle

generateOutOfBounds public property

Continue to generate characters even if the text runs out of bounds.

public bool generateOutOfBounds
return	bool

generationExtents public property

Extents that the generator will attempt to fit the text in.

public Vector2 generationExtents
return	Vector2

horizontalOverflow public property

What happens to text when it reaches the horizontal generation bounds.

public HorizontalWrapMode horizontalOverflow
return	HorizontalWrapMode

lineSpacing public property

The line spacing multiplier.

public float lineSpacing
return	float

pivot public property

Generated vertices are offset by the pivot.

public Vector2 pivot
return	Vector2

resizeTextForBestFit public property

Should the text be resized to fit the configured bounds?

public bool resizeTextForBestFit
return	bool

resizeTextMaxSize public property

Maximum size for resized text.

public int resizeTextMaxSize
return	int

resizeTextMinSize public property

Minimum size for resized text.

public int resizeTextMinSize
return	int

richText public property

Allow rich text markup in generation.

public bool richText
return	bool

scaleFactor public property

A scale factor for the text. This is useful if the Text is on a Canvas and the canvas is scaled.

public float scaleFactor
return	float

textAnchor public property

How is the generated text anchored.

public TextAnchor textAnchor
return	TextAnchor

updateBounds public property

Should the text generator update the bounds from the generated text.

public bool updateBounds
return	bool

verticalOverflow public property

What happens to text when it reaches the bottom generation bounds.

public VerticalWrapMode verticalOverflow
return	VerticalWrapMode