Class TMP_SpriteAsset
Inherited Members
UnityEngine.ScriptableObject.SetDirty()
UnityEngine.ScriptableObject.CreateInstance<T>()
UnityEngine.Object.GetHashCode()
UnityEngine.Object.Equals(System.Object)
UnityEngine.Object.InstantiateAsync<T>(T)
UnityEngine.Object.InstantiateAsync<T>(T, UnityEngine.Transform)
UnityEngine.Object.InstantiateAsync<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.InstantiateAsync<T>(T, UnityEngine.Transform, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.InstantiateAsync<T>(T, System.Int32)
UnityEngine.Object.InstantiateAsync<T>(T, System.Int32, UnityEngine.Transform)
UnityEngine.Object.InstantiateAsync<T>(T, System.Int32, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.InstantiateAsync<T>(T, System.Int32, System.ReadOnlySpan<UnityEngine.Vector3>, System.ReadOnlySpan<UnityEngine.Quaternion>)
UnityEngine.Object.InstantiateAsync<T>(T, System.Int32, UnityEngine.Transform, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.InstantiateAsync<T>(T, System.Int32, UnityEngine.Transform, UnityEngine.Vector3, UnityEngine.Quaternion, System.Threading.CancellationToken)
UnityEngine.Object.InstantiateAsync<T>(T, System.Int32, UnityEngine.Transform, System.ReadOnlySpan<UnityEngine.Vector3>, System.ReadOnlySpan<UnityEngine.Quaternion>)
UnityEngine.Object.InstantiateAsync<T>(T, System.Int32, UnityEngine.Transform, System.ReadOnlySpan<UnityEngine.Vector3>, System.ReadOnlySpan<UnityEngine.Quaternion>, System.Threading.CancellationToken)
UnityEngine.Object.Instantiate<T>(T)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)
UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)
UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)
UnityEngine.Object.DestroyObject(UnityEngine.Object)
UnityEngine.Object.FindSceneObjectsOfType(System.Type)
UnityEngine.Object.FindObjectsOfType<T>()
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectOfType<T>()
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
UnityEngine.Object.FindFirstObjectByType<T>()
UnityEngine.Object.FindAnyObjectByType<T>()
UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
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 |
---|---|
System.Collections.Generic.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 |
---|---|
System.Collections.Generic.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 |
---|---|---|
System.Int32 | hashCode |
Returns
Type | Description |
---|---|
System.Int32 |
GetSpriteIndexFromName(String)
Returns the index of the sprite for the given name.
Declaration
public int GetSpriteIndexFromName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name |
Returns
Type | Description |
---|---|
System.Int32 |
GetSpriteIndexFromUnicode(Int32)
Returns the index of the sprite for the given unicode value.
Declaration
public int GetSpriteIndexFromUnicode(int unicode)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | unicode |
Returns
Type | Description |
---|---|
System.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 |
---|---|---|
System.Collections.Generic.List<TMP_SpriteAsset> | spriteAssets | |
System.Int32 | unicode | |
System.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. |
System.Int32 | unicode | The character to find. |
System.Int32 | spriteIndex |
Returns
Type | Description |
---|---|
TMP_SpriteAsset |
UpdateLookupTables()
Function to update the sprite name and unicode lookup tables.
Declaration
public void UpdateLookupTables()