Class TMP_SubMeshUI
Inheritance
TMP_SubMeshUI
Namespace: TMPro
Syntax
public class TMP_SubMeshUI : MaskableGraphic, 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
isDefaultMaterial
Is the text object using the default font asset material.
Declaration
public bool isDefaultMaterial { get; set; }
Property Value
mainTexture
Declaration
public override Texture mainTexture { get; }
Property Value
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 |
|
materialForRendering
Get the material that will be used for rendering.
Declaration
public override Material materialForRendering { get; }
Property Value
| Type |
Description |
| Material |
|
mesh
The Mesh of this text sub object.
Declaration
public Mesh mesh { get; set; }
Property Value
padding
Padding value resulting for the property settings on the material.
Declaration
public float padding { get; set; }
Property Value
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
Methods
AddSubTextObject(TextMeshProUGUI, MaterialReference)
Function to add a new sub text object.
Declaration
public static TMP_SubMeshUI AddSubTextObject(TextMeshProUGUI textComponent, MaterialReference materialReference)
Parameters
Returns
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 |
|
| 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 |
|
Function called when the padding value for the material needs to be re-calculated.
Declaration
public float GetPaddingForMaterial()
Returns
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
OnDestroy()
Declaration
protected override void OnDestroy()
OnDisable()
Declaration
protected override void OnDisable()
OnEnable()
Declaration
protected override void OnEnable()
Declaration
protected override void OnTransformParentChanged()
Rebuild(CanvasUpdate)
Declaration
public override void Rebuild(CanvasUpdate update)
Parameters
| Type |
Name |
Description |
| CanvasUpdate |
update |
|
RecalculateClipping()
Method called when the state of a parent changes.
Declaration
public override void RecalculateClipping()
RecalculateMasking()
Declaration
public override void RecalculateMasking()
RefreshMaterial()
Function to update the material from the parent text object.
Declaration
public void RefreshMaterial()
SetAllDirty()
Declaration
public override void SetAllDirty()
SetLayoutDirty()
Declaration
public override void SetLayoutDirty()
SetMaterialDirty()
Declaration
public override void SetMaterialDirty()
SetPivotDirty()
Declaration
public void SetPivotDirty()
SetVerticesDirty()
Declaration
public override void SetVerticesDirty()
UpdateGeometry()
Declaration
protected override void UpdateGeometry()
UpdateMaterial()
Declaration
protected override void UpdateMaterial()
UpdateMeshPadding(Boolean, Boolean)
Declaration
public void UpdateMeshPadding(bool isExtraPadding, bool isUsingBold)
Parameters
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.