docs.unity3d.com
    Show / Hide Table of Contents

    Class TMP_SubMesh

    Inheritance
    System.Object
    Object
    Component
    Behaviour
    MonoBehaviour
    TMP_SubMesh
    Inherited Members
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(String, Single)
    MonoBehaviour.InvokeRepeating(String, Single, Single)
    MonoBehaviour.CancelInvoke(String)
    MonoBehaviour.IsInvoking(String)
    MonoBehaviour.StartCoroutine(String)
    MonoBehaviour.StartCoroutine(String, Object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(String)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(Object)
    MonoBehaviour.destroyCancellationToken
    MonoBehaviour.useGUILayout
    MonoBehaviour.didStart
    MonoBehaviour.didAwake
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    UnityEngine.Component.GetComponent<T>()
    UnityEngine.Component.TryGetComponent(System.Type, UnityEngine.Component)
    UnityEngine.Component.TryGetComponent<T>(T)
    Component.GetComponent(String)
    Component.GetComponentInChildren(Type, Boolean)
    Component.GetComponentInChildren(Type)
    UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)
    UnityEngine.Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, Boolean)
    UnityEngine.Component.GetComponentsInChildren(System.Type)
    UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)
    UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)
    UnityEngine.Component.GetComponentsInChildren<T>()
    UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)
    Component.GetComponentInParent(Type, Boolean)
    Component.GetComponentInParent(Type)
    UnityEngine.Component.GetComponentInParent<T>(System.Boolean)
    UnityEngine.Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, Boolean)
    UnityEngine.Component.GetComponentsInParent(System.Type)
    UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)
    UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)
    UnityEngine.Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)
    UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)
    UnityEngine.Component.GetComponents<T>()
    Component.GetComponentIndex()
    Component.CompareTag(String)
    Component.CompareTag(TagHandle)
    Component.SendMessageUpwards(String, Object, SendMessageOptions)
    Component.SendMessageUpwards(String, Object)
    Component.SendMessageUpwards(String)
    Component.SendMessageUpwards(String, SendMessageOptions)
    Component.SendMessage(String, Object)
    Component.SendMessage(String)
    Component.SendMessage(String, Object, SendMessageOptions)
    Component.SendMessage(String, SendMessageOptions)
    Component.BroadcastMessage(String, Object, SendMessageOptions)
    Component.BroadcastMessage(String, Object)
    Component.BroadcastMessage(String)
    Component.BroadcastMessage(String, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Object.GetInstanceID()
    UnityEngine.Object.GetHashCode()
    UnityEngine.Object.Equals(System.Object)
    UnityEngine.Object.InstantiateAsync<T>(T)
    UnityEngine.Object.InstantiateAsync<T>(T, UnityEngine.Transform)
    UnityEngine.Object.InstantiateAsync<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)
    UnityEngine.Object.InstantiateAsync<T>(T, UnityEngine.Transform, UnityEngine.Vector3, UnityEngine.Quaternion)
    UnityEngine.Object.InstantiateAsync<T>(T, System.Int32)
    UnityEngine.Object.InstantiateAsync<T>(T, System.Int32, UnityEngine.Transform)
    UnityEngine.Object.InstantiateAsync<T>(T, System.Int32, UnityEngine.Vector3, UnityEngine.Quaternion)
    UnityEngine.Object.InstantiateAsync<T>(T, System.Int32, System.ReadOnlySpan<UnityEngine.Vector3>, System.ReadOnlySpan<UnityEngine.Quaternion>)
    UnityEngine.Object.InstantiateAsync<T>(T, System.Int32, UnityEngine.Transform, UnityEngine.Vector3, UnityEngine.Quaternion)
    UnityEngine.Object.InstantiateAsync<T>(T, System.Int32, UnityEngine.Transform, UnityEngine.Vector3, UnityEngine.Quaternion, System.Threading.CancellationToken)
    UnityEngine.Object.InstantiateAsync<T>(T, System.Int32, UnityEngine.Transform, System.ReadOnlySpan<UnityEngine.Vector3>, System.ReadOnlySpan<UnityEngine.Quaternion>)
    UnityEngine.Object.InstantiateAsync<T>(T, System.Int32, UnityEngine.Transform, System.ReadOnlySpan<UnityEngine.Vector3>, System.ReadOnlySpan<UnityEngine.Quaternion>, System.Threading.CancellationToken)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Scene)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    UnityEngine.Object.Instantiate<T>(T)
    UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)
    UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
    UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)
    UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, Boolean)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)
    UnityEngine.Object.DestroyObject(UnityEngine.Object)
    UnityEngine.Object.FindSceneObjectsOfType(System.Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    UnityEngine.Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
    UnityEngine.Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    UnityEngine.Object.FindFirstObjectByType<T>()
    UnityEngine.Object.FindAnyObjectByType<T>()
    UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)
    UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: TMPro
    Syntax
    [ExecuteInEditMode]
    [RequireComponent(typeof(MeshRenderer))]
    [RequireComponent(typeof(MeshFilter))]
    public class TMP_SubMesh : MonoBehaviour

    Properties

    boxCollider

    Declaration
    public BoxCollider boxCollider { get; }
    Property Value
    Type Description
    BoxCollider

    fallbackMaterial

    The fallback material created from the properties of the fallback source material.

    Declaration
    public Material fallbackMaterial { get; set; }
    Property Value
    Type Description
    Material

    fallbackSourceMaterial

    The source material used by the fallback font

    Declaration
    public Material fallbackSourceMaterial { get; set; }
    Property Value
    Type Description
    Material

    fontAsset

    The TMP Font Asset assigned to this sub text object.

    Declaration
    public TMP_FontAsset fontAsset { get; set; }
    Property Value
    Type Description
    TMP_FontAsset

    isDefaultMaterial

    Is the text object using the default font asset material.

    Declaration
    public bool isDefaultMaterial { get; set; }
    Property Value
    Type Description
    System.Boolean

    material

    The material to be assigned to this object. Returns an instance of the material.

    Declaration
    public Material material { get; set; }
    Property Value
    Type Description
    Material

    mesh

    The Mesh of this text sub object.

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

    meshFilter

    The MeshFilter of this text sub object.

    Declaration
    public MeshFilter meshFilter { get; }
    Property Value
    Type Description
    MeshFilter

    padding

    Padding value resulting for the property settings on the material.

    Declaration
    public float padding { get; set; }
    Property Value
    Type Description
    System.Single

    renderer

    The Mesh Renderer of this text sub object.

    Declaration
    public Renderer renderer { get; }
    Property Value
    Type Description
    Renderer

    sharedMaterial

    The material to be assigned to this text object.

    Declaration
    public Material sharedMaterial { get; set; }
    Property Value
    Type Description
    Material

    spriteAsset

    The TMP Sprite Asset assigned to this sub text object.

    Declaration
    public TMP_SpriteAsset spriteAsset { get; set; }
    Property Value
    Type Description
    TMP_SpriteAsset

    Methods

    AddSubTextObject(TextMeshPro, MaterialReference)

    Declaration
    public static TMP_SubMesh AddSubTextObject(TextMeshPro textComponent, MaterialReference materialReference)
    Parameters
    Type Name Description
    TextMeshPro textComponent
    MaterialReference materialReference
    Returns
    Type Description
    TMP_SubMesh

    DestroySelf()

    Declaration
    public void DestroySelf()

    GetPaddingForMaterial()

    Function called when the padding value for the material needs to be re-calculated.

    Declaration
    public float GetPaddingForMaterial()
    Returns
    Type Description
    System.Single

    SetMaterialDirty()

    Declaration
    public void SetMaterialDirty()

    SetVerticesDirty()

    Declaration
    public void SetVerticesDirty()

    UpdateColliders(Int32)

    Declaration
    public void UpdateColliders(int vertexCount)
    Parameters
    Type Name Description
    System.Int32 vertexCount

    UpdateMaterial()

    Declaration
    protected void UpdateMaterial()

    UpdateMeshPadding(Boolean, Boolean)

    Function to update the padding values of the object.

    Declaration
    public void UpdateMeshPadding(bool isExtraPadding, bool isUsingBold)
    Parameters
    Type Name Description
    System.Boolean isExtraPadding
    System.Boolean isUsingBold
    Back to top
    Copyright © 2025 Unity Technologies
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 02 April 2025