Class TMP_SubMeshUI

Inheritance
Object
UIBehaviour
Graphic
MaskableGraphic
TMP_SubMeshUI
Inherited Members
UnityEngine.UI.MaskableGraphic.OnValidate()
UnityEngine.UI.MaskableGraphic.UnityEngine.UI.IClippable.get_gameObject()
UnityEngine.UI.Graphic.SetRaycastDirty()
UnityEngine.UI.Graphic.OnRebuildRequested()
UnityEngine.UI.Graphic.Reset()
UnityEngine.UI.Graphic.UnityEngine.UI.ICanvasElement.get_transform()
Namespace: TMPro
Syntax
[ExecuteAlways]
[RequireComponent(typeof(CanvasRenderer))]
public class TMP_SubMeshUI : MaskableGraphic, ICanvasElement, IClippable, IMaskable, IMaterialModifier

Properties

fallbackMaterial

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 FontAsset fontAsset { get; set; }
Property Value
Type Description
UnityEngine.TextCore.Text.FontAsset

isDefaultMaterial

Is the text object using the default font asset material.

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

mainTexture

Declaration
public override Texture mainTexture { get; }
Property Value
Type Description
Texture
Overrides

material

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

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

materialForRendering

Get the material that will be used for rendering.

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

mesh

The Mesh of this text sub object.

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

padding

Padding value resulting for the property settings on the material.

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

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 SpriteAsset spriteAsset { get; set; }
Property Value
Type Description
UnityEngine.TextCore.Text.SpriteAsset

textComponent

Reference to the parent Text Component.

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

Methods

AddSubTextObject(TextMeshProUGUI, MaterialReference)

Function to add a new sub text object.

Declaration
public static TMP_SubMeshUI AddSubTextObject(TextMeshProUGUI textComponent, MaterialReference materialReference)
Parameters
Type Name Description
TextMeshProUGUI textComponent
MaterialReference materialReference
Returns
Type Description
TMP_SubMeshUI

Cull(Rect, Boolean)

Override Cull function as this is handled by the parent text object.

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

GetModifiedMaterial(Material)

Function returning the modified material for masking if necessary.

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

GetPaddingForMaterial()

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

Declaration
public float GetPaddingForMaterial()
Returns
Type Description
Single

GetPaddingForMaterial(Material)

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

Declaration
public float GetPaddingForMaterial(Material mat)
Parameters
Type Name Description
Material mat
Returns
Type Description
Single

OnDestroy()

Declaration
protected override void OnDestroy()
Overrides

OnDisable()

Declaration
protected override void OnDisable()
Overrides

OnEnable()

Declaration
protected override void OnEnable()
Overrides

OnTransformParentChanged()

Declaration
protected override void OnTransformParentChanged()
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

RefreshMaterial()

Function to update the material from the parent text object.

Declaration
public void RefreshMaterial()

SetAllDirty()

Declaration
public override void SetAllDirty()
Overrides

SetLayoutDirty()

Declaration
public override void SetLayoutDirty()
Overrides

SetMaterialDirty()

Declaration
public override void SetMaterialDirty()
Overrides

SetPivotDirty()

Declaration
public void SetPivotDirty()

SetVerticesDirty()

Declaration
public override void SetVerticesDirty()
Overrides

UpdateGeometry()

Declaration
protected override void UpdateGeometry()
Overrides

UpdateMaterial()

Declaration
protected override void UpdateMaterial()
Overrides

UpdateMeshPadding(Boolean, Boolean)

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