Class TMP_SpriteAsset

Inheritance
object
Object
ScriptableObject
TMP_Asset
TMP_SpriteAsset
Inherited Members
Object.MemberwiseClone()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T, InstantiateParameters)
Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Object.FindObjectsByType<T>()
Object.FindObjectsByType<T>(FindObjectsInactive)
Namespace: TMPro
Assembly: Unity.TextMeshPro.dll
Syntax
[ExcludeFromPreset]
public class TMP_SpriteAsset : TMP_Asset

Fields

fallbackSpriteAssets

List which contains the Fallback font assets for this font.

Declaration
[SerializeField]
public List<TMP_SpriteAsset> fallbackSpriteAssets
Field Value
Type Description
List<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

spriteCharacterLookupTable

Dictionary used to lookup sprite characters by their unicode value.

Declaration
public Dictionary<uint, TMP_SpriteCharacter> spriteCharacterLookupTable { get; }
Property Value
Type Description
Dictionary<uint, TMP_SpriteCharacter>

spriteCharacterTable

List of sprite characters in this asset. Used to populate lookup dictionaries.

Declaration
public List<TMP_SpriteCharacter> spriteCharacterTable { get; }
Property Value
Type Description
List<TMP_SpriteCharacter>

spriteGlyphTable

Declaration
public List<TMP_SpriteGlyph> spriteGlyphTable { get; }
Property Value
Type Description
List<TMP_SpriteGlyph>

Methods

GetSpriteIndexFromHashcode(int)

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

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

Case-insensitive hash of the sprite name, typically from TMP_TextUtilities.GetHashCode(spriteName).
Returns
Type Description
int

The sprite index in this asset's tables, or -1 when no sprite name produces the given hash.

GetSpriteIndexFromName(string)

Returns the index of the sprite for the given name.

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

Sprite name as authored in the sprite asset (case-insensitive hash; null or empty yields no match).
Returns
Type Description
int

The sprite index in this asset, or -1 when the name is not found.

GetSpriteIndexFromUnicode(uint)

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

Declaration
public int GetSpriteIndexFromUnicode(uint unicode)
Parameters
Type Name Description
uint unicode

Unicode scalar value (for example 0x263A) assigned to a TMP_SpriteCharacter in this asset.
Returns
Type Description
int

The sprite glyph index, or -1 if the code point is not mapped in this asset.

SearchForSpriteByHashCode(TMP_SpriteAsset, int, bool, out int)

Search the given sprite asset and fallbacks for a sprite whose hash code value of its name matches the target hash code.

Declaration
public static TMP_SpriteAsset SearchForSpriteByHashCode(TMP_SpriteAsset spriteAsset, int hashCode, bool includeFallbacks, out int spriteIndex)
Parameters
Type Name Description
TMP_SpriteAsset spriteAsset

The Sprite Asset to search for the given sprite whose name matches the hashcode value
int hashCode

The hash code value matching the name of the sprite
bool includeFallbacks

Include fallback sprite assets in the search
int spriteIndex

The index of the sprite matching the provided hash code
Returns
Type Description
TMP_SpriteAsset

The Sprite Asset that contains the sprite

SearchForSpriteByUnicode(TMP_SpriteAsset, uint, bool, out int)

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

Declaration
public static TMP_SpriteAsset SearchForSpriteByUnicode(TMP_SpriteAsset spriteAsset, uint unicode, bool includeFallbacks, out int spriteIndex)
Parameters
Type Name Description
TMP_SpriteAsset spriteAsset

The sprite asset to search for the given character.
uint unicode

The character to find.
bool includeFallbacks

Whether to search fallback sprite assets.
int spriteIndex

out parameter containing the sprite index for the specified character (if found).
Returns
Type Description
TMP_SpriteAsset

The asset instance that contains the sprite, or null if no match exists.

SortGlyphTable()

Sort the sprite glyph table by glyph index.

Declaration
public void SortGlyphTable()

UpdateLookupTables()

Function to update the sprite name and unicode lookup tables. This function should be called when a sprite's name or unicode value changes or when a new sprite is added.

Declaration
public void UpdateLookupTables()