Class TextMeshProUGUI

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
UIBehaviour
Graphic
MaskableGraphic
TMP_Text
TextMeshProUGUI
Implements
Inherited Members
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Object.GetHashCode()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: TMPro
Assembly: Unity.TextMeshPro.dll
Syntax
[DisallowMultipleComponent]
[RequireComponent(typeof(RectTransform))]
[RequireComponent(typeof(CanvasRenderer))]
[AddComponentMenu("UI/TextMeshPro - Text (UI)", 11)]
[ExecuteAlways]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.ugui@2.0/manual/TextMeshPro/index.html")]
public class TextMeshProUGUI : TMP_Text, ICanvasElement, IClippable, IMaskable, IMaterialModifier, ILayoutElement

Fields

m_subTextObjects

Declaration
protected TMP_SubMeshUI[] m_subTextObjects
Field Value
Type Description
TMP_SubMeshUI[]

Properties

autoSizeTextContainer

Determines if the size of the text container will be adjusted to fit the text object when it is first created.

Declaration
public override bool autoSizeTextContainer { get; set; }
Property Value
Type Description
bool
Overrides

canvasRenderer

Reference to the CanvasRenderer used by the text object.

Declaration
public CanvasRenderer canvasRenderer { get; }
Property Value
Type Description
CanvasRenderer

maskOffset

Sets the masking offset from the bounds of the object

Declaration
public Vector4 maskOffset { get; set; }
Property Value
Type Description
Vector4

materialForRendering

Get the material that will be used for rendering.

Declaration
public override Material materialForRendering { get; }
Property Value
Type Description
Material
Overrides

mesh

Reference to the Mesh used by the text object.

Declaration
public override Mesh mesh { get; }
Property Value
Type Description
Mesh
Overrides

Methods

Awake()

Declaration
protected override void Awake()
Overrides

CalculateLayoutInputHorizontal()

Function called by Unity when the horizontal layout needs to be recalculated.

Declaration
public void CalculateLayoutInputHorizontal()

CalculateLayoutInputVertical()

Function called by Unity when the vertical layout needs to be recalculated.

Declaration
public void CalculateLayoutInputVertical()

ClearMesh()

Function to clear the geometry of the Primary and Sub Text objects.

Declaration
public override void ClearMesh()
Overrides

ComputeMarginSize()

Update the margin width and height

Declaration
public override void ComputeMarginSize()
Overrides

Cull(Rect, bool)

Override of the Cull function to provide for the ability to override the culling of the text object.

Declaration
public override void Cull(Rect clipRect, bool validRect)
Parameters
Type Name Description
Rect clipRect
bool validRect
Overrides

DestroySubMeshObjects()

Destroy Sub Mesh Objects

Declaration
protected override void DestroySubMeshObjects()
Overrides

ForceMeshUpdate(bool, bool)

Function to force regeneration of the text object before its normal process time. This is useful when changes to the text object properties need to be applied immediately.

Declaration
public override void ForceMeshUpdate(bool ignoreActiveState = false, bool forceTextReparsing = false)
Parameters
Type Name Description
bool ignoreActiveState

Ignore Active State of text objects. Inactive objects are ignored by default.
bool forceTextReparsing

Force re-parsing of the text.
Overrides

GenerateTextMesh()

This is the main function that is responsible for creating / displaying the text.

Declaration
protected virtual void GenerateTextMesh()

GetCompoundBounds()

Method returning the compound bounds of the text object and child sub objects.

Declaration
protected override Bounds GetCompoundBounds()
Returns
Type Description
Bounds
Overrides

GetMaterial(Material)

Function called internally when a new material is assigned via the fontMaterial property.

Declaration
protected override Material GetMaterial(Material mat)
Parameters
Type Name Description
Material mat
Returns
Type Description
Material
Overrides

GetMaterials(Material[])

Method returning instances of the materials used by the text object.

Declaration
protected override Material[] GetMaterials(Material[] mats)
Parameters
Type Name Description
Material[] mats
Returns
Type Description
Material[]
Overrides

GetModifiedMaterial(Material)

Declaration
public override Material GetModifiedMaterial(Material baseMaterial)
Parameters
Type Name Description
Material baseMaterial
Returns
Type Description
Material
Overrides

GetSharedMaterials()

Method returning an array containing the materials used by the text object.

Declaration
protected override Material[] GetSharedMaterials()
Returns
Type Description
Material[]
Overrides

GetTextContainerLocalCorners()

Method to return the local corners of the Text Container or RectTransform.

Declaration
protected override Vector3[] GetTextContainerLocalCorners()
Returns
Type Description
Vector3[]
Overrides

GetTextInfo(string)

Function used to evaluate the length of a text string.

Declaration
public override TMP_TextInfo GetTextInfo(string text)
Parameters
Type Name Description
string text
Returns
Type Description
TMP_TextInfo
Overrides

InternalCrossFadeAlpha(float, float, bool)

Tweens the alpha of the CanvasRenderer color associated with this Graphic.

Declaration
protected override void InternalCrossFadeAlpha(float alpha, float duration, bool ignoreTimeScale)
Parameters
Type Name Description
float alpha

Target alpha.
float duration

Duration of the tween in seconds.
bool ignoreTimeScale

Should ignore Time.scale?
Overrides

InternalCrossFadeColor(Color, float, bool, bool)

Tweens the CanvasRenderer color associated with this Graphic.

Declaration
protected override void InternalCrossFadeColor(Color targetColor, float duration, bool ignoreTimeScale, bool useAlpha)
Parameters
Type Name Description
Color targetColor

Target color.
float duration

Tween duration.
bool ignoreTimeScale

Should ignore Time.scale?
bool useAlpha

Should also Tween the alpha channel?
Overrides

LoadFontAsset()

Method which derived classes need to override to load Font Assets.

Declaration
protected override void LoadFontAsset()
Overrides

OnCanvasHierarchyChanged()

Called when the state of the parent Canvas is changed.

Declaration
protected override void OnCanvasHierarchyChanged()
Overrides

OnDestroy()

Declaration
protected override void OnDestroy()
Overrides

OnDidApplyAnimationProperties()

Declaration
protected override void OnDidApplyAnimationProperties()
Overrides

OnDisable()

Clear references.

Declaration
protected override void OnDisable()
Overrides

OnEnable()

Mark the Graphic and the canvas as having been changed.

Declaration
protected override void OnEnable()
Overrides

OnRectTransformDimensionsChange()

This callback is called when the dimensions of an associated RectTransform change. It is always called before Awake, OnEnable, or Start. The call is also made to all child RectTransforms, regardless of whether their dimensions change (which depends on how they are anchored).

Declaration
protected override void OnRectTransformDimensionsChange()
Overrides

OnTransformParentChanged()

Declaration
protected override void OnTransformParentChanged()
Overrides

OnValidate()

Declaration
protected override void OnValidate()
Overrides

Rebuild(CanvasUpdate)

Declaration
public override void Rebuild(CanvasUpdate update)
Parameters
Type Name Description
CanvasUpdate update
Overrides

RecalculateClipping()

Method called when the state of a parent changes.

Declaration
public override void RecalculateClipping()
Overrides

Reset()

Declaration
protected override void Reset()
Overrides

SetActiveSubMeshes(bool)

Method to Enable or Disable child SubMesh objects.

Declaration
protected override void SetActiveSubMeshes(bool state)
Parameters
Type Name Description
bool state
Overrides

SetAllDirty()

Declaration
public override void SetAllDirty()
Overrides

SetCulling()

Set the culling mode on the material.

Declaration
protected override void SetCulling()
Overrides

SetFaceColor(Color32)

Function called internally to set the face color of the material. This will results in an instance of the material.

Declaration
protected override void SetFaceColor(Color32 color)
Parameters
Type Name Description
Color32 color
Overrides

SetLayoutDirty()

Declaration
public override void SetLayoutDirty()
Overrides

SetMaterialDirty()

Declaration
public override void SetMaterialDirty()
Overrides

SetOutlineColor(Color32)

Function called internally to set the outline color of the material. This will results in an instance of the material.

Declaration
protected override void SetOutlineColor(Color32 color)
Parameters
Type Name Description
Color32 color
Overrides

SetOutlineThickness(float)

Function called internally to set the outline thickness property of the material. This will results in an instance of the material.

Declaration
protected override void SetOutlineThickness(float thickness)
Parameters
Type Name Description
float thickness
Overrides

SetShaderDepth()

Set the Render Queue and ZTest mode on the current material

Declaration
protected override void SetShaderDepth()
Overrides

SetSharedMaterial(Material)

Function called internally when a new shared material is assigned via the fontSharedMaterial property.

Declaration
protected override void SetSharedMaterial(Material mat)
Parameters
Type Name Description
Material mat
Overrides

SetSharedMaterials(Material[])

Method used to assign new materials to the text and sub text objects.

Declaration
protected override void SetSharedMaterials(Material[] materials)
Parameters
Type Name Description
Material[] materials
Overrides

SetVerticesDirty()

Mark the vertices as dirty and needing rebuilt.

Declaration
public override void SetVerticesDirty()
Overrides
Remarks

Send a OnDirtyVertsCallback notification if any elements are registered. See RegisterDirtyVerticesCallback

UpdateFontAsset()

Declaration
public void UpdateFontAsset()

UpdateGeometry(Mesh, int)

Function to update the geometry of the main and sub text objects.

Declaration
public override void UpdateGeometry(Mesh mesh, int index)
Parameters
Type Name Description
Mesh mesh
int index
Overrides

UpdateMaterial()

Declaration
protected override void UpdateMaterial()
Overrides

UpdateMeshPadding()

Function to be used to force recomputing of character padding when Shader / Material properties have been changed via script.

Declaration
public override void UpdateMeshPadding()
Overrides

UpdateVertexData()

Function to upload the updated vertex data and renderer.

Declaration
public override void UpdateVertexData()
Overrides

UpdateVertexData(TMP_VertexDataUpdateFlags)

Function to upload the updated vertex data and renderer.

Declaration
public override void UpdateVertexData(TMP_VertexDataUpdateFlags flags)
Parameters
Type Name Description
TMP_VertexDataUpdateFlags flags
Overrides

Events

OnPreRenderText

Event to allow users to modify the content of the text info before the text is rendered.

Declaration
public override event Action<TMP_TextInfo> OnPreRenderText
Event Type
Type Description
Action<TMP_TextInfo>
Overrides

Implements