class_dynamicfont.rst 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the DynamicFont.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_DynamicFont:
  5. DynamicFont
  6. ===========
  7. **Inherits:** :ref:`Font<class_font>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Member Functions
  12. ----------------
  13. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  14. | void | :ref:`add_fallback<class_DynamicFont_add_fallback>` **(** :ref:`DynamicFontData<class_dynamicfontdata>` data **)** |
  15. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`DynamicFontData<class_dynamicfontdata>` | :ref:`get_fallback<class_DynamicFont_get_fallback>` **(** :ref:`int<class_int>` idx **)** const |
  17. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`int<class_int>` | :ref:`get_fallback_count<class_DynamicFont_get_fallback_count>` **(** **)** const |
  19. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`DynamicFontData<class_dynamicfontdata>` | :ref:`get_font_data<class_DynamicFont_get_font_data>` **(** **)** const |
  21. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`int<class_int>` | :ref:`get_size<class_DynamicFont_get_size>` **(** **)** const |
  23. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`int<class_int>` | :ref:`get_spacing<class_DynamicFont_get_spacing>` **(** :ref:`int<class_int>` type **)** const |
  25. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`bool<class_bool>` | :ref:`get_use_filter<class_DynamicFont_get_use_filter>` **(** **)** const |
  27. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`bool<class_bool>` | :ref:`get_use_mipmaps<class_DynamicFont_get_use_mipmaps>` **(** **)** const |
  29. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | void | :ref:`remove_fallback<class_DynamicFont_remove_fallback>` **(** :ref:`int<class_int>` idx **)** |
  31. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | void | :ref:`set_fallback<class_DynamicFont_set_fallback>` **(** :ref:`int<class_int>` idx, :ref:`DynamicFontData<class_dynamicfontdata>` data **)** |
  33. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | void | :ref:`set_font_data<class_DynamicFont_set_font_data>` **(** :ref:`DynamicFontData<class_dynamicfontdata>` data **)** |
  35. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | void | :ref:`set_size<class_DynamicFont_set_size>` **(** :ref:`int<class_int>` data **)** |
  37. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | void | :ref:`set_spacing<class_DynamicFont_set_spacing>` **(** :ref:`int<class_int>` type, :ref:`int<class_int>` value **)** |
  39. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | void | :ref:`set_use_filter<class_DynamicFont_set_use_filter>` **(** :ref:`bool<class_bool>` enable **)** |
  41. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | void | :ref:`set_use_mipmaps<class_DynamicFont_set_use_mipmaps>` **(** :ref:`bool<class_bool>` enable **)** |
  43. +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  44. Member Variables
  45. ----------------
  46. - :ref:`int<class_int>` **extra_spacing_bottom**
  47. - :ref:`int<class_int>` **extra_spacing_char**
  48. - :ref:`int<class_int>` **extra_spacing_space**
  49. - :ref:`int<class_int>` **extra_spacing_top**
  50. - :ref:`DynamicFontData<class_dynamicfontdata>` **font_data**
  51. - :ref:`int<class_int>` **size**
  52. - :ref:`bool<class_bool>` **use_filter**
  53. - :ref:`bool<class_bool>` **use_mipmaps**
  54. Numeric Constants
  55. -----------------
  56. - **SPACING_TOP** = **0**
  57. - **SPACING_BOTTOM** = **1**
  58. - **SPACING_CHAR** = **2**
  59. - **SPACING_SPACE** = **3**
  60. Member Function Description
  61. ---------------------------
  62. .. _class_DynamicFont_add_fallback:
  63. - void **add_fallback** **(** :ref:`DynamicFontData<class_dynamicfontdata>` data **)**
  64. .. _class_DynamicFont_get_fallback:
  65. - :ref:`DynamicFontData<class_dynamicfontdata>` **get_fallback** **(** :ref:`int<class_int>` idx **)** const
  66. .. _class_DynamicFont_get_fallback_count:
  67. - :ref:`int<class_int>` **get_fallback_count** **(** **)** const
  68. .. _class_DynamicFont_get_font_data:
  69. - :ref:`DynamicFontData<class_dynamicfontdata>` **get_font_data** **(** **)** const
  70. .. _class_DynamicFont_get_size:
  71. - :ref:`int<class_int>` **get_size** **(** **)** const
  72. .. _class_DynamicFont_get_spacing:
  73. - :ref:`int<class_int>` **get_spacing** **(** :ref:`int<class_int>` type **)** const
  74. .. _class_DynamicFont_get_use_filter:
  75. - :ref:`bool<class_bool>` **get_use_filter** **(** **)** const
  76. .. _class_DynamicFont_get_use_mipmaps:
  77. - :ref:`bool<class_bool>` **get_use_mipmaps** **(** **)** const
  78. .. _class_DynamicFont_remove_fallback:
  79. - void **remove_fallback** **(** :ref:`int<class_int>` idx **)**
  80. .. _class_DynamicFont_set_fallback:
  81. - void **set_fallback** **(** :ref:`int<class_int>` idx, :ref:`DynamicFontData<class_dynamicfontdata>` data **)**
  82. .. _class_DynamicFont_set_font_data:
  83. - void **set_font_data** **(** :ref:`DynamicFontData<class_dynamicfontdata>` data **)**
  84. .. _class_DynamicFont_set_size:
  85. - void **set_size** **(** :ref:`int<class_int>` data **)**
  86. .. _class_DynamicFont_set_spacing:
  87. - void **set_spacing** **(** :ref:`int<class_int>` type, :ref:`int<class_int>` value **)**
  88. .. _class_DynamicFont_set_use_filter:
  89. - void **set_use_filter** **(** :ref:`bool<class_bool>` enable **)**
  90. .. _class_DynamicFont_set_use_mipmaps:
  91. - void **set_use_mipmaps** **(** :ref:`bool<class_bool>` enable **)**