docs.unity3d.com
    Show / Hide Table of Contents

    Class TMP_MaterialManager

    Inheritance
    System.Object
    TMP_MaterialManager
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: TMPro
    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, Int32)

    Declaration
    public static void AddMaskingMaterial(Material baseMaterial, Material stencilMaterial, int stencilID)
    Parameters
    Type Name Description
    Material baseMaterial
    Material stencilMaterial
    System.Int32 stencilID

    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
    Type Name Description
    Material source
    Material destination

    GetBaseMaterial(Material)

    Declaration
    public static Material GetBaseMaterial(Material stencilMaterial)
    Parameters
    Type Name Description
    Material stencilMaterial
    Returns
    Type Description
    Material

    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
    Type Description
    Material

    GetMaterialForRendering(MaskableGraphic, Material)

    Declaration
    public static Material GetMaterialForRendering(MaskableGraphic graphic, Material baseMaterial)
    Parameters
    Type Name Description
    UnityEngine.UI.MaskableGraphic graphic
    Material baseMaterial
    Returns
    Type Description
    Material

    GetStencilID(GameObject)

    Function to get the Stencil ID

    Declaration
    public static int GetStencilID(GameObject obj)
    Parameters
    Type Name Description
    GameObject obj
    Returns
    Type Description
    System.Int32

    GetStencilMaterial(Material, Int32)

    Create a Masking Material Instance for the given ID

    Declaration
    public static Material GetStencilMaterial(Material baseMaterial, int stencilID)
    Parameters
    Type Name Description
    Material baseMaterial
    System.Int32 stencilID
    Returns
    Type Description
    Material

    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 fallackMaterial)
    Parameters
    Type Name Description
    Material fallackMaterial

    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, Int32)

    Function to set the Material Stencil ID

    Declaration
    public static Material SetStencil(Material material, int stencilID)
    Parameters
    Type Name Description
    Material material
    System.Int32 stencilID
    Returns
    Type Description
    Material
    Back to top
    Copyright © 2025 Unity Technologies
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 02 April 2025