Class FontAsset

Font asset contains glyph collection and cached data used to render text.

System.Object
Object
Asset
BinaryAsset
FontAsset
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
[Tooltip("Font asset contains glyph collection and cached data used to render text.")]
public class FontAsset : BinaryAsset

Constructors

FontAsset()

Initializes a new instance of the FontAsset.

Declaration
public FontAsset()

Properties

FamilyName

Gets the font family name.

Declaration
[Unmanaged]
[Tooltip("The font family name.")]
public string FamilyName { get; }
Property Value
System.String

Options

Gets or sets the font options.

Declaration
[Unmanaged]
[Tooltip("The font options.")]
public FontOptions Options { get; set; }
Property Value
FontOptions

StyleName

Gets the font style name.

Declaration
[Unmanaged]
[Tooltip("The font style name.")]
public string StyleName { get; }
Property Value
System.String

Methods

CreateFont(Int32)

Creates the font object of given characters size.

Declaration
[Unmanaged]
public Font CreateFont(int size)
Parameters
System.Int32 size

The font characters size.
Returns
Font

The created font object.

Invalidate()

Invalidates all cached dynamic font atlases using this font. Can be used to reload font characters after changing font asset options.

Declaration
[Unmanaged]
public void Invalidate()

Save(String)

Saves this asset to the file. Supported only in Editor.

Declaration
[Unmanaged]
public bool Save(string path = null)
Parameters
System.String path

The custom asset path to use for the saving. Use empty value to save this asset to its own storage location. Can be used to duplicate asset. Must be specified when saving virtual asset.
Returns
System.Boolean

True if cannot save data, otherwise false.

Extension Methods