Class TMP_SubMesh
Inherited Members
Namespace: TMPro
Assembly: Unity.TextMeshPro.dll
Syntax
[RequireComponent(typeof(MeshRenderer))]
[ExecuteAlways]
public class TMP_SubMesh : MonoBehaviourProperties
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 | Uniform padding in mesh units required to avoid clipping expanded SDF effects for the active material. |
SetMaterialDirty()
Applies the shared material to the renderer and syncs culling with the parent text component.
Declaration
public void SetMaterialDirty()SetVerticesDirty()
Suppresses the base rebuild; updates are driven by the parent text component. Use SetVerticesDirty() on the parent to mark it dirty.
Declaration
public void SetVerticesDirty()UpdateMaterial()
Applies the shared material to the renderer and syncs culling with the parent text component.
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 | True to add TMP's additional safety padding (shader-dependent, usually a few pixels worth in SDF space) for effects. |
| bool | isUsingBold | True when bold weight is active so padding accounts for thicker glyph outlines in the material. |