godot-docs/classes/class_fontfile.rst

: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-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:`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>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size **)**                                                                                                            |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`clear_kerning_map<class_FontFile_method_clear_kerning_map>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)**                                                                                                            |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`clear_size_cache<class_FontFile_method_clear_size_cache>` **(** :ref:`int<class_int>` cache_index **)**                                                                                                                                          |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`clear_textures<class_FontFile_method_clear_textures>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size **)**                                                                                                        |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                         | :ref:`get_cache_ascent<class_FontFile_method_get_cache_ascent>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |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>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |const|                                                                                                    |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                         | :ref:`get_cache_scale<class_FontFile_method_get_cache_scale>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |const|                                                                                                        |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                         | :ref:`get_cache_underline_position<class_FontFile_method_get_cache_underline_position>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |const|                                                                              |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                         | :ref:`get_cache_underline_thickness<class_FontFile_method_get_cache_underline_thickness>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |const|                                                                            |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                             | :ref:`get_char_from_glyph_index<class_FontFile_method_get_char_from_glyph_index>` **(** :ref:`int<class_int>` size, :ref:`int<class_int>` glyph_index **)** |const|                                                                                    |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                         | :ref:`get_embolden<class_FontFile_method_get_embolden>` **(** :ref:`int<class_int>` cache_index **)** |const|                                                                                                                                          |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                             | :ref:`get_extra_spacing<class_FontFile_method_get_extra_spacing>` **(** :ref:`int<class_int>` cache_index, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |const|                                                                       |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                             | :ref:`get_face_index<class_FontFile_method_get_face_index>` **(** :ref:`int<class_int>` cache_index **)** |const|                                                                                                                                      |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>`                     | :ref:`get_glyph_advance<class_FontFile_method_get_glyph_advance>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph **)** |const|                                                                       |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                             | :ref:`get_glyph_index<class_FontFile_method_get_glyph_index>` **(** :ref:`int<class_int>` size, :ref:`int<class_int>` char, :ref:`int<class_int>` variation_selector **)** |const|                                                                     |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedInt32Array<class_PackedInt32Array>`   | :ref:`get_glyph_list<class_FontFile_method_get_glyph_list>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size **)** |const|                                                                                                |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>`                     | :ref:`get_glyph_offset<class_FontFile_method_get_glyph_offset>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|                                                               |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>`                     | :ref:`get_glyph_size<class_FontFile_method_get_glyph_size>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|                                                                   |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                             | :ref:`get_glyph_texture_idx<class_FontFile_method_get_glyph_texture_idx>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|                                                     |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Rect2<class_Rect2>`                         | :ref:`get_glyph_uv_rect<class_FontFile_method_get_glyph_uv_rect>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|                                                             |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>`                     | :ref:`get_kerning<class_FontFile_method_get_kerning>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)** |const|                                                                    |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2i[]<class_Vector2i>`                 | :ref:`get_kerning_list<class_FontFile_method_get_kerning_list>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |const|                                                                                                      |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                           | :ref:`get_language_support_override<class_FontFile_method_get_language_support_override>` **(** :ref:`String<class_String>` language **)** |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>` **(** :ref:`String<class_String>` script **)** |const|                                                                                                           |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_script_support_overrides<class_FontFile_method_get_script_support_overrides>` **(** **)** |const|                                                                                                                                            |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2i[]<class_Vector2i>`                 | :ref:`get_size_cache_list<class_FontFile_method_get_size_cache_list>` **(** :ref:`int<class_int>` cache_index **)** |const|                                                                                                                            |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                             | :ref:`get_texture_count<class_FontFile_method_get_texture_count>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size **)** |const|                                                                                          |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Image<class_Image>`                         | :ref:`get_texture_image<class_FontFile_method_get_texture_image>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |const|                                                     |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedInt32Array<class_PackedInt32Array>`   | :ref:`get_texture_offsets<class_FontFile_method_get_texture_offsets>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |const|                                                 |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Transform2D<class_Transform2D>`             | :ref:`get_transform<class_FontFile_method_get_transform>` **(** :ref:`int<class_int>` cache_index **)** |const|                                                                                                                                        |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Dictionary<class_Dictionary>`               | :ref:`get_variation_coordinates<class_FontFile_method_get_variation_coordinates>` **(** :ref:`int<class_int>` cache_index **)** |const|                                                                                                                |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`             | :ref:`load_bitmap_font<class_FontFile_method_load_bitmap_font>` **(** :ref:`String<class_String>` path **)**                                                                                                                                           |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`             | :ref:`load_dynamic_font<class_FontFile_method_load_dynamic_font>` **(** :ref:`String<class_String>` path **)**                                                                                                                                         |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`remove_cache<class_FontFile_method_remove_cache>` **(** :ref:`int<class_int>` cache_index **)**                                                                                                                                                  |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`remove_glyph<class_FontFile_method_remove_glyph>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)**                                                                               |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`remove_kerning<class_FontFile_method_remove_kerning>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)**                                                                      |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`remove_language_support_override<class_FontFile_method_remove_language_support_override>` **(** :ref:`String<class_String>` language **)**                                                                                                       |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`remove_script_support_override<class_FontFile_method_remove_script_support_override>` **(** :ref:`String<class_String>` script **)**                                                                                                             |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`remove_size_cache<class_FontFile_method_remove_size_cache>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size **)**                                                                                                  |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`remove_texture<class_FontFile_method_remove_texture>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)**                                                                   |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`render_glyph<class_FontFile_method_render_glyph>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` index **)**                                                                               |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`render_range<class_FontFile_method_render_range>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)**                                                    |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_cache_ascent<class_FontFile_method_set_cache_ascent>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`float<class_float>` ascent **)**                                                                            |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_cache_descent<class_FontFile_method_set_cache_descent>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`float<class_float>` descent **)**                                                                         |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_cache_scale<class_FontFile_method_set_cache_scale>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`float<class_float>` scale **)**                                                                               |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_cache_underline_position<class_FontFile_method_set_cache_underline_position>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_position **)**                                        |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_cache_underline_thickness<class_FontFile_method_set_cache_underline_thickness>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_thickness **)**                                     |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_embolden<class_FontFile_method_set_embolden>` **(** :ref:`int<class_int>` cache_index, :ref:`float<class_float>` strength **)**                                                                                                              |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_extra_spacing<class_FontFile_method_set_extra_spacing>` **(** :ref:`int<class_int>` cache_index, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)**                                                  |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_face_index<class_FontFile_method_set_face_index>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` face_index **)**                                                                                                            |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_glyph_advance<class_FontFile_method_set_glyph_advance>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` advance **)**                                        |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_glyph_offset<class_FontFile_method_set_glyph_offset>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` offset **)**                                 |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_glyph_size<class_FontFile_method_set_glyph_size>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` gl_size **)**                                    |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_glyph_texture_idx<class_FontFile_method_set_glyph_texture_idx>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`int<class_int>` texture_idx **)**                          |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_glyph_uv_rect<class_FontFile_method_set_glyph_uv_rect>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Rect2<class_Rect2>` uv_rect **)**                                  |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_kerning<class_FontFile_method_set_kerning>` **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair, :ref:`Vector2<class_Vector2>` kerning **)**                                     |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_language_support_override<class_FontFile_method_set_language_support_override>` **(** :ref:`String<class_String>` language, :ref:`bool<class_bool>` supported **)**                                                                          |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_script_support_override<class_FontFile_method_set_script_support_override>` **(** :ref:`String<class_String>` script, :ref:`bool<class_bool>` supported **)**                                                                                |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_texture_image<class_FontFile_method_set_texture_image>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index, :ref:`Image<class_Image>` image **)**                            |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_texture_offsets<class_FontFile_method_set_texture_offsets>` **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index, :ref:`PackedInt32Array<class_PackedInt32Array>` offset **)** |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_transform<class_FontFile_method_set_transform>` **(** :ref:`int<class_int>` cache_index, :ref:`Transform2D<class_Transform2D>` transform **)**                                                                                               |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                              | :ref:`set_variation_coordinates<class_FontFile_method_set_variation_coordinates>` **(** :ref:`int<class_int>` cache_index, :ref:`Dictionary<class_Dictionary>` variation_coordinates **)**                                                             |
   +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. 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``

.. rst-class:: classref-property-setget

- void **set_allow_system_fallback** **(** :ref:`bool<class_bool>` value **)**
- :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``

.. rst-class:: classref-property-setget

- void **set_antialiasing** **(** :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` value **)**
- :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()``

.. rst-class:: classref-property-setget

- void **set_data** **(** :ref:`PackedByteArray<class_PackedByteArray>` value **)**
- :ref:`PackedByteArray<class_PackedByteArray>` **get_data** **(** **)**

Contents of the dynamic font source file.

.. rst-class:: classref-item-separator

----

.. _class_FontFile_property_fixed_size:

.. rst-class:: classref-property

:ref:`int<class_int>` **fixed_size** = ``0``

.. rst-class:: classref-property-setget

- void **set_fixed_size** **(** :ref:`int<class_int>` value **)**
- :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``

.. rst-class:: classref-property-setget

- void **set_fixed_size_scale_mode** **(** :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` value **)**
- :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** = ``""``

.. rst-class:: classref-property-setget

- void **set_font_name** **(** :ref:`String<class_String>` value **)**
- :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``

.. rst-class:: classref-property-setget

- void **set_font_stretch** **(** :ref:`int<class_int>` value **)**
- :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``

.. rst-class:: classref-property-setget

- void **set_font_style** **(** |bitfield|\<:ref:`FontStyle<enum_TextServer_FontStyle>`\> value **)**
- |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``

.. rst-class:: classref-property-setget

- void **set_font_weight** **(** :ref:`int<class_int>` value **)**
- :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``

.. rst-class:: classref-property-setget

- void **set_force_autohinter** **(** :ref:`bool<class_bool>` value **)**
- :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``

.. rst-class:: classref-property-setget

- void **set_generate_mipmaps** **(** :ref:`bool<class_bool>` value **)**
- :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``

.. rst-class:: classref-property-setget

- void **set_hinting** **(** :ref:`Hinting<enum_TextServer_Hinting>` value **)**
- :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``

.. rst-class:: classref-property-setget

- void **set_msdf_pixel_range** **(** :ref:`int<class_int>` value **)**
- :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``

.. rst-class:: classref-property-setget

- void **set_msdf_size** **(** :ref:`int<class_int>` value **)**
- :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``

.. rst-class:: classref-property-setget

- void **set_multichannel_signed_distance_field** **(** :ref:`bool<class_bool>` value **)**
- :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** = ``{}``

.. rst-class:: classref-property-setget

- void **set_opentype_feature_overrides** **(** :ref:`Dictionary<class_Dictionary>` value **)**
- :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``

.. rst-class:: classref-property-setget

- void **set_oversampling** **(** :ref:`float<class_float>` value **)**
- :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** = ``""``

.. rst-class:: classref-property-setget

- void **set_font_style_name** **(** :ref:`String<class_String>` value **)**
- :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``

.. rst-class:: classref-property-setget

- void **set_subpixel_positioning** **(** :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` value **)**
- :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** **(** **)**

Removes all font cache entries.

.. rst-class:: classref-item-separator

----

.. _class_FontFile_method_clear_glyphs:

.. rst-class:: classref-method

void **clear_glyphs** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size **)**

Removes all rendered glyphs 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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)**

Removes all kerning overrides.

.. rst-class:: classref-item-separator

----

.. _class_FontFile_method_clear_size_cache:

.. rst-class:: classref-method

void **clear_size_cache** **(** :ref:`int<class_int>` cache_index **)**

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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size **)**

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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |const|

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|

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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |const|

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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |const|

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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |const|

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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |const|

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** **(** :ref:`int<class_int>` size, :ref:`int<class_int>` glyph_index **)** |const|

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** **(** :ref:`int<class_int>` cache_index **)** |const|

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_spacing:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_extra_spacing** **(** :ref:`int<class_int>` cache_index, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |const|

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** **(** :ref:`int<class_int>` cache_index **)** |const|

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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph **)** |const|

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** **(** :ref:`int<class_int>` size, :ref:`int<class_int>` char, :ref:`int<class_int>` variation_selector **)** |const|

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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size **)** |const|

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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|

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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|

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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|

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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|

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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)** |const|

Returns kerning for the pair of glyphs.

.. rst-class:: classref-item-separator

----

.. _class_FontFile_method_get_kerning_list:

.. rst-class:: classref-method

:ref:`Vector2i[]<class_Vector2i>` **get_kerning_list** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |const|

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** **(** :ref:`String<class_String>` language **)** |const|

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|

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** **(** :ref:`String<class_String>` script **)** |const|

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|

Returns list of script support overrides.

.. rst-class:: classref-item-separator

----

.. _class_FontFile_method_get_size_cache_list:

.. rst-class:: classref-method

:ref:`Vector2i[]<class_Vector2i>` **get_size_cache_list** **(** :ref:`int<class_int>` cache_index **)** |const|

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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size **)** |const|

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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |const|

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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |const|

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** **(** :ref:`int<class_int>` cache_index **)** |const|

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** **(** :ref:`int<class_int>` cache_index **)** |const|

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** **(** :ref:`String<class_String>` path **)**

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** **(** :ref:`String<class_String>` path **)**

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** **(** :ref:`int<class_int>` cache_index **)**

Removes specified font cache entry.

.. rst-class:: classref-item-separator

----

.. _class_FontFile_method_remove_glyph:

.. rst-class:: classref-method

void **remove_glyph** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` 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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)**

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** **(** :ref:`String<class_String>` language **)**

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** **(** :ref:`String<class_String>` script **)**

Removes script support override.

.. rst-class:: classref-item-separator

----

.. _class_FontFile_method_remove_size_cache:

.. rst-class:: classref-method

void **remove_size_cache** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size **)**

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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)**

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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` index **)**

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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)**

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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`float<class_float>` 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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`float<class_float>` 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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`float<class_float>` 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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`float<class_float>` 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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`float<class_float>` 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** **(** :ref:`int<class_int>` cache_index, :ref:`float<class_float>` strength **)**

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_spacing:

.. rst-class:: classref-method

void **set_extra_spacing** **(** :ref:`int<class_int>` cache_index, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)**

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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` 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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` 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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` 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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` gl_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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`int<class_int>` 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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Rect2<class_Rect2>` 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** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair, :ref:`Vector2<class_Vector2>` 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** **(** :ref:`String<class_String>` language, :ref:`bool<class_bool>` supported **)**

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** **(** :ref:`String<class_String>` script, :ref:`bool<class_bool>` supported **)**

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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index, :ref:`Image<class_Image>` 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** **(** :ref:`int<class_int>` cache_index, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index, :ref:`PackedInt32Array<class_PackedInt32Array>` offset **)**

Sets array containing glyph packing data.

.. rst-class:: classref-item-separator

----

.. _class_FontFile_method_set_transform:

.. rst-class:: classref-method

void **set_transform** **(** :ref:`int<class_int>` cache_index, :ref:`Transform2D<class_Transform2D>` 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** **(** :ref:`int<class_int>` cache_index, :ref:`Dictionary<class_Dictionary>` 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.)`