2022-05-09 09:47:10 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 08:08:05 +00:00
<class name= "FontVariation" inherits= "Font" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2022-05-09 09:47:10 +00:00
<brief_description >
2023-04-30 14:26:09 +00:00
A variation of a font with additional settings.
2022-05-09 09:47:10 +00:00
</brief_description>
<description >
2023-04-30 14:26:09 +00:00
Provides OpenType variations, simulated bold / slant, and additional font settings like OpenType features and extra spacing.
2022-05-09 09:47:10 +00:00
To use simulated bold font variant:
[codeblocks]
[gdscript]
var fv = FontVariation.new()
fv.set_base_font(load("res://BarlowCondensed-Regular.ttf"))
2023-02-06 13:07:35 +00:00
fv.set_variation_embolden(1.2)
$Label.add_theme_font_override("font", fv)
$Label.add_theme_font_size_override("font_size", 64)
2022-05-09 09:47:10 +00:00
[/gdscript]
[csharp]
var fv = new FontVariation();
fv.SetBaseFont(ResourceLoader.Load< FontFile> ("res://BarlowCondensed-Regular.ttf"));
fv.SetVariationEmbolden(1.2);
2023-02-06 13:07:35 +00:00
GetNode("Label").AddThemeFontOverride("font", fv);
GetNode("Label").AddThemeFontSizeOverride("font_size", 64);
2022-05-09 09:47:10 +00:00
[/csharp]
[/codeblocks]
2023-03-01 14:11:45 +00:00
To set the coordinate of multiple variation axes:
[codeblock]
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 }
[/codeblock]
2022-05-09 09:47:10 +00:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "set_spacing" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "spacing" type= "int" enum= "TextServer.SpacingType" />
<param index= "1" name= "value" type= "int" />
2022-05-09 09:47:10 +00:00
<description >
2023-08-24 08:56:50 +00:00
Sets the spacing for [param spacing] (see [enum TextServer.SpacingType]) to [param value] in pixels (not relative to the font size).
2022-05-09 09:47:10 +00:00
</description>
</method>
</methods>
<members >
<member name= "base_font" type= "Font" setter= "set_base_font" getter= "get_base_font" >
Base font used to create a variation. If not set, default [Theme] font is used.
</member>
2024-01-28 10:34:56 +00:00
<member name= "baseline_offset" type= "float" setter= "set_baseline_offset" getter= "get_baseline_offset" default= "0.0" >
Extra baseline offset (as a fraction of font height).
</member>
2022-05-09 09:47:10 +00:00
<member name= "opentype_features" type= "Dictionary" setter= "set_opentype_features" getter= "get_opentype_features" default= "{}" >
A set of OpenType feature tags. More info: [url=https://docs.microsoft.com/en-us/typography/opentype/spec/featuretags]OpenType feature tags[/url].
</member>
<member name= "spacing_bottom" type= "int" setter= "set_spacing" getter= "get_spacing" default= "0" >
Extra spacing at the bottom of the line in pixels.
</member>
<member name= "spacing_glyph" type= "int" setter= "set_spacing" getter= "get_spacing" default= "0" >
2023-02-11 16:18:33 +00:00
Extra spacing between graphical glyphs.
2022-05-09 09:47:10 +00:00
</member>
<member name= "spacing_space" type= "int" setter= "set_spacing" getter= "get_spacing" default= "0" >
Extra width of the space glyphs.
</member>
<member name= "spacing_top" type= "int" setter= "set_spacing" getter= "get_spacing" default= "0" >
Extra spacing at the top of the line in pixels.
</member>
<member name= "variation_embolden" type= "float" setter= "set_variation_embolden" getter= "get_variation_embolden" default= "0.0" >
If is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
[b]Note:[/b] Emboldened fonts might have self-intersecting outlines, which will prevent MSDF fonts and [TextMesh] from working correctly.
</member>
<member name= "variation_face_index" type= "int" setter= "set_variation_face_index" getter= "get_variation_face_index" default= "0" >
Active face index in the TrueType / OpenType collection file.
</member>
<member name= "variation_opentype" type= "Dictionary" setter= "set_variation_opentype" getter= "get_variation_opentype" default= "{}" >
Font OpenType variation coordinates. More info: [url=https://docs.microsoft.com/en-us/typography/opentype/spec/dvaraxisreg]OpenType variation tags[/url].
2023-10-02 18:11:43 +00:00
[b]Note:[/b] This [Dictionary] uses OpenType tags as keys. Variation axes can be identified both by tags ([int], e.g. [code]0x77678674[/code]) and names ([String], e.g. [code]wght[/code]). Some axes might be accessible by multiple names. For example, [code]wght[/code] refers to the same axis as [code]weight[/code]. Tags on the other hand are unique. To convert between names and tags, use [method TextServer.name_to_tag] and [method TextServer.tag_to_name].
2023-03-01 14:11:45 +00:00
[b]Note:[/b] To get available variation axes of a font, use [method Font.get_supported_variation_list].
2022-05-09 09:47:10 +00:00
</member>
<member name= "variation_transform" type= "Transform2D" setter= "set_variation_transform" getter= "get_variation_transform" default= "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 [code]Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)[/code].
</member>
</members>
</class>