godot-docs/classes/class_dynamicfont.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the DynamicFont.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_DynamicFont:

DynamicFont
===========

**Inherits:** :ref:`Font<class_Font>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

DynamicFont renders vector font files at runtime.

Properties
----------

+-----------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>`                         | :ref:`extra_spacing_bottom<class_DynamicFont_property_extra_spacing_bottom>` | 0                   |
+-----------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>`                         | :ref:`extra_spacing_char<class_DynamicFont_property_extra_spacing_char>`     | 0                   |
+-----------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>`                         | :ref:`extra_spacing_space<class_DynamicFont_property_extra_spacing_space>`   | 0                   |
+-----------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>`                         | :ref:`extra_spacing_top<class_DynamicFont_property_extra_spacing_top>`       | 0                   |
+-----------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`DynamicFontData<class_DynamicFontData>` | :ref:`font_data<class_DynamicFont_property_font_data>`                       |                     |
+-----------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`Color<class_Color>`                     | :ref:`outline_color<class_DynamicFont_property_outline_color>`               | Color( 1, 1, 1, 1 ) |
+-----------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>`                         | :ref:`outline_size<class_DynamicFont_property_outline_size>`                 | 0                   |
+-----------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`int<class_int>`                         | :ref:`size<class_DynamicFont_property_size>`                                 | 16                  |
+-----------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`bool<class_bool>`                       | :ref:`use_filter<class_DynamicFont_property_use_filter>`                     | false               |
+-----------------------------------------------+------------------------------------------------------------------------------+---------------------+
| :ref:`bool<class_bool>`                       | :ref:`use_mipmaps<class_DynamicFont_property_use_mipmaps>`                   | false               |
+-----------------------------------------------+------------------------------------------------------------------------------+---------------------+

Methods
-------

+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`add_fallback<class_DynamicFont_method_add_fallback>` **(** :ref:`DynamicFontData<class_DynamicFontData>` data **)**                            |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`DynamicFontData<class_DynamicFontData>` | :ref:`get_fallback<class_DynamicFont_method_get_fallback>` **(** :ref:`int<class_int>` idx **)** const                                               |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`get_fallback_count<class_DynamicFont_method_get_fallback_count>` **(** **)** const                                                             |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`get_spacing<class_DynamicFont_method_get_spacing>` **(** :ref:`int<class_int>` type **)** const                                                |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`remove_fallback<class_DynamicFont_method_remove_fallback>` **(** :ref:`int<class_int>` idx **)**                                               |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_fallback<class_DynamicFont_method_set_fallback>` **(** :ref:`int<class_int>` idx, :ref:`DynamicFontData<class_DynamicFontData>` data **)** |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`set_spacing<class_DynamicFont_method_set_spacing>` **(** :ref:`int<class_int>` type, :ref:`int<class_int>` value **)**                         |
+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+

Enumerations
------------

.. _enum_DynamicFont_SpacingType:

.. _class_DynamicFont_constant_SPACING_TOP:

.. _class_DynamicFont_constant_SPACING_BOTTOM:

.. _class_DynamicFont_constant_SPACING_CHAR:

.. _class_DynamicFont_constant_SPACING_SPACE:

enum **SpacingType**:

- **SPACING_TOP** = **0** --- Spacing at the top.

- **SPACING_BOTTOM** = **1** --- Spacing at the bottom.

- **SPACING_CHAR** = **2** --- Character spacing.

- **SPACING_SPACE** = **3** --- Space spacing.

Description
-----------

DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like :ref:`BitmapFont<class_BitmapFont>`. This trades the faster loading time of :ref:`BitmapFont<class_BitmapFont>`\ s for the ability to change font parameters like size and spacing during runtime. :ref:`DynamicFontData<class_DynamicFontData>` is used for referencing the font file paths.

::

    var dynamic_font = DynamicFont.new()
    dynamic_font.font_data = load("res://BarlowCondensed-Bold.ttf")
    dynamic_font.size = 64
    $"Label".set("custom_fonts/font", dynamic_font)

Property Descriptions
---------------------

.. _class_DynamicFont_property_extra_spacing_bottom:

- :ref:`int<class_int>` **extra_spacing_bottom**

+-----------+--------------------+
| *Default* | 0                  |
+-----------+--------------------+
| *Setter*  | set_spacing(value) |
+-----------+--------------------+
| *Getter*  | get_spacing()      |
+-----------+--------------------+

Extra spacing at the bottom in pixels.

.. _class_DynamicFont_property_extra_spacing_char:

- :ref:`int<class_int>` **extra_spacing_char**

+-----------+--------------------+
| *Default* | 0                  |
+-----------+--------------------+
| *Setter*  | set_spacing(value) |
+-----------+--------------------+
| *Getter*  | get_spacing()      |
+-----------+--------------------+

Extra character spacing in pixels.

.. _class_DynamicFont_property_extra_spacing_space:

- :ref:`int<class_int>` **extra_spacing_space**

+-----------+--------------------+
| *Default* | 0                  |
+-----------+--------------------+
| *Setter*  | set_spacing(value) |
+-----------+--------------------+
| *Getter*  | get_spacing()      |
+-----------+--------------------+

Extra space spacing in pixels.

.. _class_DynamicFont_property_extra_spacing_top:

- :ref:`int<class_int>` **extra_spacing_top**

+-----------+--------------------+
| *Default* | 0                  |
+-----------+--------------------+
| *Setter*  | set_spacing(value) |
+-----------+--------------------+
| *Getter*  | get_spacing()      |
+-----------+--------------------+

Extra spacing at the top in pixels.

.. _class_DynamicFont_property_font_data:

- :ref:`DynamicFontData<class_DynamicFontData>` **font_data**

+----------+----------------------+
| *Setter* | set_font_data(value) |
+----------+----------------------+
| *Getter* | get_font_data()      |
+----------+----------------------+

The font data.

.. _class_DynamicFont_property_outline_color:

- :ref:`Color<class_Color>` **outline_color**

+-----------+--------------------------+
| *Default* | Color( 1, 1, 1, 1 )      |
+-----------+--------------------------+
| *Setter*  | set_outline_color(value) |
+-----------+--------------------------+
| *Getter*  | get_outline_color()      |
+-----------+--------------------------+

.. _class_DynamicFont_property_outline_size:

- :ref:`int<class_int>` **outline_size**

+-----------+-------------------------+
| *Default* | 0                       |
+-----------+-------------------------+
| *Setter*  | set_outline_size(value) |
+-----------+-------------------------+
| *Getter*  | get_outline_size()      |
+-----------+-------------------------+

.. _class_DynamicFont_property_size:

- :ref:`int<class_int>` **size**

+-----------+-----------------+
| *Default* | 16              |
+-----------+-----------------+
| *Setter*  | set_size(value) |
+-----------+-----------------+
| *Getter*  | get_size()      |
+-----------+-----------------+

The font size.

.. _class_DynamicFont_property_use_filter:

- :ref:`bool<class_bool>` **use_filter**

+-----------+-----------------------+
| *Default* | false                 |
+-----------+-----------------------+
| *Setter*  | set_use_filter(value) |
+-----------+-----------------------+
| *Getter*  | get_use_filter()      |
+-----------+-----------------------+

If ``true``, filtering is used.

.. _class_DynamicFont_property_use_mipmaps:

- :ref:`bool<class_bool>` **use_mipmaps**

+-----------+------------------------+
| *Default* | false                  |
+-----------+------------------------+
| *Setter*  | set_use_mipmaps(value) |
+-----------+------------------------+
| *Getter*  | get_use_mipmaps()      |
+-----------+------------------------+

If ``true``, mipmapping is used.

Method Descriptions
-------------------

.. _class_DynamicFont_method_add_fallback:

- void **add_fallback** **(** :ref:`DynamicFontData<class_DynamicFontData>` data **)**

Adds a fallback font.

.. _class_DynamicFont_method_get_fallback:

- :ref:`DynamicFontData<class_DynamicFontData>` **get_fallback** **(** :ref:`int<class_int>` idx **)** const

Returns the fallback font at index ``idx``.

.. _class_DynamicFont_method_get_fallback_count:

- :ref:`int<class_int>` **get_fallback_count** **(** **)** const

Returns the number of fallback fonts.

.. _class_DynamicFont_method_get_spacing:

- :ref:`int<class_int>` **get_spacing** **(** :ref:`int<class_int>` type **)** const

.. _class_DynamicFont_method_remove_fallback:

- void **remove_fallback** **(** :ref:`int<class_int>` idx **)**

Removes the fallback font at index ``idx``.

.. _class_DynamicFont_method_set_fallback:

- void **set_fallback** **(** :ref:`int<class_int>` idx, :ref:`DynamicFontData<class_DynamicFontData>` data **)**

Sets the fallback font at index ``idx``.

.. _class_DynamicFont_method_set_spacing:

- void **set_spacing** **(** :ref:`int<class_int>` type, :ref:`int<class_int>` value **)**