Version: 2023.1
LanguageEnglish
  • C#

Font

class in UnityEngine

/

Inherits from:Object

/

Implemented in:UnityEngine.TextRenderingModule

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

Switch to Manual

Description

Script interface for font assets.

You can use this class to dynamically switch fonts on Text Meshes.

See Also: TextMesh.

Properties

ascentThe ascent of the font.
characterInfoAccess an array of all characters contained in the font texture.
dynamicIs the font a dynamic font.
fontSizeThe default size of the font.
lineHeightThe line height of the font.
materialThe material used for the font display.

Constructors

FontCreate a new Font.

Public Methods

GetCharacterInfoGet rendering info for a specific character.
HasCharacterDoes this font have a specific character?
RequestCharactersInTextureRequest characters to be added to the font texture (dynamic fonts only).

Static Methods

CreateDynamicFontFromOSFontCreates a Font object which lets you render a font installed on the user machine.
GetMaxVertsForStringReturns the maximum number of verts that the text generator may return for a given string.
GetOSInstalledFontNamesGet names of fonts installed on the machine.
GetPathsToOSFontsGets the file paths of the fonts that are installed on the operating system.

Events

textureRebuiltSet a function to be called when the dynamic font texture is rebuilt.

Inherited Members

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961