Class TMP_SubMeshUI

Inheritance

System.Object

UnityEngine.EventSystems.UIBehaviour

UnityEngine.UI.Graphic

UnityEngine.UI.MaskableGraphic

TMP_SubMeshUI

Inherited Members

UnityEngine.UI.MaskableGraphic.m_ShouldRecalculateStencil

UnityEngine.UI.MaskableGraphic.m_MaskMaterial

UnityEngine.UI.MaskableGraphic.m_StencilValue

UnityEngine.UI.MaskableGraphic.SetClipRect(UnityEngine.Rect, System.Boolean)

UnityEngine.UI.MaskableGraphic.SetClipSoftness(UnityEngine.Vector2)

UnityEngine.UI.MaskableGraphic.OnValidate()

UnityEngine.UI.MaskableGraphic.OnCanvasHierarchyChanged()

UnityEngine.UI.MaskableGraphic.UnityEngine.UI.IClippable.get_gameObject()

UnityEngine.UI.MaskableGraphic.onCullStateChanged

UnityEngine.UI.MaskableGraphic.maskable

UnityEngine.UI.MaskableGraphic.isMaskingGraphic

UnityEngine.UI.Graphic.s_DefaultUI

UnityEngine.UI.Graphic.s_WhiteTexture

UnityEngine.UI.Graphic.m_Material

UnityEngine.UI.Graphic.m_SkipLayoutUpdate

UnityEngine.UI.Graphic.m_SkipMaterialUpdate

UnityEngine.UI.Graphic.m_OnDirtyLayoutCallback

UnityEngine.UI.Graphic.m_OnDirtyVertsCallback

UnityEngine.UI.Graphic.m_OnDirtyMaterialCallback

UnityEngine.UI.Graphic.s_Mesh

UnityEngine.UI.Graphic.m_CachedMesh

UnityEngine.UI.Graphic.m_CachedUvs

UnityEngine.UI.Graphic.SetRaycastDirty()

UnityEngine.UI.Graphic.OnRectTransformDimensionsChange()

UnityEngine.UI.Graphic.OnBeforeTransformParentChanged()

UnityEngine.UI.Graphic.OnCullingChanged()

UnityEngine.UI.Graphic.LayoutComplete()

UnityEngine.UI.Graphic.GraphicUpdateComplete()

UnityEngine.UI.Graphic.OnPopulateMesh(UnityEngine.Mesh)

UnityEngine.UI.Graphic.OnPopulateMesh(UnityEngine.UI.VertexHelper)

UnityEngine.UI.Graphic.OnRebuildRequested()

UnityEngine.UI.Graphic.Reset()

UnityEngine.UI.Graphic.OnDidApplyAnimationProperties()

UnityEngine.UI.Graphic.SetNativeSize()

UnityEngine.UI.Graphic.Raycast(UnityEngine.Vector2, UnityEngine.Camera)

UnityEngine.UI.Graphic.PixelAdjustPoint(UnityEngine.Vector2)

UnityEngine.UI.Graphic.GetPixelAdjustedRect()

UnityEngine.UI.Graphic.CrossFadeColor(UnityEngine.Color, System.Single, System.Boolean, System.Boolean)

UnityEngine.UI.Graphic.CrossFadeColor(UnityEngine.Color, System.Single, System.Boolean, System.Boolean, System.Boolean)

UnityEngine.UI.Graphic.CrossFadeAlpha(System.Single, System.Single, System.Boolean)

UnityEngine.UI.Graphic.RegisterDirtyLayoutCallback(UnityEngine.Events.UnityAction)

UnityEngine.UI.Graphic.UnregisterDirtyLayoutCallback(UnityEngine.Events.UnityAction)

UnityEngine.UI.Graphic.RegisterDirtyVerticesCallback(UnityEngine.Events.UnityAction)

UnityEngine.UI.Graphic.UnregisterDirtyVerticesCallback(UnityEngine.Events.UnityAction)

UnityEngine.UI.Graphic.RegisterDirtyMaterialCallback(UnityEngine.Events.UnityAction)

UnityEngine.UI.Graphic.UnregisterDirtyMaterialCallback(UnityEngine.Events.UnityAction)

UnityEngine.UI.Graphic.UnityEngine.UI.ICanvasElement.get_transform()

UnityEngine.UI.Graphic.defaultGraphicMaterial

UnityEngine.UI.Graphic.color

UnityEngine.UI.Graphic.raycastTarget

UnityEngine.UI.Graphic.raycastPadding

UnityEngine.UI.Graphic.useLegacyMeshGeneration

UnityEngine.UI.Graphic.depth

UnityEngine.UI.Graphic.rectTransform

UnityEngine.UI.Graphic.canvas

UnityEngine.UI.Graphic.defaultMaterial

UnityEngine.UI.Graphic.workerMesh

UnityEngine.EventSystems.UIBehaviour.Awake()

UnityEngine.EventSystems.UIBehaviour.Start()

UnityEngine.EventSystems.UIBehaviour.IsActive()

UnityEngine.EventSystems.UIBehaviour.OnCanvasGroupChanged()

UnityEngine.EventSystems.UIBehaviour.IsDestroyed()

Namespace: TMPro

Syntax

[ExecuteInEditMode]
public class TMP_SubMeshUI : MaskableGraphic, ICanvasElement, IClippable, IMaskable, IMaterialModifier

Properties

canvasRenderer

The Mesh Renderer of this text sub object.

Declaration

public CanvasRenderer canvasRenderer { get; }

Property Value

Type	Description
CanvasRenderer

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

mainTexture

Declaration

public override Texture mainTexture { get; }

Property Value

Type	Description
Texture

Overrides

UnityEngine.UI.Graphic.mainTexture

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

UnityEngine.UI.Graphic.material

materialForRendering

Get the material that will be used for rendering.

Declaration

public override Material materialForRendering { get; }

Property Value

Type	Description
Material

Overrides

UnityEngine.UI.Graphic.materialForRendering

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
System.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 TMP_SpriteAsset spriteAsset { get; set; }

Property Value

Type	Description
TMP_SpriteAsset

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 to Cull function of MaskableGraphic to prevent Culling.

Declaration

public override void Cull(Rect clipRect, bool validRect)

Parameters

Type	Name	Description
Rect	clipRect
System.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
System.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
System.Single

OnDestroy()

Declaration

protected override void OnDestroy()

Overrides

UnityEngine.UI.Graphic.OnDestroy()

OnDisable()

Declaration

protected override void OnDisable()

Overrides

UnityEngine.UI.MaskableGraphic.OnDisable()

OnEnable()

Declaration

protected override void OnEnable()

Overrides

UnityEngine.UI.MaskableGraphic.OnEnable()

OnTransformParentChanged()

Declaration

protected override void OnTransformParentChanged()

Overrides

UnityEngine.UI.MaskableGraphic.OnTransformParentChanged()

Rebuild(CanvasUpdate)

Declaration

public override void Rebuild(CanvasUpdate update)

Parameters

Type	Name	Description
UnityEngine.UI.CanvasUpdate	update

Overrides

UnityEngine.UI.Graphic.Rebuild(UnityEngine.UI.CanvasUpdate)

RecalculateClipping()

Method called when the state of a parent changes.

Declaration

public override void RecalculateClipping()

Overrides

UnityEngine.UI.MaskableGraphic.RecalculateClipping()

Implements

UnityEngine.UI.IClippable.RecalculateClipping()

RecalculateMasking()

Declaration

public override void RecalculateMasking()

Overrides

UnityEngine.UI.MaskableGraphic.RecalculateMasking()

Implements

UnityEngine.UI.IMaskable.RecalculateMasking()

RefreshMaterial()

Function to update the material from the parent text object.

Declaration

public void RefreshMaterial()

SetAllDirty()

Declaration

public override void SetAllDirty()

Overrides

UnityEngine.UI.Graphic.SetAllDirty()

SetLayoutDirty()

Declaration

public override void SetLayoutDirty()

Overrides

UnityEngine.UI.Graphic.SetLayoutDirty()

SetMaterialDirty()

Declaration

public override void SetMaterialDirty()

Overrides

UnityEngine.UI.Graphic.SetMaterialDirty()

SetPivotDirty()

Declaration

public void SetPivotDirty()

SetVerticesDirty()

Declaration

public override void SetVerticesDirty()

Overrides

UnityEngine.UI.Graphic.SetVerticesDirty()

UpdateGeometry()

Declaration

protected override void UpdateGeometry()

Overrides

UnityEngine.UI.Graphic.UpdateGeometry()

UpdateMaterial()

Declaration

protected override void UpdateMaterial()

Overrides

UnityEngine.UI.Graphic.UpdateMaterial()

UpdateMeshPadding(Boolean, Boolean)

Declaration

public void UpdateMeshPadding(bool isExtraPadding, bool isUsingBold)

Parameters

Type	Name	Description
System.Boolean	isExtraPadding
System.Boolean	isUsingBold