123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/FontFile.xml.
- .. _class_FontFile:
- FontFile
- ========
- **Inherits:** :ref:`Font<class_Font>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- Holds font source data and prerendered glyph cache, imported from a dynamic or a bitmap font.
- .. rst-class:: classref-introduction-group
- 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 :ref:`Font<class_Font>`\ s to use.
- Use :ref:`FontVariation<class_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 :ref:`FontVariation<class_FontVariation>` in conjunction with :ref:`TextLine<class_TextLine>` or :ref:`TextParagraph<class_TextParagraph>`.
- Supported font formats:
- - Dynamic font importer: TrueType (.ttf), TrueType collection (.ttc), OpenType (.otf), OpenType collection (.otc), WOFF (.woff), WOFF2 (.woff2), Type 1 (.pfb, .pfm).
- - Bitmap font importer: AngelCode BMFont (.fnt, .font), text and binary (version 3) format variants.
- - Monospace image font importer: All supported image formats.
- \ **Note:** A character is a symbol that represents an item (letter, digit etc.) in an abstract way.
- \ **Note:** A glyph is a bitmap or a shape used to draw one or more characters in a context-dependent manner. Glyph indices are bound to the specific font data source.
- \ **Note:** If 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.
- .. tabs::
- .. code-tab:: gdscript
- var f = load("res://BarlowCondensed-Bold.ttf")
- $Label.add_theme_font_override("font", f)
- $Label.add_theme_font_size_override("font_size", 64)
- .. code-tab:: csharp
- var f = ResourceLoader.Load<FontFile>("res://BarlowCondensed-Bold.ttf");
- GetNode("Label").AddThemeFontOverride("font", f);
- GetNode("Label").AddThemeFontSizeOverride("font_size", 64);
- .. rst-class:: classref-introduction-group
- Tutorials
- ---------
- - :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>`
- .. rst-class:: classref-reftable-group
- Properties
- ----------
- .. table::
- :widths: auto
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`bool<class_bool>` | :ref:`allow_system_fallback<class_FontFile_property_allow_system_fallback>` | ``true`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` | :ref:`antialiasing<class_FontFile_property_antialiasing>` | ``1`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`data<class_FontFile_property_data>` | ``PackedByteArray()`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`bool<class_bool>` | :ref:`disable_embedded_bitmaps<class_FontFile_property_disable_embedded_bitmaps>` | ``true`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`int<class_int>` | :ref:`fixed_size<class_FontFile_property_fixed_size>` | ``0`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` | :ref:`fixed_size_scale_mode<class_FontFile_property_fixed_size_scale_mode>` | ``0`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`String<class_String>` | :ref:`font_name<class_FontFile_property_font_name>` | ``""`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`int<class_int>` | :ref:`font_stretch<class_FontFile_property_font_stretch>` | ``100`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\] | :ref:`font_style<class_FontFile_property_font_style>` | ``0`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`int<class_int>` | :ref:`font_weight<class_FontFile_property_font_weight>` | ``400`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`bool<class_bool>` | :ref:`force_autohinter<class_FontFile_property_force_autohinter>` | ``false`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`bool<class_bool>` | :ref:`generate_mipmaps<class_FontFile_property_generate_mipmaps>` | ``false`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`Hinting<enum_TextServer_Hinting>` | :ref:`hinting<class_FontFile_property_hinting>` | ``1`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`int<class_int>` | :ref:`msdf_pixel_range<class_FontFile_property_msdf_pixel_range>` | ``16`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`int<class_int>` | :ref:`msdf_size<class_FontFile_property_msdf_size>` | ``48`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`bool<class_bool>` | :ref:`multichannel_signed_distance_field<class_FontFile_property_multichannel_signed_distance_field>` | ``false`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`Dictionary<class_Dictionary>` | :ref:`opentype_feature_overrides<class_FontFile_property_opentype_feature_overrides>` | ``{}`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`float<class_float>` | :ref:`oversampling<class_FontFile_property_oversampling>` | ``0.0`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`String<class_String>` | :ref:`style_name<class_FontFile_property_style_name>` | ``""`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- | :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` | :ref:`subpixel_positioning<class_FontFile_property_subpixel_positioning>` | ``1`` |
- +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
- .. rst-class:: classref-reftable-group
- Methods
- -------
- .. table::
- :widths: auto
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`clear_cache<class_FontFile_method_clear_cache>`\ (\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`clear_glyphs<class_FontFile_method_clear_glyphs>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`clear_kerning_map<class_FontFile_method_clear_kerning_map>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`clear_size_cache<class_FontFile_method_clear_size_cache>`\ (\ cache_index\: :ref:`int<class_int>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`clear_textures<class_FontFile_method_clear_textures>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_cache_ascent<class_FontFile_method_get_cache_ascent>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_cache_count<class_FontFile_method_get_cache_count>`\ (\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_cache_descent<class_FontFile_method_get_cache_descent>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_cache_scale<class_FontFile_method_get_cache_scale>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_cache_underline_position<class_FontFile_method_get_cache_underline_position>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_cache_underline_thickness<class_FontFile_method_get_cache_underline_thickness>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_char_from_glyph_index<class_FontFile_method_get_char_from_glyph_index>`\ (\ size\: :ref:`int<class_int>`, glyph_index\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_embolden<class_FontFile_method_get_embolden>`\ (\ cache_index\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_extra_baseline_offset<class_FontFile_method_get_extra_baseline_offset>`\ (\ cache_index\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_extra_spacing<class_FontFile_method_get_extra_spacing>`\ (\ cache_index\: :ref:`int<class_int>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_face_index<class_FontFile_method_get_face_index>`\ (\ cache_index\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`get_glyph_advance<class_FontFile_method_get_glyph_advance>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, glyph\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_glyph_index<class_FontFile_method_get_glyph_index>`\ (\ size\: :ref:`int<class_int>`, char\: :ref:`int<class_int>`, variation_selector\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_glyph_list<class_FontFile_method_get_glyph_list>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`get_glyph_offset<class_FontFile_method_get_glyph_offset>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`get_glyph_size<class_FontFile_method_get_glyph_size>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_glyph_texture_idx<class_FontFile_method_get_glyph_texture_idx>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Rect2<class_Rect2>` | :ref:`get_glyph_uv_rect<class_FontFile_method_get_glyph_uv_rect>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`get_kerning<class_FontFile_method_get_kerning>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>`\[:ref:`Vector2i<class_Vector2i>`\] | :ref:`get_kerning_list<class_FontFile_method_get_kerning_list>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`get_language_support_override<class_FontFile_method_get_language_support_override>`\ (\ language\: :ref:`String<class_String>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_language_support_overrides<class_FontFile_method_get_language_support_overrides>`\ (\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`get_script_support_override<class_FontFile_method_get_script_support_override>`\ (\ script\: :ref:`String<class_String>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_script_support_overrides<class_FontFile_method_get_script_support_overrides>`\ (\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>`\[:ref:`Vector2i<class_Vector2i>`\] | :ref:`get_size_cache_list<class_FontFile_method_get_size_cache_list>`\ (\ cache_index\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_texture_count<class_FontFile_method_get_texture_count>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Image<class_Image>` | :ref:`get_texture_image<class_FontFile_method_get_texture_image>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_texture_offsets<class_FontFile_method_get_texture_offsets>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Transform2D<class_Transform2D>` | :ref:`get_transform<class_FontFile_method_get_transform>`\ (\ cache_index\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Dictionary<class_Dictionary>` | :ref:`get_variation_coordinates<class_FontFile_method_get_variation_coordinates>`\ (\ cache_index\: :ref:`int<class_int>`\ ) |const| |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load_bitmap_font<class_FontFile_method_load_bitmap_font>`\ (\ path\: :ref:`String<class_String>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`load_dynamic_font<class_FontFile_method_load_dynamic_font>`\ (\ path\: :ref:`String<class_String>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`remove_cache<class_FontFile_method_remove_cache>`\ (\ cache_index\: :ref:`int<class_int>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`remove_glyph<class_FontFile_method_remove_glyph>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`remove_kerning<class_FontFile_method_remove_kerning>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`remove_language_support_override<class_FontFile_method_remove_language_support_override>`\ (\ language\: :ref:`String<class_String>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`remove_script_support_override<class_FontFile_method_remove_script_support_override>`\ (\ script\: :ref:`String<class_String>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`remove_size_cache<class_FontFile_method_remove_size_cache>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`remove_texture<class_FontFile_method_remove_texture>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`render_glyph<class_FontFile_method_render_glyph>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, index\: :ref:`int<class_int>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`render_range<class_FontFile_method_render_range>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, start\: :ref:`int<class_int>`, end\: :ref:`int<class_int>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_cache_ascent<class_FontFile_method_set_cache_ascent>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, ascent\: :ref:`float<class_float>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_cache_descent<class_FontFile_method_set_cache_descent>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, descent\: :ref:`float<class_float>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_cache_scale<class_FontFile_method_set_cache_scale>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, scale\: :ref:`float<class_float>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_cache_underline_position<class_FontFile_method_set_cache_underline_position>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, underline_position\: :ref:`float<class_float>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_cache_underline_thickness<class_FontFile_method_set_cache_underline_thickness>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, underline_thickness\: :ref:`float<class_float>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_embolden<class_FontFile_method_set_embolden>`\ (\ cache_index\: :ref:`int<class_int>`, strength\: :ref:`float<class_float>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_extra_baseline_offset<class_FontFile_method_set_extra_baseline_offset>`\ (\ cache_index\: :ref:`int<class_int>`, baseline_offset\: :ref:`float<class_float>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_extra_spacing<class_FontFile_method_set_extra_spacing>`\ (\ cache_index\: :ref:`int<class_int>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`, value\: :ref:`int<class_int>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_face_index<class_FontFile_method_set_face_index>`\ (\ cache_index\: :ref:`int<class_int>`, face_index\: :ref:`int<class_int>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_glyph_advance<class_FontFile_method_set_glyph_advance>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, glyph\: :ref:`int<class_int>`, advance\: :ref:`Vector2<class_Vector2>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_glyph_offset<class_FontFile_method_set_glyph_offset>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, offset\: :ref:`Vector2<class_Vector2>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_glyph_size<class_FontFile_method_set_glyph_size>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, gl_size\: :ref:`Vector2<class_Vector2>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_glyph_texture_idx<class_FontFile_method_set_glyph_texture_idx>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, texture_idx\: :ref:`int<class_int>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_glyph_uv_rect<class_FontFile_method_set_glyph_uv_rect>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, uv_rect\: :ref:`Rect2<class_Rect2>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_kerning<class_FontFile_method_set_kerning>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`, kerning\: :ref:`Vector2<class_Vector2>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_language_support_override<class_FontFile_method_set_language_support_override>`\ (\ language\: :ref:`String<class_String>`, supported\: :ref:`bool<class_bool>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_script_support_override<class_FontFile_method_set_script_support_override>`\ (\ script\: :ref:`String<class_String>`, supported\: :ref:`bool<class_bool>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_texture_image<class_FontFile_method_set_texture_image>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`, image\: :ref:`Image<class_Image>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_texture_offsets<class_FontFile_method_set_texture_offsets>`\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`, offset\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_transform<class_FontFile_method_set_transform>`\ (\ cache_index\: :ref:`int<class_int>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | |void| | :ref:`set_variation_coordinates<class_FontFile_method_set_variation_coordinates>`\ (\ cache_index\: :ref:`int<class_int>`, variation_coordinates\: :ref:`Dictionary<class_Dictionary>`\ ) |
- +--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Property Descriptions
- ---------------------
- .. _class_FontFile_property_allow_system_fallback:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **allow_system_fallback** = ``true`` :ref:`๐<class_FontFile_property_allow_system_fallback>`
- .. rst-class:: classref-property-setget
- - |void| **set_allow_system_fallback**\ (\ value\: :ref:`bool<class_bool>`\ )
- - :ref:`bool<class_bool>` **is_allow_system_fallback**\ (\ )
- If set to ``true``, system fonts can be automatically used as fallbacks.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_antialiasing:
- .. rst-class:: classref-property
- :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **antialiasing** = ``1`` :ref:`๐<class_FontFile_property_antialiasing>`
- .. rst-class:: classref-property-setget
- - |void| **set_antialiasing**\ (\ value\: :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>`\ )
- - :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **get_antialiasing**\ (\ )
- Font anti-aliasing mode.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_data:
- .. rst-class:: classref-property
- :ref:`PackedByteArray<class_PackedByteArray>` **data** = ``PackedByteArray()`` :ref:`๐<class_FontFile_property_data>`
- .. rst-class:: classref-property-setget
- - |void| **set_data**\ (\ value\: :ref:`PackedByteArray<class_PackedByteArray>`\ )
- - :ref:`PackedByteArray<class_PackedByteArray>` **get_data**\ (\ )
- Contents of the dynamic font source file.
- **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedByteArray<class_PackedByteArray>` for more details.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_disable_embedded_bitmaps:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **disable_embedded_bitmaps** = ``true`` :ref:`๐<class_FontFile_property_disable_embedded_bitmaps>`
- .. rst-class:: classref-property-setget
- - |void| **set_disable_embedded_bitmaps**\ (\ value\: :ref:`bool<class_bool>`\ )
- - :ref:`bool<class_bool>` **get_disable_embedded_bitmaps**\ (\ )
- If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property).
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_fixed_size:
- .. rst-class:: classref-property
- :ref:`int<class_int>` **fixed_size** = ``0`` :ref:`๐<class_FontFile_property_fixed_size>`
- .. rst-class:: classref-property-setget
- - |void| **set_fixed_size**\ (\ value\: :ref:`int<class_int>`\ )
- - :ref:`int<class_int>` **get_fixed_size**\ (\ )
- Font size, used only for the bitmap fonts.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_fixed_size_scale_mode:
- .. rst-class:: classref-property
- :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **fixed_size_scale_mode** = ``0`` :ref:`๐<class_FontFile_property_fixed_size_scale_mode>`
- .. rst-class:: classref-property-setget
- - |void| **set_fixed_size_scale_mode**\ (\ value\: :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>`\ )
- - :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **get_fixed_size_scale_mode**\ (\ )
- Scaling mode, used only for the bitmap fonts with :ref:`fixed_size<class_FontFile_property_fixed_size>` greater than zero.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_font_name:
- .. rst-class:: classref-property
- :ref:`String<class_String>` **font_name** = ``""`` :ref:`๐<class_FontFile_property_font_name>`
- .. rst-class:: classref-property-setget
- - |void| **set_font_name**\ (\ value\: :ref:`String<class_String>`\ )
- - :ref:`String<class_String>` **get_font_name**\ (\ )
- Font family name.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_font_stretch:
- .. rst-class:: classref-property
- :ref:`int<class_int>` **font_stretch** = ``100`` :ref:`๐<class_FontFile_property_font_stretch>`
- .. rst-class:: classref-property-setget
- - |void| **set_font_stretch**\ (\ value\: :ref:`int<class_int>`\ )
- - :ref:`int<class_int>` **get_font_stretch**\ (\ )
- Font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_font_style:
- .. rst-class:: classref-property
- |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\] **font_style** = ``0`` :ref:`๐<class_FontFile_property_font_style>`
- .. rst-class:: classref-property-setget
- - |void| **set_font_style**\ (\ value\: |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\]\ )
- - |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\] **get_font_style**\ (\ )
- Font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_font_weight:
- .. rst-class:: classref-property
- :ref:`int<class_int>` **font_weight** = ``400`` :ref:`๐<class_FontFile_property_font_weight>`
- .. rst-class:: classref-property-setget
- - |void| **set_font_weight**\ (\ value\: :ref:`int<class_int>`\ )
- - :ref:`int<class_int>` **get_font_weight**\ (\ )
- Weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_force_autohinter:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **force_autohinter** = ``false`` :ref:`๐<class_FontFile_property_force_autohinter>`
- .. rst-class:: classref-property-setget
- - |void| **set_force_autohinter**\ (\ value\: :ref:`bool<class_bool>`\ )
- - :ref:`bool<class_bool>` **is_force_autohinter**\ (\ )
- If set to ``true``, auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only (MSDF fonts don't support hinting).
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_generate_mipmaps:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **generate_mipmaps** = ``false`` :ref:`๐<class_FontFile_property_generate_mipmaps>`
- .. rst-class:: classref-property-setget
- - |void| **set_generate_mipmaps**\ (\ value\: :ref:`bool<class_bool>`\ )
- - :ref:`bool<class_bool>` **get_generate_mipmaps**\ (\ )
- If set to ``true``, generate mipmaps for the font textures.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_hinting:
- .. rst-class:: classref-property
- :ref:`Hinting<enum_TextServer_Hinting>` **hinting** = ``1`` :ref:`๐<class_FontFile_property_hinting>`
- .. rst-class:: classref-property-setget
- - |void| **set_hinting**\ (\ value\: :ref:`Hinting<enum_TextServer_Hinting>`\ )
- - :ref:`Hinting<enum_TextServer_Hinting>` **get_hinting**\ (\ )
- Font hinting mode. Used by dynamic fonts only.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_msdf_pixel_range:
- .. rst-class:: classref-property
- :ref:`int<class_int>` **msdf_pixel_range** = ``16`` :ref:`๐<class_FontFile_property_msdf_pixel_range>`
- .. rst-class:: classref-property-setget
- - |void| **set_msdf_pixel_range**\ (\ value\: :ref:`int<class_int>`\ )
- - :ref:`int<class_int>` **get_msdf_pixel_range**\ (\ )
- The width of the range around the shape between the minimum and maximum representable signed distance. If using font outlines, :ref:`msdf_pixel_range<class_FontFile_property_msdf_pixel_range>` must be set to at least *twice* the size of the largest font outline. The default :ref:`msdf_pixel_range<class_FontFile_property_msdf_pixel_range>` value of ``16`` allows outline sizes up to ``8`` to look correct.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_msdf_size:
- .. rst-class:: classref-property
- :ref:`int<class_int>` **msdf_size** = ``48`` :ref:`๐<class_FontFile_property_msdf_size>`
- .. rst-class:: classref-property-setget
- - |void| **set_msdf_size**\ (\ value\: :ref:`int<class_int>`\ )
- - :ref:`int<class_int>` **get_msdf_size**\ (\ )
- Source font size used to generate MSDF textures. Higher values allow for more precision, but are slower to render and require more memory. Only increase this value if you notice a visible lack of precision in glyph rendering.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_multichannel_signed_distance_field:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **multichannel_signed_distance_field** = ``false`` :ref:`๐<class_FontFile_property_multichannel_signed_distance_field>`
- .. rst-class:: classref-property-setget
- - |void| **set_multichannel_signed_distance_field**\ (\ value\: :ref:`bool<class_bool>`\ )
- - :ref:`bool<class_bool>` **is_multichannel_signed_distance_field**\ (\ )
- If set to ``true``, glyphs of all sizes are rendered using single multichannel signed distance field (MSDF) generated from the dynamic font vector data. Since this approach does not rely on rasterizing the font every time its size changes, this allows for resizing the font in real-time without any performance penalty. Text will also not look grainy for :ref:`Control<class_Control>`\ s that are scaled down (or for :ref:`Label3D<class_Label3D>`\ s viewed from a long distance). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes.
- \ **Note:** If using font outlines, :ref:`msdf_pixel_range<class_FontFile_property_msdf_pixel_range>` must be set to at least *twice* the size of the largest font outline.
- \ **Note:** MSDF font rendering does not render glyphs with overlapping shapes correctly. Overlapping shapes are not valid per the OpenType standard, but are still commonly found in many font files, especially those converted by Google Fonts. To avoid issues with overlapping glyphs, consider downloading the font file directly from the type foundry instead of relying on Google Fonts.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_opentype_feature_overrides:
- .. rst-class:: classref-property
- :ref:`Dictionary<class_Dictionary>` **opentype_feature_overrides** = ``{}`` :ref:`๐<class_FontFile_property_opentype_feature_overrides>`
- .. rst-class:: classref-property-setget
- - |void| **set_opentype_feature_overrides**\ (\ value\: :ref:`Dictionary<class_Dictionary>`\ )
- - :ref:`Dictionary<class_Dictionary>` **get_opentype_feature_overrides**\ (\ )
- Font OpenType feature set override.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_oversampling:
- .. rst-class:: classref-property
- :ref:`float<class_float>` **oversampling** = ``0.0`` :ref:`๐<class_FontFile_property_oversampling>`
- .. rst-class:: classref-property-setget
- - |void| **set_oversampling**\ (\ value\: :ref:`float<class_float>`\ )
- - :ref:`float<class_float>` **get_oversampling**\ (\ )
- Font oversampling factor. If set to ``0.0``, the global oversampling factor is used instead. Used by dynamic fonts only (MSDF fonts ignore oversampling).
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_style_name:
- .. rst-class:: classref-property
- :ref:`String<class_String>` **style_name** = ``""`` :ref:`๐<class_FontFile_property_style_name>`
- .. rst-class:: classref-property-setget
- - |void| **set_font_style_name**\ (\ value\: :ref:`String<class_String>`\ )
- - :ref:`String<class_String>` **get_font_style_name**\ (\ )
- Font style name.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_property_subpixel_positioning:
- .. rst-class:: classref-property
- :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **subpixel_positioning** = ``1`` :ref:`๐<class_FontFile_property_subpixel_positioning>`
- .. rst-class:: classref-property-setget
- - |void| **set_subpixel_positioning**\ (\ value\: :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>`\ )
- - :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **get_subpixel_positioning**\ (\ )
- Font glyph subpixel positioning mode. Subpixel positioning provides shaper text and better kerning for smaller font sizes, at the cost of higher memory usage and lower font rasterization speed. Use :ref:`TextServer.SUBPIXEL_POSITIONING_AUTO<class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO>` to automatically enable it based on the font size.
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Method Descriptions
- -------------------
- .. _class_FontFile_method_clear_cache:
- .. rst-class:: classref-method
- |void| **clear_cache**\ (\ ) :ref:`๐<class_FontFile_method_clear_cache>`
- Removes all font cache entries.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_clear_glyphs:
- .. rst-class:: classref-method
- |void| **clear_glyphs**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐<class_FontFile_method_clear_glyphs>`
- Removes all rendered glyph information from the cache entry.
- \ **Note:** This function will not remove textures associated with the glyphs, use :ref:`remove_texture<class_FontFile_method_remove_texture>` to remove them manually.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_clear_kerning_map:
- .. rst-class:: classref-method
- |void| **clear_kerning_map**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) :ref:`๐<class_FontFile_method_clear_kerning_map>`
- Removes all kerning overrides.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_clear_size_cache:
- .. rst-class:: classref-method
- |void| **clear_size_cache**\ (\ cache_index\: :ref:`int<class_int>`\ ) :ref:`๐<class_FontFile_method_clear_size_cache>`
- Removes all font sizes from the cache entry.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_clear_textures:
- .. rst-class:: classref-method
- |void| **clear_textures**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐<class_FontFile_method_clear_textures>`
- Removes all textures from font cache entry.
- \ **Note:** This function will not remove glyphs associated with the texture, use :ref:`remove_glyph<class_FontFile_method_remove_glyph>` to remove them manually.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_cache_ascent:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **get_cache_ascent**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_cache_ascent>`
- Returns the font ascent (number of pixels above the baseline).
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_cache_count:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **get_cache_count**\ (\ ) |const| :ref:`๐<class_FontFile_method_get_cache_count>`
- Returns number of the font cache entries.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_cache_descent:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **get_cache_descent**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_cache_descent>`
- Returns the font descent (number of pixels below the baseline).
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_cache_scale:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **get_cache_scale**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_cache_scale>`
- Returns scaling factor of the color bitmap font.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_cache_underline_position:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **get_cache_underline_position**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_cache_underline_position>`
- Returns pixel offset of the underline below the baseline.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_cache_underline_thickness:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **get_cache_underline_thickness**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_cache_underline_thickness>`
- Returns thickness of the underline in pixels.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_char_from_glyph_index:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **get_char_from_glyph_index**\ (\ size\: :ref:`int<class_int>`, glyph_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_char_from_glyph_index>`
- Returns character code associated with ``glyph_index``, or ``0`` if ``glyph_index`` is invalid. See :ref:`get_glyph_index<class_FontFile_method_get_glyph_index>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_embolden:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **get_embolden**\ (\ cache_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_embolden>`
- Returns embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_extra_baseline_offset:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **get_extra_baseline_offset**\ (\ cache_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_extra_baseline_offset>`
- Returns extra baseline offset (as a fraction of font height).
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_extra_spacing:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **get_extra_spacing**\ (\ cache_index\: :ref:`int<class_int>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`\ ) |const| :ref:`๐<class_FontFile_method_get_extra_spacing>`
- Returns spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) in pixels (not relative to the font size).
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_face_index:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **get_face_index**\ (\ cache_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_face_index>`
- Returns an active face index in the TrueType / OpenType collection.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_glyph_advance:
- .. rst-class:: classref-method
- :ref:`Vector2<class_Vector2>` **get_glyph_advance**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_glyph_advance>`
- Returns glyph advance (offset of the next glyph).
- \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_glyph_index:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **get_glyph_index**\ (\ size\: :ref:`int<class_int>`, char\: :ref:`int<class_int>`, variation_selector\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_glyph_index>`
- Returns the glyph index of a ``char``, optionally modified by the ``variation_selector``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_glyph_list:
- .. rst-class:: classref-method
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_glyph_list**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`๐<class_FontFile_method_get_glyph_list>`
- Returns list of rendered glyphs in the cache entry.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_glyph_offset:
- .. rst-class:: classref-method
- :ref:`Vector2<class_Vector2>` **get_glyph_offset**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_glyph_offset>`
- Returns glyph offset from the baseline.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_glyph_size:
- .. rst-class:: classref-method
- :ref:`Vector2<class_Vector2>` **get_glyph_size**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_glyph_size>`
- Returns glyph size.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_glyph_texture_idx:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **get_glyph_texture_idx**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_glyph_texture_idx>`
- Returns index of the cache texture containing the glyph.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_glyph_uv_rect:
- .. rst-class:: classref-method
- :ref:`Rect2<class_Rect2>` **get_glyph_uv_rect**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_glyph_uv_rect>`
- Returns rectangle in the cache texture containing the glyph.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_kerning:
- .. rst-class:: classref-method
- :ref:`Vector2<class_Vector2>` **get_kerning**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`๐<class_FontFile_method_get_kerning>`
- Returns kerning for the pair of glyphs.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_kerning_list:
- .. rst-class:: classref-method
- :ref:`Array<class_Array>`\[:ref:`Vector2i<class_Vector2i>`\] **get_kerning_list**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_kerning_list>`
- Returns list of the kerning overrides.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_language_support_override:
- .. rst-class:: classref-method
- :ref:`bool<class_bool>` **get_language_support_override**\ (\ language\: :ref:`String<class_String>`\ ) |const| :ref:`๐<class_FontFile_method_get_language_support_override>`
- Returns ``true`` if support override is enabled for the ``language``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_language_support_overrides:
- .. rst-class:: classref-method
- :ref:`PackedStringArray<class_PackedStringArray>` **get_language_support_overrides**\ (\ ) |const| :ref:`๐<class_FontFile_method_get_language_support_overrides>`
- Returns list of language support overrides.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_script_support_override:
- .. rst-class:: classref-method
- :ref:`bool<class_bool>` **get_script_support_override**\ (\ script\: :ref:`String<class_String>`\ ) |const| :ref:`๐<class_FontFile_method_get_script_support_override>`
- Returns ``true`` if support override is enabled for the ``script``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_script_support_overrides:
- .. rst-class:: classref-method
- :ref:`PackedStringArray<class_PackedStringArray>` **get_script_support_overrides**\ (\ ) |const| :ref:`๐<class_FontFile_method_get_script_support_overrides>`
- Returns list of script support overrides.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_size_cache_list:
- .. rst-class:: classref-method
- :ref:`Array<class_Array>`\[:ref:`Vector2i<class_Vector2i>`\] **get_size_cache_list**\ (\ cache_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_size_cache_list>`
- Returns list of the font sizes in the cache. Each size is :ref:`Vector2i<class_Vector2i>` with font size and outline size.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_texture_count:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **get_texture_count**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`๐<class_FontFile_method_get_texture_count>`
- Returns number of textures used by font cache entry.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_texture_image:
- .. rst-class:: classref-method
- :ref:`Image<class_Image>` **get_texture_image**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_texture_image>`
- Returns a copy of the font cache texture image.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_texture_offsets:
- .. rst-class:: classref-method
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_texture_offsets**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_texture_offsets>`
- Returns a copy of the array containing glyph packing data.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_transform:
- .. rst-class:: classref-method
- :ref:`Transform2D<class_Transform2D>` **get_transform**\ (\ cache_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_transform>`
- Returns 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_get_variation_coordinates:
- .. rst-class:: classref-method
- :ref:`Dictionary<class_Dictionary>` **get_variation_coordinates**\ (\ cache_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐<class_FontFile_method_get_variation_coordinates>`
- Returns variation coordinates for the specified font cache entry. See :ref:`Font.get_supported_variation_list<class_Font_method_get_supported_variation_list>` for more info.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_load_bitmap_font:
- .. rst-class:: classref-method
- :ref:`Error<enum_@GlobalScope_Error>` **load_bitmap_font**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`๐<class_FontFile_method_load_bitmap_font>`
- Loads an AngelCode BMFont (.fnt, .font) bitmap font from file ``path``.
- \ **Warning:** 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 ``user://`` directory.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_load_dynamic_font:
- .. rst-class:: classref-method
- :ref:`Error<enum_@GlobalScope_Error>` **load_dynamic_font**\ (\ path\: :ref:`String<class_String>`\ ) :ref:`๐<class_FontFile_method_load_dynamic_font>`
- Loads a TrueType (.ttf), OpenType (.otf), WOFF (.woff), WOFF2 (.woff2) or Type 1 (.pfb, .pfm) dynamic font from file ``path``.
- \ **Warning:** 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 ``user://`` directory.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_remove_cache:
- .. rst-class:: classref-method
- |void| **remove_cache**\ (\ cache_index\: :ref:`int<class_int>`\ ) :ref:`๐<class_FontFile_method_remove_cache>`
- Removes specified font cache entry.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_remove_glyph:
- .. rst-class:: classref-method
- |void| **remove_glyph**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) :ref:`๐<class_FontFile_method_remove_glyph>`
- Removes specified rendered glyph information from the cache entry.
- \ **Note:** This function will not remove textures associated with the glyphs, use :ref:`remove_texture<class_FontFile_method_remove_texture>` to remove them manually.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_remove_kerning:
- .. rst-class:: classref-method
- |void| **remove_kerning**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐<class_FontFile_method_remove_kerning>`
- Removes kerning override for the pair of glyphs.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_remove_language_support_override:
- .. rst-class:: classref-method
- |void| **remove_language_support_override**\ (\ language\: :ref:`String<class_String>`\ ) :ref:`๐<class_FontFile_method_remove_language_support_override>`
- Remove language support override.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_remove_script_support_override:
- .. rst-class:: classref-method
- |void| **remove_script_support_override**\ (\ script\: :ref:`String<class_String>`\ ) :ref:`๐<class_FontFile_method_remove_script_support_override>`
- Removes script support override.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_remove_size_cache:
- .. rst-class:: classref-method
- |void| **remove_size_cache**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐<class_FontFile_method_remove_size_cache>`
- Removes specified font size from the cache entry.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_remove_texture:
- .. rst-class:: classref-method
- |void| **remove_texture**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) :ref:`๐<class_FontFile_method_remove_texture>`
- Removes specified texture from the cache entry.
- \ **Note:** This function will not remove glyphs associated with the texture. Remove them manually using :ref:`remove_glyph<class_FontFile_method_remove_glyph>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_render_glyph:
- .. rst-class:: classref-method
- |void| **render_glyph**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, index\: :ref:`int<class_int>`\ ) :ref:`๐<class_FontFile_method_render_glyph>`
- Renders specified glyph to the font cache texture.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_render_range:
- .. rst-class:: classref-method
- |void| **render_range**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, start\: :ref:`int<class_int>`, end\: :ref:`int<class_int>`\ ) :ref:`๐<class_FontFile_method_render_range>`
- Renders the range of characters to the font cache texture.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_cache_ascent:
- .. rst-class:: classref-method
- |void| **set_cache_ascent**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, ascent\: :ref:`float<class_float>`\ ) :ref:`๐<class_FontFile_method_set_cache_ascent>`
- Sets the font ascent (number of pixels above the baseline).
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_cache_descent:
- .. rst-class:: classref-method
- |void| **set_cache_descent**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, descent\: :ref:`float<class_float>`\ ) :ref:`๐<class_FontFile_method_set_cache_descent>`
- Sets the font descent (number of pixels below the baseline).
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_cache_scale:
- .. rst-class:: classref-method
- |void| **set_cache_scale**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, scale\: :ref:`float<class_float>`\ ) :ref:`๐<class_FontFile_method_set_cache_scale>`
- Sets scaling factor of the color bitmap font.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_cache_underline_position:
- .. rst-class:: classref-method
- |void| **set_cache_underline_position**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, underline_position\: :ref:`float<class_float>`\ ) :ref:`๐<class_FontFile_method_set_cache_underline_position>`
- Sets pixel offset of the underline below the baseline.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_cache_underline_thickness:
- .. rst-class:: classref-method
- |void| **set_cache_underline_thickness**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, underline_thickness\: :ref:`float<class_float>`\ ) :ref:`๐<class_FontFile_method_set_cache_underline_thickness>`
- Sets thickness of the underline in pixels.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_embolden:
- .. rst-class:: classref-method
- |void| **set_embolden**\ (\ cache_index\: :ref:`int<class_int>`, strength\: :ref:`float<class_float>`\ ) :ref:`๐<class_FontFile_method_set_embolden>`
- Sets embolden strength, if is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_extra_baseline_offset:
- .. rst-class:: classref-method
- |void| **set_extra_baseline_offset**\ (\ cache_index\: :ref:`int<class_int>`, baseline_offset\: :ref:`float<class_float>`\ ) :ref:`๐<class_FontFile_method_set_extra_baseline_offset>`
- Sets extra baseline offset (as a fraction of font height).
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_extra_spacing:
- .. rst-class:: classref-method
- |void| **set_extra_spacing**\ (\ cache_index\: :ref:`int<class_int>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`, value\: :ref:`int<class_int>`\ ) :ref:`๐<class_FontFile_method_set_extra_spacing>`
- Sets the spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) to ``value`` in pixels (not relative to the font size).
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_face_index:
- .. rst-class:: classref-method
- |void| **set_face_index**\ (\ cache_index\: :ref:`int<class_int>`, face_index\: :ref:`int<class_int>`\ ) :ref:`๐<class_FontFile_method_set_face_index>`
- Sets an active face index in the TrueType / OpenType collection.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_glyph_advance:
- .. rst-class:: classref-method
- |void| **set_glyph_advance**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, glyph\: :ref:`int<class_int>`, advance\: :ref:`Vector2<class_Vector2>`\ ) :ref:`๐<class_FontFile_method_set_glyph_advance>`
- Sets glyph advance (offset of the next glyph).
- \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_glyph_offset:
- .. rst-class:: classref-method
- |void| **set_glyph_offset**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, offset\: :ref:`Vector2<class_Vector2>`\ ) :ref:`๐<class_FontFile_method_set_glyph_offset>`
- Sets glyph offset from the baseline.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_glyph_size:
- .. rst-class:: classref-method
- |void| **set_glyph_size**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, gl_size\: :ref:`Vector2<class_Vector2>`\ ) :ref:`๐<class_FontFile_method_set_glyph_size>`
- Sets glyph size.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_glyph_texture_idx:
- .. rst-class:: classref-method
- |void| **set_glyph_texture_idx**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, texture_idx\: :ref:`int<class_int>`\ ) :ref:`๐<class_FontFile_method_set_glyph_texture_idx>`
- Sets index of the cache texture containing the glyph.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_glyph_uv_rect:
- .. rst-class:: classref-method
- |void| **set_glyph_uv_rect**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, uv_rect\: :ref:`Rect2<class_Rect2>`\ ) :ref:`๐<class_FontFile_method_set_glyph_uv_rect>`
- Sets rectangle in the cache texture containing the glyph.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_kerning:
- .. rst-class:: classref-method
- |void| **set_kerning**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`, kerning\: :ref:`Vector2<class_Vector2>`\ ) :ref:`๐<class_FontFile_method_set_kerning>`
- Sets kerning for the pair of glyphs.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_language_support_override:
- .. rst-class:: classref-method
- |void| **set_language_support_override**\ (\ language\: :ref:`String<class_String>`, supported\: :ref:`bool<class_bool>`\ ) :ref:`๐<class_FontFile_method_set_language_support_override>`
- Adds override for :ref:`Font.is_language_supported<class_Font_method_is_language_supported>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_script_support_override:
- .. rst-class:: classref-method
- |void| **set_script_support_override**\ (\ script\: :ref:`String<class_String>`, supported\: :ref:`bool<class_bool>`\ ) :ref:`๐<class_FontFile_method_set_script_support_override>`
- Adds override for :ref:`Font.is_script_supported<class_Font_method_is_script_supported>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_texture_image:
- .. rst-class:: classref-method
- |void| **set_texture_image**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`, image\: :ref:`Image<class_Image>`\ ) :ref:`๐<class_FontFile_method_set_texture_image>`
- Sets font cache texture image.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_texture_offsets:
- .. rst-class:: classref-method
- |void| **set_texture_offsets**\ (\ cache_index\: :ref:`int<class_int>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`, offset\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) :ref:`๐<class_FontFile_method_set_texture_offsets>`
- Sets array containing glyph packing data.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_transform:
- .. rst-class:: classref-method
- |void| **set_transform**\ (\ cache_index\: :ref:`int<class_int>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`๐<class_FontFile_method_set_transform>`
- Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs.
- .. rst-class:: classref-item-separator
- ----
- .. _class_FontFile_method_set_variation_coordinates:
- .. rst-class:: classref-method
- |void| **set_variation_coordinates**\ (\ cache_index\: :ref:`int<class_int>`, variation_coordinates\: :ref:`Dictionary<class_Dictionary>`\ ) :ref:`๐<class_FontFile_method_set_variation_coordinates>`
- Sets variation coordinates for the specified font cache entry. See :ref:`Font.get_supported_variation_list<class_Font_method_get_supported_variation_list>` for more info.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
- .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
- .. |void| replace:: :abbr:`void (No return value.)`
|