Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 3.1
Branches Tags
godot-docs
/
classes
/
class_font.rst

class_font.rst 9.8 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the Font.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_Font:
    8. 

  8. 

  9. Font
    10. 

  10. ====
    11. 

  11. 

  12. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Inherited By:** :ref:`BitmapFont<class_BitmapFont>`, :ref:`DynamicFont<class_DynamicFont>`
    15. 

  15. 

  16. **Category:** Core
    17. 

  17. 

  18. Brief Description
    19. 

  19. -----------------
    20. 

  20. 

  21. Internationalized font and text drawing support.
    22. 

  22. 

  23. Methods
    24. 

  24. -------
    25. 

  25. 

  26. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | void                          | :ref:`draw<class_Font_method_draw>` **(** :ref:`RID<class_RID>` canvas_item, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` string, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1, :ref:`Color<class_Color>` outline_modulate=Color( 1, 1, 1, 1 ) **)** const |
    28. 

  28. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`float<class_float>`     | :ref:`draw_char<class_Font_method_draw_char>` **(** :ref:`RID<class_RID>` canvas_item, :ref:`Vector2<class_Vector2>` position, :ref:`int<class_int>` char, :ref:`int<class_int>` next=-1, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` outline=false **)** const                          |
    30. 

  30. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`float<class_float>`     | :ref:`get_ascent<class_Font_method_get_ascent>` **(** **)** const                                                                                                                                                                                                                                                            |
    32. 

  32. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`float<class_float>`     | :ref:`get_descent<class_Font_method_get_descent>` **(** **)** const                                                                                                                                                                                                                                                          |
    34. 

  34. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`float<class_float>`     | :ref:`get_height<class_Font_method_get_height>` **(** **)** const                                                                                                                                                                                                                                                            |
    36. 

  36. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`Vector2<class_Vector2>` | :ref:`get_string_size<class_Font_method_get_string_size>` **(** :ref:`String<class_String>` string **)** const                                                                                                                                                                                                               |
    38. 

  38. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`bool<class_bool>`       | :ref:`has_outline<class_Font_method_has_outline>` **(** **)** const                                                                                                                                                                                                                                                          |
    40. 

  40. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | :ref:`bool<class_bool>`       | :ref:`is_distance_field_hint<class_Font_method_is_distance_field_hint>` **(** **)** const                                                                                                                                                                                                                                    |
    42. 

  42. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. | void                          | :ref:`update_changes<class_Font_method_update_changes>` **(** **)**                                                                                                                                                                                                                                                          |
    44. 

  44. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. 

  46. Description
    47. 

  47. -----------
    48. 

  48. 

  49. Font contains a unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts.
    50. 

  50. 

  51. Method Descriptions
    52. 

  52. -------------------
    53. 

  53. 

  54. .. _class_Font_method_draw:
    55. 

  55. 

  56. - void **draw** **(** :ref:`RID<class_RID>` canvas_item, :ref:`Vector2<class_Vector2>` position, :ref:`String<class_String>` string, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`int<class_int>` clip_w=-1, :ref:`Color<class_Color>` outline_modulate=Color( 1, 1, 1, 1 ) **)** const
    57. 

  57. 

  58. Draw "string" into a canvas item using the font at a given position, with "modulate" color, and optionally clipping the width. "position" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis.
    59. 

  59. 

  60. ----
    61. 

  61. 

  62. .. _class_Font_method_draw_char:
    63. 

  63. 

  64. - :ref:`float<class_float>` **draw_char** **(** :ref:`RID<class_RID>` canvas_item, :ref:`Vector2<class_Vector2>` position, :ref:`int<class_int>` char, :ref:`int<class_int>` next=-1, :ref:`Color<class_Color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` outline=false **)** const
    65. 

  65. 

  66. Draw character "char" into a canvas item using the font at a given position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "position" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character.
    67. 

  67. 

  68. ----
    69. 

  69. 

  70. .. _class_Font_method_get_ascent:
    71. 

  71. 

  72. - :ref:`float<class_float>` **get_ascent** **(** **)** const
    73. 

  73. 

  74. Returns the font ascent (number of pixels above the baseline).
    75. 

  75. 

  76. ----
    77. 

  77. 

  78. .. _class_Font_method_get_descent:
    79. 

  79. 

  80. - :ref:`float<class_float>` **get_descent** **(** **)** const
    81. 

  81. 

  82. Returns the font descent (number of pixels below the baseline).
    83. 

  83. 

  84. ----
    85. 

  85. 

  86. .. _class_Font_method_get_height:
    87. 

  87. 

  88. - :ref:`float<class_float>` **get_height** **(** **)** const
    89. 

  89. 

  90. Returns the total font height (ascent plus descent) in pixels.
    91. 

  91. 

  92. ----
    93. 

  93. 

  94. .. _class_Font_method_get_string_size:
    95. 

  95. 

  96. - :ref:`Vector2<class_Vector2>` **get_string_size** **(** :ref:`String<class_String>` string **)** const
    97. 

  97. 

  98. Returns the size of a string, taking kerning and advance into account.
    99. 

  99. 

  100. ----
    101. 

  101. 

  102. .. _class_Font_method_has_outline:
    103. 

  103. 

  104. - :ref:`bool<class_bool>` **has_outline** **(** **)** const
    105. 

  105. 

  106. ----
    107. 

  107. 

  108. .. _class_Font_method_is_distance_field_hint:
    109. 

  109. 

  110. - :ref:`bool<class_bool>` **is_distance_field_hint** **(** **)** const
    111. 

  111. 

  112. ----
    113. 

  113. 

  114. .. _class_Font_method_update_changes:
    115. 

  115. 

  116. - void **update_changes** **(** **)**
    117. 

  117. 

  118. After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it.
    119. 

  119.