Struct MaterialReference

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: TMPro

Assembly: Unity.TextMeshPro.dll

Syntax

public struct MaterialReference

Constructors

MaterialReference(int, TMP_FontAsset, TMP_SpriteAsset, Material, float)

Constructor for new Material Reference.

Declaration

public MaterialReference(int index, TMP_FontAsset fontAsset, TMP_SpriteAsset spriteAsset, Material material, float padding)

Parameters

Type	Name	Description
int	index	The index in the material reference array.
TMP_FontAsset	fontAsset	The font asset for this material reference.
TMP_SpriteAsset	spriteAsset	The sprite asset for this material reference.
Material	material	The material instance for this reference entry.
float	padding	The padding value applied to the material reference.

Fields

fallbackMaterial

Declaration

public Material fallbackMaterial

Field Value

Type	Description
Material

fontAsset

Declaration

public TMP_FontAsset fontAsset

Field Value

Type	Description
TMP_FontAsset

index

Declaration

public int index

Field Value

Type	Description
int

isDefaultMaterial

Declaration

public bool isDefaultMaterial

Field Value

Type	Description
bool

isFallbackMaterial

Declaration

public bool isFallbackMaterial

Field Value

Type	Description
bool

material

Declaration

public Material material

Field Value

Type	Description
Material

padding

Declaration

public float padding

Field Value

Type	Description
float

referenceCount

Declaration

public int referenceCount

Field Value

Type	Description
int

spriteAsset

Declaration

public TMP_SpriteAsset spriteAsset

Field Value

Type	Description
TMP_SpriteAsset

Methods

AddMaterialReference(Material, TMP_FontAsset, ref MaterialReference[], Dictionary<int, int>)

Adds a new material reference and returns its index in the material reference array.

Declaration

[Obsolete("AddMaterialReference(Material material, TMP_FontAsset fontAsset, ref MaterialReference[] materialReferences, Dictionary<int, int> materialReferenceIndexLookup) is obsolete, use AddMaterialReference(Material material, TMP_FontAsset fontAsset, ref MaterialReference[] materialReferences, Dictionary<int, int> materialReferenceIndexLookup) instead.", true)]
public static int AddMaterialReference(Material material, TMP_FontAsset fontAsset, ref MaterialReference[] materialReferences, Dictionary<int, int> materialReferenceIndexLookup)

Parameters

Type	Name	Description
Material	material	The material to add.
TMP_FontAsset	fontAsset	The font asset.
MaterialReference[]	materialReferences	The material reference array.
Dictionary<int, int>	materialReferenceIndexLookup	The lookup dictionary.

Returns

Type	Description
int	The index of the added or existing material reference.

AddMaterialReference(Material, TMP_FontAsset, ref MaterialReference[], Dictionary<EntityId, int>)

Adds a new material reference and returns its index in the material reference array.

Declaration

public static int AddMaterialReference(Material material, TMP_FontAsset fontAsset, ref MaterialReference[] materialReferences, Dictionary<EntityId, int> materialReferenceIndexLookup)

Parameters

Type	Name	Description
Material	material	The material to add.
TMP_FontAsset	fontAsset	The font asset.
MaterialReference[]	materialReferences	The material reference array.
Dictionary<EntityId, int>	materialReferenceIndexLookup	The lookup dictionary.

Returns

Type	Description
int	The index of the added or existing material reference.

AddMaterialReference(Material, TMP_SpriteAsset, ref MaterialReference[], Dictionary<int, int>)

Adds a new material reference for a sprite asset and returns its index in the array.

Declaration

[Obsolete("AddMaterialReference(Material material, TMP_SpriteAsset spriteAsset, ref MaterialReference[] materialReferences, Dictionary<int, int> materialReferenceIndexLookup) is obsolete, use AddMaterialReference(Material material, TMP_SpriteAsset spriteAsset, ref MaterialReference[] materialReferences, Dictionary<int, int> materialReferenceIndexLookup) instead.", true)]
public static int AddMaterialReference(Material material, TMP_SpriteAsset spriteAsset, ref MaterialReference[] materialReferences, Dictionary<int, int> materialReferenceIndexLookup)

Parameters

Type	Name	Description
Material	material	The material to add.
TMP_SpriteAsset	spriteAsset	The sprite asset.
MaterialReference[]	materialReferences	The material reference array.
Dictionary<int, int>	materialReferenceIndexLookup	The lookup dictionary.

Returns

Type	Description
int	The index of the added or existing material reference.

AddMaterialReference(Material, TMP_SpriteAsset, ref MaterialReference[], Dictionary<EntityId, int>)

Adds a new material reference for a sprite asset and returns its index in the array.

Declaration

public static int AddMaterialReference(Material material, TMP_SpriteAsset spriteAsset, ref MaterialReference[] materialReferences, Dictionary<EntityId, int> materialReferenceIndexLookup)

Parameters

Type	Name	Description
Material	material	The material to add.
TMP_SpriteAsset	spriteAsset	The sprite asset.
MaterialReference[]	materialReferences	The material reference array.
Dictionary<EntityId, int>	materialReferenceIndexLookup	The lookup dictionary.

Returns

Type	Description
int	The index of the added or existing material reference.

Contains(MaterialReference[], TMP_FontAsset)

Checks whether the font asset is contained in the material reference array.

Declaration

public static bool Contains(MaterialReference[] materialReferences, TMP_FontAsset fontAsset)

Parameters

Type	Name	Description
MaterialReference[]	materialReferences	The material reference array to search.
TMP_FontAsset	fontAsset	The font asset to look for.

Returns

Type	Description
bool	True if the font asset is in the array.