| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102 |
- :github_url: hide
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the DynamicFontData.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_DynamicFontData:
- DynamicFontData
- ===============
- **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
- Used with :ref:`DynamicFont<class_DynamicFont>` to describe the location of a font file.
- Description
- -----------
- Used with :ref:`DynamicFont<class_DynamicFont>` to describe the location of a vector font file for dynamic rendering at runtime.
- Properties
- ----------
- +----------------------------------------------+----------------------------------------------------------------+----------+
- | :ref:`bool<class_bool>` | :ref:`antialiased<class_DynamicFontData_property_antialiased>` | ``true`` |
- +----------------------------------------------+----------------------------------------------------------------+----------+
- | :ref:`String<class_String>` | :ref:`font_path<class_DynamicFontData_property_font_path>` | ``""`` |
- +----------------------------------------------+----------------------------------------------------------------+----------+
- | :ref:`Hinting<enum_DynamicFontData_Hinting>` | :ref:`hinting<class_DynamicFontData_property_hinting>` | ``2`` |
- +----------------------------------------------+----------------------------------------------------------------+----------+
- Enumerations
- ------------
- .. _enum_DynamicFontData_Hinting:
- .. _class_DynamicFontData_constant_HINTING_NONE:
- .. _class_DynamicFontData_constant_HINTING_LIGHT:
- .. _class_DynamicFontData_constant_HINTING_NORMAL:
- enum **Hinting**:
- - **HINTING_NONE** = **0** --- Disables font hinting (smoother but less crisp).
- - **HINTING_LIGHT** = **1** --- Use the light font hinting mode.
- - **HINTING_NORMAL** = **2** --- Use the default font hinting mode (crisper but less smooth).
- Property Descriptions
- ---------------------
- .. _class_DynamicFontData_property_antialiased:
- - :ref:`bool<class_bool>` **antialiased**
- +-----------+------------------------+
- | *Default* | ``true`` |
- +-----------+------------------------+
- | *Setter* | set_antialiased(value) |
- +-----------+------------------------+
- | *Getter* | is_antialiased() |
- +-----------+------------------------+
- If ``true``, the font is rendered with anti-aliasing. This property applies both to the main font and its outline (if it has one).
- ----
- .. _class_DynamicFontData_property_font_path:
- - :ref:`String<class_String>` **font_path**
- +-----------+----------------------+
- | *Default* | ``""`` |
- +-----------+----------------------+
- | *Setter* | set_font_path(value) |
- +-----------+----------------------+
- | *Getter* | get_font_path() |
- +-----------+----------------------+
- The path to the vector font file.
- ----
- .. _class_DynamicFontData_property_hinting:
- - :ref:`Hinting<enum_DynamicFontData_Hinting>` **hinting**
- +-----------+--------------------+
- | *Default* | ``2`` |
- +-----------+--------------------+
- | *Setter* | set_hinting(value) |
- +-----------+--------------------+
- | *Getter* | get_hinting() |
- +-----------+--------------------+
- The font hinting mode used by FreeType. See :ref:`Hinting<enum_DynamicFontData_Hinting>` for options.
- .. |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.)`
|
