FontFile

Inherits: Font < Resource < RefCounted < Object

Holds font source data and prerendered glyph cache, imported from a dynamic or a bitmap font.

Description

FontFile contains a set of glyphs to represent Unicode characters imported from a font file, as well as a cache of rasterized glyphs, and a set of fallback Fonts to use.

Use FontVariation to access specific OpenType variation of the font, create simulated bold / slanted version, and draw lines of text.

For more complex text processing, use FontVariation in conjunction with TextLine or TextParagraph.

Supported font formats:

• Dynamic font importer: TrueType (.ttf), TrueType collection (.ttc), OpenType (.otf), OpenType collection (.otc), WOFF (.woff), WOFF2 (.woff2), Type 1 (.pfb, .pfm).

• Bitmap font importer: AngelCode BMFont (.fnt, .font), text and binary (version 3) format variants.

• Monospace image font importer: All supported image formats.

Note: A character is a symbol that represents an item (letter, digit etc.) in an abstract way.

Note: A glyph is a bitmap or a shape used to draw one or more characters in a context-dependent manner. Glyph indices are bound to the specific font data source.

Note: If none of the font data sources contain glyphs for a character used in a string, the character in question will be replaced with a box displaying its hexadecimal code.

GDScriptC#

var f = load("res://BarlowCondensed-Bold.ttf")
$Label.add_theme_font_override("font", f)
$Label.add_theme_font_size_override("font_size", 64)

Properties

bool	allow_system_fallback	true
FontAntialiasing	antialiasing	1
PackedByteArray	data	PackedByteArray()
int	fixed_size	0
String	font_name	""
int	font_stretch	100
BitField<FontStyle>	font_style	0
int	font_weight	400
bool	force_autohinter	false
bool	generate_mipmaps	false
Hinting	hinting	1
int	msdf_pixel_range	16
int	msdf_size	48
bool	multichannel_signed_distance_field	false
Dictionary	opentype_feature_overrides	{}
float	oversampling	0.0
String	style_name	""
SubpixelPositioning	subpixel_positioning	1

Methods

void	clear_cache ( )
void	clear_glyphs ( int cache_index, Vector2i size )
void	clear_kerning_map ( int cache_index, int size )
void	clear_size_cache ( int cache_index )
void	clear_textures ( int cache_index, Vector2i size )
float	get_cache_ascent ( int cache_index, int size ) const
int	get_cache_count ( ) const
float