mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-23 15:17:21 +01:00
127 lines
4.9 KiB
ReStructuredText
127 lines
4.9 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/DynamicFontData.xml.
|
|
|
|
.. _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.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- `3D Voxel Demo <https://godotengine.org/asset-library/asset/676>`__
|
|
|
|
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`` |
|
|
+----------------------------------------------+------------------------------------------------------------------------------------+----------+
|
|
| :ref:`float<class_float>` | :ref:`override_oversampling<class_DynamicFontData_property_override_oversampling>` | ``0.0`` |
|
|
+----------------------------------------------+------------------------------------------------------------------------------------+----------+
|
|
|
|
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.
|
|
|
|
----
|
|
|
|
.. _class_DynamicFontData_property_override_oversampling:
|
|
|
|
- :ref:`float<class_float>` **override_oversampling**
|
|
|
|
+-----------+----------------------------------+
|
|
| *Default* | ``0.0`` |
|
|
+-----------+----------------------------------+
|
|
| *Setter* | set_override_oversampling(value) |
|
|
+-----------+----------------------------------+
|
|
| *Getter* | get_override_oversampling() |
|
|
+-----------+----------------------------------+
|
|
|
|
If set to a value greater than ``0.0``, it will override default font oversampling, ignoring :ref:`SceneTree.use_font_oversampling<class_SceneTree_property_use_font_oversampling>` value and viewport stretch mode.
|
|
|
|
.. |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.)`
|