FontVariation | Godot Docs 4.3

class-description

NEWS

COMMUNITY

STORE

TUTORIALS

LOGOUT

LOGOUT

Object

FontVariation

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:

var fv = FontVariation.new()
fv.set_base_font(load("res://BarlowCondensed-Regular.ttf"))
fv.set_variation_embolden(1.2)
$Label.add_theme_font_override("font", fv)
$Label.add_theme_font_size_override("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 }

Font

base_font

()

:Font

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

float

baseline_offset

()

:float

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

Dictionary

opentype_features

()

:Dictionary

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

int

spacing_bottom

()

:int

Extra spacing at the bottom of the line in pixels.

int

spacing_glyph

()

:int

Extra spacing between graphical glyphs.

int

spacing_space

()

:int

Extra width of the space glyphs.

int

spacing_top

()

:int

Extra spacing at the top of the line in pixels.

float

variation_embolden

()

:float

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.

int

variation_face_index

()

:int

Active face index in the TrueType / OpenType collection file.

Dictionary

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.