Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

FontVariation

Inherits: Font < Resource < RefCounted < Object

A variation of a font with additional settings.

Description

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 }

Properties

Font

base_font

Dictionary

opentype_features

{}

int

spacing_bottom

0

int

spacing_glyph

0

int

spacing_space

0

int

spacing_top

0

float

variation_embolden

0.0

int

variation_face_index

0

Dictionary

variation_opentype

{}

Transform2D

variation_transform

Transform2D(1, 0, 0, 1, 0, 0)

Methods

void

set_spacing ( SpacingType spacing, int value )


Property Descriptions

Font base_font

  • void set_base_font ( Font value )

  • Font get_base_font ( )

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


Dictionary opentype_features = {}

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