Class TMP_FontAsset

Inheritance
Object
TMP_Asset
TMP_FontAsset
Inherited Members
Namespace: TMPro
Syntax
[Serializable]
public class TMP_FontAsset : TMP_Asset

Fields

atlas

Declaration
public Texture2D atlas
Field Value
Type Description
Texture2D

boldSpacing

Declaration
public float boldSpacing
Field Value
Type Description
Single

boldStyle

Declaration
public float boldStyle
Field Value
Type Description
Single

fallbackFontAssets

List which contains the Fallback font assets for this font.

Declaration
public List<TMP_FontAsset> fallbackFontAssets
Field Value
Type Description
List<TMP_FontAsset>

fontAssetType

Declaration
public TMP_FontAsset.FontAssetTypes fontAssetType
Field Value
Type Description
TMP_FontAsset.FontAssetTypes

fontCreationSettings

Declaration
public FontCreationSetting fontCreationSettings
Field Value
Type Description
FontCreationSetting

fontWeights

Declaration
public TMP_FontWeights[] fontWeights
Field Value
Type Description
TMP_FontWeights[]

italicStyle

Declaration
public byte italicStyle
Field Value
Type Description
Byte

normalSpacingOffset

Declaration
public float normalSpacingOffset
Field Value
Type Description
Single

normalStyle

Declaration
public float normalStyle
Field Value
Type Description
Single

tabSize

Declaration
public byte tabSize
Field Value
Type Description
Byte

Properties

characterDictionary

Declaration
public Dictionary<int, TMP_Glyph> characterDictionary { get; }
Property Value
Type Description
Dictionary<Int32, TMP_Glyph>

defaultFontAsset

Default Font Asset used as last resort when glyphs are missing.

Declaration
public static TMP_FontAsset defaultFontAsset { get; }
Property Value
Type Description
TMP_FontAsset

fontInfo

The general information about the font.

Declaration
public FaceInfo fontInfo { get; }
Property Value
Type Description
FaceInfo

kerningDictionary

Dictionary containing the kerning data

Declaration
public Dictionary<int, KerningPair> kerningDictionary { get; }
Property Value
Type Description
Dictionary<Int32, KerningPair>

kerningInfo

Declaration
public KerningTable kerningInfo { get; }
Property Value
Type Description
KerningTable

Methods

AddFaceInfo(FaceInfo)

Declaration
public void AddFaceInfo(FaceInfo faceInfo)
Parameters
Type Name Description
FaceInfo faceInfo

AddGlyphInfo(TMP_Glyph[])

Declaration
public void AddGlyphInfo(TMP_Glyph[] glyphInfo)
Parameters
Type Name Description
TMP_Glyph[] glyphInfo

AddKerningInfo(KerningTable)

Declaration
public void AddKerningInfo(KerningTable kerningTable)
Parameters
Type Name Description
KerningTable kerningTable

GetCharacters(TMP_FontAsset)

Function to extract all the characters from a font asset.

Declaration
public static string GetCharacters(TMP_FontAsset fontAsset)
Parameters
Type Name Description
TMP_FontAsset fontAsset
Returns
Type Description
String

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
Type Name Description
TMP_FontAsset fontAsset
Returns
Type Description
Int32[]

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
Type Description
Boolean

HasCharacter(Char, Boolean)

Function to check if a character is contained in a 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
Type Description
Boolean

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
Type Description
Boolean

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
Type Description
Boolean

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
Type Name Description
String text
List<Char> missingCharacters
Returns
Type Description
Boolean

ReadFontDefinition()

Declaration
public void ReadFontDefinition()

SortGlyphs()

Function to sort the list of glyphs.

Declaration
public void SortGlyphs()

Did you find this page useful? Please give it a rating: