Font
Script interface for font assets.
Read time 4 minutesLast updated 4 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.TextRenderingModule
- Inherits from: Object
public sealed class Font : Object
Remarks
You can use this class to dynamically switch fonts on Text Meshes.
Additional Resources: TextMesh.
Constructors
Constructor | Description |
|---|---|
| Font() | Create a new Font. |
| Font(System.String) | Create a new Font. |
Properties
Property | Description |
|---|---|
| ascent | The ascent of the font. |
| characterInfo | Access an array of all characters contained in the font texture. |
| dynamic | Is the font a dynamic font. |
| fontSize | The default size of the font. |
| lineHeight | The line height of the font. |
| material | The material used for the font display. |
Methods
Method | Description |
|---|---|
| GetCharacterInfo | Get rendering info for a specific character. |
| HasCharacter | Does this font have a specific character? |
| RequestCharactersInTexture | Request characters to be added to the font texture (dynamic fonts only). |
Static Methods
Method | Description |
|---|---|
| CreateDynamicFontFromOSFont | Creates a Font object which lets you render a font installed on the user machine. |
| GetMaxVertsForString | Returns the maximum number of verts that the text generator may return for a given string. |
| GetOSInstalledFontNames | Get names of fonts installed on the machine. |
| GetPathsToOSFonts | Gets the file paths of the fonts that are installed on the operating system. |
Static Events
Member | Description |
|---|---|
| textureRebuilt | Set a function to be called when the dynamic font texture is rebuilt. |
Inheritance
Operators
Operator | Description |
|---|---|
| operator == | Compares two object references to see if they refer to the same object. |
| bool | Determines whether the object exists. |
| operator != | Compares if two objects refer to a different object. |