Class TMP_SubMesh

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
TMP_SubMesh
Inherited Members
MonoBehaviour.IsInvoking()
MonoBehaviour.CancelInvoke()
MonoBehaviour.StopCoroutine(Coroutine)
MonoBehaviour.StopAllCoroutines()
MonoBehaviour.useGUILayout
MonoBehaviour.runInEditMode
Behaviour.enabled
Behaviour.isActiveAndEnabled
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Component.transform
Component.gameObject
Component.tag
Object.GetInstanceID()
Object.GetHashCode()
Object.Instantiate(Object, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion, Transform)
Object.Instantiate(Object)
Object.Instantiate(Object, Transform)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.Destroy(Object)
Object.DestroyImmediate(Object)
Object.DontDestroyOnLoad(Object)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectOfType<T>()
Object.ToString()
Object.name
Object.hideFlags
Namespace: TMPro
Assembly: Unity.TextMeshPro.dll
Syntax
[RequireComponent(typeof(MeshRenderer))]
[ExecuteAlways]
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
bool

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
float

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
float

SetMaterialDirty()

Declaration
public void SetMaterialDirty()

SetVerticesDirty()

Declaration
public void SetVerticesDirty()

UpdateMaterial()

Declaration
protected void UpdateMaterial()

UpdateMeshPadding(bool, bool)

Function to update the padding values of the object.

Declaration
public void UpdateMeshPadding(bool isExtraPadding, bool isUsingBold)
Parameters
Type Name Description
bool isExtraPadding
bool isUsingBold