docs.unity3d.com
    Show / Hide Table of Contents

    Class TMP_SubMesh

    Inheritance
    Object
    TMP_SubMesh
    Namespace: TMPro
    Syntax
    public class TMP_SubMesh : MonoBehaviour

    Properties

    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
    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
    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

    textComponent

    Reference to the parent Text Component.

    Declaration
    public TMP_Text textComponent { get; }
    Property Value
    Type Description
    TMP_Text

    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
    Single

    SetMaterialDirty()

    Declaration
    public void SetMaterialDirty()

    SetVerticesDirty()

    Declaration
    public void SetVerticesDirty()

    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
    Boolean isExtraPadding
    Boolean isUsingBold
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • 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 18 October 2023