class_textserverextension.rst 202 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the TextServerExtension.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_TextServerExtension:
  6. TextServerExtension
  7. ===================
  8. **Inherits:** :ref:`TextServer<class_TextServer>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Base class for TextServer custom implementations (plugins).
  10. Description
  11. -----------
  12. External TextServer implementations should inherit from this class.
  13. Methods
  14. -------
  15. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | :ref:`RID<class_RID>` | :ref:`_create_font<class_TextServerExtension_method__create_font>` **(** **)** |virtual| |
  17. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`RID<class_RID>` | :ref:`_create_shaped_text<class_TextServerExtension_method__create_shaped_text>` **(** :ref:`Direction<enum_TextServer_Direction>` direction, :ref:`Orientation<enum_TextServer_Orientation>` orientation **)** |virtual| |
  19. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | void | :ref:`_draw_hex_code_box<class_TextServerExtension_method__draw_hex_code_box>` **(** :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` size, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)** |virtual| |const| |
  21. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`_font_clear_glyphs<class_TextServerExtension_method__font_clear_glyphs>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |virtual| |
  23. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`_font_clear_kerning_map<class_TextServerExtension_method__font_clear_kerning_map>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |virtual| |
  25. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | void | :ref:`_font_clear_size_cache<class_TextServerExtension_method__font_clear_size_cache>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |
  27. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | void | :ref:`_font_clear_textures<class_TextServerExtension_method__font_clear_textures>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |virtual| |
  29. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | void | :ref:`_font_draw_glyph<class_TextServerExtension_method__font_draw_glyph>` **(** :ref:`RID<class_RID>` font_rid, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` size, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)** |virtual| |const| |
  31. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | void | :ref:`_font_draw_glyph_outline<class_TextServerExtension_method__font_draw_glyph_outline>` **(** :ref:`RID<class_RID>` font_rid, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` size, :ref:`int<class_int>` outline_size, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)** |virtual| |const| |
  33. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | :ref:`float<class_float>` | :ref:`_font_get_ascent<class_TextServerExtension_method__font_get_ascent>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |virtual| |const| |
  35. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`float<class_float>` | :ref:`_font_get_descent<class_TextServerExtension_method__font_get_descent>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |virtual| |const| |
  37. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | :ref:`float<class_float>` | :ref:`_font_get_embolden<class_TextServerExtension_method__font_get_embolden>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  39. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`int<class_int>` | :ref:`_font_get_fixed_size<class_TextServerExtension_method__font_get_fixed_size>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  41. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`float<class_float>` | :ref:`_font_get_global_oversampling<class_TextServerExtension_method__font_get_global_oversampling>` **(** **)** |virtual| |const| |
  43. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`Vector2<class_Vector2>` | :ref:`_font_get_glyph_advance<class_TextServerExtension_method__font_get_glyph_advance>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph **)** |virtual| |const| |
  45. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`Dictionary<class_Dictionary>` | :ref:`_font_get_glyph_contours<class_TextServerExtension_method__font_get_glyph_contours>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |virtual| |const| |
  47. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`int<class_int>` | :ref:`_font_get_glyph_index<class_TextServerExtension_method__font_get_glyph_index>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` char, :ref:`int<class_int>` variation_selector **)** |virtual| |const| |
  49. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`Array<class_Array>` | :ref:`_font_get_glyph_list<class_TextServerExtension_method__font_get_glyph_list>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |virtual| |const| |
  51. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | :ref:`Vector2<class_Vector2>` | :ref:`_font_get_glyph_offset<class_TextServerExtension_method__font_get_glyph_offset>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |virtual| |const| |
  53. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :ref:`Vector2<class_Vector2>` | :ref:`_font_get_glyph_size<class_TextServerExtension_method__font_get_glyph_size>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |virtual| |const| |
  55. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`int<class_int>` | :ref:`_font_get_glyph_texture_idx<class_TextServerExtension_method__font_get_glyph_texture_idx>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |virtual| |const| |
  57. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`Rect2<class_Rect2>` | :ref:`_font_get_glyph_uv_rect<class_TextServerExtension_method__font_get_glyph_uv_rect>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |virtual| |const| |
  59. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | :ref:`Hinting<enum_TextServer_Hinting>` | :ref:`_font_get_hinting<class_TextServerExtension_method__font_get_hinting>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  61. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`Vector2<class_Vector2>` | :ref:`_font_get_kerning<class_TextServerExtension_method__font_get_kerning>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)** |virtual| |const| |
  63. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`Array<class_Array>` | :ref:`_font_get_kerning_list<class_TextServerExtension_method__font_get_kerning_list>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |virtual| |const| |
  65. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`bool<class_bool>` | :ref:`_font_get_language_support_override<class_TextServerExtension_method__font_get_language_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |virtual| |
  67. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`_font_get_language_support_overrides<class_TextServerExtension_method__font_get_language_support_overrides>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |
  69. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :ref:`int<class_int>` | :ref:`_font_get_msdf_pixel_range<class_TextServerExtension_method__font_get_msdf_pixel_range>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  71. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :ref:`int<class_int>` | :ref:`_font_get_msdf_size<class_TextServerExtension_method__font_get_msdf_size>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  73. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :ref:`String<class_String>` | :ref:`_font_get_name<class_TextServerExtension_method__font_get_name>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  75. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | :ref:`Dictionary<class_Dictionary>` | :ref:`_font_get_opentype_feature_overrides<class_TextServerExtension_method__font_get_opentype_feature_overrides>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  77. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :ref:`float<class_float>` | :ref:`_font_get_oversampling<class_TextServerExtension_method__font_get_oversampling>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  79. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | :ref:`float<class_float>` | :ref:`_font_get_scale<class_TextServerExtension_method__font_get_scale>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |virtual| |const| |
  81. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | :ref:`bool<class_bool>` | :ref:`_font_get_script_support_override<class_TextServerExtension_method__font_get_script_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |virtual| |
  83. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`_font_get_script_support_overrides<class_TextServerExtension_method__font_get_script_support_overrides>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |
  85. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | :ref:`Array<class_Array>` | :ref:`_font_get_size_cache_list<class_TextServerExtension_method__font_get_size_cache_list>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  87. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | :ref:`int<class_int>` | :ref:`_font_get_spacing<class_TextServerExtension_method__font_get_spacing>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |virtual| |const| |
  89. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :ref:`int<class_int>` | :ref:`_font_get_style<class_TextServerExtension_method__font_get_style>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  91. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | :ref:`String<class_String>` | :ref:`_font_get_style_name<class_TextServerExtension_method__font_get_style_name>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  93. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` | :ref:`_font_get_subpixel_positioning<class_TextServerExtension_method__font_get_subpixel_positioning>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  95. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | :ref:`String<class_String>` | :ref:`_font_get_supported_chars<class_TextServerExtension_method__font_get_supported_chars>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  97. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | :ref:`int<class_int>` | :ref:`_font_get_texture_count<class_TextServerExtension_method__font_get_texture_count>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |virtual| |const| |
  99. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | :ref:`Image<class_Image>` | :ref:`_font_get_texture_image<class_TextServerExtension_method__font_get_texture_image>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |virtual| |const| |
  101. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`_font_get_texture_offsets<class_TextServerExtension_method__font_get_texture_offsets>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |virtual| |const| |
  103. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | :ref:`Transform2D<class_Transform2D>` | :ref:`_font_get_transform<class_TextServerExtension_method__font_get_transform>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  105. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | :ref:`float<class_float>` | :ref:`_font_get_underline_position<class_TextServerExtension_method__font_get_underline_position>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |virtual| |const| |
  107. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | :ref:`float<class_float>` | :ref:`_font_get_underline_thickness<class_TextServerExtension_method__font_get_underline_thickness>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |virtual| |const| |
  109. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | :ref:`Dictionary<class_Dictionary>` | :ref:`_font_get_variation_coordinates<class_TextServerExtension_method__font_get_variation_coordinates>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  111. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | :ref:`bool<class_bool>` | :ref:`_font_has_char<class_TextServerExtension_method__font_has_char>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` char **)** |virtual| |const| |
  113. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | :ref:`bool<class_bool>` | :ref:`_font_is_antialiased<class_TextServerExtension_method__font_is_antialiased>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  115. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | :ref:`bool<class_bool>` | :ref:`_font_is_force_autohinter<class_TextServerExtension_method__font_is_force_autohinter>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  117. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | :ref:`bool<class_bool>` | :ref:`_font_is_language_supported<class_TextServerExtension_method__font_is_language_supported>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |virtual| |const| |
  119. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | :ref:`bool<class_bool>` | :ref:`_font_is_multichannel_signed_distance_field<class_TextServerExtension_method__font_is_multichannel_signed_distance_field>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  121. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | :ref:`bool<class_bool>` | :ref:`_font_is_script_supported<class_TextServerExtension_method__font_is_script_supported>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |virtual| |const| |
  123. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | void | :ref:`_font_remove_glyph<class_TextServerExtension_method__font_remove_glyph>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |virtual| |
  125. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | void | :ref:`_font_remove_kerning<class_TextServerExtension_method__font_remove_kerning>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)** |virtual| |
  127. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | void | :ref:`_font_remove_language_support_override<class_TextServerExtension_method__font_remove_language_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |virtual| |
  129. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | void | :ref:`_font_remove_script_support_override<class_TextServerExtension_method__font_remove_script_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |virtual| |
  131. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | void | :ref:`_font_remove_size_cache<class_TextServerExtension_method__font_remove_size_cache>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |virtual| |
  133. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | void | :ref:`_font_remove_texture<class_TextServerExtension_method__font_remove_texture>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |virtual| |
  135. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. | void | :ref:`_font_render_glyph<class_TextServerExtension_method__font_render_glyph>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` index **)** |virtual| |
  137. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  138. | void | :ref:`_font_render_range<class_TextServerExtension_method__font_render_range>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |virtual| |
  139. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  140. | void | :ref:`_font_set_antialiased<class_TextServerExtension_method__font_set_antialiased>` **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` antialiased **)** |virtual| |
  141. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  142. | void | :ref:`_font_set_ascent<class_TextServerExtension_method__font_set_ascent>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` ascent **)** |virtual| |
  143. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  144. | void | :ref:`_font_set_data<class_TextServerExtension_method__font_set_data>` **(** :ref:`RID<class_RID>` font_rid, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |virtual| |
  145. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  146. | void | :ref:`_font_set_data_ptr<class_TextServerExtension_method__font_set_data_ptr>` **(** :ref:`RID<class_RID>` font_rid, const uint8_t* data_ptr, :ref:`int<class_int>` data_size **)** |virtual| |
  147. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  148. | void | :ref:`_font_set_descent<class_TextServerExtension_method__font_set_descent>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` descent **)** |virtual| |
  149. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  150. | void | :ref:`_font_set_embolden<class_TextServerExtension_method__font_set_embolden>` **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` strength **)** |virtual| |
  151. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  152. | void | :ref:`_font_set_fixed_size<class_TextServerExtension_method__font_set_fixed_size>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` fixed_size **)** |virtual| |
  153. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  154. | void | :ref:`_font_set_force_autohinter<class_TextServerExtension_method__font_set_force_autohinter>` **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` force_autohinter **)** |virtual| |
  155. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  156. | void | :ref:`_font_set_global_oversampling<class_TextServerExtension_method__font_set_global_oversampling>` **(** :ref:`float<class_float>` oversampling **)** |virtual| |
  157. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  158. | void | :ref:`_font_set_glyph_advance<class_TextServerExtension_method__font_set_glyph_advance>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` advance **)** |virtual| |
  159. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  160. | void | :ref:`_font_set_glyph_offset<class_TextServerExtension_method__font_set_glyph_offset>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` offset **)** |virtual| |
  161. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  162. | void | :ref:`_font_set_glyph_size<class_TextServerExtension_method__font_set_glyph_size>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` gl_size **)** |virtual| |
  163. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  164. | void | :ref:`_font_set_glyph_texture_idx<class_TextServerExtension_method__font_set_glyph_texture_idx>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`int<class_int>` texture_idx **)** |virtual| |
  165. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  166. | void | :ref:`_font_set_glyph_uv_rect<class_TextServerExtension_method__font_set_glyph_uv_rect>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Rect2<class_Rect2>` uv_rect **)** |virtual| |
  167. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  168. | void | :ref:`_font_set_hinting<class_TextServerExtension_method__font_set_hinting>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Hinting<enum_TextServer_Hinting>` hinting **)** |virtual| |
  169. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  170. | void | :ref:`_font_set_kerning<class_TextServerExtension_method__font_set_kerning>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair, :ref:`Vector2<class_Vector2>` kerning **)** |virtual| |
  171. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  172. | void | :ref:`_font_set_language_support_override<class_TextServerExtension_method__font_set_language_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language, :ref:`bool<class_bool>` supported **)** |virtual| |
  173. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  174. | void | :ref:`_font_set_msdf_pixel_range<class_TextServerExtension_method__font_set_msdf_pixel_range>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_pixel_range **)** |virtual| |
  175. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  176. | void | :ref:`_font_set_msdf_size<class_TextServerExtension_method__font_set_msdf_size>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_size **)** |virtual| |
  177. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  178. | void | :ref:`_font_set_multichannel_signed_distance_field<class_TextServerExtension_method__font_set_multichannel_signed_distance_field>` **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` msdf **)** |virtual| |
  179. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  180. | void | :ref:`_font_set_name<class_TextServerExtension_method__font_set_name>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)** |virtual| |
  181. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  182. | void | :ref:`_font_set_opentype_feature_overrides<class_TextServerExtension_method__font_set_opentype_feature_overrides>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` overrides **)** |virtual| |
  183. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  184. | void | :ref:`_font_set_oversampling<class_TextServerExtension_method__font_set_oversampling>` **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` oversampling **)** |virtual| |
  185. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  186. | void | :ref:`_font_set_scale<class_TextServerExtension_method__font_set_scale>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` scale **)** |virtual| |
  187. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  188. | void | :ref:`_font_set_script_support_override<class_TextServerExtension_method__font_set_script_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script, :ref:`bool<class_bool>` supported **)** |virtual| |
  189. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  190. | void | :ref:`_font_set_spacing<class_TextServerExtension_method__font_set_spacing>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)** |virtual| |
  191. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  192. | void | :ref:`_font_set_style<class_TextServerExtension_method__font_set_style>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` style **)** |virtual| |
  193. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  194. | void | :ref:`_font_set_style_name<class_TextServerExtension_method__font_set_style_name>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name_style **)** |virtual| |
  195. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  196. | void | :ref:`_font_set_subpixel_positioning<class_TextServerExtension_method__font_set_subpixel_positioning>` **(** :ref:`RID<class_RID>` font_rid, :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` subpixel_positioning **)** |virtual| |
  197. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  198. | void | :ref:`_font_set_texture_image<class_TextServerExtension_method__font_set_texture_image>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index, :ref:`Image<class_Image>` image **)** |virtual| |
  199. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  200. | void | :ref:`_font_set_texture_offsets<class_TextServerExtension_method__font_set_texture_offsets>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index, :ref:`PackedInt32Array<class_PackedInt32Array>` offset **)** |virtual| |
  201. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  202. | void | :ref:`_font_set_transform<class_TextServerExtension_method__font_set_transform>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Transform2D<class_Transform2D>` transform **)** |virtual| |
  203. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  204. | void | :ref:`_font_set_underline_position<class_TextServerExtension_method__font_set_underline_position>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_position **)** |virtual| |
  205. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  206. | void | :ref:`_font_set_underline_thickness<class_TextServerExtension_method__font_set_underline_thickness>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_thickness **)** |virtual| |
  207. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  208. | void | :ref:`_font_set_variation_coordinates<class_TextServerExtension_method__font_set_variation_coordinates>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` variation_coordinates **)** |virtual| |
  209. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  210. | :ref:`Dictionary<class_Dictionary>` | :ref:`_font_supported_feature_list<class_TextServerExtension_method__font_supported_feature_list>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  211. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  212. | :ref:`Dictionary<class_Dictionary>` | :ref:`_font_supported_variation_list<class_TextServerExtension_method__font_supported_variation_list>` **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const| |
  213. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  214. | :ref:`String<class_String>` | :ref:`_format_number<class_TextServerExtension_method__format_number>` **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language **)** |virtual| |const| |
  215. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  216. | void | :ref:`_free<class_TextServerExtension_method__free>` **(** :ref:`RID<class_RID>` rid **)** |virtual| |
  217. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  218. | :ref:`int<class_int>` | :ref:`_get_features<class_TextServerExtension_method__get_features>` **(** **)** |virtual| |const| |
  219. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  220. | :ref:`Vector2<class_Vector2>` | :ref:`_get_hex_code_box_size<class_TextServerExtension_method__get_hex_code_box_size>` **(** :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |virtual| |const| |
  221. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  222. | :ref:`String<class_String>` | :ref:`_get_name<class_TextServerExtension_method__get_name>` **(** **)** |virtual| |const| |
  223. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  224. | :ref:`String<class_String>` | :ref:`_get_support_data_filename<class_TextServerExtension_method__get_support_data_filename>` **(** **)** |virtual| |const| |
  225. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  226. | :ref:`String<class_String>` | :ref:`_get_support_data_info<class_TextServerExtension_method__get_support_data_info>` **(** **)** |virtual| |const| |
  227. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  228. | :ref:`bool<class_bool>` | :ref:`_has<class_TextServerExtension_method__has>` **(** :ref:`RID<class_RID>` rid **)** |virtual| |
  229. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  230. | :ref:`bool<class_bool>` | :ref:`_has_feature<class_TextServerExtension_method__has_feature>` **(** :ref:`Feature<enum_TextServer_Feature>` feature **)** |virtual| |const| |
  231. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  232. | :ref:`bool<class_bool>` | :ref:`_is_locale_right_to_left<class_TextServerExtension_method__is_locale_right_to_left>` **(** :ref:`String<class_String>` locale **)** |virtual| |const| |
  233. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  234. | :ref:`bool<class_bool>` | :ref:`_load_support_data<class_TextServerExtension_method__load_support_data>` **(** :ref:`String<class_String>` filename **)** |virtual| |
  235. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  236. | :ref:`int<class_int>` | :ref:`_name_to_tag<class_TextServerExtension_method__name_to_tag>` **(** :ref:`String<class_String>` name **)** |virtual| |const| |
  237. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  238. | :ref:`String<class_String>` | :ref:`_parse_number<class_TextServerExtension_method__parse_number>` **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language **)** |virtual| |const| |
  239. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  240. | :ref:`String<class_String>` | :ref:`_percent_sign<class_TextServerExtension_method__percent_sign>` **(** :ref:`String<class_String>` language **)** |virtual| |const| |
  241. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  242. | :ref:`bool<class_bool>` | :ref:`_save_support_data<class_TextServerExtension_method__save_support_data>` **(** :ref:`String<class_String>` filename **)** |virtual| |const| |
  243. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  244. | :ref:`int<class_int>` | :ref:`_shaped_get_span_count<class_TextServerExtension_method__shaped_get_span_count>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  245. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  246. | :ref:`Variant<class_Variant>` | :ref:`_shaped_get_span_meta<class_TextServerExtension_method__shaped_get_span_meta>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` index **)** |virtual| |const| |
  247. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  248. | void | :ref:`_shaped_set_span_update_font<class_TextServerExtension_method__shaped_set_span_update_font>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` index, :ref:`Array<class_Array>` fonts, :ref:`int<class_int>` size, :ref:`Dictionary<class_Dictionary>` opentype_features **)** |virtual| |
  249. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  250. | :ref:`bool<class_bool>` | :ref:`_shaped_text_add_object<class_TextServerExtension_method__shaped_text_add_object>` **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key, :ref:`Vector2<class_Vector2>` size, :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` inline_align, :ref:`int<class_int>` length **)** |virtual| |
  251. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  252. | :ref:`bool<class_bool>` | :ref:`_shaped_text_add_string<class_TextServerExtension_method__shaped_text_add_string>` **(** :ref:`RID<class_RID>` shaped, :ref:`String<class_String>` text, :ref:`Array<class_Array>` fonts, :ref:`int<class_int>` size, :ref:`Dictionary<class_Dictionary>` opentype_features, :ref:`String<class_String>` language, :ref:`Variant<class_Variant>` meta **)** |virtual| |
  253. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  254. | void | :ref:`_shaped_text_clear<class_TextServerExtension_method__shaped_text_clear>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |
  255. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  256. | void | :ref:`_shaped_text_draw<class_TextServerExtension_method__shaped_text_draw>` **(** :ref:`RID<class_RID>` shaped, :ref:`RID<class_RID>` canvas, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` clip_l, :ref:`float<class_float>` clip_r, :ref:`Color<class_Color>` color **)** |virtual| |const| |
  257. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  258. | void | :ref:`_shaped_text_draw_outline<class_TextServerExtension_method__shaped_text_draw_outline>` **(** :ref:`RID<class_RID>` shaped, :ref:`RID<class_RID>` canvas, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` clip_l, :ref:`float<class_float>` clip_r, :ref:`int<class_int>` outline_size, :ref:`Color<class_Color>` color **)** |virtual| |const| |
  259. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  260. | :ref:`float<class_float>` | :ref:`_shaped_text_fit_to_width<class_TextServerExtension_method__shaped_text_fit_to_width>` **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width, :ref:`int<class_int>` jst_flags **)** |virtual| |
  261. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  262. | :ref:`float<class_float>` | :ref:`_shaped_text_get_ascent<class_TextServerExtension_method__shaped_text_get_ascent>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  263. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  264. | void | :ref:`_shaped_text_get_carets<class_TextServerExtension_method__shaped_text_get_carets>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` position, CaretInfo* caret **)** |virtual| |const| |
  265. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  266. | :ref:`String<class_String>` | :ref:`_shaped_text_get_custom_punctuation<class_TextServerExtension_method__shaped_text_get_custom_punctuation>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  267. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  268. | :ref:`float<class_float>` | :ref:`_shaped_text_get_descent<class_TextServerExtension_method__shaped_text_get_descent>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  269. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  270. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`_shaped_text_get_direction<class_TextServerExtension_method__shaped_text_get_direction>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  271. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  272. | :ref:`int<class_int>` | :ref:`_shaped_text_get_dominant_direction_in_range<class_TextServerExtension_method__shaped_text_get_dominant_direction_in_range>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |virtual| |const| |
  273. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  274. | :ref:`int<class_int>` | :ref:`_shaped_text_get_ellipsis_glyph_count<class_TextServerExtension_method__shaped_text_get_ellipsis_glyph_count>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  275. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  276. | Glyph* | :ref:`_shaped_text_get_ellipsis_glyphs<class_TextServerExtension_method__shaped_text_get_ellipsis_glyphs>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  277. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  278. | :ref:`int<class_int>` | :ref:`_shaped_text_get_ellipsis_pos<class_TextServerExtension_method__shaped_text_get_ellipsis_pos>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  279. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  280. | :ref:`int<class_int>` | :ref:`_shaped_text_get_glyph_count<class_TextServerExtension_method__shaped_text_get_glyph_count>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  281. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  282. | Glyph* | :ref:`_shaped_text_get_glyphs<class_TextServerExtension_method__shaped_text_get_glyphs>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  283. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  284. | :ref:`Vector2<class_Vector2>` | :ref:`_shaped_text_get_grapheme_bounds<class_TextServerExtension_method__shaped_text_get_grapheme_bounds>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |virtual| |const| |
  285. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  286. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`_shaped_text_get_inferred_direction<class_TextServerExtension_method__shaped_text_get_inferred_direction>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  287. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  288. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`_shaped_text_get_line_breaks<class_TextServerExtension_method__shaped_text_get_line_breaks>` **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width, :ref:`int<class_int>` start, :ref:`int<class_int>` break_flags **)** |virtual| |const| |
  289. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  290. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`_shaped_text_get_line_breaks_adv<class_TextServerExtension_method__shaped_text_get_line_breaks_adv>` **(** :ref:`RID<class_RID>` shaped, :ref:`PackedFloat32Array<class_PackedFloat32Array>` width, :ref:`int<class_int>` start, :ref:`bool<class_bool>` once, :ref:`int<class_int>` break_flags **)** |virtual| |const| |
  291. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  292. | :ref:`Rect2<class_Rect2>` | :ref:`_shaped_text_get_object_rect<class_TextServerExtension_method__shaped_text_get_object_rect>` **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key **)** |virtual| |const| |
  293. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  294. | :ref:`Array<class_Array>` | :ref:`_shaped_text_get_objects<class_TextServerExtension_method__shaped_text_get_objects>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  295. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  296. | :ref:`Orientation<enum_TextServer_Orientation>` | :ref:`_shaped_text_get_orientation<class_TextServerExtension_method__shaped_text_get_orientation>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  297. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  298. | :ref:`RID<class_RID>` | :ref:`_shaped_text_get_parent<class_TextServerExtension_method__shaped_text_get_parent>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  299. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  300. | :ref:`bool<class_bool>` | :ref:`_shaped_text_get_preserve_control<class_TextServerExtension_method__shaped_text_get_preserve_control>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  301. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  302. | :ref:`bool<class_bool>` | :ref:`_shaped_text_get_preserve_invalid<class_TextServerExtension_method__shaped_text_get_preserve_invalid>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  303. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  304. | :ref:`Vector2i<class_Vector2i>` | :ref:`_shaped_text_get_range<class_TextServerExtension_method__shaped_text_get_range>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  305. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  306. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`_shaped_text_get_selection<class_TextServerExtension_method__shaped_text_get_selection>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |virtual| |const| |
  307. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  308. | :ref:`Vector2<class_Vector2>` | :ref:`_shaped_text_get_size<class_TextServerExtension_method__shaped_text_get_size>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  309. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  310. | :ref:`int<class_int>` | :ref:`_shaped_text_get_trim_pos<class_TextServerExtension_method__shaped_text_get_trim_pos>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  311. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  312. | :ref:`float<class_float>` | :ref:`_shaped_text_get_underline_position<class_TextServerExtension_method__shaped_text_get_underline_position>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  313. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  314. | :ref:`float<class_float>` | :ref:`_shaped_text_get_underline_thickness<class_TextServerExtension_method__shaped_text_get_underline_thickness>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  315. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  316. | :ref:`float<class_float>` | :ref:`_shaped_text_get_width<class_TextServerExtension_method__shaped_text_get_width>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  317. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  318. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`_shaped_text_get_word_breaks<class_TextServerExtension_method__shaped_text_get_word_breaks>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` grapheme_flags **)** |virtual| |const| |
  319. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  320. | :ref:`int<class_int>` | :ref:`_shaped_text_hit_test_grapheme<class_TextServerExtension_method__shaped_text_hit_test_grapheme>` **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coord **)** |virtual| |const| |
  321. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  322. | :ref:`int<class_int>` | :ref:`_shaped_text_hit_test_position<class_TextServerExtension_method__shaped_text_hit_test_position>` **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coord **)** |virtual| |const| |
  323. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  324. | :ref:`bool<class_bool>` | :ref:`_shaped_text_is_ready<class_TextServerExtension_method__shaped_text_is_ready>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const| |
  325. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  326. | :ref:`int<class_int>` | :ref:`_shaped_text_next_grapheme_pos<class_TextServerExtension_method__shaped_text_next_grapheme_pos>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |virtual| |const| |
  327. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  328. | void | :ref:`_shaped_text_overrun_trim_to_width<class_TextServerExtension_method__shaped_text_overrun_trim_to_width>` **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width, :ref:`int<class_int>` trim_flags **)** |virtual| |
  329. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  330. | :ref:`int<class_int>` | :ref:`_shaped_text_prev_grapheme_pos<class_TextServerExtension_method__shaped_text_prev_grapheme_pos>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |virtual| |const| |
  331. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  332. | :ref:`bool<class_bool>` | :ref:`_shaped_text_resize_object<class_TextServerExtension_method__shaped_text_resize_object>` **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key, :ref:`Vector2<class_Vector2>` size, :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` inline_align **)** |virtual| |
  333. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  334. | void | :ref:`_shaped_text_set_bidi_override<class_TextServerExtension_method__shaped_text_set_bidi_override>` **(** :ref:`RID<class_RID>` shaped, :ref:`Array<class_Array>` override **)** |virtual| |
  335. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  336. | void | :ref:`_shaped_text_set_custom_punctuation<class_TextServerExtension_method__shaped_text_set_custom_punctuation>` **(** :ref:`RID<class_RID>` shaped, :ref:`String<class_String>` punct **)** |virtual| |
  337. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  338. | void | :ref:`_shaped_text_set_direction<class_TextServerExtension_method__shaped_text_set_direction>` **(** :ref:`RID<class_RID>` shaped, :ref:`Direction<enum_TextServer_Direction>` direction **)** |virtual| |
  339. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  340. | void | :ref:`_shaped_text_set_orientation<class_TextServerExtension_method__shaped_text_set_orientation>` **(** :ref:`RID<class_RID>` shaped, :ref:`Orientation<enum_TextServer_Orientation>` orientation **)** |virtual| |
  341. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  342. | void | :ref:`_shaped_text_set_preserve_control<class_TextServerExtension_method__shaped_text_set_preserve_control>` **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)** |virtual| |
  343. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  344. | void | :ref:`_shaped_text_set_preserve_invalid<class_TextServerExtension_method__shaped_text_set_preserve_invalid>` **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)** |virtual| |
  345. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  346. | :ref:`bool<class_bool>` | :ref:`_shaped_text_shape<class_TextServerExtension_method__shaped_text_shape>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |
  347. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  348. | Glyph* | :ref:`_shaped_text_sort_logical<class_TextServerExtension_method__shaped_text_sort_logical>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |
  349. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  350. | :ref:`RID<class_RID>` | :ref:`_shaped_text_substr<class_TextServerExtension_method__shaped_text_substr>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` length **)** |virtual| |const| |
  351. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  352. | :ref:`float<class_float>` | :ref:`_shaped_text_tab_align<class_TextServerExtension_method__shaped_text_tab_align>` **(** :ref:`RID<class_RID>` shaped, :ref:`PackedFloat32Array<class_PackedFloat32Array>` tab_stops **)** |virtual| |
  353. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  354. | :ref:`bool<class_bool>` | :ref:`_shaped_text_update_breaks<class_TextServerExtension_method__shaped_text_update_breaks>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |
  355. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  356. | :ref:`bool<class_bool>` | :ref:`_shaped_text_update_justification_ops<class_TextServerExtension_method__shaped_text_update_justification_ops>` **(** :ref:`RID<class_RID>` shaped **)** |virtual| |
  357. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  358. | :ref:`String<class_String>` | :ref:`_string_to_lower<class_TextServerExtension_method__string_to_lower>` **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language **)** |virtual| |const| |
  359. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  360. | :ref:`String<class_String>` | :ref:`_string_to_upper<class_TextServerExtension_method__string_to_upper>` **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language **)** |virtual| |const| |
  361. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  362. | :ref:`String<class_String>` | :ref:`_tag_to_name<class_TextServerExtension_method__tag_to_name>` **(** :ref:`int<class_int>` tag **)** |virtual| |const| |
  363. +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  364. Method Descriptions
  365. -------------------
  366. .. _class_TextServerExtension_method__create_font:
  367. - :ref:`RID<class_RID>` **_create_font** **(** **)** |virtual|
  368. Creates new, empty font cache entry resource. To free the resulting resourec, use :ref:`_free<class_TextServerExtension_method__free>` method.
  369. ----
  370. .. _class_TextServerExtension_method__create_shaped_text:
  371. - :ref:`RID<class_RID>` **_create_shaped_text** **(** :ref:`Direction<enum_TextServer_Direction>` direction, :ref:`Orientation<enum_TextServer_Orientation>` orientation **)** |virtual|
  372. Creates new buffer for complex text layout, with the given ``direction`` and ``orientation``. To free the resulting buffer, use :ref:`_free<class_TextServerExtension_method__free>` method.
  373. \ **Note:** Direction is ignored if server does not support ``FEATURE_BIDI_LAYOUT`` feature.
  374. \ **Note:** Orientation is ignored if server does not support ``FEATURE_VERTICAL_LAYOUT`` feature.
  375. ----
  376. .. _class_TextServerExtension_method__draw_hex_code_box:
  377. - void **_draw_hex_code_box** **(** :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` size, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)** |virtual| |const|
  378. Draws box displaying character hexadecimal code. Used for replacing missing characters.
  379. ----
  380. .. _class_TextServerExtension_method__font_clear_glyphs:
  381. - void **_font_clear_glyphs** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |virtual|
  382. Removes all rendered glyphs information from the cache entry.
  383. \ **Note:** This function will not remove textures associated with the glyphs, use :ref:`_font_remove_texture<class_TextServerExtension_method__font_remove_texture>` to remove them manually.
  384. ----
  385. .. _class_TextServerExtension_method__font_clear_kerning_map:
  386. - void **_font_clear_kerning_map** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |virtual|
  387. Removes all kerning overrides.
  388. ----
  389. .. _class_TextServerExtension_method__font_clear_size_cache:
  390. - void **_font_clear_size_cache** **(** :ref:`RID<class_RID>` font_rid **)** |virtual|
  391. Removes all font sizes from the cache entry
  392. ----
  393. .. _class_TextServerExtension_method__font_clear_textures:
  394. - void **_font_clear_textures** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |virtual|
  395. Removes all textures from font cache entry.
  396. \ **Note:** This function will not remove glyphs associated with the texture, use :ref:`_font_remove_glyph<class_TextServerExtension_method__font_remove_glyph>` to remove them manually.
  397. ----
  398. .. _class_TextServerExtension_method__font_draw_glyph:
  399. - void **_font_draw_glyph** **(** :ref:`RID<class_RID>` font_rid, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` size, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)** |virtual| |const|
  400. Draws single glyph into a canvas item at the position, using ``font_rid`` at the size ``size``.
  401. \ **Note:** Glyph index is specific to the font, use glyphs indices returned by :ref:`_shaped_text_get_glyphs<class_TextServerExtension_method__shaped_text_get_glyphs>` or :ref:`_font_get_glyph_index<class_TextServerExtension_method__font_get_glyph_index>`.
  402. ----
  403. .. _class_TextServerExtension_method__font_draw_glyph_outline:
  404. - void **_font_draw_glyph_outline** **(** :ref:`RID<class_RID>` font_rid, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` size, :ref:`int<class_int>` outline_size, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)** |virtual| |const|
  405. Draws single glyph outline of size ``outline_size`` into a canvas item at the position, using ``font_rid`` at the size ``size``.
  406. \ **Note:** Glyph index is specific to the font, use glyphs indices returned by :ref:`_shaped_text_get_glyphs<class_TextServerExtension_method__shaped_text_get_glyphs>` or :ref:`_font_get_glyph_index<class_TextServerExtension_method__font_get_glyph_index>`.
  407. ----
  408. .. _class_TextServerExtension_method__font_get_ascent:
  409. - :ref:`float<class_float>` **_font_get_ascent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |virtual| |const|
  410. Returns the font ascent (number of pixels above the baseline).
  411. ----
  412. .. _class_TextServerExtension_method__font_get_descent:
  413. - :ref:`float<class_float>` **_font_get_descent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |virtual| |const|
  414. Returns the font descent (number of pixels below the baseline).
  415. ----
  416. .. _class_TextServerExtension_method__font_get_embolden:
  417. - :ref:`float<class_float>` **_font_get_embolden** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  418. Returns font embolden strength.
  419. ----
  420. .. _class_TextServerExtension_method__font_get_fixed_size:
  421. - :ref:`int<class_int>` **_font_get_fixed_size** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  422. Returns bitmap font fixed size.
  423. ----
  424. .. _class_TextServerExtension_method__font_get_global_oversampling:
  425. - :ref:`float<class_float>` **_font_get_global_oversampling** **(** **)** |virtual| |const|
  426. Returns the font oversampling factor, shared by all fonts in the TextServer.
  427. ----
  428. .. _class_TextServerExtension_method__font_get_glyph_advance:
  429. - :ref:`Vector2<class_Vector2>` **_font_get_glyph_advance** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph **)** |virtual| |const|
  430. Returns glyph advance (offset of the next glyph).
  431. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  432. ----
  433. .. _class_TextServerExtension_method__font_get_glyph_contours:
  434. - :ref:`Dictionary<class_Dictionary>` **_font_get_glyph_contours** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |virtual| |const|
  435. Returns outline contours of the glyph as a ``Dictionary`` with the following contents:
  436. \ ``points`` - :ref:`PackedVector3Array<class_PackedVector3Array>`, containing outline points. ``x`` and ``y`` are point coordinates. ``z`` is the type of the point, using the :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` values.
  437. \ ``contours`` - :ref:`PackedInt32Array<class_PackedInt32Array>`, containing indices the end points of each contour.
  438. \ ``orientation`` - :ref:`bool<class_bool>`, contour orientation. If ``true``, clockwise contours must be filled.
  439. ----
  440. .. _class_TextServerExtension_method__font_get_glyph_index:
  441. - :ref:`int<class_int>` **_font_get_glyph_index** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` char, :ref:`int<class_int>` variation_selector **)** |virtual| |const|
  442. Returns the glyph index of a ``char``, optionally modified by the ``variation_selector``.
  443. ----
  444. .. _class_TextServerExtension_method__font_get_glyph_list:
  445. - :ref:`Array<class_Array>` **_font_get_glyph_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |virtual| |const|
  446. Returns list of rendered glyphs in the cache entry.
  447. ----
  448. .. _class_TextServerExtension_method__font_get_glyph_offset:
  449. - :ref:`Vector2<class_Vector2>` **_font_get_glyph_offset** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |virtual| |const|
  450. Returns glyph offset from the baseline.
  451. ----
  452. .. _class_TextServerExtension_method__font_get_glyph_size:
  453. - :ref:`Vector2<class_Vector2>` **_font_get_glyph_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |virtual| |const|
  454. Returns size of the glyph.
  455. ----
  456. .. _class_TextServerExtension_method__font_get_glyph_texture_idx:
  457. - :ref:`int<class_int>` **_font_get_glyph_texture_idx** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |virtual| |const|
  458. Returns index of the cache texture containing the glyph.
  459. ----
  460. .. _class_TextServerExtension_method__font_get_glyph_uv_rect:
  461. - :ref:`Rect2<class_Rect2>` **_font_get_glyph_uv_rect** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |virtual| |const|
  462. Returns rectangle in the cache texture containing the glyph.
  463. ----
  464. .. _class_TextServerExtension_method__font_get_hinting:
  465. - :ref:`Hinting<enum_TextServer_Hinting>` **_font_get_hinting** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  466. Returns the font hinting mode. Used by dynamic fonts only.
  467. ----
  468. .. _class_TextServerExtension_method__font_get_kerning:
  469. - :ref:`Vector2<class_Vector2>` **_font_get_kerning** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)** |virtual| |const|
  470. Returns kerning for the pair of glyphs.
  471. ----
  472. .. _class_TextServerExtension_method__font_get_kerning_list:
  473. - :ref:`Array<class_Array>` **_font_get_kerning_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |virtual| |const|
  474. Returns list of the kerning overrides.
  475. ----
  476. .. _class_TextServerExtension_method__font_get_language_support_override:
  477. - :ref:`bool<class_bool>` **_font_get_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |virtual|
  478. Returns ``true`` if support override is enabled for the ``language``.
  479. ----
  480. .. _class_TextServerExtension_method__font_get_language_support_overrides:
  481. - :ref:`PackedStringArray<class_PackedStringArray>` **_font_get_language_support_overrides** **(** :ref:`RID<class_RID>` font_rid **)** |virtual|
  482. Returns list of language support overrides.
  483. ----
  484. .. _class_TextServerExtension_method__font_get_msdf_pixel_range:
  485. - :ref:`int<class_int>` **_font_get_msdf_pixel_range** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  486. Return the width of the range around the shape between the minimum and maximum representable signed distance.
  487. ----
  488. .. _class_TextServerExtension_method__font_get_msdf_size:
  489. - :ref:`int<class_int>` **_font_get_msdf_size** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  490. Returns source font size used to generate MSDF textures.
  491. ----
  492. .. _class_TextServerExtension_method__font_get_name:
  493. - :ref:`String<class_String>` **_font_get_name** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  494. Returns font family name.
  495. ----
  496. .. _class_TextServerExtension_method__font_get_opentype_feature_overrides:
  497. - :ref:`Dictionary<class_Dictionary>` **_font_get_opentype_feature_overrides** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  498. Returns font OpenType feature set override.
  499. ----
  500. .. _class_TextServerExtension_method__font_get_oversampling:
  501. - :ref:`float<class_float>` **_font_get_oversampling** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  502. Returns font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  503. ----
  504. .. _class_TextServerExtension_method__font_get_scale:
  505. - :ref:`float<class_float>` **_font_get_scale** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |virtual| |const|
  506. Returns scaling factor of the color bitmap font.
  507. ----
  508. .. _class_TextServerExtension_method__font_get_script_support_override:
  509. - :ref:`bool<class_bool>` **_font_get_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |virtual|
  510. Returns ``true`` if support override is enabled for the ``script``.
  511. ----
  512. .. _class_TextServerExtension_method__font_get_script_support_overrides:
  513. - :ref:`PackedStringArray<class_PackedStringArray>` **_font_get_script_support_overrides** **(** :ref:`RID<class_RID>` font_rid **)** |virtual|
  514. Returns list of script support overrides.
  515. ----
  516. .. _class_TextServerExtension_method__font_get_size_cache_list:
  517. - :ref:`Array<class_Array>` **_font_get_size_cache_list** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  518. Return list of the font sizes in the cache. Each size is ``Vector2i`` with font size and outline size.
  519. ----
  520. .. _class_TextServerExtension_method__font_get_spacing:
  521. - :ref:`int<class_int>` **_font_get_spacing** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |virtual| |const|
  522. Returns extra spacing added between glyphs in pixels.
  523. ----
  524. .. _class_TextServerExtension_method__font_get_style:
  525. - :ref:`int<class_int>` **_font_get_style** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  526. Returns font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  527. ----
  528. .. _class_TextServerExtension_method__font_get_style_name:
  529. - :ref:`String<class_String>` **_font_get_style_name** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  530. Returns font style name.
  531. ----
  532. .. _class_TextServerExtension_method__font_get_subpixel_positioning:
  533. - :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **_font_get_subpixel_positioning** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  534. Returns font sub-pixel glyph positioning mode.
  535. ----
  536. .. _class_TextServerExtension_method__font_get_supported_chars:
  537. - :ref:`String<class_String>` **_font_get_supported_chars** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  538. Returns a string containing all the characters available in the font.
  539. ----
  540. .. _class_TextServerExtension_method__font_get_texture_count:
  541. - :ref:`int<class_int>` **_font_get_texture_count** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |virtual| |const|
  542. Returns number of textures used by font cache entry.
  543. ----
  544. .. _class_TextServerExtension_method__font_get_texture_image:
  545. - :ref:`Image<class_Image>` **_font_get_texture_image** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |virtual| |const|
  546. Returns font cache texture image data.
  547. ----
  548. .. _class_TextServerExtension_method__font_get_texture_offsets:
  549. - :ref:`PackedInt32Array<class_PackedInt32Array>` **_font_get_texture_offsets** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |virtual| |const|
  550. Returns array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty.
  551. ----
  552. .. _class_TextServerExtension_method__font_get_transform:
  553. - :ref:`Transform2D<class_Transform2D>` **_font_get_transform** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  554. Retruns 2D transform applied to the font outlines.
  555. ----
  556. .. _class_TextServerExtension_method__font_get_underline_position:
  557. - :ref:`float<class_float>` **_font_get_underline_position** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |virtual| |const|
  558. Returns pixel offset of the underline below the baseline.
  559. ----
  560. .. _class_TextServerExtension_method__font_get_underline_thickness:
  561. - :ref:`float<class_float>` **_font_get_underline_thickness** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |virtual| |const|
  562. Returns thickness of the underline in pixels.
  563. ----
  564. .. _class_TextServerExtension_method__font_get_variation_coordinates:
  565. - :ref:`Dictionary<class_Dictionary>` **_font_get_variation_coordinates** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  566. Returns variation coordinates for the specified font cache entry. See :ref:`_font_supported_variation_list<class_TextServerExtension_method__font_supported_variation_list>` for more info.
  567. ----
  568. .. _class_TextServerExtension_method__font_has_char:
  569. - :ref:`bool<class_bool>` **_font_has_char** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` char **)** |virtual| |const|
  570. Return ``true`` if a Unicode ``char`` is available in the font.
  571. ----
  572. .. _class_TextServerExtension_method__font_is_antialiased:
  573. - :ref:`bool<class_bool>` **_font_is_antialiased** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  574. Returns ``true`` if font 8-bit anitialiased glyph rendering is supported and enabled.
  575. ----
  576. .. _class_TextServerExtension_method__font_is_force_autohinter:
  577. - :ref:`bool<class_bool>` **_font_is_force_autohinter** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  578. Returns ``true`` if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.
  579. ----
  580. .. _class_TextServerExtension_method__font_is_language_supported:
  581. - :ref:`bool<class_bool>` **_font_is_language_supported** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |virtual| |const|
  582. Returns ``true``, if font supports given language (`ISO 639 <https://en.wikipedia.org/wiki/ISO_639-1>`__ code).
  583. ----
  584. .. _class_TextServerExtension_method__font_is_multichannel_signed_distance_field:
  585. - :ref:`bool<class_bool>` **_font_is_multichannel_signed_distance_field** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  586. Returns ``true`` if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.
  587. ----
  588. .. _class_TextServerExtension_method__font_is_script_supported:
  589. - :ref:`bool<class_bool>` **_font_is_script_supported** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |virtual| |const|
  590. Returns ``true``, if font supports given script (ISO 15924 code).
  591. ----
  592. .. _class_TextServerExtension_method__font_remove_glyph:
  593. - void **_font_remove_glyph** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |virtual|
  594. Removes specified rendered glyph information from the cache entry.
  595. \ **Note:** This function will not remove textures associated with the glyphs, use :ref:`_font_remove_texture<class_TextServerExtension_method__font_remove_texture>` to remove them manually.
  596. ----
  597. .. _class_TextServerExtension_method__font_remove_kerning:
  598. - void **_font_remove_kerning** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)** |virtual|
  599. Removes kerning override for the pair of glyphs.
  600. ----
  601. .. _class_TextServerExtension_method__font_remove_language_support_override:
  602. - void **_font_remove_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |virtual|
  603. Remove language support override.
  604. ----
  605. .. _class_TextServerExtension_method__font_remove_script_support_override:
  606. - void **_font_remove_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |virtual|
  607. Removes script support override.
  608. ----
  609. .. _class_TextServerExtension_method__font_remove_size_cache:
  610. - void **_font_remove_size_cache** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |virtual|
  611. Removes specified font size from the cache entry.
  612. ----
  613. .. _class_TextServerExtension_method__font_remove_texture:
  614. - void **_font_remove_texture** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |virtual|
  615. Removes specified texture from font cache entry.
  616. \ **Note:** This function will not remove glyphs associated with the texture, remove them manually, using :ref:`_font_remove_glyph<class_TextServerExtension_method__font_remove_glyph>`.
  617. ----
  618. .. _class_TextServerExtension_method__font_render_glyph:
  619. - void **_font_render_glyph** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` index **)** |virtual|
  620. Renders specified glyph the the font cache texture.
  621. ----
  622. .. _class_TextServerExtension_method__font_render_range:
  623. - void **_font_render_range** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |virtual|
  624. Renders the range of characters to the font cache texture.
  625. ----
  626. .. _class_TextServerExtension_method__font_set_antialiased:
  627. - void **_font_set_antialiased** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` antialiased **)** |virtual|
  628. If set to ``true``, 8-bit antialiased glyph rendering is used, otherwise 1-bit rendering is used. Used by dynamic fonts only.
  629. ----
  630. .. _class_TextServerExtension_method__font_set_ascent:
  631. - void **_font_set_ascent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` ascent **)** |virtual|
  632. Sets the font ascent (number of pixels above the baseline).
  633. ----
  634. .. _class_TextServerExtension_method__font_set_data:
  635. - void **_font_set_data** **(** :ref:`RID<class_RID>` font_rid, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |virtual|
  636. Sets font source data, e.g contents of the dynamic font source file.
  637. ----
  638. .. _class_TextServerExtension_method__font_set_data_ptr:
  639. - void **_font_set_data_ptr** **(** :ref:`RID<class_RID>` font_rid, const uint8_t* data_ptr, :ref:`int<class_int>` data_size **)** |virtual|
  640. Sets the font descent (number of pixels below the baseline).
  641. ----
  642. .. _class_TextServerExtension_method__font_set_descent:
  643. - void **_font_set_descent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` descent **)** |virtual|
  644. Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.
  645. ----
  646. .. _class_TextServerExtension_method__font_set_embolden:
  647. - void **_font_set_embolden** **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` strength **)** |virtual|
  648. Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
  649. ----
  650. .. _class_TextServerExtension_method__font_set_fixed_size:
  651. - void **_font_set_fixed_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` fixed_size **)** |virtual|
  652. If set to ``true`` auto-hinting is preferred over font built-in hinting.
  653. ----
  654. .. _class_TextServerExtension_method__font_set_force_autohinter:
  655. - void **_font_set_force_autohinter** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` force_autohinter **)** |virtual|
  656. If set to ``true`` auto-hinting is preferred over font built-in hinting.
  657. ----
  658. .. _class_TextServerExtension_method__font_set_global_oversampling:
  659. - void **_font_set_global_oversampling** **(** :ref:`float<class_float>` oversampling **)** |virtual|
  660. Sets oversampling factor, shared by all font in the TextServer.
  661. \ **Note:** This value can be automatically changed by display server.
  662. ----
  663. .. _class_TextServerExtension_method__font_set_glyph_advance:
  664. - void **_font_set_glyph_advance** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` advance **)** |virtual|
  665. Sets glyph advance (offset of the next glyph).
  666. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  667. ----
  668. .. _class_TextServerExtension_method__font_set_glyph_offset:
  669. - void **_font_set_glyph_offset** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` offset **)** |virtual|
  670. Sets glyph offset from the baseline.
  671. ----
  672. .. _class_TextServerExtension_method__font_set_glyph_size:
  673. - void **_font_set_glyph_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` gl_size **)** |virtual|
  674. Sets size of the glyph.
  675. ----
  676. .. _class_TextServerExtension_method__font_set_glyph_texture_idx:
  677. - void **_font_set_glyph_texture_idx** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`int<class_int>` texture_idx **)** |virtual|
  678. Sets index of the cache texture containing the glyph.
  679. ----
  680. .. _class_TextServerExtension_method__font_set_glyph_uv_rect:
  681. - void **_font_set_glyph_uv_rect** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Rect2<class_Rect2>` uv_rect **)** |virtual|
  682. Sets rectangle in the cache texture containing the glyph.
  683. ----
  684. .. _class_TextServerExtension_method__font_set_hinting:
  685. - void **_font_set_hinting** **(** :ref:`RID<class_RID>` font_rid, :ref:`Hinting<enum_TextServer_Hinting>` hinting **)** |virtual|
  686. Sets font hinting mode. Used by dynamic fonts only.
  687. ----
  688. .. _class_TextServerExtension_method__font_set_kerning:
  689. - void **_font_set_kerning** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair, :ref:`Vector2<class_Vector2>` kerning **)** |virtual|
  690. Sets kerning for the pair of glyphs.
  691. ----
  692. .. _class_TextServerExtension_method__font_set_language_support_override:
  693. - void **_font_set_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language, :ref:`bool<class_bool>` supported **)** |virtual|
  694. Adds override for :ref:`_font_is_language_supported<class_TextServerExtension_method__font_is_language_supported>`.
  695. ----
  696. .. _class_TextServerExtension_method__font_set_msdf_pixel_range:
  697. - void **_font_set_msdf_pixel_range** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_pixel_range **)** |virtual|
  698. Sets the width of the range around the shape between the minimum and maximum representable signed distance.
  699. ----
  700. .. _class_TextServerExtension_method__font_set_msdf_size:
  701. - void **_font_set_msdf_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_size **)** |virtual|
  702. Sets source font size used to generate MSDF textures.
  703. ----
  704. .. _class_TextServerExtension_method__font_set_multichannel_signed_distance_field:
  705. - void **_font_set_multichannel_signed_distance_field** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` msdf **)** |virtual|
  706. If set to ``true``, glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.
  707. ----
  708. .. _class_TextServerExtension_method__font_set_name:
  709. - void **_font_set_name** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)** |virtual|
  710. Sets the font family name.
  711. ----
  712. .. _class_TextServerExtension_method__font_set_opentype_feature_overrides:
  713. - void **_font_set_opentype_feature_overrides** **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` overrides **)** |virtual|
  714. Sets font OpenType feature set override.
  715. ----
  716. .. _class_TextServerExtension_method__font_set_oversampling:
  717. - void **_font_set_oversampling** **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` oversampling **)** |virtual|
  718. Sets font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  719. ----
  720. .. _class_TextServerExtension_method__font_set_scale:
  721. - void **_font_set_scale** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` scale **)** |virtual|
  722. Sets scaling factor of the color bitmap font.
  723. ----
  724. .. _class_TextServerExtension_method__font_set_script_support_override:
  725. - void **_font_set_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script, :ref:`bool<class_bool>` supported **)** |virtual|
  726. Adds override for :ref:`_font_is_script_supported<class_TextServerExtension_method__font_is_script_supported>`.
  727. ----
  728. .. _class_TextServerExtension_method__font_set_spacing:
  729. - void **_font_set_spacing** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)** |virtual|
  730. Sets extra spacing added between glyphs in pixels.
  731. ----
  732. .. _class_TextServerExtension_method__font_set_style:
  733. - void **_font_set_style** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` style **)** |virtual|
  734. Sets the font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  735. ----
  736. .. _class_TextServerExtension_method__font_set_style_name:
  737. - void **_font_set_style_name** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name_style **)** |virtual|
  738. Sets the font style name.
  739. ----
  740. .. _class_TextServerExtension_method__font_set_subpixel_positioning:
  741. - void **_font_set_subpixel_positioning** **(** :ref:`RID<class_RID>` font_rid, :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` subpixel_positioning **)** |virtual|
  742. Sets font sub-pixel glyph positioning mode.
  743. ----
  744. .. _class_TextServerExtension_method__font_set_texture_image:
  745. - void **_font_set_texture_image** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index, :ref:`Image<class_Image>` image **)** |virtual|
  746. Sets font cache texture image data.
  747. ----
  748. .. _class_TextServerExtension_method__font_set_texture_offsets:
  749. - void **_font_set_texture_offsets** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index, :ref:`PackedInt32Array<class_PackedInt32Array>` offset **)** |virtual|
  750. Sets array containing the first free pixel in the each column of texture. Should be the same size as texture width or empty.
  751. ----
  752. .. _class_TextServerExtension_method__font_set_transform:
  753. - void **_font_set_transform** **(** :ref:`RID<class_RID>` font_rid, :ref:`Transform2D<class_Transform2D>` transform **)** |virtual|
  754. Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs.
  755. For example, to simulate italic typeface by slanting, apply the following transform ``Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)``.
  756. ----
  757. .. _class_TextServerExtension_method__font_set_underline_position:
  758. - void **_font_set_underline_position** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_position **)** |virtual|
  759. Sets pixel offset of the underline below the baseline.
  760. ----
  761. .. _class_TextServerExtension_method__font_set_underline_thickness:
  762. - void **_font_set_underline_thickness** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_thickness **)** |virtual|
  763. Sets thickness of the underline in pixels.
  764. ----
  765. .. _class_TextServerExtension_method__font_set_variation_coordinates:
  766. - void **_font_set_variation_coordinates** **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` variation_coordinates **)** |virtual|
  767. Sets variation coordinates for the specified font cache entry. See :ref:`_font_supported_variation_list<class_TextServerExtension_method__font_supported_variation_list>` for more info.
  768. ----
  769. .. _class_TextServerExtension_method__font_supported_feature_list:
  770. - :ref:`Dictionary<class_Dictionary>` **_font_supported_feature_list** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  771. Returns the dictionary of the supported OpenType features.
  772. ----
  773. .. _class_TextServerExtension_method__font_supported_variation_list:
  774. - :ref:`Dictionary<class_Dictionary>` **_font_supported_variation_list** **(** :ref:`RID<class_RID>` font_rid **)** |virtual| |const|
  775. Returns the dictionary of the supported OpenType variation coordinates.
  776. ----
  777. .. _class_TextServerExtension_method__format_number:
  778. - :ref:`String<class_String>` **_format_number** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language **)** |virtual| |const|
  779. Converts a number from the Western Arabic (0..9) to the numeral systems used in ``language``.
  780. ----
  781. .. _class_TextServerExtension_method__free:
  782. - void **_free** **(** :ref:`RID<class_RID>` rid **)** |virtual|
  783. Frees an object created by this :ref:`TextServer<class_TextServer>`.
  784. ----
  785. .. _class_TextServerExtension_method__get_features:
  786. - :ref:`int<class_int>` **_get_features** **(** **)** |virtual| |const|
  787. Returns text server features, see :ref:`Feature<enum_TextServer_Feature>`.
  788. ----
  789. .. _class_TextServerExtension_method__get_hex_code_box_size:
  790. - :ref:`Vector2<class_Vector2>` **_get_hex_code_box_size** **(** :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |virtual| |const|
  791. Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).
  792. ----
  793. .. _class_TextServerExtension_method__get_name:
  794. - :ref:`String<class_String>` **_get_name** **(** **)** |virtual| |const|
  795. Returns the name of the server interface.
  796. ----
  797. .. _class_TextServerExtension_method__get_support_data_filename:
  798. - :ref:`String<class_String>` **_get_support_data_filename** **(** **)** |virtual| |const|
  799. Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename.
  800. ----
  801. .. _class_TextServerExtension_method__get_support_data_info:
  802. - :ref:`String<class_String>` **_get_support_data_info** **(** **)** |virtual| |const|
  803. Returns TextServer database (e.g. ICU break iterators and dictionaries) description.
  804. ----
  805. .. _class_TextServerExtension_method__has:
  806. - :ref:`bool<class_bool>` **_has** **(** :ref:`RID<class_RID>` rid **)** |virtual|
  807. Returns ``true`` if ``rid`` is valid resource owned by this text server.
  808. ----
  809. .. _class_TextServerExtension_method__has_feature:
  810. - :ref:`bool<class_bool>` **_has_feature** **(** :ref:`Feature<enum_TextServer_Feature>` feature **)** |virtual| |const|
  811. Returns ``true`` if the server supports a feature.
  812. ----
  813. .. _class_TextServerExtension_method__is_locale_right_to_left:
  814. - :ref:`bool<class_bool>` **_is_locale_right_to_left** **(** :ref:`String<class_String>` locale **)** |virtual| |const|
  815. Returns ``true`` if locale is right-to-left.
  816. ----
  817. .. _class_TextServerExtension_method__load_support_data:
  818. - :ref:`bool<class_bool>` **_load_support_data** **(** :ref:`String<class_String>` filename **)** |virtual|
  819. Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
  820. \ **Note:** This function should be called before any other TextServer functions used, otherwise it won't have any effect.
  821. ----
  822. .. _class_TextServerExtension_method__name_to_tag:
  823. - :ref:`int<class_int>` **_name_to_tag** **(** :ref:`String<class_String>` name **)** |virtual| |const|
  824. Converts readable feature, variation, script or language name to OpenType tag.
  825. ----
  826. .. _class_TextServerExtension_method__parse_number:
  827. - :ref:`String<class_String>` **_parse_number** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language **)** |virtual| |const|
  828. Converts a number from the numeral systems used in ``language`` to Western Arabic (0..9).
  829. ----
  830. .. _class_TextServerExtension_method__percent_sign:
  831. - :ref:`String<class_String>` **_percent_sign** **(** :ref:`String<class_String>` language **)** |virtual| |const|
  832. Returns percent sign used in the ``language``.
  833. ----
  834. .. _class_TextServerExtension_method__save_support_data:
  835. - :ref:`bool<class_bool>` **_save_support_data** **(** :ref:`String<class_String>` filename **)** |virtual| |const|
  836. Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.
  837. \ **Note:** This function is used by during project export, to include TextServer database.
  838. ----
  839. .. _class_TextServerExtension_method__shaped_get_span_count:
  840. - :ref:`int<class_int>` **_shaped_get_span_count** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  841. Returns number of text spans added using :ref:`_shaped_text_add_string<class_TextServerExtension_method__shaped_text_add_string>` or :ref:`_shaped_text_add_object<class_TextServerExtension_method__shaped_text_add_object>`.
  842. ----
  843. .. _class_TextServerExtension_method__shaped_get_span_meta:
  844. - :ref:`Variant<class_Variant>` **_shaped_get_span_meta** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` index **)** |virtual| |const|
  845. Returns text span metadata.
  846. ----
  847. .. _class_TextServerExtension_method__shaped_set_span_update_font:
  848. - void **_shaped_set_span_update_font** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` index, :ref:`Array<class_Array>` fonts, :ref:`int<class_int>` size, :ref:`Dictionary<class_Dictionary>` opentype_features **)** |virtual|
  849. Changes text span font, font size and OpenType features, without changing the text.
  850. ----
  851. .. _class_TextServerExtension_method__shaped_text_add_object:
  852. - :ref:`bool<class_bool>` **_shaped_text_add_object** **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key, :ref:`Vector2<class_Vector2>` size, :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` inline_align, :ref:`int<class_int>` length **)** |virtual|
  853. Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters.
  854. ----
  855. .. _class_TextServerExtension_method__shaped_text_add_string:
  856. - :ref:`bool<class_bool>` **_shaped_text_add_string** **(** :ref:`RID<class_RID>` shaped, :ref:`String<class_String>` text, :ref:`Array<class_Array>` fonts, :ref:`int<class_int>` size, :ref:`Dictionary<class_Dictionary>` opentype_features, :ref:`String<class_String>` language, :ref:`Variant<class_Variant>` meta **)** |virtual|
  857. Adds text span and font to draw it to the text buffer.
  858. ----
  859. .. _class_TextServerExtension_method__shaped_text_clear:
  860. - void **_shaped_text_clear** **(** :ref:`RID<class_RID>` shaped **)** |virtual|
  861. Clears text buffer (removes text and inline objects).
  862. ----
  863. .. _class_TextServerExtension_method__shaped_text_draw:
  864. - void **_shaped_text_draw** **(** :ref:`RID<class_RID>` shaped, :ref:`RID<class_RID>` canvas, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` clip_l, :ref:`float<class_float>` clip_r, :ref:`Color<class_Color>` color **)** |virtual| |const|
  865. Draw shaped text into a canvas item at a given position, with ``color``. ``pos`` specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout).
  866. ----
  867. .. _class_TextServerExtension_method__shaped_text_draw_outline:
  868. - void **_shaped_text_draw_outline** **(** :ref:`RID<class_RID>` shaped, :ref:`RID<class_RID>` canvas, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` clip_l, :ref:`float<class_float>` clip_r, :ref:`int<class_int>` outline_size, :ref:`Color<class_Color>` color **)** |virtual| |const|
  869. Draw the outline of the shaped text into a canvas item at a given position, with ``color``. ``pos`` specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout).
  870. ----
  871. .. _class_TextServerExtension_method__shaped_text_fit_to_width:
  872. - :ref:`float<class_float>` **_shaped_text_fit_to_width** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width, :ref:`int<class_int>` jst_flags **)** |virtual|
  873. Adjusts text with to fit to specified width, returns new text width
  874. ----
  875. .. _class_TextServerExtension_method__shaped_text_get_ascent:
  876. - :ref:`float<class_float>` **_shaped_text_get_ascent** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  877. Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
  878. \ **Note:** Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline.
  879. ----
  880. .. _class_TextServerExtension_method__shaped_text_get_carets:
  881. - void **_shaped_text_get_carets** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` position, CaretInfo* caret **)** |virtual| |const|
  882. Returns shapes of the carets corresponding to the character offset ``position`` in the text. Returned caret shape is 1 pixel wide rectangle.
  883. ----
  884. .. _class_TextServerExtension_method__shaped_text_get_custom_punctuation:
  885. - :ref:`String<class_String>` **_shaped_text_get_custom_punctuation** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  886. Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  887. ----
  888. .. _class_TextServerExtension_method__shaped_text_get_descent:
  889. - :ref:`float<class_float>` **_shaped_text_get_descent** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  890. Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
  891. \ **Note:** Overall descent can be higher than font descent, if some glyphs are displaced from the baseline.
  892. ----
  893. .. _class_TextServerExtension_method__shaped_text_get_direction:
  894. - :ref:`Direction<enum_TextServer_Direction>` **_shaped_text_get_direction** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  895. Returns direction of the text.
  896. ----
  897. .. _class_TextServerExtension_method__shaped_text_get_dominant_direction_in_range:
  898. - :ref:`int<class_int>` **_shaped_text_get_dominant_direction_in_range** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |virtual| |const|
  899. Returns dominant direction of in the range of text.
  900. ----
  901. .. _class_TextServerExtension_method__shaped_text_get_ellipsis_glyph_count:
  902. - :ref:`int<class_int>` **_shaped_text_get_ellipsis_glyph_count** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  903. Returns number of glyphs in the ellipsis.
  904. ----
  905. .. _class_TextServerExtension_method__shaped_text_get_ellipsis_glyphs:
  906. - Glyph* **_shaped_text_get_ellipsis_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  907. Returns array of the glyphs in the ellipsis.
  908. ----
  909. .. _class_TextServerExtension_method__shaped_text_get_ellipsis_pos:
  910. - :ref:`int<class_int>` **_shaped_text_get_ellipsis_pos** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  911. Returns position of the ellipsis.
  912. ----
  913. .. _class_TextServerExtension_method__shaped_text_get_glyph_count:
  914. - :ref:`int<class_int>` **_shaped_text_get_glyph_count** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  915. Returns text glyphs count.
  916. ----
  917. .. _class_TextServerExtension_method__shaped_text_get_glyphs:
  918. - Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  919. Copies text glyphs in the visual order, into preallocated array of the size returned by :ref:`_shaped_text_get_glyph_count<class_TextServerExtension_method__shaped_text_get_glyph_count>`.
  920. ----
  921. .. _class_TextServerExtension_method__shaped_text_get_grapheme_bounds:
  922. - :ref:`Vector2<class_Vector2>` **_shaped_text_get_grapheme_bounds** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |virtual| |const|
  923. Returns composite character's bounds as offsets from the start of the line.
  924. ----
  925. .. _class_TextServerExtension_method__shaped_text_get_inferred_direction:
  926. - :ref:`Direction<enum_TextServer_Direction>` **_shaped_text_get_inferred_direction** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  927. Returns direction of the text, inferred by the BiDi algorithm.
  928. ----
  929. .. _class_TextServerExtension_method__shaped_text_get_line_breaks:
  930. - :ref:`PackedInt32Array<class_PackedInt32Array>` **_shaped_text_get_line_breaks** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width, :ref:`int<class_int>` start, :ref:`int<class_int>` break_flags **)** |virtual| |const|
  931. Breaks text to the lines and returns character ranges for each line.
  932. ----
  933. .. _class_TextServerExtension_method__shaped_text_get_line_breaks_adv:
  934. - :ref:`PackedInt32Array<class_PackedInt32Array>` **_shaped_text_get_line_breaks_adv** **(** :ref:`RID<class_RID>` shaped, :ref:`PackedFloat32Array<class_PackedFloat32Array>` width, :ref:`int<class_int>` start, :ref:`bool<class_bool>` once, :ref:`int<class_int>` break_flags **)** |virtual| |const|
  935. Breaks text to the lines and columns. Returns character ranges for each segment.
  936. ----
  937. .. _class_TextServerExtension_method__shaped_text_get_object_rect:
  938. - :ref:`Rect2<class_Rect2>` **_shaped_text_get_object_rect** **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key **)** |virtual| |const|
  939. Returns bounding rectangle of the inline object.
  940. ----
  941. .. _class_TextServerExtension_method__shaped_text_get_objects:
  942. - :ref:`Array<class_Array>` **_shaped_text_get_objects** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  943. Returns array of inline objects.
  944. ----
  945. .. _class_TextServerExtension_method__shaped_text_get_orientation:
  946. - :ref:`Orientation<enum_TextServer_Orientation>` **_shaped_text_get_orientation** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  947. Returns text orientation.
  948. ----
  949. .. _class_TextServerExtension_method__shaped_text_get_parent:
  950. - :ref:`RID<class_RID>` **_shaped_text_get_parent** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  951. Sets text orientation.
  952. ----
  953. .. _class_TextServerExtension_method__shaped_text_get_preserve_control:
  954. - :ref:`bool<class_bool>` **_shaped_text_get_preserve_control** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  955. Returns ``true`` if text buffer is configured to display control characters.
  956. ----
  957. .. _class_TextServerExtension_method__shaped_text_get_preserve_invalid:
  958. - :ref:`bool<class_bool>` **_shaped_text_get_preserve_invalid** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  959. Returns ``true`` if text buffer is configured to display hexadecimal codes in place of invalid characters.
  960. \ **Note:** If set to ``false``, nothing is displayed in place of invalid characters.
  961. ----
  962. .. _class_TextServerExtension_method__shaped_text_get_range:
  963. - :ref:`Vector2i<class_Vector2i>` **_shaped_text_get_range** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  964. Returns substring buffer character range in the parent buffer.
  965. ----
  966. .. _class_TextServerExtension_method__shaped_text_get_selection:
  967. - :ref:`PackedVector2Array<class_PackedVector2Array>` **_shaped_text_get_selection** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |virtual| |const|
  968. Returns selection rectangles for the specified character range.
  969. ----
  970. .. _class_TextServerExtension_method__shaped_text_get_size:
  971. - :ref:`Vector2<class_Vector2>` **_shaped_text_get_size** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  972. Returns size of the text.
  973. ----
  974. .. _class_TextServerExtension_method__shaped_text_get_trim_pos:
  975. - :ref:`int<class_int>` **_shaped_text_get_trim_pos** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  976. Returns ellipsis and trim positions.
  977. ----
  978. .. _class_TextServerExtension_method__shaped_text_get_underline_position:
  979. - :ref:`float<class_float>` **_shaped_text_get_underline_position** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  980. Returns pixel offset of the underline below the baseline.
  981. ----
  982. .. _class_TextServerExtension_method__shaped_text_get_underline_thickness:
  983. - :ref:`float<class_float>` **_shaped_text_get_underline_thickness** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  984. Returns thickness of the underline.
  985. ----
  986. .. _class_TextServerExtension_method__shaped_text_get_width:
  987. - :ref:`float<class_float>` **_shaped_text_get_width** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  988. Returns width (for horizontal layout) or height (for vertical) of the text.
  989. ----
  990. .. _class_TextServerExtension_method__shaped_text_get_word_breaks:
  991. - :ref:`PackedInt32Array<class_PackedInt32Array>` **_shaped_text_get_word_breaks** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` grapheme_flags **)** |virtual| |const|
  992. Breaks text into words and returns array of character ranges.
  993. ----
  994. .. _class_TextServerExtension_method__shaped_text_hit_test_grapheme:
  995. - :ref:`int<class_int>` **_shaped_text_hit_test_grapheme** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coord **)** |virtual| |const|
  996. Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` if none is found.
  997. ----
  998. .. _class_TextServerExtension_method__shaped_text_hit_test_position:
  999. - :ref:`int<class_int>` **_shaped_text_hit_test_position** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coord **)** |virtual| |const|
  1000. Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
  1001. ----
  1002. .. _class_TextServerExtension_method__shaped_text_is_ready:
  1003. - :ref:`bool<class_bool>` **_shaped_text_is_ready** **(** :ref:`RID<class_RID>` shaped **)** |virtual| |const|
  1004. Returns ``true`` if buffer is successfully shaped.
  1005. ----
  1006. .. _class_TextServerExtension_method__shaped_text_next_grapheme_pos:
  1007. - :ref:`int<class_int>` **_shaped_text_next_grapheme_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |virtual| |const|
  1008. Returns composite character end position closest to the ``pos``.
  1009. ----
  1010. .. _class_TextServerExtension_method__shaped_text_overrun_trim_to_width:
  1011. - void **_shaped_text_overrun_trim_to_width** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width, :ref:`int<class_int>` trim_flags **)** |virtual|
  1012. Trims text if it exceeds the given width.
  1013. ----
  1014. .. _class_TextServerExtension_method__shaped_text_prev_grapheme_pos:
  1015. - :ref:`int<class_int>` **_shaped_text_prev_grapheme_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |virtual| |const|
  1016. Returns composite character start position closest to the ``pos``.
  1017. ----
  1018. .. _class_TextServerExtension_method__shaped_text_resize_object:
  1019. - :ref:`bool<class_bool>` **_shaped_text_resize_object** **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key, :ref:`Vector2<class_Vector2>` size, :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` inline_align **)** |virtual|
  1020. Sets new size and alignment of embedded object.
  1021. ----
  1022. .. _class_TextServerExtension_method__shaped_text_set_bidi_override:
  1023. - void **_shaped_text_set_bidi_override** **(** :ref:`RID<class_RID>` shaped, :ref:`Array<class_Array>` override **)** |virtual|
  1024. Overrides BiDi for the structured text.
  1025. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
  1026. ----
  1027. .. _class_TextServerExtension_method__shaped_text_set_custom_punctuation:
  1028. - void **_shaped_text_set_custom_punctuation** **(** :ref:`RID<class_RID>` shaped, :ref:`String<class_String>` punct **)** |virtual|
  1029. Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  1030. ----
  1031. .. _class_TextServerExtension_method__shaped_text_set_direction:
  1032. - void **_shaped_text_set_direction** **(** :ref:`RID<class_RID>` shaped, :ref:`Direction<enum_TextServer_Direction>` direction **)** |virtual|
  1033. Sets desired text direction. If set to ``TEXT_DIRECTION_AUTO``, direction will be detected based on the buffer contents and current locale.
  1034. \ **Note:** Direction is ignored if server does not support ``FEATURE_BIDI_LAYOUT`` feature.
  1035. ----
  1036. .. _class_TextServerExtension_method__shaped_text_set_orientation:
  1037. - void **_shaped_text_set_orientation** **(** :ref:`RID<class_RID>` shaped, :ref:`Orientation<enum_TextServer_Orientation>` orientation **)** |virtual|
  1038. Sets desired text orientation.
  1039. \ **Note:** Orientation is ignored if server does not support ``FEATURE_VERTICAL_LAYOUT`` feature.
  1040. ----
  1041. .. _class_TextServerExtension_method__shaped_text_set_preserve_control:
  1042. - void **_shaped_text_set_preserve_control** **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)** |virtual|
  1043. If set to ``true`` text buffer will display control characters.
  1044. ----
  1045. .. _class_TextServerExtension_method__shaped_text_set_preserve_invalid:
  1046. - void **_shaped_text_set_preserve_invalid** **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)** |virtual|
  1047. If set to ``true`` text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.
  1048. ----
  1049. .. _class_TextServerExtension_method__shaped_text_shape:
  1050. - :ref:`bool<class_bool>` **_shaped_text_shape** **(** :ref:`RID<class_RID>` shaped **)** |virtual|
  1051. Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped successfully.
  1052. \ **Note:** It is not necessary to call this function manually, buffer will be shaped automatically as soon as any of its output data is requested.
  1053. ----
  1054. .. _class_TextServerExtension_method__shaped_text_sort_logical:
  1055. - Glyph* **_shaped_text_sort_logical** **(** :ref:`RID<class_RID>` shaped **)** |virtual|
  1056. Copies text glyphs in the logical order, into preallocated array of the size returned by :ref:`_shaped_text_get_glyph_count<class_TextServerExtension_method__shaped_text_get_glyph_count>`.
  1057. ----
  1058. .. _class_TextServerExtension_method__shaped_text_substr:
  1059. - :ref:`RID<class_RID>` **_shaped_text_substr** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` length **)** |virtual| |const|
  1060. Returns text buffer for the substring of the text in the ``shaped`` text buffer (including inline objects).
  1061. ----
  1062. .. _class_TextServerExtension_method__shaped_text_tab_align:
  1063. - :ref:`float<class_float>` **_shaped_text_tab_align** **(** :ref:`RID<class_RID>` shaped, :ref:`PackedFloat32Array<class_PackedFloat32Array>` tab_stops **)** |virtual|
  1064. Aligns shaped text to the given tab-stops.
  1065. ----
  1066. .. _class_TextServerExtension_method__shaped_text_update_breaks:
  1067. - :ref:`bool<class_bool>` **_shaped_text_update_breaks** **(** :ref:`RID<class_RID>` shaped **)** |virtual|
  1068. Updates line and word breaks.
  1069. ----
  1070. .. _class_TextServerExtension_method__shaped_text_update_justification_ops:
  1071. - :ref:`bool<class_bool>` **_shaped_text_update_justification_ops** **(** :ref:`RID<class_RID>` shaped **)** |virtual|
  1072. Updates justification opportunities (spaces, kashidas, etc.).
  1073. ----
  1074. .. _class_TextServerExtension_method__string_to_lower:
  1075. - :ref:`String<class_String>` **_string_to_lower** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language **)** |virtual| |const|
  1076. Returns the string converted to lowercase. Casing is locale dependent and context sensitive. The result may be longer or shorter than the original.
  1077. ----
  1078. .. _class_TextServerExtension_method__string_to_upper:
  1079. - :ref:`String<class_String>` **_string_to_upper** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language **)** |virtual| |const|
  1080. Returns the string converted to uppercase. Casing is locale dependent and context sensitive. The result may be longer or shorter than the original.
  1081. ----
  1082. .. _class_TextServerExtension_method__tag_to_name:
  1083. - :ref:`String<class_String>` **_tag_to_name** **(** :ref:`int<class_int>` tag **)** |virtual| |const|
  1084. Converts OpenType tag to readable feature, variation, script or language name.
  1085. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  1086. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  1087. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  1088. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  1089. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  1090. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`