Class TMP_TextInfo

Class which contains information about every element contained within the text object.

Inheritance

object

TMP_TextInfo

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: TMPro

Assembly: Unity.TextMeshPro.dll

Syntax

[Serializable]
public class TMP_TextInfo

Constructors

TMP_TextInfo()

Declaration

public TMP_TextInfo()

TMP_TextInfo(TMP_Text)

Declaration

public TMP_TextInfo(TMP_Text textComponent)

Parameters

Type	Name	Description
TMP_Text	textComponent

Fields

characterCount

Declaration

public int characterCount

Field Value

Type	Description
int

characterInfo

Declaration

[NonSerialized]
public TMP_CharacterInfo[] characterInfo

Field Value

Type	Description
TMP_CharacterInfo[]

lineCount

Declaration

public int lineCount

Field Value

Type	Description
int

lineInfo

Declaration

[NonSerialized]
public TMP_LineInfo[] lineInfo

Field Value

Type	Description
TMP_LineInfo[]

linkCount

Declaration

public int linkCount

Field Value

Type	Description
int

linkInfo

Declaration

[NonSerialized]
public TMP_LinkInfo[] linkInfo

Field Value

Type	Description
TMP_LinkInfo[]

materialCount

Declaration

public int materialCount

Field Value

Type	Description
int

meshInfo

Declaration

[NonSerialized]
public TMP_MeshInfo[] meshInfo

Field Value

Type	Description
TMP_MeshInfo[]

pageCount

Declaration

public int pageCount

Field Value

Type	Description
int

pageInfo

Declaration

[NonSerialized]
public TMP_PageInfo[] pageInfo

Field Value

Type	Description
TMP_PageInfo[]

spaceCount

Declaration

public int spaceCount

Field Value

Type	Description
int

spriteCount

Declaration

public int spriteCount

Field Value

Type	Description
int

textComponent

Declaration

public TMP_Text textComponent

Field Value

Type	Description
TMP_Text

wordCount

Declaration

public int wordCount

Field Value

Type	Description
int

wordInfo

Declaration

[NonSerialized]
public TMP_WordInfo[] wordInfo

Field Value

Type	Description
TMP_WordInfo[]

Methods

ClearAllMeshInfo()

Function to clear the content of all the MeshInfo arrays while preserving their Triangles, Normals and Tangents.

Declaration

public void ClearAllMeshInfo()

ClearMeshInfo(bool)

Function to clear the content of the MeshInfo array while preserving the Triangles, Normals and Tangents.

Declaration

public void ClearMeshInfo(bool updateMesh)

Parameters

Type	Name	Description
bool	updateMesh

ClearUnusedVertices(MaterialReference[])

Marks unused vertices as degenerate.

Declaration

public void ClearUnusedVertices(MaterialReference[] materials)

Parameters

Type	Name	Description
MaterialReference[]	materials	Parallel material references for each sub-mesh entry; reserved for per-material vertex ranges when clearing unused vertices.

Remarks

Iterates meshInfo and calls ClearUnusedVertices(int) from the computed start index so trailing vertices in each buffer can be cleared without reallocating the mesh.

CopyMeshInfoVertexData()

Function to copy the MeshInfo Arrays and their primary vertex data content.

Declaration

public TMP_MeshInfo[] CopyMeshInfoVertexData()

Returns

Type	Description
TMP_MeshInfo[]	A copy of the MeshInfo[]

ResetVertexLayout(bool)

Clears all mesh data and reconfigures the vertex structures to support either standard quads or volumetric (3D) character geometry.

Declaration

public void ResetVertexLayout(bool isVolumetric)

Parameters

Type	Name	Description
bool	isVolumetric	When true, subsequent mesh growth uses eight vertices per glyph; otherwise four vertices per glyph.

Remarks

Resizes each entry in meshInfo to zero vertices using ResizeMeshInfo(int, bool), so subsequent text generation allocates buffers for either billboard quads or extruded volumetric glyphs as required.

Resize<T>(ref T[], int)

Resizes any of the structure contained in the TMP_TextInfo class.

Declaration

public static void Resize<T>(ref T[] array, int size)

Parameters

Type	Name	Description
T[]	array	The array to resize (passed by reference).
int	size	The required number of elements; actual size may be rounded up to next power of two.

Type Parameters

Name	Description
T	Element type of the array.

Remarks

Uses the next power of two (or size plus 256 when above 1024) to reduce frequent reallocations while TMP grows character, word, or line tables during layout.

Resize<T>(ref T[], int, bool)

Resizes any of the structure contained in the TMP_TextInfo class.

Declaration

public static void Resize<T>(ref T[] array, int size, bool isBlockAllocated)

Parameters

Type	Name	Description
T[]	array	The array to resize (passed by reference).
int	size	The required number of elements; when isBlockAllocated is true, rounded up to next power of two.
bool	isBlockAllocated	When true, size is rounded up to the next power of two for block allocation.

Type Parameters

Name	Description
T	Element type of the array.

Remarks

When isBlockAllocated is false, the array is resized to exactly size if different from the current length, which is used for structures that already use explicit sizing instead of power-of-two blocks.