class_dynamicfontdata.rst 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the DynamicFontData.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_DynamicFontData:
  5. DynamicFontData
  6. ===============
  7. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Used with :ref:`DynamicFont<class_DynamicFont>` to describe the location of a font file.
  12. Properties
  13. ----------
  14. +----------------------------------------------+---------------------------------------------------+
  15. | :ref:`String<class_String>` | :ref:`font_path<class_DynamicFontData_font_path>` |
  16. +----------------------------------------------+---------------------------------------------------+
  17. | :ref:`Hinting<enum_DynamicFontData_Hinting>` | :ref:`hinting<class_DynamicFontData_hinting>` |
  18. +----------------------------------------------+---------------------------------------------------+
  19. Enumerations
  20. ------------
  21. .. _enum_DynamicFontData_Hinting:
  22. enum **Hinting**:
  23. - **HINTING_NONE** = **0** --- Disable font hinting (smoother but less crisp).
  24. - **HINTING_LIGHT** = **1** --- Use the light font hinting mode.
  25. - **HINTING_NORMAL** = **2** --- Use the default font hinting mode (crisper but less smooth).
  26. Description
  27. -----------
  28. Used with :ref:`DynamicFont<class_DynamicFont>` to describe the location of a vector font file for dynamic rendering at runtime.
  29. Property Descriptions
  30. ---------------------
  31. .. _class_DynamicFontData_font_path:
  32. - :ref:`String<class_String>` **font_path**
  33. +----------+----------------------+
  34. | *Setter* | set_font_path(value) |
  35. +----------+----------------------+
  36. | *Getter* | get_font_path() |
  37. +----------+----------------------+
  38. The path to the vector font file.
  39. .. _class_DynamicFontData_hinting:
  40. - :ref:`Hinting<enum_DynamicFontData_Hinting>` **hinting**
  41. +----------+--------------------+
  42. | *Setter* | set_hinting(value) |
  43. +----------+--------------------+
  44. | *Getter* | get_hinting() |
  45. +----------+--------------------+
  46. The font hinting mode used by FreeType.