Class TMP_FontAsset
Inheritance
TMP_FontAsset
Namespace: TMPro
Syntax
[Serializable]
public class TMP_FontAsset : TMP_Asset
Fields
atlas
Declaration
Field Value
| Type |
Description |
| Texture2D |
|
boldSpacing
Declaration
Field Value
boldStyle
Declaration
Field Value
fallbackFontAssets
List containing the Fallback font assets for this font.
Declaration
public List<TMP_FontAsset> fallbackFontAssets
Field Value
fontAssetType
Declaration
public TMP_FontAsset.FontAssetTypes fontAssetType
Field Value
fontWeights
Declaration
public TMP_FontWeights[] fontWeights
Field Value
italicStyle
Declaration
Field Value
m_CreationSettings
Declaration
public FontAssetCreationSettings m_CreationSettings
Field Value
normalSpacingOffset
Declaration
public float normalSpacingOffset
Field Value
normalStyle
Declaration
Field Value
tabSize
Declaration
Field Value
Properties
characterDictionary
Declaration
public Dictionary<int, TMP_Glyph> characterDictionary { get; }
Property Value
creationSettings
The settings used in the Font Asset Creator when this font asset was created or edited.
Declaration
public FontAssetCreationSettings creationSettings { get; set; }
Property Value
defaultFontAsset
Default Font Asset used as last resort when glyphs are missing.
Declaration
public static TMP_FontAsset defaultFontAsset { get; }
Property Value
fontInfo
The general information about the font.
Declaration
public FaceInfo fontInfo { get; }
Property Value
kerningDictionary
Dictionary containing the kerning data
Declaration
public Dictionary<int, KerningPair> kerningDictionary { get; }
Property Value
kerningInfo
Declaration
public KerningTable kerningInfo { get; }
Property Value
Methods
AddFaceInfo(FaceInfo)
Declaration
public void AddFaceInfo(FaceInfo faceInfo)
Parameters
AddGlyphInfo(TMP_Glyph[])
Declaration
public void AddGlyphInfo(TMP_Glyph[] glyphInfo)
Parameters
AddKerningInfo(KerningTable)
Declaration
public void AddKerningInfo(KerningTable kerningTable)
Parameters
GetCharacters(TMP_FontAsset)
Function to extract all the characters from a font asset.
Declaration
public static string GetCharacters(TMP_FontAsset fontAsset)
Parameters
Returns
GetCharactersArray(TMP_FontAsset)
Function which returns an array that contains all the characters from a font asset.
Declaration
public static int[] GetCharactersArray(TMP_FontAsset fontAsset)
Parameters
Returns
HasCharacter(Char)
Function to check if a certain character exists in the font asset.
Declaration
public bool HasCharacter(char character)
Parameters
| Type |
Name |
Description |
| Char |
character |
|
Returns
HasCharacter(Char, Boolean)
Function to check if a character is contained in the font asset with the option to also check through fallback font assets.
Declaration
public bool HasCharacter(char character, bool searchFallbacks)
Parameters
| Type |
Name |
Description |
| Char |
character |
|
| Boolean |
searchFallbacks |
|
Returns
HasCharacter(Int32)
Function to check if a certain character exists in the font asset.
Declaration
public bool HasCharacter(int character)
Parameters
| Type |
Name |
Description |
| Int32 |
character |
|
Returns
HasCharacters(String)
Function to check if certain characters exists in the font asset. Function returns false if any characters are missing.
Declaration
public bool HasCharacters(string text)
Parameters
| Type |
Name |
Description |
| String |
text |
String containing the characters to check
|
Returns
HasCharacters(String, out List<Char>)
Function to check if certain characters exists in the font asset. Function returns a list of missing characters.
Declaration
public bool HasCharacters(string text, out List<char> missingCharacters)
Parameters
Returns
ReadFontDefinition()
Declaration
public void ReadFontDefinition()
SortGlyphs()
Function to sort the list of glyphs.
Declaration