Class TMP_MaterialManager
Inheritance
TMP_MaterialManager
Namespace: TMPro
Assembly: Unity.TextMeshPro.dll
Syntax
public static class TMP_MaterialManager
Methods
AddFallbackMaterialReference(Material)
Declaration
public static void AddFallbackMaterialReference(Material targetMaterial)
Parameters
Type |
Name |
Description |
Material |
targetMaterial |
|
AddMaskingMaterial(Material, Material, int)
Declaration
public static void AddMaskingMaterial(Material baseMaterial, Material stencilMaterial, int stencilID)
Parameters
CleanupFallbackMaterials()
Declaration
public static void CleanupFallbackMaterials()
ClearMaterials()
Declaration
public static void ClearMaterials()
CopyMaterialPresetProperties(Material, Material)
Function to copy the properties of a source material preset to another while preserving the unique font asset properties of the destination material.
Declaration
public static void CopyMaterialPresetProperties(Material source, Material destination)
Parameters
GetBaseMaterial(Material)
Declaration
public static Material GetBaseMaterial(Material stencilMaterial)
Parameters
Type |
Name |
Description |
Material |
stencilMaterial |
|
Returns
GetFallbackMaterial(Material, Material)
This function returns a material instance using the material properties of a previous material but using the font atlas texture of the new font asset.
Declaration
public static Material GetFallbackMaterial(Material sourceMaterial, Material targetMaterial)
Parameters
Type |
Name |
Description |
Material |
sourceMaterial |
The material containing the source material properties to be copied to the new material.
|
Material |
targetMaterial |
The font atlas texture that should be assigned to the new material.
|
Returns
GetMaterialForRendering(MaskableGraphic, Material)
Declaration
public static Material GetMaterialForRendering(MaskableGraphic graphic, Material baseMaterial)
Parameters
Returns
GetStencilID(GameObject)
Function to get the Stencil ID
Declaration
public static int GetStencilID(GameObject obj)
Parameters
Returns
GetStencilMaterial(Material, int)
Create a Masking Material Instance for the given ID
Declaration
public static Material GetStencilMaterial(Material baseMaterial, int stencilID)
Parameters
Type |
Name |
Description |
Material |
baseMaterial |
|
int |
stencilID |
|
Returns
ReleaseBaseMaterial(Material)
Declaration
public static void ReleaseBaseMaterial(Material baseMaterial)
Parameters
Type |
Name |
Description |
Material |
baseMaterial |
|
ReleaseFallbackMaterial(Material)
Function to release the fallback material.
Declaration
public static void ReleaseFallbackMaterial(Material fallbackMaterial)
Parameters
Type |
Name |
Description |
Material |
fallbackMaterial |
Material to be released.
|
ReleaseStencilMaterial(Material)
Function to release the stencil material.
Declaration
public static void ReleaseStencilMaterial(Material stencilMaterial)
Parameters
Type |
Name |
Description |
Material |
stencilMaterial |
|
RemoveFallbackMaterialReference(Material)
Declaration
public static void RemoveFallbackMaterialReference(Material targetMaterial)
Parameters
Type |
Name |
Description |
Material |
targetMaterial |
|
RemoveStencilMaterial(Material)
Declaration
public static void RemoveStencilMaterial(Material stencilMaterial)
Parameters
Type |
Name |
Description |
Material |
stencilMaterial |
|
SetStencil(Material, int)
Function to set the Material Stencil ID
Declaration
public static Material SetStencil(Material material, int stencilID)
Parameters
Returns
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.