Class TMP_SpriteAsset

Inheritance

object

Object

ScriptableObject

TMP_Asset

TMP_SpriteAsset

Inherited Members

TMP_Asset.instanceID

TMP_Asset.hashCode

TMP_Asset.material

TMP_Asset.materialHashCode

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsOfType<T>(bool)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindObjectOfType(Type, bool)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

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

faceInfo

Information about the sprite asset's face.

Declaration

public FaceInfo faceInfo { get; }

Property Value

Type	Description
FaceInfo

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

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

Returns

Type	Description
int

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
int

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

Returns

Type	Description
int

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 font asset to search for the given character.
uint	unicode	The character to find.
bool	includeFallbacks
int	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()