Inheritance #

FontVariation #

is_refcounted, is_instantiable, resource, core, not_builtin_classes

A variation of a font with additional settings.

Provides OpenType variations, simulated bold / slant, and additional font settings like OpenType features and extra spacing.

To use simulated bold font variant:

GDScript

var fv = FontVariation.new()
fv.base_font = load("res://BarlowCondensed-Regular.ttf")
fv.variation_embolden = 1.2
$Label.add_theme_font_override("font", fv)
$Label.add_theme_font_size_override("font_size", 64)

C#

var fv = new FontVariation();
fv.SetBaseFont(ResourceLoader.Load("res://BarlowCondensed-Regular.ttf"));
fv.SetVariationEmbolden(1.2);
GetNode("Label").AddThemeFontOverride("font", fv);
GetNode("Label").AddThemeFontSizeOverride("font_size", 64);

To set the coordinate of multiple variation axes:

var fv = FontVariation.new();
var ts = TextServerManager.get_primary_interface()
fv.base_font = load("res://BarlowCondensed-Regular.ttf")
fv.variation_opentype = { ts.name_to_tag("wght"): 900, ts.name_to_tag("custom_hght"): 900 }

Members #

var base_font: Font#

Base font used to create a variation. If not set, default Theme font is used.

var baseline_offset: float = 0.0#

Extra baseline offset (as a fraction of font height).

var opentype_features: Dictionary = {}#

A set of OpenType feature tags. More info: OpenType feature tags.

var spacing_bottom: int = 0#

Extra spacing at the bottom of the line in pixels.

var spacing_glyph: int = 0#

Extra spacing between graphical glyphs.

var spacing_space: int = 0#

Extra width of the space glyphs.

var spacing_top: int = 0#

Extra spacing at the top of the line in pixels.

var variation_embolden: float = 0.0#

If is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.

Note: Emboldened fonts might have self-intersecting outlines, which will prevent MSDF fonts and TextMesh from working correctly.

var variation_face_index: int = 0#

Active face index in the TrueType / OpenType collection file.

var variation_opentype: Dictionary = {}#

Font OpenType variation coordinates. More info: OpenType variation tags.

Note: This Dictionary uses OpenType tags as keys. Variation axes can be identified both by tags (int, e.g. 0x77678674) and names (String, e.g. wght). Some axes might be accessible by multiple names. For example, wght refers to the same axis as weight. Tags on the other hand are unique. To convert between names and tags, use TextServer.name_to_tag and TextServer.tag_to_name.

Note: To get available variation axes of a font, use Font.get_supported_variation_list.

var variation_transform: Transform2D = Transform2D(1, 0, 0, 1, 0, 0)#

2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs.

For example, to simulate italic typeface by slanting, apply the following transform Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0).

Methods #

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

Theme Items #

Tutorials #