class_textserver.rst 263 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextServer.xml.
  6. .. _class_TextServer:
  7. TextServer
  8. ==========
  9. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`TextServerExtension<class_TextServerExtension>`
  11. Interface for the fonts and complex text layouts.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. **TextServer** is the API backend for managing fonts, and rendering complex text.
  16. .. rst-class:: classref-reftable-group
  17. Methods
  18. -------
  19. .. table::
  20. :widths: auto
  21. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`RID<class_RID>` | :ref:`create_font<class_TextServer_method_create_font>` **(** **)** |
  23. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`RID<class_RID>` | :ref:`create_shaped_text<class_TextServer_method_create_shaped_text>` **(** :ref:`Direction<enum_TextServer_Direction>` direction=0, :ref:`Orientation<enum_TextServer_Orientation>` orientation=0 **)** |
  25. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | void | :ref:`draw_hex_code_box<class_TextServer_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 **)** |const| |
  27. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | void | :ref:`font_clear_glyphs<class_TextServer_method_font_clear_glyphs>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |
  29. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | void | :ref:`font_clear_kerning_map<class_TextServer_method_font_clear_kerning_map>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |
  31. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | void | :ref:`font_clear_size_cache<class_TextServer_method_font_clear_size_cache>` **(** :ref:`RID<class_RID>` font_rid **)** |
  33. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | void | :ref:`font_clear_textures<class_TextServer_method_font_clear_textures>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |
  35. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | void | :ref:`font_draw_glyph<class_TextServer_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=Color(1, 1, 1, 1) **)** |const| |
  37. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | void | :ref:`font_draw_glyph_outline<class_TextServer_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=Color(1, 1, 1, 1) **)** |const| |
  39. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` | :ref:`font_get_antialiasing<class_TextServer_method_font_get_antialiasing>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  41. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`float<class_float>` | :ref:`font_get_ascent<class_TextServer_method_font_get_ascent>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
  43. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`float<class_float>` | :ref:`font_get_descent<class_TextServer_method_font_get_descent>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
  45. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`float<class_float>` | :ref:`font_get_embolden<class_TextServer_method_font_get_embolden>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  47. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`int<class_int>` | :ref:`font_get_face_count<class_TextServer_method_font_get_face_count>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  49. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`int<class_int>` | :ref:`font_get_face_index<class_TextServer_method_font_get_face_index>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  51. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | :ref:`int<class_int>` | :ref:`font_get_fixed_size<class_TextServer_method_font_get_fixed_size>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  53. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :ref:`bool<class_bool>` | :ref:`font_get_generate_mipmaps<class_TextServer_method_font_get_generate_mipmaps>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  55. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`float<class_float>` | :ref:`font_get_global_oversampling<class_TextServer_method_font_get_global_oversampling>` **(** **)** |const| |
  57. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_advance<class_TextServer_method_font_get_glyph_advance>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph **)** |const| |
  59. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_glyph_contours<class_TextServer_method_font_get_glyph_contours>` **(** :ref:`RID<class_RID>` font, :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |const| |
  61. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`int<class_int>` | :ref:`font_get_glyph_index<class_TextServer_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 **)** |const| |
  63. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`font_get_glyph_list<class_TextServer_method_font_get_glyph_list>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const| |
  65. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_offset<class_TextServer_method_font_get_glyph_offset>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const| |
  67. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_size<class_TextServer_method_font_get_glyph_size>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const| |
  69. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :ref:`int<class_int>` | :ref:`font_get_glyph_texture_idx<class_TextServer_method_font_get_glyph_texture_idx>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const| |
  71. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :ref:`RID<class_RID>` | :ref:`font_get_glyph_texture_rid<class_TextServer_method_font_get_glyph_texture_rid>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const| |
  73. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_texture_size<class_TextServer_method_font_get_glyph_texture_size>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const| |
  75. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | :ref:`Rect2<class_Rect2>` | :ref:`font_get_glyph_uv_rect<class_TextServer_method_font_get_glyph_uv_rect>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const| |
  77. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :ref:`Hinting<enum_TextServer_Hinting>` | :ref:`font_get_hinting<class_TextServer_method_font_get_hinting>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  79. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_kerning<class_TextServer_method_font_get_kerning>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)** |const| |
  81. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | :ref:`Vector2i[]<class_Vector2i>` | :ref:`font_get_kerning_list<class_TextServer_method_font_get_kerning_list>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
  83. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | :ref:`bool<class_bool>` | :ref:`font_get_language_support_override<class_TextServer_method_font_get_language_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |
  85. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_language_support_overrides<class_TextServer_method_font_get_language_support_overrides>` **(** :ref:`RID<class_RID>` font_rid **)** |
  87. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | :ref:`int<class_int>` | :ref:`font_get_msdf_pixel_range<class_TextServer_method_font_get_msdf_pixel_range>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  89. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :ref:`int<class_int>` | :ref:`font_get_msdf_size<class_TextServer_method_font_get_msdf_size>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  91. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | :ref:`String<class_String>` | :ref:`font_get_name<class_TextServer_method_font_get_name>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  93. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_opentype_feature_overrides<class_TextServer_method_font_get_opentype_feature_overrides>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  95. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | :ref:`float<class_float>` | :ref:`font_get_oversampling<class_TextServer_method_font_get_oversampling>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  97. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | :ref:`float<class_float>` | :ref:`font_get_scale<class_TextServer_method_font_get_scale>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
  99. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | :ref:`bool<class_bool>` | :ref:`font_get_script_support_override<class_TextServer_method_font_get_script_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |
  101. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_script_support_overrides<class_TextServer_method_font_get_script_support_overrides>` **(** :ref:`RID<class_RID>` font_rid **)** |
  103. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | :ref:`Vector2i[]<class_Vector2i>` | :ref:`font_get_size_cache_list<class_TextServer_method_font_get_size_cache_list>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  105. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | :ref:`int<class_int>` | :ref:`font_get_stretch<class_TextServer_method_font_get_stretch>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  107. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | :ref:`FontStyle<enum_TextServer_FontStyle>` | :ref:`font_get_style<class_TextServer_method_font_get_style>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  109. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | :ref:`String<class_String>` | :ref:`font_get_style_name<class_TextServer_method_font_get_style_name>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  111. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` | :ref:`font_get_subpixel_positioning<class_TextServer_method_font_get_subpixel_positioning>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  113. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | :ref:`String<class_String>` | :ref:`font_get_supported_chars<class_TextServer_method_font_get_supported_chars>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  115. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | :ref:`int<class_int>` | :ref:`font_get_texture_count<class_TextServer_method_font_get_texture_count>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const| |
  117. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | :ref:`Image<class_Image>` | :ref:`font_get_texture_image<class_TextServer_method_font_get_texture_image>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |const| |
  119. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`font_get_texture_offsets<class_TextServer_method_font_get_texture_offsets>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |const| |
  121. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | :ref:`Transform2D<class_Transform2D>` | :ref:`font_get_transform<class_TextServer_method_font_get_transform>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  123. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | :ref:`float<class_float>` | :ref:`font_get_underline_position<class_TextServer_method_font_get_underline_position>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
  125. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | :ref:`float<class_float>` | :ref:`font_get_underline_thickness<class_TextServer_method_font_get_underline_thickness>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
  127. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_variation_coordinates<class_TextServer_method_font_get_variation_coordinates>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  129. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | :ref:`int<class_int>` | :ref:`font_get_weight<class_TextServer_method_font_get_weight>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  131. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | :ref:`bool<class_bool>` | :ref:`font_has_char<class_TextServer_method_font_has_char>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` char **)** |const| |
  133. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | :ref:`bool<class_bool>` | :ref:`font_is_allow_system_fallback<class_TextServer_method_font_is_allow_system_fallback>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  135. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. | :ref:`bool<class_bool>` | :ref:`font_is_force_autohinter<class_TextServer_method_font_is_force_autohinter>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  137. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  138. | :ref:`bool<class_bool>` | :ref:`font_is_language_supported<class_TextServer_method_font_is_language_supported>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |const| |
  139. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  140. | :ref:`bool<class_bool>` | :ref:`font_is_multichannel_signed_distance_field<class_TextServer_method_font_is_multichannel_signed_distance_field>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  141. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  142. | :ref:`bool<class_bool>` | :ref:`font_is_script_supported<class_TextServer_method_font_is_script_supported>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |const| |
  143. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  144. | void | :ref:`font_remove_glyph<class_TextServer_method_font_remove_glyph>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |
  145. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  146. | void | :ref:`font_remove_kerning<class_TextServer_method_font_remove_kerning>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)** |
  147. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  148. | void | :ref:`font_remove_language_support_override<class_TextServer_method_font_remove_language_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |
  149. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  150. | void | :ref:`font_remove_script_support_override<class_TextServer_method_font_remove_script_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |
  151. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  152. | void | :ref:`font_remove_size_cache<class_TextServer_method_font_remove_size_cache>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |
  153. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  154. | void | :ref:`font_remove_texture<class_TextServer_method_font_remove_texture>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |
  155. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  156. | void | :ref:`font_render_glyph<class_TextServer_method_font_render_glyph>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` index **)** |
  157. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  158. | void | :ref:`font_render_range<class_TextServer_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 **)** |
  159. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  160. | void | :ref:`font_set_allow_system_fallback<class_TextServer_method_font_set_allow_system_fallback>` **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` allow_system_fallback **)** |
  161. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  162. | void | :ref:`font_set_antialiasing<class_TextServer_method_font_set_antialiasing>` **(** :ref:`RID<class_RID>` font_rid, :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` antialiasing **)** |
  163. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  164. | void | :ref:`font_set_ascent<class_TextServer_method_font_set_ascent>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` ascent **)** |
  165. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  166. | void | :ref:`font_set_data<class_TextServer_method_font_set_data>` **(** :ref:`RID<class_RID>` font_rid, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |
  167. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  168. | void | :ref:`font_set_descent<class_TextServer_method_font_set_descent>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` descent **)** |
  169. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  170. | void | :ref:`font_set_embolden<class_TextServer_method_font_set_embolden>` **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` strength **)** |
  171. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  172. | void | :ref:`font_set_face_index<class_TextServer_method_font_set_face_index>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` face_index **)** |
  173. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  174. | void | :ref:`font_set_fixed_size<class_TextServer_method_font_set_fixed_size>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` fixed_size **)** |
  175. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  176. | void | :ref:`font_set_force_autohinter<class_TextServer_method_font_set_force_autohinter>` **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` force_autohinter **)** |
  177. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  178. | void | :ref:`font_set_generate_mipmaps<class_TextServer_method_font_set_generate_mipmaps>` **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` generate_mipmaps **)** |
  179. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  180. | void | :ref:`font_set_global_oversampling<class_TextServer_method_font_set_global_oversampling>` **(** :ref:`float<class_float>` oversampling **)** |
  181. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  182. | void | :ref:`font_set_glyph_advance<class_TextServer_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 **)** |
  183. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  184. | void | :ref:`font_set_glyph_offset<class_TextServer_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 **)** |
  185. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  186. | void | :ref:`font_set_glyph_size<class_TextServer_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 **)** |
  187. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  188. | void | :ref:`font_set_glyph_texture_idx<class_TextServer_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 **)** |
  189. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  190. | void | :ref:`font_set_glyph_uv_rect<class_TextServer_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 **)** |
  191. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  192. | void | :ref:`font_set_hinting<class_TextServer_method_font_set_hinting>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Hinting<enum_TextServer_Hinting>` hinting **)** |
  193. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  194. | void | :ref:`font_set_kerning<class_TextServer_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 **)** |
  195. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  196. | void | :ref:`font_set_language_support_override<class_TextServer_method_font_set_language_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language, :ref:`bool<class_bool>` supported **)** |
  197. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  198. | void | :ref:`font_set_msdf_pixel_range<class_TextServer_method_font_set_msdf_pixel_range>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_pixel_range **)** |
  199. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  200. | void | :ref:`font_set_msdf_size<class_TextServer_method_font_set_msdf_size>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_size **)** |
  201. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  202. | void | :ref:`font_set_multichannel_signed_distance_field<class_TextServer_method_font_set_multichannel_signed_distance_field>` **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` msdf **)** |
  203. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  204. | void | :ref:`font_set_name<class_TextServer_method_font_set_name>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)** |
  205. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  206. | void | :ref:`font_set_opentype_feature_overrides<class_TextServer_method_font_set_opentype_feature_overrides>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` overrides **)** |
  207. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  208. | void | :ref:`font_set_oversampling<class_TextServer_method_font_set_oversampling>` **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` oversampling **)** |
  209. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  210. | void | :ref:`font_set_scale<class_TextServer_method_font_set_scale>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` scale **)** |
  211. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  212. | void | :ref:`font_set_script_support_override<class_TextServer_method_font_set_script_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script, :ref:`bool<class_bool>` supported **)** |
  213. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  214. | void | :ref:`font_set_stretch<class_TextServer_method_font_set_stretch>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)** |
  215. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  216. | void | :ref:`font_set_style<class_TextServer_method_font_set_style>` **(** :ref:`RID<class_RID>` font_rid, :ref:`FontStyle<enum_TextServer_FontStyle>` style **)** |
  217. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  218. | void | :ref:`font_set_style_name<class_TextServer_method_font_set_style_name>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)** |
  219. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  220. | void | :ref:`font_set_subpixel_positioning<class_TextServer_method_font_set_subpixel_positioning>` **(** :ref:`RID<class_RID>` font_rid, :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` subpixel_positioning **)** |
  221. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  222. | void | :ref:`font_set_texture_image<class_TextServer_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 **)** |
  223. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  224. | void | :ref:`font_set_texture_offsets<class_TextServer_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 **)** |
  225. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  226. | void | :ref:`font_set_transform<class_TextServer_method_font_set_transform>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Transform2D<class_Transform2D>` transform **)** |
  227. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  228. | void | :ref:`font_set_underline_position<class_TextServer_method_font_set_underline_position>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_position **)** |
  229. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  230. | void | :ref:`font_set_underline_thickness<class_TextServer_method_font_set_underline_thickness>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_thickness **)** |
  231. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  232. | void | :ref:`font_set_variation_coordinates<class_TextServer_method_font_set_variation_coordinates>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` variation_coordinates **)** |
  233. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  234. | void | :ref:`font_set_weight<class_TextServer_method_font_set_weight>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)** |
  235. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  236. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_feature_list<class_TextServer_method_font_supported_feature_list>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  237. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  238. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_variation_list<class_TextServer_method_font_supported_variation_list>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  239. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  240. | :ref:`String<class_String>` | :ref:`format_number<class_TextServer_method_format_number>` **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const| |
  241. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  242. | void | :ref:`free_rid<class_TextServer_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
  243. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  244. | :ref:`int<class_int>` | :ref:`get_features<class_TextServer_method_get_features>` **(** **)** |const| |
  245. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  246. | :ref:`Vector2<class_Vector2>` | :ref:`get_hex_code_box_size<class_TextServer_method_get_hex_code_box_size>` **(** :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |const| |
  247. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  248. | :ref:`String<class_String>` | :ref:`get_name<class_TextServer_method_get_name>` **(** **)** |const| |
  249. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  250. | :ref:`String<class_String>` | :ref:`get_support_data_filename<class_TextServer_method_get_support_data_filename>` **(** **)** |const| |
  251. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  252. | :ref:`String<class_String>` | :ref:`get_support_data_info<class_TextServer_method_get_support_data_info>` **(** **)** |const| |
  253. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  254. | :ref:`bool<class_bool>` | :ref:`has<class_TextServer_method_has>` **(** :ref:`RID<class_RID>` rid **)** |
  255. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  256. | :ref:`bool<class_bool>` | :ref:`has_feature<class_TextServer_method_has_feature>` **(** :ref:`Feature<enum_TextServer_Feature>` feature **)** |const| |
  257. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  258. | :ref:`int<class_int>` | :ref:`is_confusable<class_TextServer_method_is_confusable>` **(** :ref:`String<class_String>` string, :ref:`PackedStringArray<class_PackedStringArray>` dict **)** |const| |
  259. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  260. | :ref:`bool<class_bool>` | :ref:`is_locale_right_to_left<class_TextServer_method_is_locale_right_to_left>` **(** :ref:`String<class_String>` locale **)** |const| |
  261. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  262. | :ref:`bool<class_bool>` | :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>` **(** :ref:`String<class_String>` string **)** |const| |
  263. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  264. | :ref:`bool<class_bool>` | :ref:`load_support_data<class_TextServer_method_load_support_data>` **(** :ref:`String<class_String>` filename **)** |
  265. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  266. | :ref:`int<class_int>` | :ref:`name_to_tag<class_TextServer_method_name_to_tag>` **(** :ref:`String<class_String>` name **)** |const| |
  267. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  268. | :ref:`String<class_String>` | :ref:`parse_number<class_TextServer_method_parse_number>` **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const| |
  269. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  270. | :ref:`Vector3i[]<class_Vector3i>` | :ref:`parse_structured_text<class_TextServer_method_parse_structured_text>` **(** :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` parser_type, :ref:`Array<class_Array>` args, :ref:`String<class_String>` text **)** |const| |
  271. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  272. | :ref:`String<class_String>` | :ref:`percent_sign<class_TextServer_method_percent_sign>` **(** :ref:`String<class_String>` language="" **)** |const| |
  273. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  274. | :ref:`bool<class_bool>` | :ref:`save_support_data<class_TextServer_method_save_support_data>` **(** :ref:`String<class_String>` filename **)** |const| |
  275. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  276. | :ref:`int<class_int>` | :ref:`shaped_get_span_count<class_TextServer_method_shaped_get_span_count>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  277. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  278. | :ref:`Variant<class_Variant>` | :ref:`shaped_get_span_meta<class_TextServer_method_shaped_get_span_meta>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` index **)** |const| |
  279. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  280. | void | :ref:`shaped_set_span_update_font<class_TextServer_method_shaped_set_span_update_font>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` index, :ref:`RID[]<class_RID>` fonts, :ref:`int<class_int>` size, :ref:`Dictionary<class_Dictionary>` opentype_features={} **)** |
  281. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  282. | :ref:`bool<class_bool>` | :ref:`shaped_text_add_object<class_TextServer_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=5, :ref:`int<class_int>` length=1, :ref:`float<class_float>` baseline=0.0 **)** |
  283. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  284. | :ref:`bool<class_bool>` | :ref:`shaped_text_add_string<class_TextServer_method_shaped_text_add_string>` **(** :ref:`RID<class_RID>` shaped, :ref:`String<class_String>` text, :ref:`RID[]<class_RID>` fonts, :ref:`int<class_int>` size, :ref:`Dictionary<class_Dictionary>` opentype_features={}, :ref:`String<class_String>` language="", :ref:`Variant<class_Variant>` meta=null **)** |
  285. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  286. | void | :ref:`shaped_text_clear<class_TextServer_method_shaped_text_clear>` **(** :ref:`RID<class_RID>` rid **)** |
  287. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  288. | void | :ref:`shaped_text_draw<class_TextServer_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=-1, :ref:`float<class_float>` clip_r=-1, :ref:`Color<class_Color>` color=Color(1, 1, 1, 1) **)** |const| |
  289. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  290. | void | :ref:`shaped_text_draw_outline<class_TextServer_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=-1, :ref:`float<class_float>` clip_r=-1, :ref:`int<class_int>` outline_size=1, :ref:`Color<class_Color>` color=Color(1, 1, 1, 1) **)** |const| |
  291. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  292. | :ref:`float<class_float>` | :ref:`shaped_text_fit_to_width<class_TextServer_method_shaped_text_fit_to_width>` **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width, :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` jst_flags=3 **)** |
  293. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  294. | :ref:`float<class_float>` | :ref:`shaped_text_get_ascent<class_TextServer_method_shaped_text_get_ascent>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  295. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  296. | :ref:`Dictionary<class_Dictionary>` | :ref:`shaped_text_get_carets<class_TextServer_method_shaped_text_get_carets>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` position **)** |const| |
  297. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  298. | :ref:`String<class_String>` | :ref:`shaped_text_get_custom_punctuation<class_TextServer_method_shaped_text_get_custom_punctuation>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  299. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  300. | :ref:`float<class_float>` | :ref:`shaped_text_get_descent<class_TextServer_method_shaped_text_get_descent>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  301. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  302. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_direction<class_TextServer_method_shaped_text_get_direction>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  303. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  304. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_dominant_direction_in_range<class_TextServer_method_shaped_text_get_dominant_direction_in_range>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |const| |
  305. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  306. | :ref:`int<class_int>` | :ref:`shaped_text_get_ellipsis_glyph_count<class_TextServer_method_shaped_text_get_ellipsis_glyph_count>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  307. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  308. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`shaped_text_get_ellipsis_glyphs<class_TextServer_method_shaped_text_get_ellipsis_glyphs>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  309. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  310. | :ref:`int<class_int>` | :ref:`shaped_text_get_ellipsis_pos<class_TextServer_method_shaped_text_get_ellipsis_pos>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  311. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  312. | :ref:`int<class_int>` | :ref:`shaped_text_get_glyph_count<class_TextServer_method_shaped_text_get_glyph_count>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  313. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  314. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`shaped_text_get_glyphs<class_TextServer_method_shaped_text_get_glyphs>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  315. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  316. | :ref:`Vector2<class_Vector2>` | :ref:`shaped_text_get_grapheme_bounds<class_TextServer_method_shaped_text_get_grapheme_bounds>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const| |
  317. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  318. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_inferred_direction<class_TextServer_method_shaped_text_get_inferred_direction>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  319. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  320. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_line_breaks<class_TextServer_method_shaped_text_get_line_breaks>` **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width, :ref:`int<class_int>` start=0, :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` break_flags=3 **)** |const| |
  321. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  322. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_line_breaks_adv<class_TextServer_method_shaped_text_get_line_breaks_adv>` **(** :ref:`RID<class_RID>` shaped, :ref:`PackedFloat32Array<class_PackedFloat32Array>` width, :ref:`int<class_int>` start=0, :ref:`bool<class_bool>` once=true, :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` break_flags=3 **)** |const| |
  323. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  324. | :ref:`Rect2<class_Rect2>` | :ref:`shaped_text_get_object_rect<class_TextServer_method_shaped_text_get_object_rect>` **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key **)** |const| |
  325. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  326. | :ref:`Array<class_Array>` | :ref:`shaped_text_get_objects<class_TextServer_method_shaped_text_get_objects>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  327. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  328. | :ref:`Orientation<enum_TextServer_Orientation>` | :ref:`shaped_text_get_orientation<class_TextServer_method_shaped_text_get_orientation>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  329. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  330. | :ref:`RID<class_RID>` | :ref:`shaped_text_get_parent<class_TextServer_method_shaped_text_get_parent>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  331. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  332. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_control<class_TextServer_method_shaped_text_get_preserve_control>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  333. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  334. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_invalid<class_TextServer_method_shaped_text_get_preserve_invalid>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  335. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  336. | :ref:`Vector2i<class_Vector2i>` | :ref:`shaped_text_get_range<class_TextServer_method_shaped_text_get_range>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  337. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  338. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`shaped_text_get_selection<class_TextServer_method_shaped_text_get_selection>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |const| |
  339. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  340. | :ref:`Vector2<class_Vector2>` | :ref:`shaped_text_get_size<class_TextServer_method_shaped_text_get_size>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  341. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  342. | :ref:`int<class_int>` | :ref:`shaped_text_get_spacing<class_TextServer_method_shaped_text_get_spacing>` **(** :ref:`RID<class_RID>` shaped, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |const| |
  343. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  344. | :ref:`int<class_int>` | :ref:`shaped_text_get_trim_pos<class_TextServer_method_shaped_text_get_trim_pos>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  345. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  346. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_position<class_TextServer_method_shaped_text_get_underline_position>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  347. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  348. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_thickness<class_TextServer_method_shaped_text_get_underline_thickness>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  349. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  350. | :ref:`float<class_float>` | :ref:`shaped_text_get_width<class_TextServer_method_shaped_text_get_width>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  351. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  352. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_word_breaks<class_TextServer_method_shaped_text_get_word_breaks>` **(** :ref:`RID<class_RID>` shaped, :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` grapheme_flags=264 **)** |const| |
  353. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  354. | :ref:`int<class_int>` | :ref:`shaped_text_hit_test_grapheme<class_TextServer_method_shaped_text_hit_test_grapheme>` **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coords **)** |const| |
  355. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  356. | :ref:`int<class_int>` | :ref:`shaped_text_hit_test_position<class_TextServer_method_shaped_text_hit_test_position>` **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coords **)** |const| |
  357. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  358. | :ref:`bool<class_bool>` | :ref:`shaped_text_is_ready<class_TextServer_method_shaped_text_is_ready>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  359. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  360. | :ref:`int<class_int>` | :ref:`shaped_text_next_grapheme_pos<class_TextServer_method_shaped_text_next_grapheme_pos>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const| |
  361. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  362. | void | :ref:`shaped_text_overrun_trim_to_width<class_TextServer_method_shaped_text_overrun_trim_to_width>` **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width=0, :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` overrun_trim_flags=0 **)** |
  363. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  364. | :ref:`int<class_int>` | :ref:`shaped_text_prev_grapheme_pos<class_TextServer_method_shaped_text_prev_grapheme_pos>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const| |
  365. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  366. | :ref:`bool<class_bool>` | :ref:`shaped_text_resize_object<class_TextServer_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=5, :ref:`float<class_float>` baseline=0.0 **)** |
  367. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  368. | void | :ref:`shaped_text_set_bidi_override<class_TextServer_method_shaped_text_set_bidi_override>` **(** :ref:`RID<class_RID>` shaped, :ref:`Array<class_Array>` override **)** |
  369. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  370. | void | :ref:`shaped_text_set_custom_punctuation<class_TextServer_method_shaped_text_set_custom_punctuation>` **(** :ref:`RID<class_RID>` shaped, :ref:`String<class_String>` punct **)** |
  371. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  372. | void | :ref:`shaped_text_set_direction<class_TextServer_method_shaped_text_set_direction>` **(** :ref:`RID<class_RID>` shaped, :ref:`Direction<enum_TextServer_Direction>` direction=0 **)** |
  373. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  374. | void | :ref:`shaped_text_set_orientation<class_TextServer_method_shaped_text_set_orientation>` **(** :ref:`RID<class_RID>` shaped, :ref:`Orientation<enum_TextServer_Orientation>` orientation=0 **)** |
  375. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  376. | void | :ref:`shaped_text_set_preserve_control<class_TextServer_method_shaped_text_set_preserve_control>` **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)** |
  377. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  378. | void | :ref:`shaped_text_set_preserve_invalid<class_TextServer_method_shaped_text_set_preserve_invalid>` **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)** |
  379. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  380. | void | :ref:`shaped_text_set_spacing<class_TextServer_method_shaped_text_set_spacing>` **(** :ref:`RID<class_RID>` shaped, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)** |
  381. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  382. | :ref:`bool<class_bool>` | :ref:`shaped_text_shape<class_TextServer_method_shaped_text_shape>` **(** :ref:`RID<class_RID>` shaped **)** |
  383. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  384. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`shaped_text_sort_logical<class_TextServer_method_shaped_text_sort_logical>` **(** :ref:`RID<class_RID>` shaped **)** |
  385. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  386. | :ref:`RID<class_RID>` | :ref:`shaped_text_substr<class_TextServer_method_shaped_text_substr>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` length **)** |const| |
  387. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  388. | :ref:`float<class_float>` | :ref:`shaped_text_tab_align<class_TextServer_method_shaped_text_tab_align>` **(** :ref:`RID<class_RID>` shaped, :ref:`PackedFloat32Array<class_PackedFloat32Array>` tab_stops **)** |
  389. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  390. | :ref:`bool<class_bool>` | :ref:`spoof_check<class_TextServer_method_spoof_check>` **(** :ref:`String<class_String>` string **)** |const| |
  391. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  392. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`string_get_word_breaks<class_TextServer_method_string_get_word_breaks>` **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="", :ref:`int<class_int>` chars_per_line=0 **)** |const| |
  393. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  394. | :ref:`String<class_String>` | :ref:`string_to_lower<class_TextServer_method_string_to_lower>` **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const| |
  395. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  396. | :ref:`String<class_String>` | :ref:`string_to_upper<class_TextServer_method_string_to_upper>` **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const| |
  397. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  398. | :ref:`String<class_String>` | :ref:`strip_diacritics<class_TextServer_method_strip_diacritics>` **(** :ref:`String<class_String>` string **)** |const| |
  399. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  400. | :ref:`String<class_String>` | :ref:`tag_to_name<class_TextServer_method_tag_to_name>` **(** :ref:`int<class_int>` tag **)** |const| |
  401. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  402. .. rst-class:: classref-section-separator
  403. ----
  404. .. rst-class:: classref-descriptions-group
  405. Enumerations
  406. ------------
  407. .. _enum_TextServer_FontAntialiasing:
  408. .. rst-class:: classref-enumeration
  409. enum **FontAntialiasing**:
  410. .. _class_TextServer_constant_FONT_ANTIALIASING_NONE:
  411. .. rst-class:: classref-enumeration-constant
  412. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_NONE** = ``0``
  413. Font glyphs are rasterized as 1-bit bitmaps.
  414. .. _class_TextServer_constant_FONT_ANTIALIASING_GRAY:
  415. .. rst-class:: classref-enumeration-constant
  416. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_GRAY** = ``1``
  417. Font glyphs are rasterized as 8-bit grayscale anti-aliased bitmaps.
  418. .. _class_TextServer_constant_FONT_ANTIALIASING_LCD:
  419. .. rst-class:: classref-enumeration-constant
  420. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_LCD** = ``2``
  421. Font glyphs are rasterized for LCD screens.
  422. LCD subpixel layout is determined by the value of ``gui/theme/lcd_subpixel_layout`` project settings.
  423. LCD subpixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D.
  424. .. rst-class:: classref-item-separator
  425. ----
  426. .. _enum_TextServer_FontLCDSubpixelLayout:
  427. .. rst-class:: classref-enumeration
  428. enum **FontLCDSubpixelLayout**:
  429. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_NONE:
  430. .. rst-class:: classref-enumeration-constant
  431. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_NONE** = ``0``
  432. Unknown or unsupported subpixel layout, LCD subpixel antialiasing is disabled.
  433. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HRGB:
  434. .. rst-class:: classref-enumeration-constant
  435. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HRGB** = ``1``
  436. Horizontal RGB subpixel layout.
  437. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HBGR:
  438. .. rst-class:: classref-enumeration-constant
  439. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HBGR** = ``2``
  440. Horizontal BGR subpixel layout.
  441. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VRGB:
  442. .. rst-class:: classref-enumeration-constant
  443. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VRGB** = ``3``
  444. Vertical RGB subpixel layout.
  445. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VBGR:
  446. .. rst-class:: classref-enumeration-constant
  447. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VBGR** = ``4``
  448. Vertical BGR subpixel layout.
  449. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_MAX:
  450. .. rst-class:: classref-enumeration-constant
  451. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_MAX** = ``5``
  452. .. rst-class:: classref-item-separator
  453. ----
  454. .. _enum_TextServer_Direction:
  455. .. rst-class:: classref-enumeration
  456. enum **Direction**:
  457. .. _class_TextServer_constant_DIRECTION_AUTO:
  458. .. rst-class:: classref-enumeration-constant
  459. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_AUTO** = ``0``
  460. Text direction is determined based on contents and current locale.
  461. .. _class_TextServer_constant_DIRECTION_LTR:
  462. .. rst-class:: classref-enumeration-constant
  463. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_LTR** = ``1``
  464. Text is written from left to right.
  465. .. _class_TextServer_constant_DIRECTION_RTL:
  466. .. rst-class:: classref-enumeration-constant
  467. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_RTL** = ``2``
  468. Text is written from right to left.
  469. .. _class_TextServer_constant_DIRECTION_INHERITED:
  470. .. rst-class:: classref-enumeration-constant
  471. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_INHERITED** = ``3``
  472. Text writing direction is the same as base string writing direction. Used for BiDi override only.
  473. .. rst-class:: classref-item-separator
  474. ----
  475. .. _enum_TextServer_Orientation:
  476. .. rst-class:: classref-enumeration
  477. enum **Orientation**:
  478. .. _class_TextServer_constant_ORIENTATION_HORIZONTAL:
  479. .. rst-class:: classref-enumeration-constant
  480. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_HORIZONTAL** = ``0``
  481. Text is written horizontally.
  482. .. _class_TextServer_constant_ORIENTATION_VERTICAL:
  483. .. rst-class:: classref-enumeration-constant
  484. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_VERTICAL** = ``1``
  485. Left to right text is written vertically from top to bottom.
  486. Right to left text is written vertically from bottom to top.
  487. .. rst-class:: classref-item-separator
  488. ----
  489. .. _enum_TextServer_JustificationFlag:
  490. .. rst-class:: classref-enumeration
  491. flags **JustificationFlag**:
  492. .. _class_TextServer_constant_JUSTIFICATION_NONE:
  493. .. rst-class:: classref-enumeration-constant
  494. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_NONE** = ``0``
  495. Do not justify text.
  496. .. _class_TextServer_constant_JUSTIFICATION_KASHIDA:
  497. .. rst-class:: classref-enumeration-constant
  498. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_KASHIDA** = ``1``
  499. Justify text by adding and removing kashidas.
  500. .. _class_TextServer_constant_JUSTIFICATION_WORD_BOUND:
  501. .. rst-class:: classref-enumeration-constant
  502. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_WORD_BOUND** = ``2``
  503. Justify text by changing width of the spaces between the words.
  504. .. _class_TextServer_constant_JUSTIFICATION_TRIM_EDGE_SPACES:
  505. .. rst-class:: classref-enumeration-constant
  506. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_TRIM_EDGE_SPACES** = ``4``
  507. Remove trailing and leading spaces from the justified text.
  508. .. _class_TextServer_constant_JUSTIFICATION_AFTER_LAST_TAB:
  509. .. rst-class:: classref-enumeration-constant
  510. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_AFTER_LAST_TAB** = ``8``
  511. Only apply justification to the part of the text after the last tab.
  512. .. _class_TextServer_constant_JUSTIFICATION_CONSTRAIN_ELLIPSIS:
  513. .. rst-class:: classref-enumeration-constant
  514. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_CONSTRAIN_ELLIPSIS** = ``16``
  515. Apply justification to the trimmed line with ellipsis.
  516. .. rst-class:: classref-item-separator
  517. ----
  518. .. _enum_TextServer_AutowrapMode:
  519. .. rst-class:: classref-enumeration
  520. enum **AutowrapMode**:
  521. .. _class_TextServer_constant_AUTOWRAP_OFF:
  522. .. rst-class:: classref-enumeration-constant
  523. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_OFF** = ``0``
  524. Autowrap is disabled.
  525. .. _class_TextServer_constant_AUTOWRAP_ARBITRARY:
  526. .. rst-class:: classref-enumeration-constant
  527. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_ARBITRARY** = ``1``
  528. Wraps the text inside the node's bounding rectangle by allowing to break lines at arbitrary positions, which is useful when very limited space is available.
  529. .. _class_TextServer_constant_AUTOWRAP_WORD:
  530. .. rst-class:: classref-enumeration-constant
  531. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD** = ``2``
  532. Wraps the text inside the node's bounding rectangle by soft-breaking between words.
  533. .. _class_TextServer_constant_AUTOWRAP_WORD_SMART:
  534. .. rst-class:: classref-enumeration-constant
  535. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD_SMART** = ``3``
  536. Behaves similarly to :ref:`AUTOWRAP_WORD<class_TextServer_constant_AUTOWRAP_WORD>`, but force-breaks a word if that single word does not fit in one line.
  537. .. rst-class:: classref-item-separator
  538. ----
  539. .. _enum_TextServer_LineBreakFlag:
  540. .. rst-class:: classref-enumeration
  541. flags **LineBreakFlag**:
  542. .. _class_TextServer_constant_BREAK_NONE:
  543. .. rst-class:: classref-enumeration-constant
  544. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_NONE** = ``0``
  545. Do not break the line.
  546. .. _class_TextServer_constant_BREAK_MANDATORY:
  547. .. rst-class:: classref-enumeration-constant
  548. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_MANDATORY** = ``1``
  549. Break the line at the line mandatory break characters (e.g. ``"\n"``).
  550. .. _class_TextServer_constant_BREAK_WORD_BOUND:
  551. .. rst-class:: classref-enumeration-constant
  552. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_WORD_BOUND** = ``2``
  553. Break the line between the words.
  554. .. _class_TextServer_constant_BREAK_GRAPHEME_BOUND:
  555. .. rst-class:: classref-enumeration-constant
  556. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_GRAPHEME_BOUND** = ``4``
  557. Break the line between any unconnected graphemes.
  558. .. _class_TextServer_constant_BREAK_ADAPTIVE:
  559. .. rst-class:: classref-enumeration-constant
  560. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_ADAPTIVE** = ``8``
  561. Should be used only in conjunction with :ref:`BREAK_WORD_BOUND<class_TextServer_constant_BREAK_WORD_BOUND>`, break the line between any unconnected graphemes, if it's impossible to break it between the words.
  562. .. _class_TextServer_constant_BREAK_TRIM_EDGE_SPACES:
  563. .. rst-class:: classref-enumeration-constant
  564. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_EDGE_SPACES** = ``16``
  565. Remove edge spaces from the broken line segments.
  566. .. rst-class:: classref-item-separator
  567. ----
  568. .. _enum_TextServer_VisibleCharactersBehavior:
  569. .. rst-class:: classref-enumeration
  570. enum **VisibleCharactersBehavior**:
  571. .. _class_TextServer_constant_VC_CHARS_BEFORE_SHAPING:
  572. .. rst-class:: classref-enumeration-constant
  573. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_BEFORE_SHAPING** = ``0``
  574. Trims text before the shaping. e.g, increasing :ref:`Label.visible_characters<class_Label_property_visible_characters>` or :ref:`RichTextLabel.visible_characters<class_RichTextLabel_property_visible_characters>` value is visually identical to typing the text.
  575. .. _class_TextServer_constant_VC_CHARS_AFTER_SHAPING:
  576. .. rst-class:: classref-enumeration-constant
  577. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_AFTER_SHAPING** = ``1``
  578. Displays glyphs that are mapped to the first :ref:`Label.visible_characters<class_Label_property_visible_characters>` or :ref:`RichTextLabel.visible_characters<class_RichTextLabel_property_visible_characters>` characters from the beginning of the text.
  579. .. _class_TextServer_constant_VC_GLYPHS_AUTO:
  580. .. rst-class:: classref-enumeration-constant
  581. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_AUTO** = ``2``
  582. Displays :ref:`Label.visible_ratio<class_Label_property_visible_ratio>` or :ref:`RichTextLabel.visible_ratio<class_RichTextLabel_property_visible_ratio>` glyphs, starting from the left or from the right, depending on :ref:`Control.layout_direction<class_Control_property_layout_direction>` value.
  583. .. _class_TextServer_constant_VC_GLYPHS_LTR:
  584. .. rst-class:: classref-enumeration-constant
  585. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_LTR** = ``3``
  586. Displays :ref:`Label.visible_ratio<class_Label_property_visible_ratio>` or :ref:`RichTextLabel.visible_ratio<class_RichTextLabel_property_visible_ratio>` glyphs, starting from the left.
  587. .. _class_TextServer_constant_VC_GLYPHS_RTL:
  588. .. rst-class:: classref-enumeration-constant
  589. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_RTL** = ``4``
  590. Displays :ref:`Label.visible_ratio<class_Label_property_visible_ratio>` or :ref:`RichTextLabel.visible_ratio<class_RichTextLabel_property_visible_ratio>` glyphs, starting from the right.
  591. .. rst-class:: classref-item-separator
  592. ----
  593. .. _enum_TextServer_OverrunBehavior:
  594. .. rst-class:: classref-enumeration
  595. enum **OverrunBehavior**:
  596. .. _class_TextServer_constant_OVERRUN_NO_TRIMMING:
  597. .. rst-class:: classref-enumeration-constant
  598. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_NO_TRIMMING** = ``0``
  599. No text trimming is performed.
  600. .. _class_TextServer_constant_OVERRUN_TRIM_CHAR:
  601. .. rst-class:: classref-enumeration-constant
  602. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_CHAR** = ``1``
  603. Trims the text per character.
  604. .. _class_TextServer_constant_OVERRUN_TRIM_WORD:
  605. .. rst-class:: classref-enumeration-constant
  606. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD** = ``2``
  607. Trims the text per word.
  608. .. _class_TextServer_constant_OVERRUN_TRIM_ELLIPSIS:
  609. .. rst-class:: classref-enumeration-constant
  610. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_ELLIPSIS** = ``3``
  611. Trims the text per character and adds an ellipsis to indicate that parts are hidden.
  612. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ELLIPSIS:
  613. .. rst-class:: classref-enumeration-constant
  614. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD_ELLIPSIS** = ``4``
  615. Trims the text per word and adds an ellipsis to indicate that parts are hidden.
  616. .. rst-class:: classref-item-separator
  617. ----
  618. .. _enum_TextServer_TextOverrunFlag:
  619. .. rst-class:: classref-enumeration
  620. flags **TextOverrunFlag**:
  621. .. _class_TextServer_constant_OVERRUN_NO_TRIM:
  622. .. rst-class:: classref-enumeration-constant
  623. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_NO_TRIM** = ``0``
  624. No trimming is performed.
  625. .. _class_TextServer_constant_OVERRUN_TRIM:
  626. .. rst-class:: classref-enumeration-constant
  627. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM** = ``1``
  628. Trims the text when it exceeds the given width.
  629. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ONLY:
  630. .. rst-class:: classref-enumeration-constant
  631. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM_WORD_ONLY** = ``2``
  632. Trims the text per word instead of per grapheme.
  633. .. _class_TextServer_constant_OVERRUN_ADD_ELLIPSIS:
  634. .. rst-class:: classref-enumeration-constant
  635. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ADD_ELLIPSIS** = ``4``
  636. Determines whether an ellipsis should be added at the end of the text.
  637. .. _class_TextServer_constant_OVERRUN_ENFORCE_ELLIPSIS:
  638. .. rst-class:: classref-enumeration-constant
  639. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ENFORCE_ELLIPSIS** = ``8``
  640. Determines whether the ellipsis at the end of the text is enforced and may not be hidden.
  641. .. _class_TextServer_constant_OVERRUN_JUSTIFICATION_AWARE:
  642. .. rst-class:: classref-enumeration-constant
  643. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_JUSTIFICATION_AWARE** = ``16``
  644. .. rst-class:: classref-item-separator
  645. ----
  646. .. _enum_TextServer_GraphemeFlag:
  647. .. rst-class:: classref-enumeration
  648. flags **GraphemeFlag**:
  649. .. _class_TextServer_constant_GRAPHEME_IS_VALID:
  650. .. rst-class:: classref-enumeration-constant
  651. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VALID** = ``1``
  652. Grapheme is supported by the font, and can be drawn.
  653. .. _class_TextServer_constant_GRAPHEME_IS_RTL:
  654. .. rst-class:: classref-enumeration-constant
  655. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_RTL** = ``2``
  656. Grapheme is part of right-to-left or bottom-to-top run.
  657. .. _class_TextServer_constant_GRAPHEME_IS_VIRTUAL:
  658. .. rst-class:: classref-enumeration-constant
  659. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VIRTUAL** = ``4``
  660. Grapheme is not part of source text, it was added by justification process.
  661. .. _class_TextServer_constant_GRAPHEME_IS_SPACE:
  662. .. rst-class:: classref-enumeration-constant
  663. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SPACE** = ``8``
  664. Grapheme is whitespace.
  665. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_HARD:
  666. .. rst-class:: classref-enumeration-constant
  667. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_HARD** = ``16``
  668. Grapheme is mandatory break point (e.g. ``"\n"``).
  669. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_SOFT:
  670. .. rst-class:: classref-enumeration-constant
  671. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_SOFT** = ``32``
  672. Grapheme is optional break point (e.g. space).
  673. .. _class_TextServer_constant_GRAPHEME_IS_TAB:
  674. .. rst-class:: classref-enumeration-constant
  675. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_TAB** = ``64``
  676. Grapheme is the tabulation character.
  677. .. _class_TextServer_constant_GRAPHEME_IS_ELONGATION:
  678. .. rst-class:: classref-enumeration-constant
  679. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_ELONGATION** = ``128``
  680. Grapheme is kashida.
  681. .. _class_TextServer_constant_GRAPHEME_IS_PUNCTUATION:
  682. .. rst-class:: classref-enumeration-constant
  683. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_PUNCTUATION** = ``256``
  684. Grapheme is punctuation character.
  685. .. _class_TextServer_constant_GRAPHEME_IS_UNDERSCORE:
  686. .. rst-class:: classref-enumeration-constant
  687. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_UNDERSCORE** = ``512``
  688. Grapheme is underscore character.
  689. .. _class_TextServer_constant_GRAPHEME_IS_CONNECTED:
  690. .. rst-class:: classref-enumeration-constant
  691. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_CONNECTED** = ``1024``
  692. Grapheme is connected to the previous grapheme. Breaking line before this grapheme is not safe.
  693. .. _class_TextServer_constant_GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL:
  694. .. rst-class:: classref-enumeration-constant
  695. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL** = ``2048``
  696. It is safe to insert a U+0640 before this grapheme for elongation.
  697. .. rst-class:: classref-item-separator
  698. ----
  699. .. _enum_TextServer_Hinting:
  700. .. rst-class:: classref-enumeration
  701. enum **Hinting**:
  702. .. _class_TextServer_constant_HINTING_NONE:
  703. .. rst-class:: classref-enumeration-constant
  704. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NONE** = ``0``
  705. Disables font hinting (smoother but less crisp).
  706. .. _class_TextServer_constant_HINTING_LIGHT:
  707. .. rst-class:: classref-enumeration-constant
  708. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_LIGHT** = ``1``
  709. Use the light font hinting mode.
  710. .. _class_TextServer_constant_HINTING_NORMAL:
  711. .. rst-class:: classref-enumeration-constant
  712. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NORMAL** = ``2``
  713. Use the default font hinting mode (crisper but less smooth).
  714. \ **Note:** This hinting mode changes both horizontal and vertical glyph metrics. If applied to monospace font, some glyphs might have different width.
  715. .. rst-class:: classref-item-separator
  716. ----
  717. .. _enum_TextServer_SubpixelPositioning:
  718. .. rst-class:: classref-enumeration
  719. enum **SubpixelPositioning**:
  720. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_DISABLED:
  721. .. rst-class:: classref-enumeration-constant
  722. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_DISABLED** = ``0``
  723. Glyph horizontal position is rounded to the whole pixel size, each glyph is rasterized once.
  724. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO:
  725. .. rst-class:: classref-enumeration-constant
  726. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_AUTO** = ``1``
  727. Glyph horizontal position is rounded based on font size.
  728. - To one quarter of the pixel size if font size is smaller or equal to :ref:`SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE<class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE>`.
  729. - To one half of the pixel size if font size is smaller or equal to :ref:`SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE<class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE>`.
  730. - To the whole pixel size for larger fonts.
  731. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF:
  732. .. rst-class:: classref-enumeration-constant
  733. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF** = ``2``
  734. Glyph horizontal position is rounded to one half of the pixel size, each glyph is rasterized up to two times.
  735. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER:
  736. .. rst-class:: classref-enumeration-constant
  737. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER** = ``3``
  738. Glyph horizontal position is rounded to one quarter of the pixel size, each glyph is rasterized up to four times.
  739. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE:
  740. .. rst-class:: classref-enumeration-constant
  741. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE** = ``20``
  742. Maximum font size which will use one half of the pixel subpixel positioning in :ref:`SUBPIXEL_POSITIONING_AUTO<class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO>` mode.
  743. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE:
  744. .. rst-class:: classref-enumeration-constant
  745. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE** = ``16``
  746. Maximum font size which will use one quarter of the pixel subpixel positioning in :ref:`SUBPIXEL_POSITIONING_AUTO<class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO>` mode.
  747. .. rst-class:: classref-item-separator
  748. ----
  749. .. _enum_TextServer_Feature:
  750. .. rst-class:: classref-enumeration
  751. enum **Feature**:
  752. .. _class_TextServer_constant_FEATURE_SIMPLE_LAYOUT:
  753. .. rst-class:: classref-enumeration-constant
  754. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SIMPLE_LAYOUT** = ``1``
  755. TextServer supports simple text layouts.
  756. .. _class_TextServer_constant_FEATURE_BIDI_LAYOUT:
  757. .. rst-class:: classref-enumeration-constant
  758. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BIDI_LAYOUT** = ``2``
  759. TextServer supports bidirectional text layouts.
  760. .. _class_TextServer_constant_FEATURE_VERTICAL_LAYOUT:
  761. .. rst-class:: classref-enumeration-constant
  762. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_VERTICAL_LAYOUT** = ``4``
  763. TextServer supports vertical layouts.
  764. .. _class_TextServer_constant_FEATURE_SHAPING:
  765. .. rst-class:: classref-enumeration-constant
  766. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SHAPING** = ``8``
  767. TextServer supports complex text shaping.
  768. .. _class_TextServer_constant_FEATURE_KASHIDA_JUSTIFICATION:
  769. .. rst-class:: classref-enumeration-constant
  770. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_KASHIDA_JUSTIFICATION** = ``16``
  771. TextServer supports justification using kashidas.
  772. .. _class_TextServer_constant_FEATURE_BREAK_ITERATORS:
  773. .. rst-class:: classref-enumeration-constant
  774. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BREAK_ITERATORS** = ``32``
  775. TextServer supports complex line/word breaking rules (e.g. dictionary based).
  776. .. _class_TextServer_constant_FEATURE_FONT_BITMAP:
  777. .. rst-class:: classref-enumeration-constant
  778. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_BITMAP** = ``64``
  779. TextServer supports loading bitmap fonts.
  780. .. _class_TextServer_constant_FEATURE_FONT_DYNAMIC:
  781. .. rst-class:: classref-enumeration-constant
  782. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_DYNAMIC** = ``128``
  783. TextServer supports loading dynamic (TrueType, OpeType, etc.) fonts.
  784. .. _class_TextServer_constant_FEATURE_FONT_MSDF:
  785. .. rst-class:: classref-enumeration-constant
  786. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_MSDF** = ``256``
  787. TextServer supports multichannel signed distance field dynamic font rendering.
  788. .. _class_TextServer_constant_FEATURE_FONT_SYSTEM:
  789. .. rst-class:: classref-enumeration-constant
  790. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_SYSTEM** = ``512``
  791. TextServer supports loading system fonts.
  792. .. _class_TextServer_constant_FEATURE_FONT_VARIABLE:
  793. .. rst-class:: classref-enumeration-constant
  794. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_VARIABLE** = ``1024``
  795. TextServer supports variable fonts.
  796. .. _class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION:
  797. .. rst-class:: classref-enumeration-constant
  798. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION** = ``2048``
  799. TextServer supports locale dependent and context sensitive case conversion.
  800. .. _class_TextServer_constant_FEATURE_USE_SUPPORT_DATA:
  801. .. rst-class:: classref-enumeration-constant
  802. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_USE_SUPPORT_DATA** = ``4096``
  803. TextServer require external data file for some features, see :ref:`load_support_data<class_TextServer_method_load_support_data>`.
  804. .. _class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS:
  805. .. rst-class:: classref-enumeration-constant
  806. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_IDENTIFIERS** = ``8192``
  807. TextServer supports UAX #31 identifier validation, see :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>`.
  808. .. _class_TextServer_constant_FEATURE_UNICODE_SECURITY:
  809. .. rst-class:: classref-enumeration-constant
  810. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_SECURITY** = ``16384``
  811. TextServer supports `Unicode Technical Report #36 <https://unicode.org/reports/tr36/>`__ and `Unicode Technical Standard #39 <https://unicode.org/reports/tr39/>`__ based spoof detection features.
  812. .. rst-class:: classref-item-separator
  813. ----
  814. .. _enum_TextServer_ContourPointTag:
  815. .. rst-class:: classref-enumeration
  816. enum **ContourPointTag**:
  817. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_ON:
  818. .. rst-class:: classref-enumeration-constant
  819. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_ON** = ``1``
  820. Contour point is on the curve.
  821. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC:
  822. .. rst-class:: classref-enumeration-constant
  823. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CONIC** = ``0``
  824. Contour point isn't on the curve, but serves as a control point for a conic (quadratic) Bézier arc.
  825. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CUBIC:
  826. .. rst-class:: classref-enumeration-constant
  827. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CUBIC** = ``2``
  828. Contour point isn't on the curve, but serves as a control point for a cubic Bézier arc.
  829. .. rst-class:: classref-item-separator
  830. ----
  831. .. _enum_TextServer_SpacingType:
  832. .. rst-class:: classref-enumeration
  833. enum **SpacingType**:
  834. .. _class_TextServer_constant_SPACING_GLYPH:
  835. .. rst-class:: classref-enumeration-constant
  836. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_GLYPH** = ``0``
  837. Spacing for each glyph.
  838. .. _class_TextServer_constant_SPACING_SPACE:
  839. .. rst-class:: classref-enumeration-constant
  840. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_SPACE** = ``1``
  841. Spacing for the space character.
  842. .. _class_TextServer_constant_SPACING_TOP:
  843. .. rst-class:: classref-enumeration-constant
  844. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_TOP** = ``2``
  845. Spacing at the top of the line.
  846. .. _class_TextServer_constant_SPACING_BOTTOM:
  847. .. rst-class:: classref-enumeration-constant
  848. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_BOTTOM** = ``3``
  849. Spacing at the bottom of the line.
  850. .. _class_TextServer_constant_SPACING_MAX:
  851. .. rst-class:: classref-enumeration-constant
  852. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_MAX** = ``4``
  853. .. rst-class:: classref-item-separator
  854. ----
  855. .. _enum_TextServer_FontStyle:
  856. .. rst-class:: classref-enumeration
  857. flags **FontStyle**:
  858. .. _class_TextServer_constant_FONT_BOLD:
  859. .. rst-class:: classref-enumeration-constant
  860. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_BOLD** = ``1``
  861. Font is bold.
  862. .. _class_TextServer_constant_FONT_ITALIC:
  863. .. rst-class:: classref-enumeration-constant
  864. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_ITALIC** = ``2``
  865. Font is italic or oblique.
  866. .. _class_TextServer_constant_FONT_FIXED_WIDTH:
  867. .. rst-class:: classref-enumeration-constant
  868. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_FIXED_WIDTH** = ``4``
  869. Font have fixed-width characters.
  870. .. rst-class:: classref-item-separator
  871. ----
  872. .. _enum_TextServer_StructuredTextParser:
  873. .. rst-class:: classref-enumeration
  874. enum **StructuredTextParser**:
  875. .. _class_TextServer_constant_STRUCTURED_TEXT_DEFAULT:
  876. .. rst-class:: classref-enumeration-constant
  877. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_DEFAULT** = ``0``
  878. Use default Unicode BiDi algorithm.
  879. .. _class_TextServer_constant_STRUCTURED_TEXT_URI:
  880. .. rst-class:: classref-enumeration-constant
  881. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_URI** = ``1``
  882. BiDi override for URI.
  883. .. _class_TextServer_constant_STRUCTURED_TEXT_FILE:
  884. .. rst-class:: classref-enumeration-constant
  885. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_FILE** = ``2``
  886. BiDi override for file path.
  887. .. _class_TextServer_constant_STRUCTURED_TEXT_EMAIL:
  888. .. rst-class:: classref-enumeration-constant
  889. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_EMAIL** = ``3``
  890. BiDi override for email.
  891. .. _class_TextServer_constant_STRUCTURED_TEXT_LIST:
  892. .. rst-class:: classref-enumeration-constant
  893. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_LIST** = ``4``
  894. BiDi override for lists.
  895. Structured text options: list separator ``String``.
  896. .. _class_TextServer_constant_STRUCTURED_TEXT_GDSCRIPT:
  897. .. rst-class:: classref-enumeration-constant
  898. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_GDSCRIPT** = ``5``
  899. BiDi override for GDScript.
  900. .. _class_TextServer_constant_STRUCTURED_TEXT_CUSTOM:
  901. .. rst-class:: classref-enumeration-constant
  902. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_CUSTOM** = ``6``
  903. User defined structured text BiDi override function.
  904. .. rst-class:: classref-section-separator
  905. ----
  906. .. rst-class:: classref-descriptions-group
  907. Method Descriptions
  908. -------------------
  909. .. _class_TextServer_method_create_font:
  910. .. rst-class:: classref-method
  911. :ref:`RID<class_RID>` **create_font** **(** **)**
  912. Creates new, empty font cache entry resource. To free the resulting resource, use :ref:`free_rid<class_TextServer_method_free_rid>` method.
  913. .. rst-class:: classref-item-separator
  914. ----
  915. .. _class_TextServer_method_create_shaped_text:
  916. .. rst-class:: classref-method
  917. :ref:`RID<class_RID>` **create_shaped_text** **(** :ref:`Direction<enum_TextServer_Direction>` direction=0, :ref:`Orientation<enum_TextServer_Orientation>` orientation=0 **)**
  918. Creates new buffer for complex text layout, with the given ``direction`` and ``orientation``. To free the resulting buffer, use :ref:`free_rid<class_TextServer_method_free_rid>` method.
  919. \ **Note:** Direction is ignored if server does not support :ref:`FEATURE_BIDI_LAYOUT<class_TextServer_constant_FEATURE_BIDI_LAYOUT>` feature (supported by :ref:`TextServerAdvanced<class_TextServerAdvanced>`).
  920. \ **Note:** Orientation is ignored if server does not support :ref:`FEATURE_VERTICAL_LAYOUT<class_TextServer_constant_FEATURE_VERTICAL_LAYOUT>` feature (supported by :ref:`TextServerAdvanced<class_TextServerAdvanced>`).
  921. .. rst-class:: classref-item-separator
  922. ----
  923. .. _class_TextServer_method_draw_hex_code_box:
  924. .. rst-class:: classref-method
  925. 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 **)** |const|
  926. Draws box displaying character hexadecimal code. Used for replacing missing characters.
  927. .. rst-class:: classref-item-separator
  928. ----
  929. .. _class_TextServer_method_font_clear_glyphs:
  930. .. rst-class:: classref-method
  931. void **font_clear_glyphs** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)**
  932. Removes all rendered glyphs information from the cache entry.
  933. \ **Note:** This function will not remove textures associated with the glyphs, use :ref:`font_remove_texture<class_TextServer_method_font_remove_texture>` to remove them manually.
  934. .. rst-class:: classref-item-separator
  935. ----
  936. .. _class_TextServer_method_font_clear_kerning_map:
  937. .. rst-class:: classref-method
  938. void **font_clear_kerning_map** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)**
  939. Removes all kerning overrides.
  940. .. rst-class:: classref-item-separator
  941. ----
  942. .. _class_TextServer_method_font_clear_size_cache:
  943. .. rst-class:: classref-method
  944. void **font_clear_size_cache** **(** :ref:`RID<class_RID>` font_rid **)**
  945. Removes all font sizes from the cache entry.
  946. .. rst-class:: classref-item-separator
  947. ----
  948. .. _class_TextServer_method_font_clear_textures:
  949. .. rst-class:: classref-method
  950. void **font_clear_textures** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)**
  951. Removes all textures from font cache entry.
  952. \ **Note:** This function will not remove glyphs associated with the texture, use :ref:`font_remove_glyph<class_TextServer_method_font_remove_glyph>` to remove them manually.
  953. .. rst-class:: classref-item-separator
  954. ----
  955. .. _class_TextServer_method_font_draw_glyph:
  956. .. rst-class:: classref-method
  957. 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=Color(1, 1, 1, 1) **)** |const|
  958. Draws single glyph into a canvas item at the position, using ``font_rid`` at the size ``size``.
  959. \ **Note:** Glyph index is specific to the font, use glyphs indices returned by :ref:`shaped_text_get_glyphs<class_TextServer_method_shaped_text_get_glyphs>` or :ref:`font_get_glyph_index<class_TextServer_method_font_get_glyph_index>`.
  960. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  961. .. rst-class:: classref-item-separator
  962. ----
  963. .. _class_TextServer_method_font_draw_glyph_outline:
  964. .. rst-class:: classref-method
  965. 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=Color(1, 1, 1, 1) **)** |const|
  966. Draws single glyph outline of size ``outline_size`` into a canvas item at the position, using ``font_rid`` at the size ``size``.
  967. \ **Note:** Glyph index is specific to the font, use glyphs indices returned by :ref:`shaped_text_get_glyphs<class_TextServer_method_shaped_text_get_glyphs>` or :ref:`font_get_glyph_index<class_TextServer_method_font_get_glyph_index>`.
  968. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  969. .. rst-class:: classref-item-separator
  970. ----
  971. .. _class_TextServer_method_font_get_antialiasing:
  972. .. rst-class:: classref-method
  973. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **font_get_antialiasing** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  974. Returns font anti-aliasing mode.
  975. .. rst-class:: classref-item-separator
  976. ----
  977. .. _class_TextServer_method_font_get_ascent:
  978. .. rst-class:: classref-method
  979. :ref:`float<class_float>` **font_get_ascent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  980. Returns the font ascent (number of pixels above the baseline).
  981. .. rst-class:: classref-item-separator
  982. ----
  983. .. _class_TextServer_method_font_get_descent:
  984. .. rst-class:: classref-method
  985. :ref:`float<class_float>` **font_get_descent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  986. Returns the font descent (number of pixels below the baseline).
  987. .. rst-class:: classref-item-separator
  988. ----
  989. .. _class_TextServer_method_font_get_embolden:
  990. .. rst-class:: classref-method
  991. :ref:`float<class_float>` **font_get_embolden** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  992. Returns font embolden strength.
  993. .. rst-class:: classref-item-separator
  994. ----
  995. .. _class_TextServer_method_font_get_face_count:
  996. .. rst-class:: classref-method
  997. :ref:`int<class_int>` **font_get_face_count** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  998. Returns number of faces in the TrueType / OpenType collection.
  999. .. rst-class:: classref-item-separator
  1000. ----
  1001. .. _class_TextServer_method_font_get_face_index:
  1002. .. rst-class:: classref-method
  1003. :ref:`int<class_int>` **font_get_face_index** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1004. Recturns an active face index in the TrueType / OpenType collection.
  1005. .. rst-class:: classref-item-separator
  1006. ----
  1007. .. _class_TextServer_method_font_get_fixed_size:
  1008. .. rst-class:: classref-method
  1009. :ref:`int<class_int>` **font_get_fixed_size** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1010. Returns bitmap font fixed size.
  1011. .. rst-class:: classref-item-separator
  1012. ----
  1013. .. _class_TextServer_method_font_get_generate_mipmaps:
  1014. .. rst-class:: classref-method
  1015. :ref:`bool<class_bool>` **font_get_generate_mipmaps** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1016. Returns ``true`` if font texture mipmap generation is enabled.
  1017. .. rst-class:: classref-item-separator
  1018. ----
  1019. .. _class_TextServer_method_font_get_global_oversampling:
  1020. .. rst-class:: classref-method
  1021. :ref:`float<class_float>` **font_get_global_oversampling** **(** **)** |const|
  1022. Returns the font oversampling factor, shared by all fonts in the TextServer.
  1023. .. rst-class:: classref-item-separator
  1024. ----
  1025. .. _class_TextServer_method_font_get_glyph_advance:
  1026. .. rst-class:: classref-method
  1027. :ref:`Vector2<class_Vector2>` **font_get_glyph_advance** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph **)** |const|
  1028. Returns glyph advance (offset of the next glyph).
  1029. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1030. .. rst-class:: classref-item-separator
  1031. ----
  1032. .. _class_TextServer_method_font_get_glyph_contours:
  1033. .. rst-class:: classref-method
  1034. :ref:`Dictionary<class_Dictionary>` **font_get_glyph_contours** **(** :ref:`RID<class_RID>` font, :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |const|
  1035. Returns outline contours of the glyph as a ``Dictionary`` with the following contents:
  1036. \ ``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.
  1037. \ ``contours`` - :ref:`PackedInt32Array<class_PackedInt32Array>`, containing indices the end points of each contour.
  1038. \ ``orientation`` - :ref:`bool<class_bool>`, contour orientation. If ``true``, clockwise contours must be filled.
  1039. .. rst-class:: classref-item-separator
  1040. ----
  1041. .. _class_TextServer_method_font_get_glyph_index:
  1042. .. rst-class:: classref-method
  1043. :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 **)** |const|
  1044. Returns the glyph index of a ``char``, optionally modified by the ``variation_selector``.
  1045. .. rst-class:: classref-item-separator
  1046. ----
  1047. .. _class_TextServer_method_font_get_glyph_list:
  1048. .. rst-class:: classref-method
  1049. :ref:`PackedInt32Array<class_PackedInt32Array>` **font_get_glyph_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const|
  1050. Returns list of rendered glyphs in the cache entry.
  1051. .. rst-class:: classref-item-separator
  1052. ----
  1053. .. _class_TextServer_method_font_get_glyph_offset:
  1054. .. rst-class:: classref-method
  1055. :ref:`Vector2<class_Vector2>` **font_get_glyph_offset** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|
  1056. Returns glyph offset from the baseline.
  1057. .. rst-class:: classref-item-separator
  1058. ----
  1059. .. _class_TextServer_method_font_get_glyph_size:
  1060. .. rst-class:: classref-method
  1061. :ref:`Vector2<class_Vector2>` **font_get_glyph_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|
  1062. Returns size of the glyph.
  1063. .. rst-class:: classref-item-separator
  1064. ----
  1065. .. _class_TextServer_method_font_get_glyph_texture_idx:
  1066. .. rst-class:: classref-method
  1067. :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 **)** |const|
  1068. Returns index of the cache texture containing the glyph.
  1069. .. rst-class:: classref-item-separator
  1070. ----
  1071. .. _class_TextServer_method_font_get_glyph_texture_rid:
  1072. .. rst-class:: classref-method
  1073. :ref:`RID<class_RID>` **font_get_glyph_texture_rid** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|
  1074. Returns resource ID of the cache texture containing the glyph.
  1075. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1076. .. rst-class:: classref-item-separator
  1077. ----
  1078. .. _class_TextServer_method_font_get_glyph_texture_size:
  1079. .. rst-class:: classref-method
  1080. :ref:`Vector2<class_Vector2>` **font_get_glyph_texture_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|
  1081. Returns size of the cache texture containing the glyph.
  1082. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1083. .. rst-class:: classref-item-separator
  1084. ----
  1085. .. _class_TextServer_method_font_get_glyph_uv_rect:
  1086. .. rst-class:: classref-method
  1087. :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 **)** |const|
  1088. Returns rectangle in the cache texture containing the glyph.
  1089. .. rst-class:: classref-item-separator
  1090. ----
  1091. .. _class_TextServer_method_font_get_hinting:
  1092. .. rst-class:: classref-method
  1093. :ref:`Hinting<enum_TextServer_Hinting>` **font_get_hinting** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1094. Returns the font hinting mode. Used by dynamic fonts only.
  1095. .. rst-class:: classref-item-separator
  1096. ----
  1097. .. _class_TextServer_method_font_get_kerning:
  1098. .. rst-class:: classref-method
  1099. :ref:`Vector2<class_Vector2>` **font_get_kerning** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)** |const|
  1100. Returns kerning for the pair of glyphs.
  1101. .. rst-class:: classref-item-separator
  1102. ----
  1103. .. _class_TextServer_method_font_get_kerning_list:
  1104. .. rst-class:: classref-method
  1105. :ref:`Vector2i[]<class_Vector2i>` **font_get_kerning_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1106. Returns list of the kerning overrides.
  1107. .. rst-class:: classref-item-separator
  1108. ----
  1109. .. _class_TextServer_method_font_get_language_support_override:
  1110. .. rst-class:: classref-method
  1111. :ref:`bool<class_bool>` **font_get_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)**
  1112. Returns ``true`` if support override is enabled for the ``language``.
  1113. .. rst-class:: classref-item-separator
  1114. ----
  1115. .. _class_TextServer_method_font_get_language_support_overrides:
  1116. .. rst-class:: classref-method
  1117. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_language_support_overrides** **(** :ref:`RID<class_RID>` font_rid **)**
  1118. Returns list of language support overrides.
  1119. .. rst-class:: classref-item-separator
  1120. ----
  1121. .. _class_TextServer_method_font_get_msdf_pixel_range:
  1122. .. rst-class:: classref-method
  1123. :ref:`int<class_int>` **font_get_msdf_pixel_range** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1124. Returns the width of the range around the shape between the minimum and maximum representable signed distance.
  1125. .. rst-class:: classref-item-separator
  1126. ----
  1127. .. _class_TextServer_method_font_get_msdf_size:
  1128. .. rst-class:: classref-method
  1129. :ref:`int<class_int>` **font_get_msdf_size** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1130. Returns source font size used to generate MSDF textures.
  1131. .. rst-class:: classref-item-separator
  1132. ----
  1133. .. _class_TextServer_method_font_get_name:
  1134. .. rst-class:: classref-method
  1135. :ref:`String<class_String>` **font_get_name** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1136. Returns font family name.
  1137. .. rst-class:: classref-item-separator
  1138. ----
  1139. .. _class_TextServer_method_font_get_opentype_feature_overrides:
  1140. .. rst-class:: classref-method
  1141. :ref:`Dictionary<class_Dictionary>` **font_get_opentype_feature_overrides** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1142. Returns font OpenType feature set override.
  1143. .. rst-class:: classref-item-separator
  1144. ----
  1145. .. _class_TextServer_method_font_get_oversampling:
  1146. .. rst-class:: classref-method
  1147. :ref:`float<class_float>` **font_get_oversampling** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1148. Returns font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1149. .. rst-class:: classref-item-separator
  1150. ----
  1151. .. _class_TextServer_method_font_get_scale:
  1152. .. rst-class:: classref-method
  1153. :ref:`float<class_float>` **font_get_scale** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1154. Returns scaling factor of the color bitmap font.
  1155. .. rst-class:: classref-item-separator
  1156. ----
  1157. .. _class_TextServer_method_font_get_script_support_override:
  1158. .. rst-class:: classref-method
  1159. :ref:`bool<class_bool>` **font_get_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)**
  1160. Returns ``true`` if support override is enabled for the ``script``.
  1161. .. rst-class:: classref-item-separator
  1162. ----
  1163. .. _class_TextServer_method_font_get_script_support_overrides:
  1164. .. rst-class:: classref-method
  1165. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_script_support_overrides** **(** :ref:`RID<class_RID>` font_rid **)**
  1166. Returns list of script support overrides.
  1167. .. rst-class:: classref-item-separator
  1168. ----
  1169. .. _class_TextServer_method_font_get_size_cache_list:
  1170. .. rst-class:: classref-method
  1171. :ref:`Vector2i[]<class_Vector2i>` **font_get_size_cache_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1172. Returns list of the font sizes in the cache. Each size is ``Vector2i`` with font size and outline size.
  1173. .. rst-class:: classref-item-separator
  1174. ----
  1175. .. _class_TextServer_method_font_get_stretch:
  1176. .. rst-class:: classref-method
  1177. :ref:`int<class_int>` **font_get_stretch** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1178. Returns font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1179. .. rst-class:: classref-item-separator
  1180. ----
  1181. .. _class_TextServer_method_font_get_style:
  1182. .. rst-class:: classref-method
  1183. :ref:`FontStyle<enum_TextServer_FontStyle>` **font_get_style** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1184. Returns font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1185. .. rst-class:: classref-item-separator
  1186. ----
  1187. .. _class_TextServer_method_font_get_style_name:
  1188. .. rst-class:: classref-method
  1189. :ref:`String<class_String>` **font_get_style_name** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1190. Returns font style name.
  1191. .. rst-class:: classref-item-separator
  1192. ----
  1193. .. _class_TextServer_method_font_get_subpixel_positioning:
  1194. .. rst-class:: classref-method
  1195. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **font_get_subpixel_positioning** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1196. Returns font subpixel glyph positioning mode.
  1197. .. rst-class:: classref-item-separator
  1198. ----
  1199. .. _class_TextServer_method_font_get_supported_chars:
  1200. .. rst-class:: classref-method
  1201. :ref:`String<class_String>` **font_get_supported_chars** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1202. Returns a string containing all the characters available in the font.
  1203. .. rst-class:: classref-item-separator
  1204. ----
  1205. .. _class_TextServer_method_font_get_texture_count:
  1206. .. rst-class:: classref-method
  1207. :ref:`int<class_int>` **font_get_texture_count** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const|
  1208. Returns number of textures used by font cache entry.
  1209. .. rst-class:: classref-item-separator
  1210. ----
  1211. .. _class_TextServer_method_font_get_texture_image:
  1212. .. rst-class:: classref-method
  1213. :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 **)** |const|
  1214. Returns font cache texture image data.
  1215. .. rst-class:: classref-item-separator
  1216. ----
  1217. .. _class_TextServer_method_font_get_texture_offsets:
  1218. .. rst-class:: classref-method
  1219. :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 **)** |const|
  1220. Returns array containing glyph packing data.
  1221. .. rst-class:: classref-item-separator
  1222. ----
  1223. .. _class_TextServer_method_font_get_transform:
  1224. .. rst-class:: classref-method
  1225. :ref:`Transform2D<class_Transform2D>` **font_get_transform** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1226. Returns 2D transform applied to the font outlines.
  1227. .. rst-class:: classref-item-separator
  1228. ----
  1229. .. _class_TextServer_method_font_get_underline_position:
  1230. .. rst-class:: classref-method
  1231. :ref:`float<class_float>` **font_get_underline_position** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1232. Returns pixel offset of the underline below the baseline.
  1233. .. rst-class:: classref-item-separator
  1234. ----
  1235. .. _class_TextServer_method_font_get_underline_thickness:
  1236. .. rst-class:: classref-method
  1237. :ref:`float<class_float>` **font_get_underline_thickness** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1238. Returns thickness of the underline in pixels.
  1239. .. rst-class:: classref-item-separator
  1240. ----
  1241. .. _class_TextServer_method_font_get_variation_coordinates:
  1242. .. rst-class:: classref-method
  1243. :ref:`Dictionary<class_Dictionary>` **font_get_variation_coordinates** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1244. Returns variation coordinates for the specified font cache entry. See :ref:`font_supported_variation_list<class_TextServer_method_font_supported_variation_list>` for more info.
  1245. .. rst-class:: classref-item-separator
  1246. ----
  1247. .. _class_TextServer_method_font_get_weight:
  1248. .. rst-class:: classref-method
  1249. :ref:`int<class_int>` **font_get_weight** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1250. Returns weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1251. .. rst-class:: classref-item-separator
  1252. ----
  1253. .. _class_TextServer_method_font_has_char:
  1254. .. rst-class:: classref-method
  1255. :ref:`bool<class_bool>` **font_has_char** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` char **)** |const|
  1256. Returns ``true`` if a Unicode ``char`` is available in the font.
  1257. .. rst-class:: classref-item-separator
  1258. ----
  1259. .. _class_TextServer_method_font_is_allow_system_fallback:
  1260. .. rst-class:: classref-method
  1261. :ref:`bool<class_bool>` **font_is_allow_system_fallback** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1262. Returns ``true`` if system fonts can be automatically used as fallbacks.
  1263. .. rst-class:: classref-item-separator
  1264. ----
  1265. .. _class_TextServer_method_font_is_force_autohinter:
  1266. .. rst-class:: classref-method
  1267. :ref:`bool<class_bool>` **font_is_force_autohinter** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1268. Returns ``true`` if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.
  1269. .. rst-class:: classref-item-separator
  1270. ----
  1271. .. _class_TextServer_method_font_is_language_supported:
  1272. .. rst-class:: classref-method
  1273. :ref:`bool<class_bool>` **font_is_language_supported** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |const|
  1274. Returns ``true``, if font supports given language (`ISO 639 <https://en.wikipedia.org/wiki/ISO_639-1>`__ code).
  1275. .. rst-class:: classref-item-separator
  1276. ----
  1277. .. _class_TextServer_method_font_is_multichannel_signed_distance_field:
  1278. .. rst-class:: classref-method
  1279. :ref:`bool<class_bool>` **font_is_multichannel_signed_distance_field** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1280. Returns ``true`` if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.
  1281. .. rst-class:: classref-item-separator
  1282. ----
  1283. .. _class_TextServer_method_font_is_script_supported:
  1284. .. rst-class:: classref-method
  1285. :ref:`bool<class_bool>` **font_is_script_supported** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |const|
  1286. Returns ``true``, if font supports given script (ISO 15924 code).
  1287. .. rst-class:: classref-item-separator
  1288. ----
  1289. .. _class_TextServer_method_font_remove_glyph:
  1290. .. rst-class:: classref-method
  1291. void **font_remove_glyph** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)**
  1292. Removes specified rendered glyph information from the cache entry.
  1293. \ **Note:** This function will not remove textures associated with the glyphs, use :ref:`font_remove_texture<class_TextServer_method_font_remove_texture>` to remove them manually.
  1294. .. rst-class:: classref-item-separator
  1295. ----
  1296. .. _class_TextServer_method_font_remove_kerning:
  1297. .. rst-class:: classref-method
  1298. void **font_remove_kerning** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)**
  1299. Removes kerning override for the pair of glyphs.
  1300. .. rst-class:: classref-item-separator
  1301. ----
  1302. .. _class_TextServer_method_font_remove_language_support_override:
  1303. .. rst-class:: classref-method
  1304. void **font_remove_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)**
  1305. Remove language support override.
  1306. .. rst-class:: classref-item-separator
  1307. ----
  1308. .. _class_TextServer_method_font_remove_script_support_override:
  1309. .. rst-class:: classref-method
  1310. void **font_remove_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)**
  1311. Removes script support override.
  1312. .. rst-class:: classref-item-separator
  1313. ----
  1314. .. _class_TextServer_method_font_remove_size_cache:
  1315. .. rst-class:: classref-method
  1316. void **font_remove_size_cache** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)**
  1317. Removes specified font size from the cache entry.
  1318. .. rst-class:: classref-item-separator
  1319. ----
  1320. .. _class_TextServer_method_font_remove_texture:
  1321. .. rst-class:: classref-method
  1322. void **font_remove_texture** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)**
  1323. Removes specified texture from the cache entry.
  1324. \ **Note:** This function will not remove glyphs associated with the texture, remove them manually, using :ref:`font_remove_glyph<class_TextServer_method_font_remove_glyph>`.
  1325. .. rst-class:: classref-item-separator
  1326. ----
  1327. .. _class_TextServer_method_font_render_glyph:
  1328. .. rst-class:: classref-method
  1329. void **font_render_glyph** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` index **)**
  1330. Renders specified glyph to the font cache texture.
  1331. .. rst-class:: classref-item-separator
  1332. ----
  1333. .. _class_TextServer_method_font_render_range:
  1334. .. rst-class:: classref-method
  1335. 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 **)**
  1336. Renders the range of characters to the font cache texture.
  1337. .. rst-class:: classref-item-separator
  1338. ----
  1339. .. _class_TextServer_method_font_set_allow_system_fallback:
  1340. .. rst-class:: classref-method
  1341. void **font_set_allow_system_fallback** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` allow_system_fallback **)**
  1342. If set to ``true``, system fonts can be automatically used as fallbacks.
  1343. .. rst-class:: classref-item-separator
  1344. ----
  1345. .. _class_TextServer_method_font_set_antialiasing:
  1346. .. rst-class:: classref-method
  1347. void **font_set_antialiasing** **(** :ref:`RID<class_RID>` font_rid, :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` antialiasing **)**
  1348. Sets font anti-aliasing mode.
  1349. .. rst-class:: classref-item-separator
  1350. ----
  1351. .. _class_TextServer_method_font_set_ascent:
  1352. .. rst-class:: classref-method
  1353. void **font_set_ascent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` ascent **)**
  1354. Sets the font ascent (number of pixels above the baseline).
  1355. .. rst-class:: classref-item-separator
  1356. ----
  1357. .. _class_TextServer_method_font_set_data:
  1358. .. rst-class:: classref-method
  1359. void **font_set_data** **(** :ref:`RID<class_RID>` font_rid, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
  1360. Sets font source data, e.g contents of the dynamic font source file.
  1361. .. rst-class:: classref-item-separator
  1362. ----
  1363. .. _class_TextServer_method_font_set_descent:
  1364. .. rst-class:: classref-method
  1365. void **font_set_descent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` descent **)**
  1366. Sets the font descent (number of pixels below the baseline).
  1367. .. rst-class:: classref-item-separator
  1368. ----
  1369. .. _class_TextServer_method_font_set_embolden:
  1370. .. rst-class:: classref-method
  1371. void **font_set_embolden** **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` strength **)**
  1372. Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
  1373. .. rst-class:: classref-item-separator
  1374. ----
  1375. .. _class_TextServer_method_font_set_face_index:
  1376. .. rst-class:: classref-method
  1377. void **font_set_face_index** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` face_index **)**
  1378. Sets an active face index in the TrueType / OpenType collection.
  1379. .. rst-class:: classref-item-separator
  1380. ----
  1381. .. _class_TextServer_method_font_set_fixed_size:
  1382. .. rst-class:: classref-method
  1383. void **font_set_fixed_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` fixed_size **)**
  1384. Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.
  1385. .. rst-class:: classref-item-separator
  1386. ----
  1387. .. _class_TextServer_method_font_set_force_autohinter:
  1388. .. rst-class:: classref-method
  1389. void **font_set_force_autohinter** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` force_autohinter **)**
  1390. If set to ``true`` auto-hinting is preferred over font built-in hinting.
  1391. .. rst-class:: classref-item-separator
  1392. ----
  1393. .. _class_TextServer_method_font_set_generate_mipmaps:
  1394. .. rst-class:: classref-method
  1395. void **font_set_generate_mipmaps** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` generate_mipmaps **)**
  1396. If set to ``true`` font texture mipmap generation is enabled.
  1397. .. rst-class:: classref-item-separator
  1398. ----
  1399. .. _class_TextServer_method_font_set_global_oversampling:
  1400. .. rst-class:: classref-method
  1401. void **font_set_global_oversampling** **(** :ref:`float<class_float>` oversampling **)**
  1402. Sets oversampling factor, shared by all font in the TextServer.
  1403. \ **Note:** This value can be automatically changed by display server.
  1404. .. rst-class:: classref-item-separator
  1405. ----
  1406. .. _class_TextServer_method_font_set_glyph_advance:
  1407. .. rst-class:: classref-method
  1408. 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 **)**
  1409. Sets glyph advance (offset of the next glyph).
  1410. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1411. .. rst-class:: classref-item-separator
  1412. ----
  1413. .. _class_TextServer_method_font_set_glyph_offset:
  1414. .. rst-class:: classref-method
  1415. 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 **)**
  1416. Sets glyph offset from the baseline.
  1417. .. rst-class:: classref-item-separator
  1418. ----
  1419. .. _class_TextServer_method_font_set_glyph_size:
  1420. .. rst-class:: classref-method
  1421. 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 **)**
  1422. Sets size of the glyph.
  1423. .. rst-class:: classref-item-separator
  1424. ----
  1425. .. _class_TextServer_method_font_set_glyph_texture_idx:
  1426. .. rst-class:: classref-method
  1427. 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 **)**
  1428. Sets index of the cache texture containing the glyph.
  1429. .. rst-class:: classref-item-separator
  1430. ----
  1431. .. _class_TextServer_method_font_set_glyph_uv_rect:
  1432. .. rst-class:: classref-method
  1433. 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 **)**
  1434. Sets rectangle in the cache texture containing the glyph.
  1435. .. rst-class:: classref-item-separator
  1436. ----
  1437. .. _class_TextServer_method_font_set_hinting:
  1438. .. rst-class:: classref-method
  1439. void **font_set_hinting** **(** :ref:`RID<class_RID>` font_rid, :ref:`Hinting<enum_TextServer_Hinting>` hinting **)**
  1440. Sets font hinting mode. Used by dynamic fonts only.
  1441. .. rst-class:: classref-item-separator
  1442. ----
  1443. .. _class_TextServer_method_font_set_kerning:
  1444. .. rst-class:: classref-method
  1445. 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 **)**
  1446. Sets kerning for the pair of glyphs.
  1447. .. rst-class:: classref-item-separator
  1448. ----
  1449. .. _class_TextServer_method_font_set_language_support_override:
  1450. .. rst-class:: classref-method
  1451. void **font_set_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language, :ref:`bool<class_bool>` supported **)**
  1452. Adds override for :ref:`font_is_language_supported<class_TextServer_method_font_is_language_supported>`.
  1453. .. rst-class:: classref-item-separator
  1454. ----
  1455. .. _class_TextServer_method_font_set_msdf_pixel_range:
  1456. .. rst-class:: classref-method
  1457. void **font_set_msdf_pixel_range** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_pixel_range **)**
  1458. Sets the width of the range around the shape between the minimum and maximum representable signed distance.
  1459. .. rst-class:: classref-item-separator
  1460. ----
  1461. .. _class_TextServer_method_font_set_msdf_size:
  1462. .. rst-class:: classref-method
  1463. void **font_set_msdf_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_size **)**
  1464. Sets source font size used to generate MSDF textures.
  1465. .. rst-class:: classref-item-separator
  1466. ----
  1467. .. _class_TextServer_method_font_set_multichannel_signed_distance_field:
  1468. .. rst-class:: classref-method
  1469. void **font_set_multichannel_signed_distance_field** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` msdf **)**
  1470. If set to ``true``, glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. MSDF rendering allows displaying the font at any scaling factor without blurriness, and without incurring a CPU cost when the font size changes (since the font no longer needs to be rasterized on the CPU). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes.
  1471. \ **Note:** MSDF font rendering does not render glyphs with overlapping shapes correctly. Overlapping shapes are not valid per the OpenType standard, but are still commonly found in many font files, especially those converted by Google Fonts. To avoid issues with overlapping glyphs, consider downloading the font file directly from the type foundry instead of relying on Google Fonts.
  1472. .. rst-class:: classref-item-separator
  1473. ----
  1474. .. _class_TextServer_method_font_set_name:
  1475. .. rst-class:: classref-method
  1476. void **font_set_name** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)**
  1477. Sets the font family name.
  1478. .. rst-class:: classref-item-separator
  1479. ----
  1480. .. _class_TextServer_method_font_set_opentype_feature_overrides:
  1481. .. rst-class:: classref-method
  1482. void **font_set_opentype_feature_overrides** **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` overrides **)**
  1483. Sets font OpenType feature set override.
  1484. .. rst-class:: classref-item-separator
  1485. ----
  1486. .. _class_TextServer_method_font_set_oversampling:
  1487. .. rst-class:: classref-method
  1488. void **font_set_oversampling** **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` oversampling **)**
  1489. Sets font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1490. .. rst-class:: classref-item-separator
  1491. ----
  1492. .. _class_TextServer_method_font_set_scale:
  1493. .. rst-class:: classref-method
  1494. void **font_set_scale** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` scale **)**
  1495. Sets scaling factor of the color bitmap font.
  1496. .. rst-class:: classref-item-separator
  1497. ----
  1498. .. _class_TextServer_method_font_set_script_support_override:
  1499. .. rst-class:: classref-method
  1500. void **font_set_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script, :ref:`bool<class_bool>` supported **)**
  1501. Adds override for :ref:`font_is_script_supported<class_TextServer_method_font_is_script_supported>`.
  1502. .. rst-class:: classref-item-separator
  1503. ----
  1504. .. _class_TextServer_method_font_set_stretch:
  1505. .. rst-class:: classref-method
  1506. void **font_set_stretch** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)**
  1507. Sets font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1508. \ **Note:** This value is used for font matching only and will not affect font rendering. Use :ref:`font_set_face_index<class_TextServer_method_font_set_face_index>`, :ref:`font_set_variation_coordinates<class_TextServer_method_font_set_variation_coordinates>`, or :ref:`font_set_transform<class_TextServer_method_font_set_transform>` instead.
  1509. .. rst-class:: classref-item-separator
  1510. ----
  1511. .. _class_TextServer_method_font_set_style:
  1512. .. rst-class:: classref-method
  1513. void **font_set_style** **(** :ref:`RID<class_RID>` font_rid, :ref:`FontStyle<enum_TextServer_FontStyle>` style **)**
  1514. Sets the font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1515. \ **Note:** This value is used for font matching only and will not affect font rendering. Use :ref:`font_set_face_index<class_TextServer_method_font_set_face_index>`, :ref:`font_set_variation_coordinates<class_TextServer_method_font_set_variation_coordinates>`, :ref:`font_set_embolden<class_TextServer_method_font_set_embolden>`, or :ref:`font_set_transform<class_TextServer_method_font_set_transform>` instead.
  1516. .. rst-class:: classref-item-separator
  1517. ----
  1518. .. _class_TextServer_method_font_set_style_name:
  1519. .. rst-class:: classref-method
  1520. void **font_set_style_name** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)**
  1521. Sets the font style name.
  1522. .. rst-class:: classref-item-separator
  1523. ----
  1524. .. _class_TextServer_method_font_set_subpixel_positioning:
  1525. .. rst-class:: classref-method
  1526. void **font_set_subpixel_positioning** **(** :ref:`RID<class_RID>` font_rid, :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` subpixel_positioning **)**
  1527. Sets font subpixel glyph positioning mode.
  1528. .. rst-class:: classref-item-separator
  1529. ----
  1530. .. _class_TextServer_method_font_set_texture_image:
  1531. .. rst-class:: classref-method
  1532. 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 **)**
  1533. Sets font cache texture image data.
  1534. .. rst-class:: classref-item-separator
  1535. ----
  1536. .. _class_TextServer_method_font_set_texture_offsets:
  1537. .. rst-class:: classref-method
  1538. 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 **)**
  1539. Sets array containing glyph packing data.
  1540. .. rst-class:: classref-item-separator
  1541. ----
  1542. .. _class_TextServer_method_font_set_transform:
  1543. .. rst-class:: classref-method
  1544. void **font_set_transform** **(** :ref:`RID<class_RID>` font_rid, :ref:`Transform2D<class_Transform2D>` transform **)**
  1545. Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs.
  1546. For example, to simulate italic typeface by slanting, apply the following transform ``Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)``.
  1547. .. rst-class:: classref-item-separator
  1548. ----
  1549. .. _class_TextServer_method_font_set_underline_position:
  1550. .. rst-class:: classref-method
  1551. void **font_set_underline_position** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_position **)**
  1552. Sets pixel offset of the underline below the baseline.
  1553. .. rst-class:: classref-item-separator
  1554. ----
  1555. .. _class_TextServer_method_font_set_underline_thickness:
  1556. .. rst-class:: classref-method
  1557. void **font_set_underline_thickness** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_thickness **)**
  1558. Sets thickness of the underline in pixels.
  1559. .. rst-class:: classref-item-separator
  1560. ----
  1561. .. _class_TextServer_method_font_set_variation_coordinates:
  1562. .. rst-class:: classref-method
  1563. void **font_set_variation_coordinates** **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` variation_coordinates **)**
  1564. Sets variation coordinates for the specified font cache entry. See :ref:`font_supported_variation_list<class_TextServer_method_font_supported_variation_list>` for more info.
  1565. .. rst-class:: classref-item-separator
  1566. ----
  1567. .. _class_TextServer_method_font_set_weight:
  1568. .. rst-class:: classref-method
  1569. void **font_set_weight** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)**
  1570. Sets weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1571. \ **Note:** This value is used for font matching only and will not affect font rendering. Use :ref:`font_set_face_index<class_TextServer_method_font_set_face_index>`, :ref:`font_set_variation_coordinates<class_TextServer_method_font_set_variation_coordinates>`, or :ref:`font_set_embolden<class_TextServer_method_font_set_embolden>` instead.
  1572. .. rst-class:: classref-item-separator
  1573. ----
  1574. .. _class_TextServer_method_font_supported_feature_list:
  1575. .. rst-class:: classref-method
  1576. :ref:`Dictionary<class_Dictionary>` **font_supported_feature_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1577. Returns the dictionary of the supported OpenType features.
  1578. .. rst-class:: classref-item-separator
  1579. ----
  1580. .. _class_TextServer_method_font_supported_variation_list:
  1581. .. rst-class:: classref-method
  1582. :ref:`Dictionary<class_Dictionary>` **font_supported_variation_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1583. Returns the dictionary of the supported OpenType variation coordinates.
  1584. .. rst-class:: classref-item-separator
  1585. ----
  1586. .. _class_TextServer_method_format_number:
  1587. .. rst-class:: classref-method
  1588. :ref:`String<class_String>` **format_number** **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const|
  1589. Converts a number from the Western Arabic (0..9) to the numeral systems used in ``language``.
  1590. If ``language`` is omitted, the active locale will be used.
  1591. .. rst-class:: classref-item-separator
  1592. ----
  1593. .. _class_TextServer_method_free_rid:
  1594. .. rst-class:: classref-method
  1595. void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
  1596. Frees an object created by this **TextServer**.
  1597. .. rst-class:: classref-item-separator
  1598. ----
  1599. .. _class_TextServer_method_get_features:
  1600. .. rst-class:: classref-method
  1601. :ref:`int<class_int>` **get_features** **(** **)** |const|
  1602. Returns text server features, see :ref:`Feature<enum_TextServer_Feature>`.
  1603. .. rst-class:: classref-item-separator
  1604. ----
  1605. .. _class_TextServer_method_get_hex_code_box_size:
  1606. .. rst-class:: classref-method
  1607. :ref:`Vector2<class_Vector2>` **get_hex_code_box_size** **(** :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |const|
  1608. Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).
  1609. .. rst-class:: classref-item-separator
  1610. ----
  1611. .. _class_TextServer_method_get_name:
  1612. .. rst-class:: classref-method
  1613. :ref:`String<class_String>` **get_name** **(** **)** |const|
  1614. Returns the name of the server interface.
  1615. .. rst-class:: classref-item-separator
  1616. ----
  1617. .. _class_TextServer_method_get_support_data_filename:
  1618. .. rst-class:: classref-method
  1619. :ref:`String<class_String>` **get_support_data_filename** **(** **)** |const|
  1620. Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename.
  1621. .. rst-class:: classref-item-separator
  1622. ----
  1623. .. _class_TextServer_method_get_support_data_info:
  1624. .. rst-class:: classref-method
  1625. :ref:`String<class_String>` **get_support_data_info** **(** **)** |const|
  1626. Returns TextServer database (e.g. ICU break iterators and dictionaries) description.
  1627. .. rst-class:: classref-item-separator
  1628. ----
  1629. .. _class_TextServer_method_has:
  1630. .. rst-class:: classref-method
  1631. :ref:`bool<class_bool>` **has** **(** :ref:`RID<class_RID>` rid **)**
  1632. Returns ``true`` if ``rid`` is valid resource owned by this text server.
  1633. .. rst-class:: classref-item-separator
  1634. ----
  1635. .. _class_TextServer_method_has_feature:
  1636. .. rst-class:: classref-method
  1637. :ref:`bool<class_bool>` **has_feature** **(** :ref:`Feature<enum_TextServer_Feature>` feature **)** |const|
  1638. Returns ``true`` if the server supports a feature.
  1639. .. rst-class:: classref-item-separator
  1640. ----
  1641. .. _class_TextServer_method_is_confusable:
  1642. .. rst-class:: classref-method
  1643. :ref:`int<class_int>` **is_confusable** **(** :ref:`String<class_String>` string, :ref:`PackedStringArray<class_PackedStringArray>` dict **)** |const|
  1644. Returns index of the first string in ``dict`` which is visually confusable with the ``string``, or ``-1`` if none is found.
  1645. \ **Note:** This method doesn't detect invisible characters, for spoof detection use it in combination with :ref:`spoof_check<class_TextServer_method_spoof_check>`.
  1646. \ **Note:** Always returns ``-1`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  1647. .. rst-class:: classref-item-separator
  1648. ----
  1649. .. _class_TextServer_method_is_locale_right_to_left:
  1650. .. rst-class:: classref-method
  1651. :ref:`bool<class_bool>` **is_locale_right_to_left** **(** :ref:`String<class_String>` locale **)** |const|
  1652. Returns ``true`` if locale is right-to-left.
  1653. .. rst-class:: classref-item-separator
  1654. ----
  1655. .. _class_TextServer_method_is_valid_identifier:
  1656. .. rst-class:: classref-method
  1657. :ref:`bool<class_bool>` **is_valid_identifier** **(** :ref:`String<class_String>` string **)** |const|
  1658. Returns ``true`` is ``string`` is a valid identifier.
  1659. If the text server supports the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature, a valid identifier must:
  1660. - Conform to normalization form C.
  1661. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1662. - May contain Unicode characters of class XID_Continue in the other positions.
  1663. - Use UAX #31 recommended scripts only (mixed scripts are allowed).
  1664. If the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature is not supported, a valid identifier must:
  1665. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1666. - May contain Unicode characters of class XID_Continue in the other positions.
  1667. .. rst-class:: classref-item-separator
  1668. ----
  1669. .. _class_TextServer_method_load_support_data:
  1670. .. rst-class:: classref-method
  1671. :ref:`bool<class_bool>` **load_support_data** **(** :ref:`String<class_String>` filename **)**
  1672. Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
  1673. \ **Note:** This function should be called before any other TextServer functions used, otherwise it won't have any effect.
  1674. .. rst-class:: classref-item-separator
  1675. ----
  1676. .. _class_TextServer_method_name_to_tag:
  1677. .. rst-class:: classref-method
  1678. :ref:`int<class_int>` **name_to_tag** **(** :ref:`String<class_String>` name **)** |const|
  1679. Converts readable feature, variation, script or language name to OpenType tag.
  1680. .. rst-class:: classref-item-separator
  1681. ----
  1682. .. _class_TextServer_method_parse_number:
  1683. .. rst-class:: classref-method
  1684. :ref:`String<class_String>` **parse_number** **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const|
  1685. Converts ``number`` from the numeral systems used in ``language`` to Western Arabic (0..9).
  1686. .. rst-class:: classref-item-separator
  1687. ----
  1688. .. _class_TextServer_method_parse_structured_text:
  1689. .. rst-class:: classref-method
  1690. :ref:`Vector3i[]<class_Vector3i>` **parse_structured_text** **(** :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` parser_type, :ref:`Array<class_Array>` args, :ref:`String<class_String>` text **)** |const|
  1691. Default implementation of the BiDi algorithm override function. See :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` for more info.
  1692. .. rst-class:: classref-item-separator
  1693. ----
  1694. .. _class_TextServer_method_percent_sign:
  1695. .. rst-class:: classref-method
  1696. :ref:`String<class_String>` **percent_sign** **(** :ref:`String<class_String>` language="" **)** |const|
  1697. Returns percent sign used in the ``language``.
  1698. .. rst-class:: classref-item-separator
  1699. ----
  1700. .. _class_TextServer_method_save_support_data:
  1701. .. rst-class:: classref-method
  1702. :ref:`bool<class_bool>` **save_support_data** **(** :ref:`String<class_String>` filename **)** |const|
  1703. Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.
  1704. \ **Note:** This function is used by during project export, to include TextServer database.
  1705. .. rst-class:: classref-item-separator
  1706. ----
  1707. .. _class_TextServer_method_shaped_get_span_count:
  1708. .. rst-class:: classref-method
  1709. :ref:`int<class_int>` **shaped_get_span_count** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1710. Returns number of text spans added using :ref:`shaped_text_add_string<class_TextServer_method_shaped_text_add_string>` or :ref:`shaped_text_add_object<class_TextServer_method_shaped_text_add_object>`.
  1711. .. rst-class:: classref-item-separator
  1712. ----
  1713. .. _class_TextServer_method_shaped_get_span_meta:
  1714. .. rst-class:: classref-method
  1715. :ref:`Variant<class_Variant>` **shaped_get_span_meta** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` index **)** |const|
  1716. Returns text span metadata.
  1717. .. rst-class:: classref-item-separator
  1718. ----
  1719. .. _class_TextServer_method_shaped_set_span_update_font:
  1720. .. rst-class:: classref-method
  1721. void **shaped_set_span_update_font** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` index, :ref:`RID[]<class_RID>` fonts, :ref:`int<class_int>` size, :ref:`Dictionary<class_Dictionary>` opentype_features={} **)**
  1722. Changes text span font, font size and OpenType features, without changing the text.
  1723. .. rst-class:: classref-item-separator
  1724. ----
  1725. .. _class_TextServer_method_shaped_text_add_object:
  1726. .. rst-class:: classref-method
  1727. :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=5, :ref:`int<class_int>` length=1, :ref:`float<class_float>` baseline=0.0 **)**
  1728. Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters.
  1729. .. rst-class:: classref-item-separator
  1730. ----
  1731. .. _class_TextServer_method_shaped_text_add_string:
  1732. .. rst-class:: classref-method
  1733. :ref:`bool<class_bool>` **shaped_text_add_string** **(** :ref:`RID<class_RID>` shaped, :ref:`String<class_String>` text, :ref:`RID[]<class_RID>` fonts, :ref:`int<class_int>` size, :ref:`Dictionary<class_Dictionary>` opentype_features={}, :ref:`String<class_String>` language="", :ref:`Variant<class_Variant>` meta=null **)**
  1734. Adds text span and font to draw it to the text buffer.
  1735. .. rst-class:: classref-item-separator
  1736. ----
  1737. .. _class_TextServer_method_shaped_text_clear:
  1738. .. rst-class:: classref-method
  1739. void **shaped_text_clear** **(** :ref:`RID<class_RID>` rid **)**
  1740. Clears text buffer (removes text and inline objects).
  1741. .. rst-class:: classref-item-separator
  1742. ----
  1743. .. _class_TextServer_method_shaped_text_draw:
  1744. .. rst-class:: classref-method
  1745. 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=-1, :ref:`float<class_float>` clip_r=-1, :ref:`Color<class_Color>` color=Color(1, 1, 1, 1) **)** |const|
  1746. 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).
  1747. .. rst-class:: classref-item-separator
  1748. ----
  1749. .. _class_TextServer_method_shaped_text_draw_outline:
  1750. .. rst-class:: classref-method
  1751. 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=-1, :ref:`float<class_float>` clip_r=-1, :ref:`int<class_int>` outline_size=1, :ref:`Color<class_Color>` color=Color(1, 1, 1, 1) **)** |const|
  1752. 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).
  1753. .. rst-class:: classref-item-separator
  1754. ----
  1755. .. _class_TextServer_method_shaped_text_fit_to_width:
  1756. .. rst-class:: classref-method
  1757. :ref:`float<class_float>` **shaped_text_fit_to_width** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width, :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` jst_flags=3 **)**
  1758. Adjusts text with to fit to specified width, returns new text width.
  1759. .. rst-class:: classref-item-separator
  1760. ----
  1761. .. _class_TextServer_method_shaped_text_get_ascent:
  1762. .. rst-class:: classref-method
  1763. :ref:`float<class_float>` **shaped_text_get_ascent** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1764. Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
  1765. \ **Note:** Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline.
  1766. .. rst-class:: classref-item-separator
  1767. ----
  1768. .. _class_TextServer_method_shaped_text_get_carets:
  1769. .. rst-class:: classref-method
  1770. :ref:`Dictionary<class_Dictionary>` **shaped_text_get_carets** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` position **)** |const|
  1771. Returns shapes of the carets corresponding to the character offset ``position`` in the text. Returned caret shape is 1 pixel wide rectangle.
  1772. .. rst-class:: classref-item-separator
  1773. ----
  1774. .. _class_TextServer_method_shaped_text_get_custom_punctuation:
  1775. .. rst-class:: classref-method
  1776. :ref:`String<class_String>` **shaped_text_get_custom_punctuation** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1777. Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  1778. .. rst-class:: classref-item-separator
  1779. ----
  1780. .. _class_TextServer_method_shaped_text_get_descent:
  1781. .. rst-class:: classref-method
  1782. :ref:`float<class_float>` **shaped_text_get_descent** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1783. Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
  1784. \ **Note:** Overall descent can be higher than font descent, if some glyphs are displaced from the baseline.
  1785. .. rst-class:: classref-item-separator
  1786. ----
  1787. .. _class_TextServer_method_shaped_text_get_direction:
  1788. .. rst-class:: classref-method
  1789. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_direction** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1790. Returns direction of the text.
  1791. .. rst-class:: classref-item-separator
  1792. ----
  1793. .. _class_TextServer_method_shaped_text_get_dominant_direction_in_range:
  1794. .. rst-class:: classref-method
  1795. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_dominant_direction_in_range** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |const|
  1796. Returns dominant direction of in the range of text.
  1797. .. rst-class:: classref-item-separator
  1798. ----
  1799. .. _class_TextServer_method_shaped_text_get_ellipsis_glyph_count:
  1800. .. rst-class:: classref-method
  1801. :ref:`int<class_int>` **shaped_text_get_ellipsis_glyph_count** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1802. Returns number of glyphs in the ellipsis.
  1803. .. rst-class:: classref-item-separator
  1804. ----
  1805. .. _class_TextServer_method_shaped_text_get_ellipsis_glyphs:
  1806. .. rst-class:: classref-method
  1807. :ref:`Dictionary[]<class_Dictionary>` **shaped_text_get_ellipsis_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1808. Returns array of the glyphs in the ellipsis.
  1809. .. rst-class:: classref-item-separator
  1810. ----
  1811. .. _class_TextServer_method_shaped_text_get_ellipsis_pos:
  1812. .. rst-class:: classref-method
  1813. :ref:`int<class_int>` **shaped_text_get_ellipsis_pos** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1814. Returns position of the ellipsis.
  1815. .. rst-class:: classref-item-separator
  1816. ----
  1817. .. _class_TextServer_method_shaped_text_get_glyph_count:
  1818. .. rst-class:: classref-method
  1819. :ref:`int<class_int>` **shaped_text_get_glyph_count** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1820. Returns number of glyphs in the buffer.
  1821. .. rst-class:: classref-item-separator
  1822. ----
  1823. .. _class_TextServer_method_shaped_text_get_glyphs:
  1824. .. rst-class:: classref-method
  1825. :ref:`Dictionary[]<class_Dictionary>` **shaped_text_get_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1826. Returns an array of glyphs in the visual order.
  1827. .. rst-class:: classref-item-separator
  1828. ----
  1829. .. _class_TextServer_method_shaped_text_get_grapheme_bounds:
  1830. .. rst-class:: classref-method
  1831. :ref:`Vector2<class_Vector2>` **shaped_text_get_grapheme_bounds** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  1832. Returns composite character's bounds as offsets from the start of the line.
  1833. .. rst-class:: classref-item-separator
  1834. ----
  1835. .. _class_TextServer_method_shaped_text_get_inferred_direction:
  1836. .. rst-class:: classref-method
  1837. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_inferred_direction** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1838. Returns direction of the text, inferred by the BiDi algorithm.
  1839. .. rst-class:: classref-item-separator
  1840. ----
  1841. .. _class_TextServer_method_shaped_text_get_line_breaks:
  1842. .. rst-class:: classref-method
  1843. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_line_breaks** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width, :ref:`int<class_int>` start=0, :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` break_flags=3 **)** |const|
  1844. Breaks text to the lines and returns character ranges for each line.
  1845. .. rst-class:: classref-item-separator
  1846. ----
  1847. .. _class_TextServer_method_shaped_text_get_line_breaks_adv:
  1848. .. rst-class:: classref-method
  1849. :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=0, :ref:`bool<class_bool>` once=true, :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` break_flags=3 **)** |const|
  1850. Breaks text to the lines and columns. Returns character ranges for each segment.
  1851. .. rst-class:: classref-item-separator
  1852. ----
  1853. .. _class_TextServer_method_shaped_text_get_object_rect:
  1854. .. rst-class:: classref-method
  1855. :ref:`Rect2<class_Rect2>` **shaped_text_get_object_rect** **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key **)** |const|
  1856. Returns bounding rectangle of the inline object.
  1857. .. rst-class:: classref-item-separator
  1858. ----
  1859. .. _class_TextServer_method_shaped_text_get_objects:
  1860. .. rst-class:: classref-method
  1861. :ref:`Array<class_Array>` **shaped_text_get_objects** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1862. Returns array of inline objects.
  1863. .. rst-class:: classref-item-separator
  1864. ----
  1865. .. _class_TextServer_method_shaped_text_get_orientation:
  1866. .. rst-class:: classref-method
  1867. :ref:`Orientation<enum_TextServer_Orientation>` **shaped_text_get_orientation** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1868. Returns text orientation.
  1869. .. rst-class:: classref-item-separator
  1870. ----
  1871. .. _class_TextServer_method_shaped_text_get_parent:
  1872. .. rst-class:: classref-method
  1873. :ref:`RID<class_RID>` **shaped_text_get_parent** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1874. Returns the parent buffer from which the substring originates.
  1875. .. rst-class:: classref-item-separator
  1876. ----
  1877. .. _class_TextServer_method_shaped_text_get_preserve_control:
  1878. .. rst-class:: classref-method
  1879. :ref:`bool<class_bool>` **shaped_text_get_preserve_control** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1880. Returns ``true`` if text buffer is configured to display control characters.
  1881. .. rst-class:: classref-item-separator
  1882. ----
  1883. .. _class_TextServer_method_shaped_text_get_preserve_invalid:
  1884. .. rst-class:: classref-method
  1885. :ref:`bool<class_bool>` **shaped_text_get_preserve_invalid** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1886. Returns ``true`` if text buffer is configured to display hexadecimal codes in place of invalid characters.
  1887. \ **Note:** If set to ``false``, nothing is displayed in place of invalid characters.
  1888. .. rst-class:: classref-item-separator
  1889. ----
  1890. .. _class_TextServer_method_shaped_text_get_range:
  1891. .. rst-class:: classref-method
  1892. :ref:`Vector2i<class_Vector2i>` **shaped_text_get_range** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1893. Returns substring buffer character range in the parent buffer.
  1894. .. rst-class:: classref-item-separator
  1895. ----
  1896. .. _class_TextServer_method_shaped_text_get_selection:
  1897. .. rst-class:: classref-method
  1898. :ref:`PackedVector2Array<class_PackedVector2Array>` **shaped_text_get_selection** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |const|
  1899. Returns selection rectangles for the specified character range.
  1900. .. rst-class:: classref-item-separator
  1901. ----
  1902. .. _class_TextServer_method_shaped_text_get_size:
  1903. .. rst-class:: classref-method
  1904. :ref:`Vector2<class_Vector2>` **shaped_text_get_size** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1905. Returns size of the text.
  1906. .. rst-class:: classref-item-separator
  1907. ----
  1908. .. _class_TextServer_method_shaped_text_get_spacing:
  1909. .. rst-class:: classref-method
  1910. :ref:`int<class_int>` **shaped_text_get_spacing** **(** :ref:`RID<class_RID>` shaped, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |const|
  1911. Returns extra spacing added between glyphs or lines in pixels.
  1912. .. rst-class:: classref-item-separator
  1913. ----
  1914. .. _class_TextServer_method_shaped_text_get_trim_pos:
  1915. .. rst-class:: classref-method
  1916. :ref:`int<class_int>` **shaped_text_get_trim_pos** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1917. Returns the position of the overrun trim.
  1918. .. rst-class:: classref-item-separator
  1919. ----
  1920. .. _class_TextServer_method_shaped_text_get_underline_position:
  1921. .. rst-class:: classref-method
  1922. :ref:`float<class_float>` **shaped_text_get_underline_position** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1923. Returns pixel offset of the underline below the baseline.
  1924. .. rst-class:: classref-item-separator
  1925. ----
  1926. .. _class_TextServer_method_shaped_text_get_underline_thickness:
  1927. .. rst-class:: classref-method
  1928. :ref:`float<class_float>` **shaped_text_get_underline_thickness** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1929. Returns thickness of the underline.
  1930. .. rst-class:: classref-item-separator
  1931. ----
  1932. .. _class_TextServer_method_shaped_text_get_width:
  1933. .. rst-class:: classref-method
  1934. :ref:`float<class_float>` **shaped_text_get_width** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1935. Returns width (for horizontal layout) or height (for vertical) of the text.
  1936. .. rst-class:: classref-item-separator
  1937. ----
  1938. .. _class_TextServer_method_shaped_text_get_word_breaks:
  1939. .. rst-class:: classref-method
  1940. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_word_breaks** **(** :ref:`RID<class_RID>` shaped, :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` grapheme_flags=264 **)** |const|
  1941. Breaks text into words and returns array of character ranges. Use ``grapheme_flags`` to set what characters are used for breaking (see :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`).
  1942. .. rst-class:: classref-item-separator
  1943. ----
  1944. .. _class_TextServer_method_shaped_text_hit_test_grapheme:
  1945. .. rst-class:: classref-method
  1946. :ref:`int<class_int>` **shaped_text_hit_test_grapheme** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coords **)** |const|
  1947. Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` if none is found.
  1948. .. rst-class:: classref-item-separator
  1949. ----
  1950. .. _class_TextServer_method_shaped_text_hit_test_position:
  1951. .. rst-class:: classref-method
  1952. :ref:`int<class_int>` **shaped_text_hit_test_position** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coords **)** |const|
  1953. Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
  1954. .. rst-class:: classref-item-separator
  1955. ----
  1956. .. _class_TextServer_method_shaped_text_is_ready:
  1957. .. rst-class:: classref-method
  1958. :ref:`bool<class_bool>` **shaped_text_is_ready** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1959. Returns ``true`` if buffer is successfully shaped.
  1960. .. rst-class:: classref-item-separator
  1961. ----
  1962. .. _class_TextServer_method_shaped_text_next_grapheme_pos:
  1963. .. rst-class:: classref-method
  1964. :ref:`int<class_int>` **shaped_text_next_grapheme_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  1965. Returns composite character end position closest to the ``pos``.
  1966. .. rst-class:: classref-item-separator
  1967. ----
  1968. .. _class_TextServer_method_shaped_text_overrun_trim_to_width:
  1969. .. rst-class:: classref-method
  1970. void **shaped_text_overrun_trim_to_width** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width=0, :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` overrun_trim_flags=0 **)**
  1971. Trims text if it exceeds the given width.
  1972. .. rst-class:: classref-item-separator
  1973. ----
  1974. .. _class_TextServer_method_shaped_text_prev_grapheme_pos:
  1975. .. rst-class:: classref-method
  1976. :ref:`int<class_int>` **shaped_text_prev_grapheme_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  1977. Returns composite character start position closest to the ``pos``.
  1978. .. rst-class:: classref-item-separator
  1979. ----
  1980. .. _class_TextServer_method_shaped_text_resize_object:
  1981. .. rst-class:: classref-method
  1982. :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=5, :ref:`float<class_float>` baseline=0.0 **)**
  1983. Sets new size and alignment of embedded object.
  1984. .. rst-class:: classref-item-separator
  1985. ----
  1986. .. _class_TextServer_method_shaped_text_set_bidi_override:
  1987. .. rst-class:: classref-method
  1988. void **shaped_text_set_bidi_override** **(** :ref:`RID<class_RID>` shaped, :ref:`Array<class_Array>` override **)**
  1989. Overrides BiDi for the structured text.
  1990. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
  1991. .. rst-class:: classref-item-separator
  1992. ----
  1993. .. _class_TextServer_method_shaped_text_set_custom_punctuation:
  1994. .. rst-class:: classref-method
  1995. void **shaped_text_set_custom_punctuation** **(** :ref:`RID<class_RID>` shaped, :ref:`String<class_String>` punct **)**
  1996. Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  1997. .. rst-class:: classref-item-separator
  1998. ----
  1999. .. _class_TextServer_method_shaped_text_set_direction:
  2000. .. rst-class:: classref-method
  2001. void **shaped_text_set_direction** **(** :ref:`RID<class_RID>` shaped, :ref:`Direction<enum_TextServer_Direction>` direction=0 **)**
  2002. Sets desired text direction. If set to :ref:`DIRECTION_AUTO<class_TextServer_constant_DIRECTION_AUTO>`, direction will be detected based on the buffer contents and current locale.
  2003. \ **Note:** Direction is ignored if server does not support :ref:`FEATURE_BIDI_LAYOUT<class_TextServer_constant_FEATURE_BIDI_LAYOUT>` feature (supported by :ref:`TextServerAdvanced<class_TextServerAdvanced>`).
  2004. .. rst-class:: classref-item-separator
  2005. ----
  2006. .. _class_TextServer_method_shaped_text_set_orientation:
  2007. .. rst-class:: classref-method
  2008. void **shaped_text_set_orientation** **(** :ref:`RID<class_RID>` shaped, :ref:`Orientation<enum_TextServer_Orientation>` orientation=0 **)**
  2009. Sets desired text orientation.
  2010. \ **Note:** Orientation is ignored if server does not support :ref:`FEATURE_VERTICAL_LAYOUT<class_TextServer_constant_FEATURE_VERTICAL_LAYOUT>` feature (supported by :ref:`TextServerAdvanced<class_TextServerAdvanced>`).
  2011. .. rst-class:: classref-item-separator
  2012. ----
  2013. .. _class_TextServer_method_shaped_text_set_preserve_control:
  2014. .. rst-class:: classref-method
  2015. void **shaped_text_set_preserve_control** **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)**
  2016. If set to ``true`` text buffer will display control characters.
  2017. .. rst-class:: classref-item-separator
  2018. ----
  2019. .. _class_TextServer_method_shaped_text_set_preserve_invalid:
  2020. .. rst-class:: classref-method
  2021. void **shaped_text_set_preserve_invalid** **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)**
  2022. If set to ``true`` text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.
  2023. .. rst-class:: classref-item-separator
  2024. ----
  2025. .. _class_TextServer_method_shaped_text_set_spacing:
  2026. .. rst-class:: classref-method
  2027. void **shaped_text_set_spacing** **(** :ref:`RID<class_RID>` shaped, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)**
  2028. Sets extra spacing added between glyphs or lines in pixels.
  2029. .. rst-class:: classref-item-separator
  2030. ----
  2031. .. _class_TextServer_method_shaped_text_shape:
  2032. .. rst-class:: classref-method
  2033. :ref:`bool<class_bool>` **shaped_text_shape** **(** :ref:`RID<class_RID>` shaped **)**
  2034. Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped successfully.
  2035. \ **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.
  2036. .. rst-class:: classref-item-separator
  2037. ----
  2038. .. _class_TextServer_method_shaped_text_sort_logical:
  2039. .. rst-class:: classref-method
  2040. :ref:`Dictionary[]<class_Dictionary>` **shaped_text_sort_logical** **(** :ref:`RID<class_RID>` shaped **)**
  2041. Returns text glyphs in the logical order.
  2042. .. rst-class:: classref-item-separator
  2043. ----
  2044. .. _class_TextServer_method_shaped_text_substr:
  2045. .. rst-class:: classref-method
  2046. :ref:`RID<class_RID>` **shaped_text_substr** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` length **)** |const|
  2047. Returns text buffer for the substring of the text in the ``shaped`` text buffer (including inline objects).
  2048. .. rst-class:: classref-item-separator
  2049. ----
  2050. .. _class_TextServer_method_shaped_text_tab_align:
  2051. .. rst-class:: classref-method
  2052. :ref:`float<class_float>` **shaped_text_tab_align** **(** :ref:`RID<class_RID>` shaped, :ref:`PackedFloat32Array<class_PackedFloat32Array>` tab_stops **)**
  2053. Aligns shaped text to the given tab-stops.
  2054. .. rst-class:: classref-item-separator
  2055. ----
  2056. .. _class_TextServer_method_spoof_check:
  2057. .. rst-class:: classref-method
  2058. :ref:`bool<class_bool>` **spoof_check** **(** :ref:`String<class_String>` string **)** |const|
  2059. Returns ``true`` if ``string`` is likely to be an attempt at confusing the reader.
  2060. \ **Note:** Always returns ``false`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  2061. .. rst-class:: classref-item-separator
  2062. ----
  2063. .. _class_TextServer_method_string_get_word_breaks:
  2064. .. rst-class:: classref-method
  2065. :ref:`PackedInt32Array<class_PackedInt32Array>` **string_get_word_breaks** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="", :ref:`int<class_int>` chars_per_line=0 **)** |const|
  2066. Returns an array of the word break boundaries. Elements in the returned array are the offsets of the start and end of words. Therefore the length of the array is always even.
  2067. When ``chars_per_line`` is greater than zero, line break boundaries are returned instead.
  2068. ::
  2069. var ts = TextServerManager.get_primary_interface()
  2070. print(ts.string_get_word_breaks("Godot Engine")) # Prints [0, 5, 6, 12]
  2071. print(ts.string_get_word_breaks("Godot Engine", "en", 5)) # Prints [0, 5, 6, 11, 11, 12]
  2072. .. rst-class:: classref-item-separator
  2073. ----
  2074. .. _class_TextServer_method_string_to_lower:
  2075. .. rst-class:: classref-method
  2076. :ref:`String<class_String>` **string_to_lower** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const|
  2077. Returns the string converted to lowercase.
  2078. \ **Note:** Casing is locale dependent and context sensitive if server support :ref:`FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION<class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION>` feature (supported by :ref:`TextServerAdvanced<class_TextServerAdvanced>`).
  2079. \ **Note:** The result may be longer or shorter than the original.
  2080. .. rst-class:: classref-item-separator
  2081. ----
  2082. .. _class_TextServer_method_string_to_upper:
  2083. .. rst-class:: classref-method
  2084. :ref:`String<class_String>` **string_to_upper** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const|
  2085. Returns the string converted to uppercase.
  2086. \ **Note:** Casing is locale dependent and context sensitive if server support :ref:`FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION<class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION>` feature (supported by :ref:`TextServerAdvanced<class_TextServerAdvanced>`).
  2087. \ **Note:** The result may be longer or shorter than the original.
  2088. .. rst-class:: classref-item-separator
  2089. ----
  2090. .. _class_TextServer_method_strip_diacritics:
  2091. .. rst-class:: classref-method
  2092. :ref:`String<class_String>` **strip_diacritics** **(** :ref:`String<class_String>` string **)** |const|
  2093. Strips diacritics from the string.
  2094. \ **Note:** The result may be longer or shorter than the original.
  2095. .. rst-class:: classref-item-separator
  2096. ----
  2097. .. _class_TextServer_method_tag_to_name:
  2098. .. rst-class:: classref-method
  2099. :ref:`String<class_String>` **tag_to_name** **(** :ref:`int<class_int>` tag **)** |const|
  2100. Converts OpenType tag to readable feature, variation, script or language name.
  2101. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2102. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2103. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2104. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2105. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2106. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`