Class TMP_SpriteAsset

Inheritance
Object
TMP_Asset
TMP_SpriteAsset
Inherited Members
Namespace: TMPro
Syntax
public class TMP_SpriteAsset : TMP_Asset

Fields

fallbackSpriteAssets

List which contains the Fallback font assets for this font.

Declaration
public List<TMP_SpriteAsset> fallbackSpriteAssets
Field Value
Type Description
List<TMP_SpriteAsset>

m_defaultSpriteAsset

Declaration
public static TMP_SpriteAsset m_defaultSpriteAsset
Field Value
Type Description
TMP_SpriteAsset

spriteInfoList

Declaration
public List<TMP_Sprite> spriteInfoList
Field Value
Type Description
List<TMP_Sprite>

spriteSheet

Declaration
public Texture spriteSheet
Field Value
Type Description
Texture

Properties

defaultSpriteAsset

Static reference to the default font asset included with TextMesh Pro.

Declaration
public static TMP_SpriteAsset defaultSpriteAsset { get; }
Property Value
Type Description
TMP_SpriteAsset

Methods

GetSpriteIndexFromHashcode(Int32)

Function which returns the sprite index using the hashcode of the name

Declaration
public int GetSpriteIndexFromHashcode(int hashCode)
Parameters
Type Name Description
Int32 hashCode
Returns
Type Description
Int32

GetSpriteIndexFromName(String)

Returns the index of the sprite for the given name.

Declaration
public int GetSpriteIndexFromName(string name)
Parameters
Type Name Description
String name
Returns
Type Description
Int32

GetSpriteIndexFromUnicode(Int32)

Returns the index of the sprite for the given unicode value.

Declaration
public int GetSpriteIndexFromUnicode(int unicode)
Parameters
Type Name Description
Int32 unicode
Returns
Type Description
Int32

SearchFallbackForSprite(List<TMP_SpriteAsset>, Int32, out Int32)

Search through the given list of sprite assets and their possible fallbacks for the specified sprite matching the given unicode character.

Declaration
public static TMP_SpriteAsset SearchFallbackForSprite(List<TMP_SpriteAsset> spriteAssets, int unicode, out int spriteIndex)
Parameters
Type Name Description
List<TMP_SpriteAsset> spriteAssets
Int32 unicode
Int32 spriteIndex
Returns
Type Description
TMP_SpriteAsset

SearchFallbackForSprite(TMP_SpriteAsset, Int32, out Int32)

Search through the given sprite asset and its fallbacks for the specified sprite matching the given unicode character.

Declaration
public static TMP_SpriteAsset SearchFallbackForSprite(TMP_SpriteAsset spriteAsset, int unicode, out int spriteIndex)
Parameters
Type Name Description
TMP_SpriteAsset spriteAsset

The font asset to search for the given character.
Int32 unicode

The character to find.
Int32 spriteIndex
Returns
Type Description
TMP_SpriteAsset

UpdateLookupTables()

Function to update the sprite name and unicode lookup tables.

Declaration
public void UpdateLookupTables()

Did you find this page useful? Please give it a rating: