Class TextMeshPro

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
UIBehaviour
Graphic
MaskableGraphic
TMP_Text
TextMeshPro
TextMeshPro
Implements
ICanvasElement
IClippable
IMaskable
IMaterialModifier
ILayoutElement
Inherited Members
MaskableGraphic.m_ShouldRecalculateStencil
MaskableGraphic.m_MaskMaterial
MaskableGraphic.m_StencilValue
MaskableGraphic.GetModifiedMaterial(Material)
MaskableGraphic.SetClipSoftness(Vector2)
MaskableGraphic.OnValidate()
MaskableGraphic.OnCanvasHierarchyChanged()
MaskableGraphic.RecalculateClipping()
MaskableGraphic.RecalculateMasking()
MaskableGraphic.onCullStateChanged
MaskableGraphic.maskable
MaskableGraphic.isMaskingGraphic
Graphic.s_DefaultUI
Graphic.s_WhiteTexture
Graphic.m_Material
Graphic.m_SkipLayoutUpdate
Graphic.m_SkipMaterialUpdate
Graphic.m_OnDirtyLayoutCallback
Graphic.m_OnDirtyVertsCallback
Graphic.m_OnDirtyMaterialCallback
Graphic.s_Mesh
Graphic.m_CachedMesh
Graphic.m_CachedUvs
Graphic.OnBeforeTransformParentChanged()
Graphic.OnCullingChanged()
Graphic.LayoutComplete()
Graphic.GraphicUpdateComplete()
Graphic.UpdateGeometry()
Graphic.OnPopulateMesh(Mesh)
Graphic.OnPopulateMesh(VertexHelper)
Graphic.OnRebuildRequested()
Graphic.Reset()
Graphic.SetNativeSize()
Graphic.Raycast(Vector2, Camera)
Graphic.PixelAdjustPoint(Vector2)
Graphic.GetPixelAdjustedRect()
Graphic.RegisterDirtyLayoutCallback(UnityAction)
Graphic.UnregisterDirtyLayoutCallback(UnityAction)
Graphic.RegisterDirtyVerticesCallback(UnityAction)
Graphic.UnregisterDirtyVerticesCallback(UnityAction)
Graphic.RegisterDirtyMaterialCallback(UnityAction)
Graphic.UnregisterDirtyMaterialCallback(UnityAction)
Graphic.defaultGraphicMaterial
Graphic.raycastTarget
Graphic.raycastPadding
Graphic.useLegacyMeshGeneration
Graphic.depth
Graphic.canvas
Graphic.canvasRenderer
Graphic.defaultMaterial
Graphic.material
Graphic.materialForRendering
Graphic.mainTexture
Graphic.workerMesh
UIBehaviour.Start()
UIBehaviour.IsActive()
UIBehaviour.OnCanvasGroupChanged()
UIBehaviour.IsDestroyed()
Namespace: TMPro
Assembly: HollowKnight.dll
Syntax
[ExecuteInEditMode]
[DisallowMultipleComponent]
[RequireComponent(typeof(MeshRenderer))]
[RequireComponent(typeof(MeshFilter))]
[AddComponentMenu("Mesh/TextMeshPro - Text")]
[SelectionBase]
public class TextMeshPro : TMP_Text, ICanvasElement, IClippable, IMaskable, IMaterialModifier, ILayoutElement

Fields

| Edit this page View Source

m_subTextObjects

Declaration
[SerializeField]
protected TMP_SubMesh[] m_subTextObjects
Field Value
Type Description
TMP_SubMesh[]

Properties

| Edit this page View Source

autoSizeTextContainer

Declaration
public override bool autoSizeTextContainer { get; set; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

maskType

Declaration
public MaskingTypes maskType { get; set; }
Property Value
Type Description
MaskingTypes
| Edit this page View Source

mesh

Declaration
public override Mesh mesh { get; }
Property Value
Type Description
Mesh
Overrides
| Edit this page View Source

meshFilter

Declaration
public MeshFilter meshFilter { get; }
Property Value
Type Description
MeshFilter
| Edit this page View Source

renderer

Declaration
public Renderer renderer { get; }
Property Value
Type Description
Renderer
| Edit this page View Source

sortingLayerID

Declaration
public int sortingLayerID { get; set; }
Property Value
Type Description
int
| Edit this page View Source

sortingOrder

Declaration
public int sortingOrder { get; set; }
Property Value
Type Description
int
| Edit this page View Source

textContainer

Declaration
[Obsolete("The TextContainer is now obsolete. Use the RectTransform instead.")]
public TextContainer textContainer { get; }
Property Value
Type Description
TextContainer
| Edit this page View Source

transform

Declaration
public Transform transform { get; }
Property Value
Type Description
Transform

Methods

| Edit this page View Source

AdjustLineOffset(int, int, float)

Declaration
protected override void AdjustLineOffset(int startIndex, int endIndex, float offset)
Parameters
Type Name Description
int startIndex
int endIndex
float offset
Overrides
| Edit this page View Source

Awake()

Declaration
protected override void Awake()
Overrides
UnityEngine.EventSystems.UIBehaviour.Awake()
| Edit this page View Source

CalculateLayoutInputHorizontal()

Declaration
public void CalculateLayoutInputHorizontal()
| Edit this page View Source

CalculateLayoutInputVertical()

Declaration
public void CalculateLayoutInputVertical()
| Edit this page View Source

ClearMesh(bool)

Declaration
public override void ClearMesh(bool updateMesh)
Parameters
Type Name Description
bool updateMesh
Overrides
| Edit this page View Source

ClearSubMeshObjects()

Declaration
protected override void ClearSubMeshObjects()
Overrides
| Edit this page View Source

ComputeMarginSize()

Declaration
protected override void ComputeMarginSize()
Overrides
| Edit this page View Source

ForceMeshUpdate()

Declaration
public override void ForceMeshUpdate()
Overrides
| Edit this page View Source

ForceMeshUpdate(bool)

Declaration
public override void ForceMeshUpdate(bool ignoreInactive)
Parameters
Type Name Description
bool ignoreInactive
Overrides
| Edit this page View Source

GenerateTextMesh()

Declaration
protected override void GenerateTextMesh()
Overrides
| Edit this page View Source

GetCompoundBounds()

Declaration
protected override Bounds GetCompoundBounds()
Returns
Type Description
Bounds
Overrides
| Edit this page View Source

GetMaterial(Material)

Declaration
protected override Material GetMaterial(Material mat)
Parameters
Type Name Description
Material mat
Returns
Type Description
Material
Overrides
| Edit this page View Source

GetMaterials(Material[])

Declaration
protected override Material[] GetMaterials(Material[] mats)
Parameters
Type Name Description
Material[] mats
Returns
Type Description
Material[]
Overrides
| Edit this page View Source

GetPaddingForMaterial()

Declaration
protected override float GetPaddingForMaterial()
Returns
Type Description
float
Overrides
| Edit this page View Source

GetPaddingForMaterial(Material)

Declaration
protected override float GetPaddingForMaterial(Material mat)
Parameters
Type Name Description
Material mat
Returns
Type Description
float
Overrides
| Edit this page View Source

GetSharedMaterials()

Declaration
protected override Material[] GetSharedMaterials()
Returns
Type Description
Material[]
Overrides
| Edit this page View Source

GetTextContainerLocalCorners()

Declaration
protected override Vector3[] GetTextContainerLocalCorners()
Returns
Type Description
Vector3[]
Overrides
| Edit this page View Source

GetTextInfo(string)

Declaration
public override TMP_TextInfo GetTextInfo(string text)
Parameters
Type Name Description
string text
Returns
Type Description
TMP_TextInfo
Overrides
| Edit this page View Source

LoadFontAsset()

Declaration
protected override void LoadFontAsset()
Overrides
| Edit this page View Source

OnDestroy()

Declaration
protected override void OnDestroy()
Overrides
UnityEngine.UI.Graphic.OnDestroy()
| Edit this page View Source

OnDidApplyAnimationProperties()

Declaration
protected override void OnDidApplyAnimationProperties()
Overrides
UnityEngine.UI.Graphic.OnDidApplyAnimationProperties()
| Edit this page View Source

OnDisable()

Declaration
protected override void OnDisable()
Overrides
UnityEngine.UI.MaskableGraphic.OnDisable()
| Edit this page View Source

OnEnable()

Declaration
protected override void OnEnable()
Overrides
UnityEngine.UI.MaskableGraphic.OnEnable()
| Edit this page View Source

OnRectTransformDimensionsChange()

Declaration
protected override void OnRectTransformDimensionsChange()
Overrides
UnityEngine.UI.Graphic.OnRectTransformDimensionsChange()
| Edit this page View Source

OnTransformParentChanged()

Declaration
protected override void OnTransformParentChanged()
Overrides
UnityEngine.UI.MaskableGraphic.OnTransformParentChanged()
| Edit this page View Source

Rebuild(CanvasUpdate)

Declaration
public override void Rebuild(CanvasUpdate update)
Parameters
Type Name Description
CanvasUpdate update
Overrides
UnityEngine.UI.Graphic.Rebuild(UnityEngine.UI.CanvasUpdate)
| Edit this page View Source

SetActiveSubMeshes(bool)

Declaration
protected override void SetActiveSubMeshes(bool state)
Parameters
Type Name Description
bool state
Overrides
| Edit this page View Source

SetAllDirty()

Declaration
public override void SetAllDirty()
Overrides
UnityEngine.UI.Graphic.SetAllDirty()
| Edit this page View Source

SetArraySizes(int[])

Declaration
protected override int SetArraySizes(int[] chars)
Parameters
Type Name Description
int[] chars
Returns
Type Description
int
Overrides
| Edit this page View Source

SetCulling()

Declaration
protected override void SetCulling()
Overrides
| Edit this page View Source

SetFaceColor(Color32)

Declaration
protected override void SetFaceColor(Color32 color)
Parameters
Type Name Description
Color32 color
Overrides
| Edit this page View Source

SetLayoutDirty()

Declaration
public override void SetLayoutDirty()
Overrides
UnityEngine.UI.Graphic.SetLayoutDirty()
| Edit this page View Source

SetMask(MaskingTypes, Vector4)

Declaration
public void SetMask(MaskingTypes type, Vector4 maskCoords)
Parameters
Type Name Description
MaskingTypes type
Vector4 maskCoords
| Edit this page View Source

SetMask(MaskingTypes, Vector4, float, float)

Declaration
public void SetMask(MaskingTypes type, Vector4 maskCoords, float softnessX, float softnessY)
Parameters
Type Name Description
MaskingTypes type
Vector4 maskCoords
float softnessX
float softnessY
| Edit this page View Source

SetMaterialDirty()

Declaration
public override void SetMaterialDirty()
Overrides
UnityEngine.UI.Graphic.SetMaterialDirty()
| Edit this page View Source

SetOutlineColor(Color32)

Declaration
protected override void SetOutlineColor(Color32 color)
Parameters
Type Name Description
Color32 color
Overrides
| Edit this page View Source

SetOutlineThickness(float)

Declaration
protected override void SetOutlineThickness(float thickness)
Parameters
Type Name Description
float thickness
Overrides
| Edit this page View Source

SetShaderDepth()

Declaration
protected override void SetShaderDepth()
Overrides
| Edit this page View Source

SetSharedMaterial(Material)

Declaration
protected override void SetSharedMaterial(Material mat)
Parameters
Type Name Description
Material mat
Overrides
| Edit this page View Source

SetSharedMaterials(Material[])

Declaration
protected override void SetSharedMaterials(Material[] materials)
Parameters
Type Name Description
Material[] materials
Overrides
| Edit this page View Source

SetVerticesDirty()

Declaration
public override void SetVerticesDirty()
Overrides
UnityEngine.UI.Graphic.SetVerticesDirty()
| Edit this page View Source

UpdateFontAsset()

Declaration
public void UpdateFontAsset()
| Edit this page View Source

UpdateGeometry(Mesh, int)

Declaration
public override void UpdateGeometry(Mesh mesh, int index)
Parameters
Type Name Description
Mesh mesh
int index
Overrides
| Edit this page View Source

UpdateMaterial()

Declaration
protected override void UpdateMaterial()
Overrides
UnityEngine.UI.Graphic.UpdateMaterial()
| Edit this page View Source

UpdateMeshPadding()

Declaration
public override void UpdateMeshPadding()
Overrides
| Edit this page View Source

UpdateVertexData()

Declaration
public override void UpdateVertexData()
Overrides
| Edit this page View Source

UpdateVertexData(TMP_VertexDataUpdateFlags)

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

Implements

UnityEngine.UI.ICanvasElement
UnityEngine.UI.IClippable
UnityEngine.UI.IMaskable
UnityEngine.UI.IMaterialModifier
UnityEngine.UI.ILayoutElement

Extension Methods