2020-08-12 11:49:10 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-05-09 09:47:10 +00:00
<class name= "FontFile" inherits= "Font" version= "4.0" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2020-08-12 11:49:10 +00:00
<brief_description >
2022-07-08 12:38:30 +00:00
Font source data and prerendered glyph cache, imported from dynamic or bitmap font.
2022-05-09 09:47:10 +00:00
</brief_description>
<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 [Font]s 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].
2020-12-27 13:30:33 +00:00
Supported font formats:
2022-06-07 08:35:59 +00:00
- Dynamic font importer: TrueType (.ttf), TrueType collection (.ttc), OpenType (.otf), OpenType collection (.otc), WOFF (.woff), WOFF2 (.woff2), Type 1 (.pfb, .pfm).
2020-12-27 13:30:33 +00:00
- Bitmap font importer: AngelCode BMFont (.fnt, .font), text and binary (version 3) format variants.
- Monospace image font importer: All supported image formats.
2022-05-09 09:47:10 +00:00
[b]Note:[/b] A character is a symbol that represents an item (letter, digit etc.) in an abstract way.
[b]Note:[/b] A glyph is a bitmap or shape used to draw a one or more characters in a context-dependent manner. Glyph indices are bound to the specific font data source.
[b]Note:[/b] If a 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.
[codeblocks]
[gdscript]
var f = load("res://BarlowCondensed-Bold.ttf")
$"Label".set("custom_fonts/font", f)
$"Label".set("custom_fonts/font_size", 64)
[/gdscript]
[csharp]
var f = ResourceLoader.Load< FontFile> ("res://BarlowCondensed-Bold.ttf");
GetNode("Label").Set("custom_fonts/font", f);
GetNode("Label").Set("custom_font_sizes/font_size", 64);
[/csharp]
[/codeblocks]
2020-08-12 11:49:10 +00:00
</description>
<tutorials >
</tutorials>
<methods >
2020-12-27 13:30:33 +00:00
<method name= "clear_cache" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2021-02-06 14:34:06 +00:00
<description >
2020-12-27 13:30:33 +00:00
Removes all font cache entries.
2021-02-06 14:34:06 +00:00
</description>
</method>
2020-12-27 13:30:33 +00:00
<method name= "clear_glyphs" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
2021-02-06 14:34:06 +00:00
<description >
2021-10-05 12:24:34 +00:00
Removes all rendered glyphs information from the cache entry.
[b]Note:[/b] This function will not remove textures associated with the glyphs, use [method remove_texture] to remove them manually.
2021-02-06 14:34:06 +00:00
</description>
</method>
2020-12-27 13:30:33 +00:00
<method name= "clear_kerning_map" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
2021-02-06 14:34:06 +00:00
<description >
2020-12-27 13:30:33 +00:00
Removes all kerning overrides.
2021-02-06 14:34:06 +00:00
</description>
</method>
2020-12-27 13:30:33 +00:00
<method name= "clear_size_cache" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
2020-08-12 11:49:10 +00:00
<description >
2020-12-27 13:30:33 +00:00
Removes all font sizes from the cache entry
2020-08-12 11:49:10 +00:00
</description>
</method>
2020-12-27 13:30:33 +00:00
<method name= "clear_textures" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
2020-12-27 13:30:33 +00:00
<description >
2021-10-05 12:24:34 +00:00
Removes all textures from font cache entry.
[b]Note:[/b] This function will not remove glyphs associated with the texture, use [method remove_glyph] to remove them manually.
2020-12-27 13:30:33 +00:00
</description>
</method>
2022-05-09 09:47:10 +00:00
<method name= "get_cache_ascent" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "float" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
2020-08-12 11:49:10 +00:00
<description >
Returns the font ascent (number of pixels above the baseline).
</description>
</method>
2020-12-27 13:30:33 +00:00
<method name= "get_cache_count" qualifiers= "const" >
<return type= "int" />
2020-08-12 11:49:10 +00:00
<description >
2020-12-27 13:30:33 +00:00
Returns number of the font cache entries.
</description>
</method>
2022-05-09 09:47:10 +00:00
<method name= "get_cache_descent" qualifiers= "const" >
<return type= "float" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
2022-05-09 09:47:10 +00:00
<description >
</description>
</method>
<method name= "get_cache_scale" qualifiers= "const" >
<return type= "float" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
2022-05-09 09:47:10 +00:00
<description >
</description>
</method>
<method name= "get_cache_underline_position" qualifiers= "const" >
<return type= "float" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
2020-12-27 13:30:33 +00:00
<description >
</description>
</method>
2022-05-09 09:47:10 +00:00
<method name= "get_cache_underline_thickness" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "float" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
2020-08-12 11:49:10 +00:00
<description >
</description>
</method>
2022-05-09 09:47:10 +00:00
<method name= "get_embolden" qualifiers= "const" >
<return type= "float" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
2022-05-09 09:47:10 +00:00
<description >
Returns embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
</description>
</method>
<method name= "get_face_index" qualifiers= "const" >
2022-06-07 08:35:59 +00:00
<return type= "int" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
2022-06-07 08:35:59 +00:00
<description >
2022-05-09 09:47:10 +00:00
Recturns an active face index in the TrueType / OpenType collection.
2022-06-07 08:35:59 +00:00
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "get_glyph_advance" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Vector2" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
<param index= "2" name= "glyph" type= "int" />
2020-08-12 11:49:10 +00:00
<description >
2021-10-05 12:24:34 +00:00
Returns glyph advance (offset of the next glyph).
[b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name= "get_glyph_index" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "int" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "size" type= "int" />
<param index= "1" name= "char" type= "int" />
<param index= "2" name= "variation_selector" type= "int" />
2020-08-12 11:49:10 +00:00
<description >
2022-08-12 16:07:53 +00:00
Returns the glyph index of a [param char], optionally modified by the [param variation_selector].
2020-08-12 11:49:10 +00:00
</description>
</method>
2020-12-27 13:30:33 +00:00
<method name= "get_glyph_list" qualifiers= "const" >
2022-08-05 01:41:48 +00:00
<return type= "PackedInt32Array" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
2020-12-27 13:30:33 +00:00
<description >
Returns list of rendered glyphs in the cache entry.
</description>
</method>
<method name= "get_glyph_offset" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Vector2" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "glyph" type= "int" />
2020-08-12 11:49:10 +00:00
<description >
2020-12-27 13:30:33 +00:00
Returns glyph offset from the baseline.
2020-08-12 11:49:10 +00:00
</description>
</method>
2020-12-27 13:30:33 +00:00
<method name= "get_glyph_size" qualifiers= "const" >
<return type= "Vector2" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "glyph" type= "int" />
2020-08-12 11:49:10 +00:00
<description >
2020-12-27 13:30:33 +00:00
Returns glyph size.
</description>
</method>
<method name= "get_glyph_texture_idx" qualifiers= "const" >
<return type= "int" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "glyph" type= "int" />
2020-12-27 13:30:33 +00:00
<description >
Returns index of the cache texture containing the glyph.
</description>
</method>
<method name= "get_glyph_uv_rect" qualifiers= "const" >
<return type= "Rect2" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "glyph" type= "int" />
2020-12-27 13:30:33 +00:00
<description >
Returns rectangle in the cache texture containing the glyph.
</description>
</method>
<method name= "get_kerning" qualifiers= "const" >
<return type= "Vector2" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
<param index= "2" name= "glyph_pair" type= "Vector2i" />
2020-12-27 13:30:33 +00:00
<description >
Returns kerning for the pair of glyphs.
</description>
</method>
<method name= "get_kerning_list" qualifiers= "const" >
2022-08-05 01:41:48 +00:00
<return type= "Vector2i[]" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
2020-12-27 13:30:33 +00:00
<description >
Returns list of the kerning overrides.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name= "get_language_support_override" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "language" type= "String" />
2020-08-12 11:49:10 +00:00
<description >
2022-08-12 16:07:53 +00:00
Returns [code]true[/code] if support override is enabled for the [param language].
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name= "get_language_support_overrides" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "PackedStringArray" />
2020-08-12 11:49:10 +00:00
<description >
Returns list of language support overrides.
</description>
</method>
<method name= "get_script_support_override" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "bool" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "script" type= "String" />
2020-08-12 11:49:10 +00:00
<description >
2022-08-12 16:07:53 +00:00
Returns [code]true[/code] if support override is enabled for the [param script].
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name= "get_script_support_overrides" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "PackedStringArray" />
2020-08-12 11:49:10 +00:00
<description >
Returns list of script support overrides.
</description>
</method>
2020-12-27 13:30:33 +00:00
<method name= "get_size_cache_list" qualifiers= "const" >
2022-08-05 01:41:48 +00:00
<return type= "Vector2i[]" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
2020-12-27 13:30:33 +00:00
<description >
2022-01-02 17:32:49 +00:00
Returns list of the font sizes in the cache. Each size is [code]Vector2i[/code] with font size and outline size.
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name= "get_texture_count" qualifiers= "const" >
<return type= "int" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
2020-12-27 13:30:33 +00:00
<description >
Returns number of textures used by font cache entry.
</description>
</method>
<method name= "get_texture_image" qualifiers= "const" >
<return type= "Image" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "texture_index" type= "int" />
2020-12-27 13:30:33 +00:00
<description >
Returns a copy of the font cache texture image.
</description>
</method>
<method name= "get_texture_offsets" qualifiers= "const" >
<return type= "PackedInt32Array" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "texture_index" type= "int" />
2020-12-27 13:30:33 +00:00
<description >
2022-10-18 07:10:24 +00:00
Returns a copy of the array containing glyph packing data.
2020-12-27 13:30:33 +00:00
</description>
</method>
2022-05-09 09:47:10 +00:00
<method name= "get_transform" qualifiers= "const" >
<return type= "Transform2D" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
2020-10-22 16:40:18 +00:00
<description >
2022-05-09 09:47:10 +00:00
Returns 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs.
2020-10-22 16:40:18 +00:00
</description>
</method>
2020-12-27 13:30:33 +00:00
<method name= "get_variation_coordinates" qualifiers= "const" >
2021-07-30 13:28:05 +00:00
<return type= "Dictionary" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
2020-10-22 16:40:18 +00:00
<description >
2022-05-09 09:47:10 +00:00
Returns variation coordinates for the specified font cache entry. See [method Font.get_supported_variation_list] for more info.
2020-08-12 11:49:10 +00:00
</description>
</method>
2021-11-09 08:41:45 +00:00
<method name= "load_bitmap_font" >
<return type= "int" enum= "Error" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "path" type= "String" />
2021-11-09 08:41:45 +00:00
<description >
2022-08-12 16:07:53 +00:00
Loads an AngelCode BMFont (.fnt, .font) bitmap font from file [param path].
2021-11-09 08:41:45 +00:00
[b]Warning:[/b] This method should only be used in the editor or in cases when you need to load external fonts at run-time, such as fonts located at the [code]user://[/code] directory.
</description>
</method>
<method name= "load_dynamic_font" >
<return type= "int" enum= "Error" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "path" type= "String" />
2021-11-09 08:41:45 +00:00
<description >
2022-08-12 16:07:53 +00:00
Loads a TrueType (.ttf), OpenType (.otf), WOFF (.woff), WOFF2 (.woff2) or Type 1 (.pfb, .pfm) dynamic font from file [param path].
2021-11-09 08:41:45 +00:00
[b]Warning:[/b] This method should only be used in the editor or in cases when you need to load external fonts at run-time, such as fonts located at the [code]user://[/code] directory.
</description>
</method>
2020-12-27 13:30:33 +00:00
<method name= "remove_cache" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
2020-08-12 11:49:10 +00:00
<description >
2020-12-27 13:30:33 +00:00
Removes specified font cache entry.
2020-08-12 11:49:10 +00:00
</description>
</method>
2020-12-27 13:30:33 +00:00
<method name= "remove_glyph" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "glyph" type= "int" />
2020-08-12 11:49:10 +00:00
<description >
2021-10-05 12:24:34 +00:00
Removes specified rendered glyph information from the cache entry.
[b]Note:[/b] This function will not remove textures associated with the glyphs, use [method remove_texture] to remove them manually.
2020-08-12 11:49:10 +00:00
</description>
</method>
2020-12-27 13:30:33 +00:00
<method name= "remove_kerning" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
<param index= "2" name= "glyph_pair" type= "Vector2i" />
2021-02-06 14:34:06 +00:00
<description >
2020-12-27 13:30:33 +00:00
Removes kerning override for the pair of glyphs.
2021-02-06 14:34:06 +00:00
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "remove_language_support_override" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "language" type= "String" />
2020-08-12 11:49:10 +00:00
<description >
Remove language support override.
</description>
</method>
<method name= "remove_script_support_override" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "script" type= "String" />
2020-08-12 11:49:10 +00:00
<description >
Removes script support override.
</description>
</method>
2020-12-27 13:30:33 +00:00
<method name= "remove_size_cache" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
2020-12-27 13:30:33 +00:00
<description >
Removes specified font size from the cache entry.
</description>
</method>
<method name= "remove_texture" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "texture_index" type= "int" />
2020-12-27 13:30:33 +00:00
<description >
2022-05-09 09:47:10 +00:00
Removes specified texture from the cache entry.
[b]Note:[/b] This function will not remove glyphs associated with the texture. Remove them manually using [method remove_glyph].
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name= "render_glyph" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "index" type= "int" />
2020-12-27 13:30:33 +00:00
<description >
2022-05-09 09:47:10 +00:00
Renders specified glyph to the font cache texture.
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name= "render_range" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "start" type= "int" />
<param index= "3" name= "end" type= "int" />
2020-12-27 13:30:33 +00:00
<description >
Renders the range of characters to the font cache texture.
</description>
</method>
2022-05-09 09:47:10 +00:00
<method name= "set_cache_ascent" >
2020-12-27 13:30:33 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
<param index= "2" name= "ascent" type= "float" />
2020-12-27 13:30:33 +00:00
<description >
</description>
</method>
2022-05-09 09:47:10 +00:00
<method name= "set_cache_descent" >
2020-12-27 13:30:33 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
<param index= "2" name= "descent" type= "float" />
2020-12-27 13:30:33 +00:00
<description >
2022-05-09 09:47:10 +00:00
</description>
</method>
<method name= "set_cache_scale" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
<param index= "2" name= "scale" type= "float" />
2022-05-09 09:47:10 +00:00
<description >
</description>
</method>
<method name= "set_cache_underline_position" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
<param index= "2" name= "underline_position" type= "float" />
2022-05-09 09:47:10 +00:00
<description >
</description>
</method>
<method name= "set_cache_underline_thickness" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
<param index= "2" name= "underline_thickness" type= "float" />
2022-05-09 09:47:10 +00:00
<description >
</description>
</method>
<method name= "set_embolden" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "strength" type= "float" />
2022-05-09 09:47:10 +00:00
<description >
Sets embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
</description>
</method>
<method name= "set_face_index" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "face_index" type= "int" />
2022-05-09 09:47:10 +00:00
<description >
Sets an active face index in the TrueType / OpenType collection.
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name= "set_glyph_advance" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
<param index= "2" name= "glyph" type= "int" />
<param index= "3" name= "advance" type= "Vector2" />
2020-12-27 13:30:33 +00:00
<description >
2021-10-05 12:24:34 +00:00
Sets glyph advance (offset of the next glyph).
[b]Note:[/b] Advance for glyphs outlines is the same as the base glyph advance and is not saved.
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name= "set_glyph_offset" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "glyph" type= "int" />
<param index= "3" name= "offset" type= "Vector2" />
2020-12-27 13:30:33 +00:00
<description >
Sets glyph offset from the baseline.
</description>
</method>
<method name= "set_glyph_size" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "glyph" type= "int" />
<param index= "3" name= "gl_size" type= "Vector2" />
2020-12-27 13:30:33 +00:00
<description >
Sets glyph size.
</description>
</method>
<method name= "set_glyph_texture_idx" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "glyph" type= "int" />
<param index= "3" name= "texture_idx" type= "int" />
2020-12-27 13:30:33 +00:00
<description >
Sets index of the cache texture containing the glyph.
</description>
</method>
<method name= "set_glyph_uv_rect" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "glyph" type= "int" />
<param index= "3" name= "uv_rect" type= "Rect2" />
2020-12-27 13:30:33 +00:00
<description >
Sets rectangle in the cache texture containing the glyph.
</description>
</method>
<method name= "set_kerning" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "int" />
<param index= "2" name= "glyph_pair" type= "Vector2i" />
<param index= "3" name= "kerning" type= "Vector2" />
2020-12-27 13:30:33 +00:00
<description >
Sets kerning for the pair of glyphs.
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "set_language_support_override" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "language" type= "String" />
<param index= "1" name= "supported" type= "bool" />
2020-08-12 11:49:10 +00:00
<description >
2022-05-09 09:47:10 +00:00
Adds override for [method Font.is_language_supported].
2020-12-27 13:30:33 +00:00
</description>
</method>
2020-08-12 11:49:10 +00:00
<method name= "set_script_support_override" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "script" type= "String" />
<param index= "1" name= "supported" type= "bool" />
2020-08-12 11:49:10 +00:00
<description >
2022-05-09 09:47:10 +00:00
Adds override for [method Font.is_script_supported].
2020-12-27 13:30:33 +00:00
</description>
</method>
<method name= "set_texture_image" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "texture_index" type= "int" />
<param index= "3" name= "image" type= "Image" />
2020-12-27 13:30:33 +00:00
<description >
Sets font cache texture image.
</description>
</method>
<method name= "set_texture_offsets" >
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "size" type= "Vector2i" />
<param index= "2" name= "texture_index" type= "int" />
<param index= "3" name= "offset" type= "PackedInt32Array" />
2020-12-27 13:30:33 +00:00
<description >
2022-10-18 07:10:24 +00:00
Sets array containing glyph packing data.
2020-12-27 13:30:33 +00:00
</description>
</method>
2022-05-09 09:47:10 +00:00
<method name= "set_transform" >
2020-12-27 13:30:33 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "transform" type= "Transform2D" />
2020-12-27 13:30:33 +00:00
<description >
2022-05-09 09:47:10 +00:00
Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs.
2021-02-15 08:46:23 +00:00
</description>
</method>
2020-12-27 13:30:33 +00:00
<method name= "set_variation_coordinates" >
2021-07-30 13:28:05 +00:00
<return type= "void" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "cache_index" type= "int" />
<param index= "1" name= "variation_coordinates" type= "Dictionary" />
2020-10-22 16:40:18 +00:00
<description >
2022-05-09 09:47:10 +00:00
Sets variation coordinates for the specified font cache entry. See [method Font.get_supported_variation_list] for more info.
2020-10-22 16:40:18 +00:00
</description>
</method>
2020-08-12 11:49:10 +00:00
</methods>
2021-11-18 21:36:22 +00:00
<members >
2022-11-21 13:04:01 +00:00
<member name= "allow_system_fallback" type= "bool" setter= "set_allow_system_fallback" getter= "is_allow_system_fallback" default= "true" >
If set to [code]true[/code], system fonts can be automatically used as fallbacks.
</member>
2022-08-12 11:03:28 +00:00
<member name= "antialiasing" type= "int" setter= "set_antialiasing" getter= "get_antialiasing" enum= "TextServer.FontAntialiasing" default= "1" >
Font anti-aliasing mode.
2021-11-18 21:36:22 +00:00
</member>
<member name= "data" type= "PackedByteArray" setter= "set_data" getter= "get_data" default= "PackedByteArray()" >
Contents of the dynamic font source file.
</member>
2022-05-09 09:47:10 +00:00
<member name= "fallbacks" type= "Font[]" setter= "set_fallbacks" getter= "get_fallbacks" default= "[]" >
Array of fallback [Font]s.
2022-06-07 08:35:59 +00:00
</member>
2021-11-18 21:36:22 +00:00
<member name= "fixed_size" type= "int" setter= "set_fixed_size" getter= "get_fixed_size" default= "0" >
Font size, used only for the bitmap fonts.
</member>
<member name= "font_name" type= "String" setter= "set_font_name" getter= "get_font_name" default= """" >
Font family name.
</member>
2022-11-21 13:04:01 +00:00
<member name= "font_stretch" type= "int" setter= "set_font_stretch" getter= "get_font_stretch" default= "100" >
Font stretch amount, compared to a normal width. A percentage value between [code]50%[/code] and [code]200%[/code].
</member>
2022-07-11 09:40:31 +00:00
<member name= "font_style" type= "int" setter= "set_font_style" getter= "get_font_style" enum= "TextServer.FontStyle" default= "0" >
2021-11-18 21:36:22 +00:00
Font style flags, see [enum TextServer.FontStyle].
</member>
2022-11-21 13:04:01 +00:00
<member name= "font_weight" type= "int" setter= "set_font_weight" getter= "get_font_weight" default= "400" >
Weight (boldness) of the font. A value in the [code]100...999[/code] range, normal font weight is [code]400[/code], bold font weight is [code]700[/code].
</member>
2021-11-18 21:36:22 +00:00
<member name= "force_autohinter" type= "bool" setter= "set_force_autohinter" getter= "is_force_autohinter" default= "false" >
2022-02-10 11:00:11 +00:00
If set to [code]true[/code], auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.
2021-11-18 21:36:22 +00:00
</member>
2022-04-19 10:27:18 +00:00
<member name= "generate_mipmaps" type= "bool" setter= "set_generate_mipmaps" getter= "get_generate_mipmaps" default= "false" >
If set to [code]true[/code], generate mipmaps for the font textures.
</member>
2021-11-18 21:36:22 +00:00
<member name= "hinting" type= "int" setter= "set_hinting" getter= "get_hinting" enum= "TextServer.Hinting" default= "1" >
Font hinting mode. Used by dynamic fonts only.
</member>
<member name= "msdf_pixel_range" type= "int" setter= "set_msdf_pixel_range" getter= "get_msdf_pixel_range" default= "16" >
The width of the range around the shape between the minimum and maximum representable signed distance.
</member>
<member name= "msdf_size" type= "int" setter= "set_msdf_size" getter= "get_msdf_size" default= "48" >
Source font size used to generate MSDF textures.
</member>
<member name= "multichannel_signed_distance_field" type= "bool" setter= "set_multichannel_signed_distance_field" getter= "is_multichannel_signed_distance_field" default= "false" >
If set to [code]true[/code], glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.
</member>
<member name= "opentype_feature_overrides" type= "Dictionary" setter= "set_opentype_feature_overrides" getter= "get_opentype_feature_overrides" default= "{}" >
Font OpenType feature set override.
</member>
<member name= "oversampling" type= "float" setter= "set_oversampling" getter= "get_oversampling" default= "0.0" >
Font oversampling factor, if set to [code]0.0[/code] global oversampling factor is used instead. Used by dynamic fonts only.
</member>
<member name= "style_name" type= "String" setter= "set_font_style_name" getter= "get_font_style_name" default= """" >
Font style name.
</member>
2022-01-10 08:13:22 +00:00
<member name= "subpixel_positioning" type= "int" setter= "set_subpixel_positioning" getter= "get_subpixel_positioning" enum= "TextServer.SubpixelPositioning" default= "1" >
2022-11-03 17:37:21 +00:00
Font glyph subpixel positioning mode. Subpixel positioning provides shaper text and better kerning for smaller font sizes, at the cost of memory usage and font rasterization speed. Use [constant TextServer.SUBPIXEL_POSITIONING_AUTO] to automatically enable it based on the font size.
2022-01-10 08:13:22 +00:00
</member>
2021-11-18 21:36:22 +00:00
</members>
2020-08-12 11:49:10 +00:00
</class>
