Version: 2022.1
LanguageEnglish
  • C#

FontEngine.LoadFontFace

Leave feedback
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static TextCore.LowLevel.FontEngineError LoadFontFace(Font font);

Declaration

public static TextCore.LowLevel.FontEngineError LoadFontFace(Font font, int pointSize);

Declaration

public static TextCore.LowLevel.FontEngineError LoadFontFace(Font font, int pointSize, int faceIndex);

Declaration

public static TextCore.LowLevel.FontEngineError LoadFontFace(string filePath);

Declaration

public static TextCore.LowLevel.FontEngineError LoadFontFace(string filePath, int pointSize);

Declaration

public static TextCore.LowLevel.FontEngineError LoadFontFace(string filePath, int pointSize, int faceIndex);

Declaration

public static TextCore.LowLevel.FontEngineError LoadFontFace(byte[] sourceFontFile);

Declaration

public static TextCore.LowLevel.FontEngineError LoadFontFace(byte[] sourceFontFile, int pointSize);

Declaration

public static TextCore.LowLevel.FontEngineError LoadFontFace(byte[] sourceFontFile, int pointSize, int faceIndex);

Declaration

public static TextCore.LowLevel.FontEngineError LoadFontFace(string familyName, string styleName);

Declaration

public static TextCore.LowLevel.FontEngineError LoadFontFace(string familyName, string styleName, int pointSize);

Parameters

filePath The path of the source font file relative to the project.
pointSize The point size used to scale the font face.
sourceFontFile The byte array that contains the source font file.
font The font to load the data from. The Unity font must be set to Dynamic mode with Include Font Data selected.
faceIndex The face index of the font face to load. When the font file is a TrueType collection (.TTC), this specifies the face index of the font face to load. If the font file is a TrueType Font (.TTF) or OpenType Font (.OTF) file, the face index is always zero (0).
familyName The family name of the font face to load.
styleName The style name of the font face to load.

Returns

FontEngineError A value of zero (0) if the font face was loaded successfully.

Description

Load a source font file.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2022 Unity Technologies. Publication Date: 2022-11-18.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information