Class TMP_SpriteAsset

Inheritance
Object
Object
ScriptableObject
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
[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

spriteCharacterTable

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>

version

The version of the sprite asset class. Version 1.1.0 updates the asset data structure to be compatible with new font asset structure.

Declaration
public string version { get; }
Property Value
Type Description
String

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(UInt32)

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

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

SearchForSpriteByHashCode(TMP_SpriteAsset, Int32, Boolean, out Int32)

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
Int32 hashCode

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

Include fallback sprite assets in the search
Int32 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, UInt32, Boolean, 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 SearchForSpriteByUnicode(TMP_SpriteAsset spriteAsset, uint unicode, bool includeFallbacks, out int spriteIndex)
Parameters
Type Name Description
TMP_SpriteAsset spriteAsset

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

The character to find.
Boolean includeFallbacks
Int32 spriteIndex
Returns
Type Description
TMP_SpriteAsset

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()