class_textserver.rst 269 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896
  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/4.1/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.1/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. A server interface for font management and text rendering.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. **TextServer** is the API backend for managing fonts and rendering 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:`int<class_int>` | :ref:`font_get_char_from_glyph_index<class_TextServer_method_font_get_char_from_glyph_index>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph_index **)** |const| |
  45. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :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| |
  47. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`float<class_float>` | :ref:`font_get_embolden<class_TextServer_method_font_get_embolden>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  49. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`int<class_int>` | :ref:`font_get_face_count<class_TextServer_method_font_get_face_count>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  51. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | :ref:`int<class_int>` | :ref:`font_get_face_index<class_TextServer_method_font_get_face_index>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  53. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :ref:`int<class_int>` | :ref:`font_get_fixed_size<class_TextServer_method_font_get_fixed_size>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  55. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`bool<class_bool>` | :ref:`font_get_generate_mipmaps<class_TextServer_method_font_get_generate_mipmaps>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  57. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`float<class_float>` | :ref:`font_get_global_oversampling<class_TextServer_method_font_get_global_oversampling>` **(** **)** |const| |
  59. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | :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| |
  61. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :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| |
  63. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :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| |
  65. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :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| |
  67. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :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| |
  69. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :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| |
  71. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :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| |
  73. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :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| |
  75. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | :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| |
  77. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :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| |
  79. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | :ref:`Hinting<enum_TextServer_Hinting>` | :ref:`font_get_hinting<class_TextServer_method_font_get_hinting>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  81. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | :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| |
  83. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | :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| |
  85. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | :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 **)** |
  87. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_language_support_overrides<class_TextServer_method_font_get_language_support_overrides>` **(** :ref:`RID<class_RID>` font_rid **)** |
  89. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :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| |
  91. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | :ref:`int<class_int>` | :ref:`font_get_msdf_size<class_TextServer_method_font_get_msdf_size>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  93. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`String<class_String>` | :ref:`font_get_name<class_TextServer_method_font_get_name>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  95. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | :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| |
  97. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_ot_name_strings<class_TextServer_method_font_get_ot_name_strings>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  99. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | :ref:`float<class_float>` | :ref:`font_get_oversampling<class_TextServer_method_font_get_oversampling>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  101. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | :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| |
  103. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | :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 **)** |
  105. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_script_support_overrides<class_TextServer_method_font_get_script_support_overrides>` **(** :ref:`RID<class_RID>` font_rid **)** |
  107. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | :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| |
  109. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | :ref:`int<class_int>` | :ref:`font_get_stretch<class_TextServer_method_font_get_stretch>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  111. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | |bitfield|\<:ref:`FontStyle<enum_TextServer_FontStyle>`\> | :ref:`font_get_style<class_TextServer_method_font_get_style>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  113. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | :ref:`String<class_String>` | :ref:`font_get_style_name<class_TextServer_method_font_get_style_name>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  115. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` | :ref:`font_get_subpixel_positioning<class_TextServer_method_font_get_subpixel_positioning>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  117. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | :ref:`String<class_String>` | :ref:`font_get_supported_chars<class_TextServer_method_font_get_supported_chars>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  119. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | :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| |
  121. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | :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| |
  123. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | :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| |
  125. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | :ref:`Transform2D<class_Transform2D>` | :ref:`font_get_transform<class_TextServer_method_font_get_transform>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  127. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | :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| |
  129. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | :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| |
  131. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_variation_coordinates<class_TextServer_method_font_get_variation_coordinates>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  133. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | :ref:`int<class_int>` | :ref:`font_get_weight<class_TextServer_method_font_get_weight>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  135. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. | :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| |
  137. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  138. | :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| |
  139. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  140. | :ref:`bool<class_bool>` | :ref:`font_is_force_autohinter<class_TextServer_method_font_is_force_autohinter>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  141. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  142. | :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| |
  143. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  144. | :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| |
  145. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  146. | :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| |
  147. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  148. | 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 **)** |
  149. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  150. | 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 **)** |
  151. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  152. | 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 **)** |
  153. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  154. | 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 **)** |
  155. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  156. | void | :ref:`font_remove_size_cache<class_TextServer_method_font_remove_size_cache>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |
  157. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  158. | 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 **)** |
  159. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  160. | 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 **)** |
  161. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  162. | 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 **)** |
  163. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  164. | 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 **)** |
  165. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  166. | void | :ref:`font_set_antialiasing<class_TextServer_method_font_set_antialiasing>` **(** :ref:`RID<class_RID>` font_rid, :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` antialiasing **)** |
  167. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  168. | 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 **)** |
  169. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  170. | void | :ref:`font_set_data<class_TextServer_method_font_set_data>` **(** :ref:`RID<class_RID>` font_rid, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |
  171. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  172. | 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 **)** |
  173. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  174. | void | :ref:`font_set_embolden<class_TextServer_method_font_set_embolden>` **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` strength **)** |
  175. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  176. | 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 **)** |
  177. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  178. | 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 **)** |
  179. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  180. | 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 **)** |
  181. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  182. | 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 **)** |
  183. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  184. | void | :ref:`font_set_global_oversampling<class_TextServer_method_font_set_global_oversampling>` **(** :ref:`float<class_float>` oversampling **)** |
  185. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  186. | 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 **)** |
  187. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  188. | 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 **)** |
  189. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  190. | 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 **)** |
  191. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  192. | 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 **)** |
  193. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  194. | 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 **)** |
  195. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  196. | void | :ref:`font_set_hinting<class_TextServer_method_font_set_hinting>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Hinting<enum_TextServer_Hinting>` hinting **)** |
  197. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  198. | 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 **)** |
  199. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  200. | 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 **)** |
  201. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  202. | 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 **)** |
  203. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  204. | 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 **)** |
  205. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  206. | 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 **)** |
  207. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  208. | void | :ref:`font_set_name<class_TextServer_method_font_set_name>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)** |
  209. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  210. | 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 **)** |
  211. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  212. | void | :ref:`font_set_oversampling<class_TextServer_method_font_set_oversampling>` **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` oversampling **)** |
  213. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  214. | 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 **)** |
  215. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  216. | 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 **)** |
  217. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  218. | void | :ref:`font_set_stretch<class_TextServer_method_font_set_stretch>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)** |
  219. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  220. | void | :ref:`font_set_style<class_TextServer_method_font_set_style>` **(** :ref:`RID<class_RID>` font_rid, |bitfield|\<:ref:`FontStyle<enum_TextServer_FontStyle>`\> style **)** |
  221. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  222. | void | :ref:`font_set_style_name<class_TextServer_method_font_set_style_name>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)** |
  223. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  224. | 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 **)** |
  225. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  226. | 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 **)** |
  227. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  228. | 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 **)** |
  229. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  230. | void | :ref:`font_set_transform<class_TextServer_method_font_set_transform>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Transform2D<class_Transform2D>` transform **)** |
  231. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  232. | 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 **)** |
  233. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  234. | 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 **)** |
  235. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  236. | 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 **)** |
  237. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  238. | void | :ref:`font_set_weight<class_TextServer_method_font_set_weight>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)** |
  239. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  240. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_feature_list<class_TextServer_method_font_supported_feature_list>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  241. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  242. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_variation_list<class_TextServer_method_font_supported_variation_list>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  243. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  244. | :ref:`String<class_String>` | :ref:`format_number<class_TextServer_method_format_number>` **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const| |
  245. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  246. | void | :ref:`free_rid<class_TextServer_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
  247. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  248. | :ref:`int<class_int>` | :ref:`get_features<class_TextServer_method_get_features>` **(** **)** |const| |
  249. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  250. | :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| |
  251. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  252. | :ref:`String<class_String>` | :ref:`get_name<class_TextServer_method_get_name>` **(** **)** |const| |
  253. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  254. | :ref:`String<class_String>` | :ref:`get_support_data_filename<class_TextServer_method_get_support_data_filename>` **(** **)** |const| |
  255. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  256. | :ref:`String<class_String>` | :ref:`get_support_data_info<class_TextServer_method_get_support_data_info>` **(** **)** |const| |
  257. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  258. | :ref:`bool<class_bool>` | :ref:`has<class_TextServer_method_has>` **(** :ref:`RID<class_RID>` rid **)** |
  259. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  260. | :ref:`bool<class_bool>` | :ref:`has_feature<class_TextServer_method_has_feature>` **(** :ref:`Feature<enum_TextServer_Feature>` feature **)** |const| |
  261. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  262. | :ref:`int<class_int>` | :ref:`is_confusable<class_TextServer_method_is_confusable>` **(** :ref:`String<class_String>` string, :ref:`PackedStringArray<class_PackedStringArray>` dict **)** |const| |
  263. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  264. | :ref:`bool<class_bool>` | :ref:`is_locale_right_to_left<class_TextServer_method_is_locale_right_to_left>` **(** :ref:`String<class_String>` locale **)** |const| |
  265. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  266. | :ref:`bool<class_bool>` | :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>` **(** :ref:`String<class_String>` string **)** |const| |
  267. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  268. | :ref:`bool<class_bool>` | :ref:`load_support_data<class_TextServer_method_load_support_data>` **(** :ref:`String<class_String>` filename **)** |
  269. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  270. | :ref:`int<class_int>` | :ref:`name_to_tag<class_TextServer_method_name_to_tag>` **(** :ref:`String<class_String>` name **)** |const| |
  271. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  272. | :ref:`String<class_String>` | :ref:`parse_number<class_TextServer_method_parse_number>` **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const| |
  273. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  274. | :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| |
  275. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  276. | :ref:`String<class_String>` | :ref:`percent_sign<class_TextServer_method_percent_sign>` **(** :ref:`String<class_String>` language="" **)** |const| |
  277. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  278. | :ref:`bool<class_bool>` | :ref:`save_support_data<class_TextServer_method_save_support_data>` **(** :ref:`String<class_String>` filename **)** |const| |
  279. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  280. | :ref:`int<class_int>` | :ref:`shaped_get_span_count<class_TextServer_method_shaped_get_span_count>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  281. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  282. | :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| |
  283. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  284. | 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={} **)** |
  285. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  286. | :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 **)** |
  287. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  288. | :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 **)** |
  289. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  290. | void | :ref:`shaped_text_clear<class_TextServer_method_shaped_text_clear>` **(** :ref:`RID<class_RID>` rid **)** |
  291. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  292. | 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| |
  293. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  294. | 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| |
  295. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  296. | :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, |bitfield|\<:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\> justification_flags=3 **)** |
  297. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  298. | :ref:`float<class_float>` | :ref:`shaped_text_get_ascent<class_TextServer_method_shaped_text_get_ascent>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  299. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  300. | :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| |
  301. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  302. | :ref:`String<class_String>` | :ref:`shaped_text_get_custom_punctuation<class_TextServer_method_shaped_text_get_custom_punctuation>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  303. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  304. | :ref:`float<class_float>` | :ref:`shaped_text_get_descent<class_TextServer_method_shaped_text_get_descent>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  305. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  306. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_direction<class_TextServer_method_shaped_text_get_direction>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  307. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  308. | :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| |
  309. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  310. | :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| |
  311. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  312. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`shaped_text_get_ellipsis_glyphs<class_TextServer_method_shaped_text_get_ellipsis_glyphs>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  313. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  314. | :ref:`int<class_int>` | :ref:`shaped_text_get_ellipsis_pos<class_TextServer_method_shaped_text_get_ellipsis_pos>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  315. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  316. | :ref:`int<class_int>` | :ref:`shaped_text_get_glyph_count<class_TextServer_method_shaped_text_get_glyph_count>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  317. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  318. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`shaped_text_get_glyphs<class_TextServer_method_shaped_text_get_glyphs>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  319. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  320. | :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| |
  321. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  322. | :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| |
  323. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  324. | :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, |bitfield|\<:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\> break_flags=3 **)** |const| |
  325. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  326. | :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, |bitfield|\<:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\> break_flags=3 **)** |const| |
  327. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  328. | :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| |
  329. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  330. | :ref:`Array<class_Array>` | :ref:`shaped_text_get_objects<class_TextServer_method_shaped_text_get_objects>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  331. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  332. | :ref:`Orientation<enum_TextServer_Orientation>` | :ref:`shaped_text_get_orientation<class_TextServer_method_shaped_text_get_orientation>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  333. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  334. | :ref:`RID<class_RID>` | :ref:`shaped_text_get_parent<class_TextServer_method_shaped_text_get_parent>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  335. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  336. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_control<class_TextServer_method_shaped_text_get_preserve_control>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  337. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  338. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_invalid<class_TextServer_method_shaped_text_get_preserve_invalid>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  339. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  340. | :ref:`Vector2i<class_Vector2i>` | :ref:`shaped_text_get_range<class_TextServer_method_shaped_text_get_range>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  341. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  342. | :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| |
  343. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  344. | :ref:`Vector2<class_Vector2>` | :ref:`shaped_text_get_size<class_TextServer_method_shaped_text_get_size>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  345. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  346. | :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| |
  347. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  348. | :ref:`int<class_int>` | :ref:`shaped_text_get_trim_pos<class_TextServer_method_shaped_text_get_trim_pos>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  349. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  350. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_position<class_TextServer_method_shaped_text_get_underline_position>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  351. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  352. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_thickness<class_TextServer_method_shaped_text_get_underline_thickness>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  353. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  354. | :ref:`float<class_float>` | :ref:`shaped_text_get_width<class_TextServer_method_shaped_text_get_width>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  355. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  356. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_word_breaks<class_TextServer_method_shaped_text_get_word_breaks>` **(** :ref:`RID<class_RID>` shaped, |bitfield|\<:ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`\> grapheme_flags=264 **)** |const| |
  357. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  358. | :ref:`bool<class_bool>` | :ref:`shaped_text_has_visible_chars<class_TextServer_method_shaped_text_has_visible_chars>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  359. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  360. | :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| |
  361. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  362. | :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| |
  363. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  364. | :ref:`bool<class_bool>` | :ref:`shaped_text_is_ready<class_TextServer_method_shaped_text_is_ready>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  365. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  366. | :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| |
  367. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  368. | 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, |bitfield|\<:ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>`\> overrun_trim_flags=0 **)** |
  369. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  370. | :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| |
  371. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  372. | :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 **)** |
  373. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  374. | 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 **)** |
  375. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  376. | 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 **)** |
  377. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  378. | 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 **)** |
  379. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  380. | 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 **)** |
  381. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  382. | 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 **)** |
  383. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  384. | 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 **)** |
  385. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  386. | 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 **)** |
  387. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  388. | :ref:`bool<class_bool>` | :ref:`shaped_text_shape<class_TextServer_method_shaped_text_shape>` **(** :ref:`RID<class_RID>` shaped **)** |
  389. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  390. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`shaped_text_sort_logical<class_TextServer_method_shaped_text_sort_logical>` **(** :ref:`RID<class_RID>` shaped **)** |
  391. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  392. | :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| |
  393. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  394. | :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 **)** |
  395. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  396. | :ref:`bool<class_bool>` | :ref:`spoof_check<class_TextServer_method_spoof_check>` **(** :ref:`String<class_String>` string **)** |const| |
  397. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  398. | :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| |
  399. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  400. | :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| |
  401. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  402. | :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| |
  403. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  404. | :ref:`String<class_String>` | :ref:`strip_diacritics<class_TextServer_method_strip_diacritics>` **(** :ref:`String<class_String>` string **)** |const| |
  405. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  406. | :ref:`String<class_String>` | :ref:`tag_to_name<class_TextServer_method_tag_to_name>` **(** :ref:`int<class_int>` tag **)** |const| |
  407. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  408. .. rst-class:: classref-section-separator
  409. ----
  410. .. rst-class:: classref-descriptions-group
  411. Enumerations
  412. ------------
  413. .. _enum_TextServer_FontAntialiasing:
  414. .. rst-class:: classref-enumeration
  415. enum **FontAntialiasing**:
  416. .. _class_TextServer_constant_FONT_ANTIALIASING_NONE:
  417. .. rst-class:: classref-enumeration-constant
  418. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_NONE** = ``0``
  419. Font glyphs are rasterized as 1-bit bitmaps.
  420. .. _class_TextServer_constant_FONT_ANTIALIASING_GRAY:
  421. .. rst-class:: classref-enumeration-constant
  422. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_GRAY** = ``1``
  423. Font glyphs are rasterized as 8-bit grayscale anti-aliased bitmaps.
  424. .. _class_TextServer_constant_FONT_ANTIALIASING_LCD:
  425. .. rst-class:: classref-enumeration-constant
  426. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_LCD** = ``2``
  427. Font glyphs are rasterized for LCD screens.
  428. LCD subpixel layout is determined by the value of ``gui/theme/lcd_subpixel_layout`` project settings.
  429. LCD subpixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D.
  430. .. rst-class:: classref-item-separator
  431. ----
  432. .. _enum_TextServer_FontLCDSubpixelLayout:
  433. .. rst-class:: classref-enumeration
  434. enum **FontLCDSubpixelLayout**:
  435. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_NONE:
  436. .. rst-class:: classref-enumeration-constant
  437. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_NONE** = ``0``
  438. Unknown or unsupported subpixel layout, LCD subpixel antialiasing is disabled.
  439. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HRGB:
  440. .. rst-class:: classref-enumeration-constant
  441. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HRGB** = ``1``
  442. Horizontal RGB subpixel layout.
  443. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HBGR:
  444. .. rst-class:: classref-enumeration-constant
  445. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HBGR** = ``2``
  446. Horizontal BGR subpixel layout.
  447. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VRGB:
  448. .. rst-class:: classref-enumeration-constant
  449. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VRGB** = ``3``
  450. Vertical RGB subpixel layout.
  451. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VBGR:
  452. .. rst-class:: classref-enumeration-constant
  453. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VBGR** = ``4``
  454. Vertical BGR subpixel layout.
  455. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_MAX:
  456. .. rst-class:: classref-enumeration-constant
  457. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_MAX** = ``5``
  458. Represents the size of the :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` enum.
  459. .. rst-class:: classref-item-separator
  460. ----
  461. .. _enum_TextServer_Direction:
  462. .. rst-class:: classref-enumeration
  463. enum **Direction**:
  464. .. _class_TextServer_constant_DIRECTION_AUTO:
  465. .. rst-class:: classref-enumeration-constant
  466. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_AUTO** = ``0``
  467. Text direction is determined based on contents and current locale.
  468. .. _class_TextServer_constant_DIRECTION_LTR:
  469. .. rst-class:: classref-enumeration-constant
  470. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_LTR** = ``1``
  471. Text is written from left to right.
  472. .. _class_TextServer_constant_DIRECTION_RTL:
  473. .. rst-class:: classref-enumeration-constant
  474. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_RTL** = ``2``
  475. Text is written from right to left.
  476. .. _class_TextServer_constant_DIRECTION_INHERITED:
  477. .. rst-class:: classref-enumeration-constant
  478. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_INHERITED** = ``3``
  479. Text writing direction is the same as base string writing direction. Used for BiDi override only.
  480. .. rst-class:: classref-item-separator
  481. ----
  482. .. _enum_TextServer_Orientation:
  483. .. rst-class:: classref-enumeration
  484. enum **Orientation**:
  485. .. _class_TextServer_constant_ORIENTATION_HORIZONTAL:
  486. .. rst-class:: classref-enumeration-constant
  487. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_HORIZONTAL** = ``0``
  488. Text is written horizontally.
  489. .. _class_TextServer_constant_ORIENTATION_VERTICAL:
  490. .. rst-class:: classref-enumeration-constant
  491. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_VERTICAL** = ``1``
  492. Left to right text is written vertically from top to bottom.
  493. Right to left text is written vertically from bottom to top.
  494. .. rst-class:: classref-item-separator
  495. ----
  496. .. _enum_TextServer_JustificationFlag:
  497. .. rst-class:: classref-enumeration
  498. flags **JustificationFlag**:
  499. .. _class_TextServer_constant_JUSTIFICATION_NONE:
  500. .. rst-class:: classref-enumeration-constant
  501. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_NONE** = ``0``
  502. Do not justify text.
  503. .. _class_TextServer_constant_JUSTIFICATION_KASHIDA:
  504. .. rst-class:: classref-enumeration-constant
  505. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_KASHIDA** = ``1``
  506. Justify text by adding and removing kashidas.
  507. .. _class_TextServer_constant_JUSTIFICATION_WORD_BOUND:
  508. .. rst-class:: classref-enumeration-constant
  509. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_WORD_BOUND** = ``2``
  510. Justify text by changing width of the spaces between the words.
  511. .. _class_TextServer_constant_JUSTIFICATION_TRIM_EDGE_SPACES:
  512. .. rst-class:: classref-enumeration-constant
  513. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_TRIM_EDGE_SPACES** = ``4``
  514. Remove trailing and leading spaces from the justified text.
  515. .. _class_TextServer_constant_JUSTIFICATION_AFTER_LAST_TAB:
  516. .. rst-class:: classref-enumeration-constant
  517. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_AFTER_LAST_TAB** = ``8``
  518. Only apply justification to the part of the text after the last tab.
  519. .. _class_TextServer_constant_JUSTIFICATION_CONSTRAIN_ELLIPSIS:
  520. .. rst-class:: classref-enumeration-constant
  521. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_CONSTRAIN_ELLIPSIS** = ``16``
  522. Apply justification to the trimmed line with ellipsis.
  523. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE:
  524. .. rst-class:: classref-enumeration-constant
  525. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE** = ``32``
  526. Do not apply justification to the last line of the paragraph.
  527. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS:
  528. .. rst-class:: classref-enumeration-constant
  529. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS** = ``64``
  530. Do not apply justification to the last line of the paragraph with visible characters (takes precedence over :ref:`JUSTIFICATION_SKIP_LAST_LINE<class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE>`).
  531. .. _class_TextServer_constant_JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE:
  532. .. rst-class:: classref-enumeration-constant
  533. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE** = ``128``
  534. Always apply justification to the paragraphs with a single line (:ref:`JUSTIFICATION_SKIP_LAST_LINE<class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE>` and :ref:`JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS<class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS>` are ignored).
  535. .. rst-class:: classref-item-separator
  536. ----
  537. .. _enum_TextServer_AutowrapMode:
  538. .. rst-class:: classref-enumeration
  539. enum **AutowrapMode**:
  540. .. _class_TextServer_constant_AUTOWRAP_OFF:
  541. .. rst-class:: classref-enumeration-constant
  542. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_OFF** = ``0``
  543. Autowrap is disabled.
  544. .. _class_TextServer_constant_AUTOWRAP_ARBITRARY:
  545. .. rst-class:: classref-enumeration-constant
  546. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_ARBITRARY** = ``1``
  547. 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.
  548. .. _class_TextServer_constant_AUTOWRAP_WORD:
  549. .. rst-class:: classref-enumeration-constant
  550. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD** = ``2``
  551. Wraps the text inside the node's bounding rectangle by soft-breaking between words.
  552. .. _class_TextServer_constant_AUTOWRAP_WORD_SMART:
  553. .. rst-class:: classref-enumeration-constant
  554. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD_SMART** = ``3``
  555. 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.
  556. .. rst-class:: classref-item-separator
  557. ----
  558. .. _enum_TextServer_LineBreakFlag:
  559. .. rst-class:: classref-enumeration
  560. flags **LineBreakFlag**:
  561. .. _class_TextServer_constant_BREAK_NONE:
  562. .. rst-class:: classref-enumeration-constant
  563. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_NONE** = ``0``
  564. Do not break the line.
  565. .. _class_TextServer_constant_BREAK_MANDATORY:
  566. .. rst-class:: classref-enumeration-constant
  567. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_MANDATORY** = ``1``
  568. Break the line at the line mandatory break characters (e.g. ``"\n"``).
  569. .. _class_TextServer_constant_BREAK_WORD_BOUND:
  570. .. rst-class:: classref-enumeration-constant
  571. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_WORD_BOUND** = ``2``
  572. Break the line between the words.
  573. .. _class_TextServer_constant_BREAK_GRAPHEME_BOUND:
  574. .. rst-class:: classref-enumeration-constant
  575. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_GRAPHEME_BOUND** = ``4``
  576. Break the line between any unconnected graphemes.
  577. .. _class_TextServer_constant_BREAK_ADAPTIVE:
  578. .. rst-class:: classref-enumeration-constant
  579. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_ADAPTIVE** = ``8``
  580. 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.
  581. .. _class_TextServer_constant_BREAK_TRIM_EDGE_SPACES:
  582. .. rst-class:: classref-enumeration-constant
  583. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_EDGE_SPACES** = ``16``
  584. Remove edge spaces from the broken line segments.
  585. .. rst-class:: classref-item-separator
  586. ----
  587. .. _enum_TextServer_VisibleCharactersBehavior:
  588. .. rst-class:: classref-enumeration
  589. enum **VisibleCharactersBehavior**:
  590. .. _class_TextServer_constant_VC_CHARS_BEFORE_SHAPING:
  591. .. rst-class:: classref-enumeration-constant
  592. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_BEFORE_SHAPING** = ``0``
  593. 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.
  594. .. _class_TextServer_constant_VC_CHARS_AFTER_SHAPING:
  595. .. rst-class:: classref-enumeration-constant
  596. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_AFTER_SHAPING** = ``1``
  597. 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.
  598. .. _class_TextServer_constant_VC_GLYPHS_AUTO:
  599. .. rst-class:: classref-enumeration-constant
  600. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_AUTO** = ``2``
  601. 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.
  602. .. _class_TextServer_constant_VC_GLYPHS_LTR:
  603. .. rst-class:: classref-enumeration-constant
  604. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_LTR** = ``3``
  605. 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.
  606. .. _class_TextServer_constant_VC_GLYPHS_RTL:
  607. .. rst-class:: classref-enumeration-constant
  608. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_RTL** = ``4``
  609. 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.
  610. .. rst-class:: classref-item-separator
  611. ----
  612. .. _enum_TextServer_OverrunBehavior:
  613. .. rst-class:: classref-enumeration
  614. enum **OverrunBehavior**:
  615. .. _class_TextServer_constant_OVERRUN_NO_TRIMMING:
  616. .. rst-class:: classref-enumeration-constant
  617. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_NO_TRIMMING** = ``0``
  618. No text trimming is performed.
  619. .. _class_TextServer_constant_OVERRUN_TRIM_CHAR:
  620. .. rst-class:: classref-enumeration-constant
  621. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_CHAR** = ``1``
  622. Trims the text per character.
  623. .. _class_TextServer_constant_OVERRUN_TRIM_WORD:
  624. .. rst-class:: classref-enumeration-constant
  625. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD** = ``2``
  626. Trims the text per word.
  627. .. _class_TextServer_constant_OVERRUN_TRIM_ELLIPSIS:
  628. .. rst-class:: classref-enumeration-constant
  629. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_ELLIPSIS** = ``3``
  630. Trims the text per character and adds an ellipsis to indicate that parts are hidden.
  631. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ELLIPSIS:
  632. .. rst-class:: classref-enumeration-constant
  633. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD_ELLIPSIS** = ``4``
  634. Trims the text per word and adds an ellipsis to indicate that parts are hidden.
  635. .. rst-class:: classref-item-separator
  636. ----
  637. .. _enum_TextServer_TextOverrunFlag:
  638. .. rst-class:: classref-enumeration
  639. flags **TextOverrunFlag**:
  640. .. _class_TextServer_constant_OVERRUN_NO_TRIM:
  641. .. rst-class:: classref-enumeration-constant
  642. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_NO_TRIM** = ``0``
  643. No trimming is performed.
  644. .. _class_TextServer_constant_OVERRUN_TRIM:
  645. .. rst-class:: classref-enumeration-constant
  646. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM** = ``1``
  647. Trims the text when it exceeds the given width.
  648. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ONLY:
  649. .. rst-class:: classref-enumeration-constant
  650. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM_WORD_ONLY** = ``2``
  651. Trims the text per word instead of per grapheme.
  652. .. _class_TextServer_constant_OVERRUN_ADD_ELLIPSIS:
  653. .. rst-class:: classref-enumeration-constant
  654. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ADD_ELLIPSIS** = ``4``
  655. Determines whether an ellipsis should be added at the end of the text.
  656. .. _class_TextServer_constant_OVERRUN_ENFORCE_ELLIPSIS:
  657. .. rst-class:: classref-enumeration-constant
  658. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ENFORCE_ELLIPSIS** = ``8``
  659. Determines whether the ellipsis at the end of the text is enforced and may not be hidden.
  660. .. _class_TextServer_constant_OVERRUN_JUSTIFICATION_AWARE:
  661. .. rst-class:: classref-enumeration-constant
  662. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_JUSTIFICATION_AWARE** = ``16``
  663. Accounts for the text being justified before attempting to trim it (see :ref:`JustificationFlag<enum_TextServer_JustificationFlag>`).
  664. .. rst-class:: classref-item-separator
  665. ----
  666. .. _enum_TextServer_GraphemeFlag:
  667. .. rst-class:: classref-enumeration
  668. flags **GraphemeFlag**:
  669. .. _class_TextServer_constant_GRAPHEME_IS_VALID:
  670. .. rst-class:: classref-enumeration-constant
  671. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VALID** = ``1``
  672. Grapheme is supported by the font, and can be drawn.
  673. .. _class_TextServer_constant_GRAPHEME_IS_RTL:
  674. .. rst-class:: classref-enumeration-constant
  675. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_RTL** = ``2``
  676. Grapheme is part of right-to-left or bottom-to-top run.
  677. .. _class_TextServer_constant_GRAPHEME_IS_VIRTUAL:
  678. .. rst-class:: classref-enumeration-constant
  679. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VIRTUAL** = ``4``
  680. Grapheme is not part of source text, it was added by justification process.
  681. .. _class_TextServer_constant_GRAPHEME_IS_SPACE:
  682. .. rst-class:: classref-enumeration-constant
  683. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SPACE** = ``8``
  684. Grapheme is whitespace.
  685. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_HARD:
  686. .. rst-class:: classref-enumeration-constant
  687. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_HARD** = ``16``
  688. Grapheme is mandatory break point (e.g. ``"\n"``).
  689. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_SOFT:
  690. .. rst-class:: classref-enumeration-constant
  691. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_SOFT** = ``32``
  692. Grapheme is optional break point (e.g. space).
  693. .. _class_TextServer_constant_GRAPHEME_IS_TAB:
  694. .. rst-class:: classref-enumeration-constant
  695. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_TAB** = ``64``
  696. Grapheme is the tabulation character.
  697. .. _class_TextServer_constant_GRAPHEME_IS_ELONGATION:
  698. .. rst-class:: classref-enumeration-constant
  699. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_ELONGATION** = ``128``
  700. Grapheme is kashida.
  701. .. _class_TextServer_constant_GRAPHEME_IS_PUNCTUATION:
  702. .. rst-class:: classref-enumeration-constant
  703. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_PUNCTUATION** = ``256``
  704. Grapheme is punctuation character.
  705. .. _class_TextServer_constant_GRAPHEME_IS_UNDERSCORE:
  706. .. rst-class:: classref-enumeration-constant
  707. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_UNDERSCORE** = ``512``
  708. Grapheme is underscore character.
  709. .. _class_TextServer_constant_GRAPHEME_IS_CONNECTED:
  710. .. rst-class:: classref-enumeration-constant
  711. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_CONNECTED** = ``1024``
  712. Grapheme is connected to the previous grapheme. Breaking line before this grapheme is not safe.
  713. .. _class_TextServer_constant_GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL:
  714. .. rst-class:: classref-enumeration-constant
  715. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL** = ``2048``
  716. It is safe to insert a U+0640 before this grapheme for elongation.
  717. .. _class_TextServer_constant_GRAPHEME_IS_EMBEDDED_OBJECT:
  718. .. rst-class:: classref-enumeration-constant
  719. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_EMBEDDED_OBJECT** = ``4096``
  720. Grapheme is an object replacement character for the embedded object.
  721. .. rst-class:: classref-item-separator
  722. ----
  723. .. _enum_TextServer_Hinting:
  724. .. rst-class:: classref-enumeration
  725. enum **Hinting**:
  726. .. _class_TextServer_constant_HINTING_NONE:
  727. .. rst-class:: classref-enumeration-constant
  728. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NONE** = ``0``
  729. Disables font hinting (smoother but less crisp).
  730. .. _class_TextServer_constant_HINTING_LIGHT:
  731. .. rst-class:: classref-enumeration-constant
  732. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_LIGHT** = ``1``
  733. Use the light font hinting mode.
  734. .. _class_TextServer_constant_HINTING_NORMAL:
  735. .. rst-class:: classref-enumeration-constant
  736. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NORMAL** = ``2``
  737. Use the default font hinting mode (crisper but less smooth).
  738. \ **Note:** This hinting mode changes both horizontal and vertical glyph metrics. If applied to monospace font, some glyphs might have different width.
  739. .. rst-class:: classref-item-separator
  740. ----
  741. .. _enum_TextServer_SubpixelPositioning:
  742. .. rst-class:: classref-enumeration
  743. enum **SubpixelPositioning**:
  744. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_DISABLED:
  745. .. rst-class:: classref-enumeration-constant
  746. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_DISABLED** = ``0``
  747. Glyph horizontal position is rounded to the whole pixel size, each glyph is rasterized once.
  748. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO:
  749. .. rst-class:: classref-enumeration-constant
  750. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_AUTO** = ``1``
  751. Glyph horizontal position is rounded based on font size.
  752. - 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>`.
  753. - 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>`.
  754. - To the whole pixel size for larger fonts.
  755. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF:
  756. .. rst-class:: classref-enumeration-constant
  757. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF** = ``2``
  758. Glyph horizontal position is rounded to one half of the pixel size, each glyph is rasterized up to two times.
  759. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER:
  760. .. rst-class:: classref-enumeration-constant
  761. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER** = ``3``
  762. Glyph horizontal position is rounded to one quarter of the pixel size, each glyph is rasterized up to four times.
  763. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE:
  764. .. rst-class:: classref-enumeration-constant
  765. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE** = ``20``
  766. 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.
  767. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE:
  768. .. rst-class:: classref-enumeration-constant
  769. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE** = ``16``
  770. 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.
  771. .. rst-class:: classref-item-separator
  772. ----
  773. .. _enum_TextServer_Feature:
  774. .. rst-class:: classref-enumeration
  775. enum **Feature**:
  776. .. _class_TextServer_constant_FEATURE_SIMPLE_LAYOUT:
  777. .. rst-class:: classref-enumeration-constant
  778. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SIMPLE_LAYOUT** = ``1``
  779. TextServer supports simple text layouts.
  780. .. _class_TextServer_constant_FEATURE_BIDI_LAYOUT:
  781. .. rst-class:: classref-enumeration-constant
  782. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BIDI_LAYOUT** = ``2``
  783. TextServer supports bidirectional text layouts.
  784. .. _class_TextServer_constant_FEATURE_VERTICAL_LAYOUT:
  785. .. rst-class:: classref-enumeration-constant
  786. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_VERTICAL_LAYOUT** = ``4``
  787. TextServer supports vertical layouts.
  788. .. _class_TextServer_constant_FEATURE_SHAPING:
  789. .. rst-class:: classref-enumeration-constant
  790. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SHAPING** = ``8``
  791. TextServer supports complex text shaping.
  792. .. _class_TextServer_constant_FEATURE_KASHIDA_JUSTIFICATION:
  793. .. rst-class:: classref-enumeration-constant
  794. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_KASHIDA_JUSTIFICATION** = ``16``
  795. TextServer supports justification using kashidas.
  796. .. _class_TextServer_constant_FEATURE_BREAK_ITERATORS:
  797. .. rst-class:: classref-enumeration-constant
  798. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BREAK_ITERATORS** = ``32``
  799. TextServer supports complex line/word breaking rules (e.g. dictionary based).
  800. .. _class_TextServer_constant_FEATURE_FONT_BITMAP:
  801. .. rst-class:: classref-enumeration-constant
  802. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_BITMAP** = ``64``
  803. TextServer supports loading bitmap fonts.
  804. .. _class_TextServer_constant_FEATURE_FONT_DYNAMIC:
  805. .. rst-class:: classref-enumeration-constant
  806. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_DYNAMIC** = ``128``
  807. TextServer supports loading dynamic (TrueType, OpeType, etc.) fonts.
  808. .. _class_TextServer_constant_FEATURE_FONT_MSDF:
  809. .. rst-class:: classref-enumeration-constant
  810. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_MSDF** = ``256``
  811. TextServer supports multichannel signed distance field dynamic font rendering.
  812. .. _class_TextServer_constant_FEATURE_FONT_SYSTEM:
  813. .. rst-class:: classref-enumeration-constant
  814. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_SYSTEM** = ``512``
  815. TextServer supports loading system fonts.
  816. .. _class_TextServer_constant_FEATURE_FONT_VARIABLE:
  817. .. rst-class:: classref-enumeration-constant
  818. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_VARIABLE** = ``1024``
  819. TextServer supports variable fonts.
  820. .. _class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION:
  821. .. rst-class:: classref-enumeration-constant
  822. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION** = ``2048``
  823. TextServer supports locale dependent and context sensitive case conversion.
  824. .. _class_TextServer_constant_FEATURE_USE_SUPPORT_DATA:
  825. .. rst-class:: classref-enumeration-constant
  826. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_USE_SUPPORT_DATA** = ``4096``
  827. TextServer require external data file for some features, see :ref:`load_support_data<class_TextServer_method_load_support_data>`.
  828. .. _class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS:
  829. .. rst-class:: classref-enumeration-constant
  830. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_IDENTIFIERS** = ``8192``
  831. TextServer supports UAX #31 identifier validation, see :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>`.
  832. .. _class_TextServer_constant_FEATURE_UNICODE_SECURITY:
  833. .. rst-class:: classref-enumeration-constant
  834. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_SECURITY** = ``16384``
  835. 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.
  836. .. rst-class:: classref-item-separator
  837. ----
  838. .. _enum_TextServer_ContourPointTag:
  839. .. rst-class:: classref-enumeration
  840. enum **ContourPointTag**:
  841. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_ON:
  842. .. rst-class:: classref-enumeration-constant
  843. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_ON** = ``1``
  844. Contour point is on the curve.
  845. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC:
  846. .. rst-class:: classref-enumeration-constant
  847. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CONIC** = ``0``
  848. Contour point isn't on the curve, but serves as a control point for a conic (quadratic) Bézier arc.
  849. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CUBIC:
  850. .. rst-class:: classref-enumeration-constant
  851. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CUBIC** = ``2``
  852. Contour point isn't on the curve, but serves as a control point for a cubic Bézier arc.
  853. .. rst-class:: classref-item-separator
  854. ----
  855. .. _enum_TextServer_SpacingType:
  856. .. rst-class:: classref-enumeration
  857. enum **SpacingType**:
  858. .. _class_TextServer_constant_SPACING_GLYPH:
  859. .. rst-class:: classref-enumeration-constant
  860. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_GLYPH** = ``0``
  861. Spacing for each glyph.
  862. .. _class_TextServer_constant_SPACING_SPACE:
  863. .. rst-class:: classref-enumeration-constant
  864. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_SPACE** = ``1``
  865. Spacing for the space character.
  866. .. _class_TextServer_constant_SPACING_TOP:
  867. .. rst-class:: classref-enumeration-constant
  868. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_TOP** = ``2``
  869. Spacing at the top of the line.
  870. .. _class_TextServer_constant_SPACING_BOTTOM:
  871. .. rst-class:: classref-enumeration-constant
  872. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_BOTTOM** = ``3``
  873. Spacing at the bottom of the line.
  874. .. _class_TextServer_constant_SPACING_MAX:
  875. .. rst-class:: classref-enumeration-constant
  876. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_MAX** = ``4``
  877. Represents the size of the :ref:`SpacingType<enum_TextServer_SpacingType>` enum.
  878. .. rst-class:: classref-item-separator
  879. ----
  880. .. _enum_TextServer_FontStyle:
  881. .. rst-class:: classref-enumeration
  882. flags **FontStyle**:
  883. .. _class_TextServer_constant_FONT_BOLD:
  884. .. rst-class:: classref-enumeration-constant
  885. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_BOLD** = ``1``
  886. Font is bold.
  887. .. _class_TextServer_constant_FONT_ITALIC:
  888. .. rst-class:: classref-enumeration-constant
  889. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_ITALIC** = ``2``
  890. Font is italic or oblique.
  891. .. _class_TextServer_constant_FONT_FIXED_WIDTH:
  892. .. rst-class:: classref-enumeration-constant
  893. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_FIXED_WIDTH** = ``4``
  894. Font have fixed-width characters.
  895. .. rst-class:: classref-item-separator
  896. ----
  897. .. _enum_TextServer_StructuredTextParser:
  898. .. rst-class:: classref-enumeration
  899. enum **StructuredTextParser**:
  900. .. _class_TextServer_constant_STRUCTURED_TEXT_DEFAULT:
  901. .. rst-class:: classref-enumeration-constant
  902. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_DEFAULT** = ``0``
  903. Use default Unicode BiDi algorithm.
  904. .. _class_TextServer_constant_STRUCTURED_TEXT_URI:
  905. .. rst-class:: classref-enumeration-constant
  906. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_URI** = ``1``
  907. BiDi override for URI.
  908. .. _class_TextServer_constant_STRUCTURED_TEXT_FILE:
  909. .. rst-class:: classref-enumeration-constant
  910. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_FILE** = ``2``
  911. BiDi override for file path.
  912. .. _class_TextServer_constant_STRUCTURED_TEXT_EMAIL:
  913. .. rst-class:: classref-enumeration-constant
  914. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_EMAIL** = ``3``
  915. BiDi override for email.
  916. .. _class_TextServer_constant_STRUCTURED_TEXT_LIST:
  917. .. rst-class:: classref-enumeration-constant
  918. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_LIST** = ``4``
  919. BiDi override for lists.
  920. Structured text options: list separator ``String``.
  921. .. _class_TextServer_constant_STRUCTURED_TEXT_GDSCRIPT:
  922. .. rst-class:: classref-enumeration-constant
  923. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_GDSCRIPT** = ``5``
  924. BiDi override for GDScript.
  925. .. _class_TextServer_constant_STRUCTURED_TEXT_CUSTOM:
  926. .. rst-class:: classref-enumeration-constant
  927. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_CUSTOM** = ``6``
  928. User defined structured text BiDi override function.
  929. .. rst-class:: classref-section-separator
  930. ----
  931. .. rst-class:: classref-descriptions-group
  932. Method Descriptions
  933. -------------------
  934. .. _class_TextServer_method_create_font:
  935. .. rst-class:: classref-method
  936. :ref:`RID<class_RID>` **create_font** **(** **)**
  937. Creates a new, empty font cache entry resource. To free the resulting resource, use the :ref:`free_rid<class_TextServer_method_free_rid>` method.
  938. .. rst-class:: classref-item-separator
  939. ----
  940. .. _class_TextServer_method_create_shaped_text:
  941. .. rst-class:: classref-method
  942. :ref:`RID<class_RID>` **create_shaped_text** **(** :ref:`Direction<enum_TextServer_Direction>` direction=0, :ref:`Orientation<enum_TextServer_Orientation>` orientation=0 **)**
  943. 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.
  944. \ **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>`).
  945. \ **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>`).
  946. .. rst-class:: classref-item-separator
  947. ----
  948. .. _class_TextServer_method_draw_hex_code_box:
  949. .. rst-class:: classref-method
  950. 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|
  951. Draws box displaying character hexadecimal code. Used for replacing missing characters.
  952. .. rst-class:: classref-item-separator
  953. ----
  954. .. _class_TextServer_method_font_clear_glyphs:
  955. .. rst-class:: classref-method
  956. void **font_clear_glyphs** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)**
  957. Removes all rendered glyphs information from the cache entry.
  958. \ **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.
  959. .. rst-class:: classref-item-separator
  960. ----
  961. .. _class_TextServer_method_font_clear_kerning_map:
  962. .. rst-class:: classref-method
  963. void **font_clear_kerning_map** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)**
  964. Removes all kerning overrides.
  965. .. rst-class:: classref-item-separator
  966. ----
  967. .. _class_TextServer_method_font_clear_size_cache:
  968. .. rst-class:: classref-method
  969. void **font_clear_size_cache** **(** :ref:`RID<class_RID>` font_rid **)**
  970. Removes all font sizes from the cache entry.
  971. .. rst-class:: classref-item-separator
  972. ----
  973. .. _class_TextServer_method_font_clear_textures:
  974. .. rst-class:: classref-method
  975. void **font_clear_textures** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)**
  976. Removes all textures from font cache entry.
  977. \ **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.
  978. .. rst-class:: classref-item-separator
  979. ----
  980. .. _class_TextServer_method_font_draw_glyph:
  981. .. rst-class:: classref-method
  982. 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|
  983. Draws single glyph into a canvas item at the position, using ``font_rid`` at the size ``size``.
  984. \ **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>`.
  985. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  986. .. rst-class:: classref-item-separator
  987. ----
  988. .. _class_TextServer_method_font_draw_glyph_outline:
  989. .. rst-class:: classref-method
  990. 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|
  991. Draws single glyph outline of size ``outline_size`` into a canvas item at the position, using ``font_rid`` at the size ``size``.
  992. \ **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>`.
  993. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  994. .. rst-class:: classref-item-separator
  995. ----
  996. .. _class_TextServer_method_font_get_antialiasing:
  997. .. rst-class:: classref-method
  998. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **font_get_antialiasing** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  999. Returns font anti-aliasing mode.
  1000. .. rst-class:: classref-item-separator
  1001. ----
  1002. .. _class_TextServer_method_font_get_ascent:
  1003. .. rst-class:: classref-method
  1004. :ref:`float<class_float>` **font_get_ascent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1005. Returns the font ascent (number of pixels above the baseline).
  1006. .. rst-class:: classref-item-separator
  1007. ----
  1008. .. _class_TextServer_method_font_get_char_from_glyph_index:
  1009. .. rst-class:: classref-method
  1010. :ref:`int<class_int>` **font_get_char_from_glyph_index** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph_index **)** |const|
  1011. Returns character code associated with ``glyph_index``, or ``0`` if ``glyph_index`` is invalid. See :ref:`font_get_glyph_index<class_TextServer_method_font_get_glyph_index>`.
  1012. .. rst-class:: classref-item-separator
  1013. ----
  1014. .. _class_TextServer_method_font_get_descent:
  1015. .. rst-class:: classref-method
  1016. :ref:`float<class_float>` **font_get_descent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1017. Returns the font descent (number of pixels below the baseline).
  1018. .. rst-class:: classref-item-separator
  1019. ----
  1020. .. _class_TextServer_method_font_get_embolden:
  1021. .. rst-class:: classref-method
  1022. :ref:`float<class_float>` **font_get_embolden** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1023. Returns font embolden strength.
  1024. .. rst-class:: classref-item-separator
  1025. ----
  1026. .. _class_TextServer_method_font_get_face_count:
  1027. .. rst-class:: classref-method
  1028. :ref:`int<class_int>` **font_get_face_count** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1029. Returns number of faces in the TrueType / OpenType collection.
  1030. .. rst-class:: classref-item-separator
  1031. ----
  1032. .. _class_TextServer_method_font_get_face_index:
  1033. .. rst-class:: classref-method
  1034. :ref:`int<class_int>` **font_get_face_index** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1035. Recturns an active face index in the TrueType / OpenType collection.
  1036. .. rst-class:: classref-item-separator
  1037. ----
  1038. .. _class_TextServer_method_font_get_fixed_size:
  1039. .. rst-class:: classref-method
  1040. :ref:`int<class_int>` **font_get_fixed_size** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1041. Returns bitmap font fixed size.
  1042. .. rst-class:: classref-item-separator
  1043. ----
  1044. .. _class_TextServer_method_font_get_generate_mipmaps:
  1045. .. rst-class:: classref-method
  1046. :ref:`bool<class_bool>` **font_get_generate_mipmaps** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1047. Returns ``true`` if font texture mipmap generation is enabled.
  1048. .. rst-class:: classref-item-separator
  1049. ----
  1050. .. _class_TextServer_method_font_get_global_oversampling:
  1051. .. rst-class:: classref-method
  1052. :ref:`float<class_float>` **font_get_global_oversampling** **(** **)** |const|
  1053. Returns the font oversampling factor, shared by all fonts in the TextServer.
  1054. .. rst-class:: classref-item-separator
  1055. ----
  1056. .. _class_TextServer_method_font_get_glyph_advance:
  1057. .. rst-class:: classref-method
  1058. :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|
  1059. Returns glyph advance (offset of the next glyph).
  1060. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1061. .. rst-class:: classref-item-separator
  1062. ----
  1063. .. _class_TextServer_method_font_get_glyph_contours:
  1064. .. rst-class:: classref-method
  1065. :ref:`Dictionary<class_Dictionary>` **font_get_glyph_contours** **(** :ref:`RID<class_RID>` font, :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |const|
  1066. Returns outline contours of the glyph as a ``Dictionary`` with the following contents:
  1067. \ ``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.
  1068. \ ``contours`` - :ref:`PackedInt32Array<class_PackedInt32Array>`, containing indices the end points of each contour.
  1069. \ ``orientation`` - :ref:`bool<class_bool>`, contour orientation. If ``true``, clockwise contours must be filled.
  1070. .. rst-class:: classref-item-separator
  1071. ----
  1072. .. _class_TextServer_method_font_get_glyph_index:
  1073. .. rst-class:: classref-method
  1074. :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|
  1075. Returns the glyph index of a ``char``, optionally modified by the ``variation_selector``. See :ref:`font_get_char_from_glyph_index<class_TextServer_method_font_get_char_from_glyph_index>`.
  1076. .. rst-class:: classref-item-separator
  1077. ----
  1078. .. _class_TextServer_method_font_get_glyph_list:
  1079. .. rst-class:: classref-method
  1080. :ref:`PackedInt32Array<class_PackedInt32Array>` **font_get_glyph_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const|
  1081. Returns list of rendered glyphs in the cache entry.
  1082. .. rst-class:: classref-item-separator
  1083. ----
  1084. .. _class_TextServer_method_font_get_glyph_offset:
  1085. .. rst-class:: classref-method
  1086. :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|
  1087. Returns glyph offset from the baseline.
  1088. .. rst-class:: classref-item-separator
  1089. ----
  1090. .. _class_TextServer_method_font_get_glyph_size:
  1091. .. rst-class:: classref-method
  1092. :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|
  1093. Returns size of the glyph.
  1094. .. rst-class:: classref-item-separator
  1095. ----
  1096. .. _class_TextServer_method_font_get_glyph_texture_idx:
  1097. .. rst-class:: classref-method
  1098. :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|
  1099. Returns index of the cache texture containing the glyph.
  1100. .. rst-class:: classref-item-separator
  1101. ----
  1102. .. _class_TextServer_method_font_get_glyph_texture_rid:
  1103. .. rst-class:: classref-method
  1104. :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|
  1105. Returns resource ID of the cache texture containing the glyph.
  1106. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1107. .. rst-class:: classref-item-separator
  1108. ----
  1109. .. _class_TextServer_method_font_get_glyph_texture_size:
  1110. .. rst-class:: classref-method
  1111. :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|
  1112. Returns size of the cache texture containing the glyph.
  1113. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1114. .. rst-class:: classref-item-separator
  1115. ----
  1116. .. _class_TextServer_method_font_get_glyph_uv_rect:
  1117. .. rst-class:: classref-method
  1118. :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|
  1119. Returns rectangle in the cache texture containing the glyph.
  1120. .. rst-class:: classref-item-separator
  1121. ----
  1122. .. _class_TextServer_method_font_get_hinting:
  1123. .. rst-class:: classref-method
  1124. :ref:`Hinting<enum_TextServer_Hinting>` **font_get_hinting** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1125. Returns the font hinting mode. Used by dynamic fonts only.
  1126. .. rst-class:: classref-item-separator
  1127. ----
  1128. .. _class_TextServer_method_font_get_kerning:
  1129. .. rst-class:: classref-method
  1130. :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|
  1131. Returns kerning for the pair of glyphs.
  1132. .. rst-class:: classref-item-separator
  1133. ----
  1134. .. _class_TextServer_method_font_get_kerning_list:
  1135. .. rst-class:: classref-method
  1136. :ref:`Vector2i[]<class_Vector2i>` **font_get_kerning_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1137. Returns list of the kerning overrides.
  1138. .. rst-class:: classref-item-separator
  1139. ----
  1140. .. _class_TextServer_method_font_get_language_support_override:
  1141. .. rst-class:: classref-method
  1142. :ref:`bool<class_bool>` **font_get_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)**
  1143. Returns ``true`` if support override is enabled for the ``language``.
  1144. .. rst-class:: classref-item-separator
  1145. ----
  1146. .. _class_TextServer_method_font_get_language_support_overrides:
  1147. .. rst-class:: classref-method
  1148. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_language_support_overrides** **(** :ref:`RID<class_RID>` font_rid **)**
  1149. Returns list of language support overrides.
  1150. .. rst-class:: classref-item-separator
  1151. ----
  1152. .. _class_TextServer_method_font_get_msdf_pixel_range:
  1153. .. rst-class:: classref-method
  1154. :ref:`int<class_int>` **font_get_msdf_pixel_range** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1155. Returns the width of the range around the shape between the minimum and maximum representable signed distance.
  1156. .. rst-class:: classref-item-separator
  1157. ----
  1158. .. _class_TextServer_method_font_get_msdf_size:
  1159. .. rst-class:: classref-method
  1160. :ref:`int<class_int>` **font_get_msdf_size** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1161. Returns source font size used to generate MSDF textures.
  1162. .. rst-class:: classref-item-separator
  1163. ----
  1164. .. _class_TextServer_method_font_get_name:
  1165. .. rst-class:: classref-method
  1166. :ref:`String<class_String>` **font_get_name** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1167. Returns font family name.
  1168. .. rst-class:: classref-item-separator
  1169. ----
  1170. .. _class_TextServer_method_font_get_opentype_feature_overrides:
  1171. .. rst-class:: classref-method
  1172. :ref:`Dictionary<class_Dictionary>` **font_get_opentype_feature_overrides** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1173. Returns font OpenType feature set override.
  1174. .. rst-class:: classref-item-separator
  1175. ----
  1176. .. _class_TextServer_method_font_get_ot_name_strings:
  1177. .. rst-class:: classref-method
  1178. :ref:`Dictionary<class_Dictionary>` **font_get_ot_name_strings** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1179. Returns :ref:`Dictionary<class_Dictionary>` with OpenType font name strings (localized font names, version, description, license information, sample text, etc.).
  1180. .. rst-class:: classref-item-separator
  1181. ----
  1182. .. _class_TextServer_method_font_get_oversampling:
  1183. .. rst-class:: classref-method
  1184. :ref:`float<class_float>` **font_get_oversampling** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1185. Returns font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1186. .. rst-class:: classref-item-separator
  1187. ----
  1188. .. _class_TextServer_method_font_get_scale:
  1189. .. rst-class:: classref-method
  1190. :ref:`float<class_float>` **font_get_scale** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1191. Returns scaling factor of the color bitmap font.
  1192. .. rst-class:: classref-item-separator
  1193. ----
  1194. .. _class_TextServer_method_font_get_script_support_override:
  1195. .. rst-class:: classref-method
  1196. :ref:`bool<class_bool>` **font_get_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)**
  1197. Returns ``true`` if support override is enabled for the ``script``.
  1198. .. rst-class:: classref-item-separator
  1199. ----
  1200. .. _class_TextServer_method_font_get_script_support_overrides:
  1201. .. rst-class:: classref-method
  1202. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_script_support_overrides** **(** :ref:`RID<class_RID>` font_rid **)**
  1203. Returns list of script support overrides.
  1204. .. rst-class:: classref-item-separator
  1205. ----
  1206. .. _class_TextServer_method_font_get_size_cache_list:
  1207. .. rst-class:: classref-method
  1208. :ref:`Vector2i[]<class_Vector2i>` **font_get_size_cache_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1209. Returns list of the font sizes in the cache. Each size is ``Vector2i`` with font size and outline size.
  1210. .. rst-class:: classref-item-separator
  1211. ----
  1212. .. _class_TextServer_method_font_get_stretch:
  1213. .. rst-class:: classref-method
  1214. :ref:`int<class_int>` **font_get_stretch** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1215. Returns font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1216. .. rst-class:: classref-item-separator
  1217. ----
  1218. .. _class_TextServer_method_font_get_style:
  1219. .. rst-class:: classref-method
  1220. |bitfield|\<:ref:`FontStyle<enum_TextServer_FontStyle>`\> **font_get_style** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1221. Returns font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1222. .. rst-class:: classref-item-separator
  1223. ----
  1224. .. _class_TextServer_method_font_get_style_name:
  1225. .. rst-class:: classref-method
  1226. :ref:`String<class_String>` **font_get_style_name** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1227. Returns font style name.
  1228. .. rst-class:: classref-item-separator
  1229. ----
  1230. .. _class_TextServer_method_font_get_subpixel_positioning:
  1231. .. rst-class:: classref-method
  1232. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **font_get_subpixel_positioning** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1233. Returns font subpixel glyph positioning mode.
  1234. .. rst-class:: classref-item-separator
  1235. ----
  1236. .. _class_TextServer_method_font_get_supported_chars:
  1237. .. rst-class:: classref-method
  1238. :ref:`String<class_String>` **font_get_supported_chars** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1239. Returns a string containing all the characters available in the font.
  1240. .. rst-class:: classref-item-separator
  1241. ----
  1242. .. _class_TextServer_method_font_get_texture_count:
  1243. .. rst-class:: classref-method
  1244. :ref:`int<class_int>` **font_get_texture_count** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const|
  1245. Returns number of textures used by font cache entry.
  1246. .. rst-class:: classref-item-separator
  1247. ----
  1248. .. _class_TextServer_method_font_get_texture_image:
  1249. .. rst-class:: classref-method
  1250. :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|
  1251. Returns font cache texture image data.
  1252. .. rst-class:: classref-item-separator
  1253. ----
  1254. .. _class_TextServer_method_font_get_texture_offsets:
  1255. .. rst-class:: classref-method
  1256. :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|
  1257. Returns array containing glyph packing data.
  1258. .. rst-class:: classref-item-separator
  1259. ----
  1260. .. _class_TextServer_method_font_get_transform:
  1261. .. rst-class:: classref-method
  1262. :ref:`Transform2D<class_Transform2D>` **font_get_transform** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1263. Returns 2D transform applied to the font outlines.
  1264. .. rst-class:: classref-item-separator
  1265. ----
  1266. .. _class_TextServer_method_font_get_underline_position:
  1267. .. rst-class:: classref-method
  1268. :ref:`float<class_float>` **font_get_underline_position** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1269. Returns pixel offset of the underline below the baseline.
  1270. .. rst-class:: classref-item-separator
  1271. ----
  1272. .. _class_TextServer_method_font_get_underline_thickness:
  1273. .. rst-class:: classref-method
  1274. :ref:`float<class_float>` **font_get_underline_thickness** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1275. Returns thickness of the underline in pixels.
  1276. .. rst-class:: classref-item-separator
  1277. ----
  1278. .. _class_TextServer_method_font_get_variation_coordinates:
  1279. .. rst-class:: classref-method
  1280. :ref:`Dictionary<class_Dictionary>` **font_get_variation_coordinates** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1281. 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.
  1282. .. rst-class:: classref-item-separator
  1283. ----
  1284. .. _class_TextServer_method_font_get_weight:
  1285. .. rst-class:: classref-method
  1286. :ref:`int<class_int>` **font_get_weight** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1287. Returns weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1288. .. rst-class:: classref-item-separator
  1289. ----
  1290. .. _class_TextServer_method_font_has_char:
  1291. .. rst-class:: classref-method
  1292. :ref:`bool<class_bool>` **font_has_char** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` char **)** |const|
  1293. Returns ``true`` if a Unicode ``char`` is available in the font.
  1294. .. rst-class:: classref-item-separator
  1295. ----
  1296. .. _class_TextServer_method_font_is_allow_system_fallback:
  1297. .. rst-class:: classref-method
  1298. :ref:`bool<class_bool>` **font_is_allow_system_fallback** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1299. Returns ``true`` if system fonts can be automatically used as fallbacks.
  1300. .. rst-class:: classref-item-separator
  1301. ----
  1302. .. _class_TextServer_method_font_is_force_autohinter:
  1303. .. rst-class:: classref-method
  1304. :ref:`bool<class_bool>` **font_is_force_autohinter** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1305. Returns ``true`` if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.
  1306. .. rst-class:: classref-item-separator
  1307. ----
  1308. .. _class_TextServer_method_font_is_language_supported:
  1309. .. rst-class:: classref-method
  1310. :ref:`bool<class_bool>` **font_is_language_supported** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |const|
  1311. Returns ``true``, if font supports given language (`ISO 639 <https://en.wikipedia.org/wiki/ISO_639-1>`__ code).
  1312. .. rst-class:: classref-item-separator
  1313. ----
  1314. .. _class_TextServer_method_font_is_multichannel_signed_distance_field:
  1315. .. rst-class:: classref-method
  1316. :ref:`bool<class_bool>` **font_is_multichannel_signed_distance_field** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1317. Returns ``true`` if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.
  1318. .. rst-class:: classref-item-separator
  1319. ----
  1320. .. _class_TextServer_method_font_is_script_supported:
  1321. .. rst-class:: classref-method
  1322. :ref:`bool<class_bool>` **font_is_script_supported** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |const|
  1323. Returns ``true``, if font supports given script (ISO 15924 code).
  1324. .. rst-class:: classref-item-separator
  1325. ----
  1326. .. _class_TextServer_method_font_remove_glyph:
  1327. .. rst-class:: classref-method
  1328. void **font_remove_glyph** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)**
  1329. Removes specified rendered glyph information from the cache entry.
  1330. \ **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.
  1331. .. rst-class:: classref-item-separator
  1332. ----
  1333. .. _class_TextServer_method_font_remove_kerning:
  1334. .. rst-class:: classref-method
  1335. void **font_remove_kerning** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)**
  1336. Removes kerning override for the pair of glyphs.
  1337. .. rst-class:: classref-item-separator
  1338. ----
  1339. .. _class_TextServer_method_font_remove_language_support_override:
  1340. .. rst-class:: classref-method
  1341. void **font_remove_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)**
  1342. Remove language support override.
  1343. .. rst-class:: classref-item-separator
  1344. ----
  1345. .. _class_TextServer_method_font_remove_script_support_override:
  1346. .. rst-class:: classref-method
  1347. void **font_remove_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)**
  1348. Removes script support override.
  1349. .. rst-class:: classref-item-separator
  1350. ----
  1351. .. _class_TextServer_method_font_remove_size_cache:
  1352. .. rst-class:: classref-method
  1353. void **font_remove_size_cache** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)**
  1354. Removes specified font size from the cache entry.
  1355. .. rst-class:: classref-item-separator
  1356. ----
  1357. .. _class_TextServer_method_font_remove_texture:
  1358. .. rst-class:: classref-method
  1359. void **font_remove_texture** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)**
  1360. Removes specified texture from the cache entry.
  1361. \ **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>`.
  1362. .. rst-class:: classref-item-separator
  1363. ----
  1364. .. _class_TextServer_method_font_render_glyph:
  1365. .. rst-class:: classref-method
  1366. void **font_render_glyph** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` index **)**
  1367. Renders specified glyph to the font cache texture.
  1368. .. rst-class:: classref-item-separator
  1369. ----
  1370. .. _class_TextServer_method_font_render_range:
  1371. .. rst-class:: classref-method
  1372. 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 **)**
  1373. Renders the range of characters to the font cache texture.
  1374. .. rst-class:: classref-item-separator
  1375. ----
  1376. .. _class_TextServer_method_font_set_allow_system_fallback:
  1377. .. rst-class:: classref-method
  1378. void **font_set_allow_system_fallback** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` allow_system_fallback **)**
  1379. If set to ``true``, system fonts can be automatically used as fallbacks.
  1380. .. rst-class:: classref-item-separator
  1381. ----
  1382. .. _class_TextServer_method_font_set_antialiasing:
  1383. .. rst-class:: classref-method
  1384. void **font_set_antialiasing** **(** :ref:`RID<class_RID>` font_rid, :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` antialiasing **)**
  1385. Sets font anti-aliasing mode.
  1386. .. rst-class:: classref-item-separator
  1387. ----
  1388. .. _class_TextServer_method_font_set_ascent:
  1389. .. rst-class:: classref-method
  1390. void **font_set_ascent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` ascent **)**
  1391. Sets the font ascent (number of pixels above the baseline).
  1392. .. rst-class:: classref-item-separator
  1393. ----
  1394. .. _class_TextServer_method_font_set_data:
  1395. .. rst-class:: classref-method
  1396. void **font_set_data** **(** :ref:`RID<class_RID>` font_rid, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
  1397. Sets font source data, e.g contents of the dynamic font source file.
  1398. .. rst-class:: classref-item-separator
  1399. ----
  1400. .. _class_TextServer_method_font_set_descent:
  1401. .. rst-class:: classref-method
  1402. void **font_set_descent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` descent **)**
  1403. Sets the font descent (number of pixels below the baseline).
  1404. .. rst-class:: classref-item-separator
  1405. ----
  1406. .. _class_TextServer_method_font_set_embolden:
  1407. .. rst-class:: classref-method
  1408. void **font_set_embolden** **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` strength **)**
  1409. Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
  1410. .. rst-class:: classref-item-separator
  1411. ----
  1412. .. _class_TextServer_method_font_set_face_index:
  1413. .. rst-class:: classref-method
  1414. void **font_set_face_index** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` face_index **)**
  1415. Sets an active face index in the TrueType / OpenType collection.
  1416. .. rst-class:: classref-item-separator
  1417. ----
  1418. .. _class_TextServer_method_font_set_fixed_size:
  1419. .. rst-class:: classref-method
  1420. void **font_set_fixed_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` fixed_size **)**
  1421. Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.
  1422. .. rst-class:: classref-item-separator
  1423. ----
  1424. .. _class_TextServer_method_font_set_force_autohinter:
  1425. .. rst-class:: classref-method
  1426. void **font_set_force_autohinter** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` force_autohinter **)**
  1427. If set to ``true`` auto-hinting is preferred over font built-in hinting.
  1428. .. rst-class:: classref-item-separator
  1429. ----
  1430. .. _class_TextServer_method_font_set_generate_mipmaps:
  1431. .. rst-class:: classref-method
  1432. void **font_set_generate_mipmaps** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` generate_mipmaps **)**
  1433. If set to ``true`` font texture mipmap generation is enabled.
  1434. .. rst-class:: classref-item-separator
  1435. ----
  1436. .. _class_TextServer_method_font_set_global_oversampling:
  1437. .. rst-class:: classref-method
  1438. void **font_set_global_oversampling** **(** :ref:`float<class_float>` oversampling **)**
  1439. Sets oversampling factor, shared by all font in the TextServer.
  1440. \ **Note:** This value can be automatically changed by display server.
  1441. .. rst-class:: classref-item-separator
  1442. ----
  1443. .. _class_TextServer_method_font_set_glyph_advance:
  1444. .. rst-class:: classref-method
  1445. 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 **)**
  1446. Sets glyph advance (offset of the next glyph).
  1447. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1448. .. rst-class:: classref-item-separator
  1449. ----
  1450. .. _class_TextServer_method_font_set_glyph_offset:
  1451. .. rst-class:: classref-method
  1452. 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 **)**
  1453. Sets glyph offset from the baseline.
  1454. .. rst-class:: classref-item-separator
  1455. ----
  1456. .. _class_TextServer_method_font_set_glyph_size:
  1457. .. rst-class:: classref-method
  1458. 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 **)**
  1459. Sets size of the glyph.
  1460. .. rst-class:: classref-item-separator
  1461. ----
  1462. .. _class_TextServer_method_font_set_glyph_texture_idx:
  1463. .. rst-class:: classref-method
  1464. 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 **)**
  1465. Sets index of the cache texture containing the glyph.
  1466. .. rst-class:: classref-item-separator
  1467. ----
  1468. .. _class_TextServer_method_font_set_glyph_uv_rect:
  1469. .. rst-class:: classref-method
  1470. 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 **)**
  1471. Sets rectangle in the cache texture containing the glyph.
  1472. .. rst-class:: classref-item-separator
  1473. ----
  1474. .. _class_TextServer_method_font_set_hinting:
  1475. .. rst-class:: classref-method
  1476. void **font_set_hinting** **(** :ref:`RID<class_RID>` font_rid, :ref:`Hinting<enum_TextServer_Hinting>` hinting **)**
  1477. Sets font hinting mode. Used by dynamic fonts only.
  1478. .. rst-class:: classref-item-separator
  1479. ----
  1480. .. _class_TextServer_method_font_set_kerning:
  1481. .. rst-class:: classref-method
  1482. 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 **)**
  1483. Sets kerning for the pair of glyphs.
  1484. .. rst-class:: classref-item-separator
  1485. ----
  1486. .. _class_TextServer_method_font_set_language_support_override:
  1487. .. rst-class:: classref-method
  1488. void **font_set_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language, :ref:`bool<class_bool>` supported **)**
  1489. Adds override for :ref:`font_is_language_supported<class_TextServer_method_font_is_language_supported>`.
  1490. .. rst-class:: classref-item-separator
  1491. ----
  1492. .. _class_TextServer_method_font_set_msdf_pixel_range:
  1493. .. rst-class:: classref-method
  1494. void **font_set_msdf_pixel_range** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_pixel_range **)**
  1495. Sets the width of the range around the shape between the minimum and maximum representable signed distance.
  1496. .. rst-class:: classref-item-separator
  1497. ----
  1498. .. _class_TextServer_method_font_set_msdf_size:
  1499. .. rst-class:: classref-method
  1500. void **font_set_msdf_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_size **)**
  1501. Sets source font size used to generate MSDF textures.
  1502. .. rst-class:: classref-item-separator
  1503. ----
  1504. .. _class_TextServer_method_font_set_multichannel_signed_distance_field:
  1505. .. rst-class:: classref-method
  1506. void **font_set_multichannel_signed_distance_field** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` msdf **)**
  1507. 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.
  1508. \ **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.
  1509. .. rst-class:: classref-item-separator
  1510. ----
  1511. .. _class_TextServer_method_font_set_name:
  1512. .. rst-class:: classref-method
  1513. void **font_set_name** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)**
  1514. Sets the font family name.
  1515. .. rst-class:: classref-item-separator
  1516. ----
  1517. .. _class_TextServer_method_font_set_opentype_feature_overrides:
  1518. .. rst-class:: classref-method
  1519. void **font_set_opentype_feature_overrides** **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` overrides **)**
  1520. Sets font OpenType feature set override.
  1521. .. rst-class:: classref-item-separator
  1522. ----
  1523. .. _class_TextServer_method_font_set_oversampling:
  1524. .. rst-class:: classref-method
  1525. void **font_set_oversampling** **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` oversampling **)**
  1526. Sets font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1527. .. rst-class:: classref-item-separator
  1528. ----
  1529. .. _class_TextServer_method_font_set_scale:
  1530. .. rst-class:: classref-method
  1531. void **font_set_scale** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` scale **)**
  1532. Sets scaling factor of the color bitmap font.
  1533. .. rst-class:: classref-item-separator
  1534. ----
  1535. .. _class_TextServer_method_font_set_script_support_override:
  1536. .. rst-class:: classref-method
  1537. void **font_set_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script, :ref:`bool<class_bool>` supported **)**
  1538. Adds override for :ref:`font_is_script_supported<class_TextServer_method_font_is_script_supported>`.
  1539. .. rst-class:: classref-item-separator
  1540. ----
  1541. .. _class_TextServer_method_font_set_stretch:
  1542. .. rst-class:: classref-method
  1543. void **font_set_stretch** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)**
  1544. Sets font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1545. \ **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.
  1546. .. rst-class:: classref-item-separator
  1547. ----
  1548. .. _class_TextServer_method_font_set_style:
  1549. .. rst-class:: classref-method
  1550. void **font_set_style** **(** :ref:`RID<class_RID>` font_rid, |bitfield|\<:ref:`FontStyle<enum_TextServer_FontStyle>`\> style **)**
  1551. Sets the font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1552. \ **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.
  1553. .. rst-class:: classref-item-separator
  1554. ----
  1555. .. _class_TextServer_method_font_set_style_name:
  1556. .. rst-class:: classref-method
  1557. void **font_set_style_name** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)**
  1558. Sets the font style name.
  1559. .. rst-class:: classref-item-separator
  1560. ----
  1561. .. _class_TextServer_method_font_set_subpixel_positioning:
  1562. .. rst-class:: classref-method
  1563. void **font_set_subpixel_positioning** **(** :ref:`RID<class_RID>` font_rid, :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` subpixel_positioning **)**
  1564. Sets font subpixel glyph positioning mode.
  1565. .. rst-class:: classref-item-separator
  1566. ----
  1567. .. _class_TextServer_method_font_set_texture_image:
  1568. .. rst-class:: classref-method
  1569. 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 **)**
  1570. Sets font cache texture image data.
  1571. .. rst-class:: classref-item-separator
  1572. ----
  1573. .. _class_TextServer_method_font_set_texture_offsets:
  1574. .. rst-class:: classref-method
  1575. 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 **)**
  1576. Sets array containing glyph packing data.
  1577. .. rst-class:: classref-item-separator
  1578. ----
  1579. .. _class_TextServer_method_font_set_transform:
  1580. .. rst-class:: classref-method
  1581. void **font_set_transform** **(** :ref:`RID<class_RID>` font_rid, :ref:`Transform2D<class_Transform2D>` transform **)**
  1582. Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs.
  1583. For example, to simulate italic typeface by slanting, apply the following transform ``Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)``.
  1584. .. rst-class:: classref-item-separator
  1585. ----
  1586. .. _class_TextServer_method_font_set_underline_position:
  1587. .. rst-class:: classref-method
  1588. void **font_set_underline_position** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_position **)**
  1589. Sets pixel offset of the underline below the baseline.
  1590. .. rst-class:: classref-item-separator
  1591. ----
  1592. .. _class_TextServer_method_font_set_underline_thickness:
  1593. .. rst-class:: classref-method
  1594. void **font_set_underline_thickness** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_thickness **)**
  1595. Sets thickness of the underline in pixels.
  1596. .. rst-class:: classref-item-separator
  1597. ----
  1598. .. _class_TextServer_method_font_set_variation_coordinates:
  1599. .. rst-class:: classref-method
  1600. void **font_set_variation_coordinates** **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` variation_coordinates **)**
  1601. 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.
  1602. .. rst-class:: classref-item-separator
  1603. ----
  1604. .. _class_TextServer_method_font_set_weight:
  1605. .. rst-class:: classref-method
  1606. void **font_set_weight** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)**
  1607. Sets weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1608. \ **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.
  1609. .. rst-class:: classref-item-separator
  1610. ----
  1611. .. _class_TextServer_method_font_supported_feature_list:
  1612. .. rst-class:: classref-method
  1613. :ref:`Dictionary<class_Dictionary>` **font_supported_feature_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1614. Returns the dictionary of the supported OpenType features.
  1615. .. rst-class:: classref-item-separator
  1616. ----
  1617. .. _class_TextServer_method_font_supported_variation_list:
  1618. .. rst-class:: classref-method
  1619. :ref:`Dictionary<class_Dictionary>` **font_supported_variation_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1620. Returns the dictionary of the supported OpenType variation coordinates.
  1621. .. rst-class:: classref-item-separator
  1622. ----
  1623. .. _class_TextServer_method_format_number:
  1624. .. rst-class:: classref-method
  1625. :ref:`String<class_String>` **format_number** **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const|
  1626. Converts a number from the Western Arabic (0..9) to the numeral systems used in ``language``.
  1627. If ``language`` is omitted, the active locale will be used.
  1628. .. rst-class:: classref-item-separator
  1629. ----
  1630. .. _class_TextServer_method_free_rid:
  1631. .. rst-class:: classref-method
  1632. void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
  1633. Frees an object created by this **TextServer**.
  1634. .. rst-class:: classref-item-separator
  1635. ----
  1636. .. _class_TextServer_method_get_features:
  1637. .. rst-class:: classref-method
  1638. :ref:`int<class_int>` **get_features** **(** **)** |const|
  1639. Returns text server features, see :ref:`Feature<enum_TextServer_Feature>`.
  1640. .. rst-class:: classref-item-separator
  1641. ----
  1642. .. _class_TextServer_method_get_hex_code_box_size:
  1643. .. rst-class:: classref-method
  1644. :ref:`Vector2<class_Vector2>` **get_hex_code_box_size** **(** :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |const|
  1645. Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).
  1646. .. rst-class:: classref-item-separator
  1647. ----
  1648. .. _class_TextServer_method_get_name:
  1649. .. rst-class:: classref-method
  1650. :ref:`String<class_String>` **get_name** **(** **)** |const|
  1651. Returns the name of the server interface.
  1652. .. rst-class:: classref-item-separator
  1653. ----
  1654. .. _class_TextServer_method_get_support_data_filename:
  1655. .. rst-class:: classref-method
  1656. :ref:`String<class_String>` **get_support_data_filename** **(** **)** |const|
  1657. Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename.
  1658. .. rst-class:: classref-item-separator
  1659. ----
  1660. .. _class_TextServer_method_get_support_data_info:
  1661. .. rst-class:: classref-method
  1662. :ref:`String<class_String>` **get_support_data_info** **(** **)** |const|
  1663. Returns TextServer database (e.g. ICU break iterators and dictionaries) description.
  1664. .. rst-class:: classref-item-separator
  1665. ----
  1666. .. _class_TextServer_method_has:
  1667. .. rst-class:: classref-method
  1668. :ref:`bool<class_bool>` **has** **(** :ref:`RID<class_RID>` rid **)**
  1669. Returns ``true`` if ``rid`` is valid resource owned by this text server.
  1670. .. rst-class:: classref-item-separator
  1671. ----
  1672. .. _class_TextServer_method_has_feature:
  1673. .. rst-class:: classref-method
  1674. :ref:`bool<class_bool>` **has_feature** **(** :ref:`Feature<enum_TextServer_Feature>` feature **)** |const|
  1675. Returns ``true`` if the server supports a feature.
  1676. .. rst-class:: classref-item-separator
  1677. ----
  1678. .. _class_TextServer_method_is_confusable:
  1679. .. rst-class:: classref-method
  1680. :ref:`int<class_int>` **is_confusable** **(** :ref:`String<class_String>` string, :ref:`PackedStringArray<class_PackedStringArray>` dict **)** |const|
  1681. Returns index of the first string in ``dict`` which is visually confusable with the ``string``, or ``-1`` if none is found.
  1682. \ **Note:** This method doesn't detect invisible characters, for spoof detection use it in combination with :ref:`spoof_check<class_TextServer_method_spoof_check>`.
  1683. \ **Note:** Always returns ``-1`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  1684. .. rst-class:: classref-item-separator
  1685. ----
  1686. .. _class_TextServer_method_is_locale_right_to_left:
  1687. .. rst-class:: classref-method
  1688. :ref:`bool<class_bool>` **is_locale_right_to_left** **(** :ref:`String<class_String>` locale **)** |const|
  1689. Returns ``true`` if locale is right-to-left.
  1690. .. rst-class:: classref-item-separator
  1691. ----
  1692. .. _class_TextServer_method_is_valid_identifier:
  1693. .. rst-class:: classref-method
  1694. :ref:`bool<class_bool>` **is_valid_identifier** **(** :ref:`String<class_String>` string **)** |const|
  1695. Returns ``true`` if ``string`` is a valid identifier.
  1696. If the text server supports the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature, a valid identifier must:
  1697. - Conform to normalization form C.
  1698. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1699. - May contain Unicode characters of class XID_Continue in the other positions.
  1700. - Use UAX #31 recommended scripts only (mixed scripts are allowed).
  1701. If the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature is not supported, a valid identifier must:
  1702. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1703. - May contain Unicode characters of class XID_Continue in the other positions.
  1704. .. rst-class:: classref-item-separator
  1705. ----
  1706. .. _class_TextServer_method_load_support_data:
  1707. .. rst-class:: classref-method
  1708. :ref:`bool<class_bool>` **load_support_data** **(** :ref:`String<class_String>` filename **)**
  1709. Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
  1710. \ **Note:** This function should be called before any other TextServer functions used, otherwise it won't have any effect.
  1711. .. rst-class:: classref-item-separator
  1712. ----
  1713. .. _class_TextServer_method_name_to_tag:
  1714. .. rst-class:: classref-method
  1715. :ref:`int<class_int>` **name_to_tag** **(** :ref:`String<class_String>` name **)** |const|
  1716. Converts readable feature, variation, script or language name to OpenType tag.
  1717. .. rst-class:: classref-item-separator
  1718. ----
  1719. .. _class_TextServer_method_parse_number:
  1720. .. rst-class:: classref-method
  1721. :ref:`String<class_String>` **parse_number** **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const|
  1722. Converts ``number`` from the numeral systems used in ``language`` to Western Arabic (0..9).
  1723. .. rst-class:: classref-item-separator
  1724. ----
  1725. .. _class_TextServer_method_parse_structured_text:
  1726. .. rst-class:: classref-method
  1727. :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|
  1728. Default implementation of the BiDi algorithm override function. See :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` for more info.
  1729. .. rst-class:: classref-item-separator
  1730. ----
  1731. .. _class_TextServer_method_percent_sign:
  1732. .. rst-class:: classref-method
  1733. :ref:`String<class_String>` **percent_sign** **(** :ref:`String<class_String>` language="" **)** |const|
  1734. Returns percent sign used in the ``language``.
  1735. .. rst-class:: classref-item-separator
  1736. ----
  1737. .. _class_TextServer_method_save_support_data:
  1738. .. rst-class:: classref-method
  1739. :ref:`bool<class_bool>` **save_support_data** **(** :ref:`String<class_String>` filename **)** |const|
  1740. Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.
  1741. \ **Note:** This function is used by during project export, to include TextServer database.
  1742. .. rst-class:: classref-item-separator
  1743. ----
  1744. .. _class_TextServer_method_shaped_get_span_count:
  1745. .. rst-class:: classref-method
  1746. :ref:`int<class_int>` **shaped_get_span_count** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1747. 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>`.
  1748. .. rst-class:: classref-item-separator
  1749. ----
  1750. .. _class_TextServer_method_shaped_get_span_meta:
  1751. .. rst-class:: classref-method
  1752. :ref:`Variant<class_Variant>` **shaped_get_span_meta** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` index **)** |const|
  1753. Returns text span metadata.
  1754. .. rst-class:: classref-item-separator
  1755. ----
  1756. .. _class_TextServer_method_shaped_set_span_update_font:
  1757. .. rst-class:: classref-method
  1758. 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={} **)**
  1759. Changes text span font, font size and OpenType features, without changing the text.
  1760. .. rst-class:: classref-item-separator
  1761. ----
  1762. .. _class_TextServer_method_shaped_text_add_object:
  1763. .. rst-class:: classref-method
  1764. :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 **)**
  1765. Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters.
  1766. .. rst-class:: classref-item-separator
  1767. ----
  1768. .. _class_TextServer_method_shaped_text_add_string:
  1769. .. rst-class:: classref-method
  1770. :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 **)**
  1771. Adds text span and font to draw it to the text buffer.
  1772. .. rst-class:: classref-item-separator
  1773. ----
  1774. .. _class_TextServer_method_shaped_text_clear:
  1775. .. rst-class:: classref-method
  1776. void **shaped_text_clear** **(** :ref:`RID<class_RID>` rid **)**
  1777. Clears text buffer (removes text and inline objects).
  1778. .. rst-class:: classref-item-separator
  1779. ----
  1780. .. _class_TextServer_method_shaped_text_draw:
  1781. .. rst-class:: classref-method
  1782. 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|
  1783. 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).
  1784. .. rst-class:: classref-item-separator
  1785. ----
  1786. .. _class_TextServer_method_shaped_text_draw_outline:
  1787. .. rst-class:: classref-method
  1788. 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|
  1789. 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).
  1790. .. rst-class:: classref-item-separator
  1791. ----
  1792. .. _class_TextServer_method_shaped_text_fit_to_width:
  1793. .. rst-class:: classref-method
  1794. :ref:`float<class_float>` **shaped_text_fit_to_width** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width, |bitfield|\<:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\> justification_flags=3 **)**
  1795. Adjusts text width to fit to specified width, returns new text width.
  1796. .. rst-class:: classref-item-separator
  1797. ----
  1798. .. _class_TextServer_method_shaped_text_get_ascent:
  1799. .. rst-class:: classref-method
  1800. :ref:`float<class_float>` **shaped_text_get_ascent** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1801. Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
  1802. \ **Note:** Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline.
  1803. .. rst-class:: classref-item-separator
  1804. ----
  1805. .. _class_TextServer_method_shaped_text_get_carets:
  1806. .. rst-class:: classref-method
  1807. :ref:`Dictionary<class_Dictionary>` **shaped_text_get_carets** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` position **)** |const|
  1808. Returns shapes of the carets corresponding to the character offset ``position`` in the text. Returned caret shape is 1 pixel wide rectangle.
  1809. .. rst-class:: classref-item-separator
  1810. ----
  1811. .. _class_TextServer_method_shaped_text_get_custom_punctuation:
  1812. .. rst-class:: classref-method
  1813. :ref:`String<class_String>` **shaped_text_get_custom_punctuation** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1814. Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  1815. .. rst-class:: classref-item-separator
  1816. ----
  1817. .. _class_TextServer_method_shaped_text_get_descent:
  1818. .. rst-class:: classref-method
  1819. :ref:`float<class_float>` **shaped_text_get_descent** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1820. Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
  1821. \ **Note:** Overall descent can be higher than font descent, if some glyphs are displaced from the baseline.
  1822. .. rst-class:: classref-item-separator
  1823. ----
  1824. .. _class_TextServer_method_shaped_text_get_direction:
  1825. .. rst-class:: classref-method
  1826. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_direction** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1827. Returns direction of the text.
  1828. .. rst-class:: classref-item-separator
  1829. ----
  1830. .. _class_TextServer_method_shaped_text_get_dominant_direction_in_range:
  1831. .. rst-class:: classref-method
  1832. :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|
  1833. Returns dominant direction of in the range of text.
  1834. .. rst-class:: classref-item-separator
  1835. ----
  1836. .. _class_TextServer_method_shaped_text_get_ellipsis_glyph_count:
  1837. .. rst-class:: classref-method
  1838. :ref:`int<class_int>` **shaped_text_get_ellipsis_glyph_count** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1839. Returns number of glyphs in the ellipsis.
  1840. .. rst-class:: classref-item-separator
  1841. ----
  1842. .. _class_TextServer_method_shaped_text_get_ellipsis_glyphs:
  1843. .. rst-class:: classref-method
  1844. :ref:`Dictionary[]<class_Dictionary>` **shaped_text_get_ellipsis_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1845. Returns array of the glyphs in the ellipsis.
  1846. .. rst-class:: classref-item-separator
  1847. ----
  1848. .. _class_TextServer_method_shaped_text_get_ellipsis_pos:
  1849. .. rst-class:: classref-method
  1850. :ref:`int<class_int>` **shaped_text_get_ellipsis_pos** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1851. Returns position of the ellipsis.
  1852. .. rst-class:: classref-item-separator
  1853. ----
  1854. .. _class_TextServer_method_shaped_text_get_glyph_count:
  1855. .. rst-class:: classref-method
  1856. :ref:`int<class_int>` **shaped_text_get_glyph_count** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1857. Returns number of glyphs in the buffer.
  1858. .. rst-class:: classref-item-separator
  1859. ----
  1860. .. _class_TextServer_method_shaped_text_get_glyphs:
  1861. .. rst-class:: classref-method
  1862. :ref:`Dictionary[]<class_Dictionary>` **shaped_text_get_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1863. Returns an array of glyphs in the visual order.
  1864. .. rst-class:: classref-item-separator
  1865. ----
  1866. .. _class_TextServer_method_shaped_text_get_grapheme_bounds:
  1867. .. rst-class:: classref-method
  1868. :ref:`Vector2<class_Vector2>` **shaped_text_get_grapheme_bounds** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  1869. Returns composite character's bounds as offsets from the start of the line.
  1870. .. rst-class:: classref-item-separator
  1871. ----
  1872. .. _class_TextServer_method_shaped_text_get_inferred_direction:
  1873. .. rst-class:: classref-method
  1874. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_inferred_direction** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1875. Returns direction of the text, inferred by the BiDi algorithm.
  1876. .. rst-class:: classref-item-separator
  1877. ----
  1878. .. _class_TextServer_method_shaped_text_get_line_breaks:
  1879. .. rst-class:: classref-method
  1880. :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, |bitfield|\<:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\> break_flags=3 **)** |const|
  1881. Breaks text to the lines and returns character ranges for each line.
  1882. .. rst-class:: classref-item-separator
  1883. ----
  1884. .. _class_TextServer_method_shaped_text_get_line_breaks_adv:
  1885. .. rst-class:: classref-method
  1886. :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, |bitfield|\<:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\> break_flags=3 **)** |const|
  1887. Breaks text to the lines and columns. Returns character ranges for each segment.
  1888. .. rst-class:: classref-item-separator
  1889. ----
  1890. .. _class_TextServer_method_shaped_text_get_object_rect:
  1891. .. rst-class:: classref-method
  1892. :ref:`Rect2<class_Rect2>` **shaped_text_get_object_rect** **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key **)** |const|
  1893. Returns bounding rectangle of the inline object.
  1894. .. rst-class:: classref-item-separator
  1895. ----
  1896. .. _class_TextServer_method_shaped_text_get_objects:
  1897. .. rst-class:: classref-method
  1898. :ref:`Array<class_Array>` **shaped_text_get_objects** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1899. Returns array of inline objects.
  1900. .. rst-class:: classref-item-separator
  1901. ----
  1902. .. _class_TextServer_method_shaped_text_get_orientation:
  1903. .. rst-class:: classref-method
  1904. :ref:`Orientation<enum_TextServer_Orientation>` **shaped_text_get_orientation** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1905. Returns text orientation.
  1906. .. rst-class:: classref-item-separator
  1907. ----
  1908. .. _class_TextServer_method_shaped_text_get_parent:
  1909. .. rst-class:: classref-method
  1910. :ref:`RID<class_RID>` **shaped_text_get_parent** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1911. Returns the parent buffer from which the substring originates.
  1912. .. rst-class:: classref-item-separator
  1913. ----
  1914. .. _class_TextServer_method_shaped_text_get_preserve_control:
  1915. .. rst-class:: classref-method
  1916. :ref:`bool<class_bool>` **shaped_text_get_preserve_control** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1917. Returns ``true`` if text buffer is configured to display control characters.
  1918. .. rst-class:: classref-item-separator
  1919. ----
  1920. .. _class_TextServer_method_shaped_text_get_preserve_invalid:
  1921. .. rst-class:: classref-method
  1922. :ref:`bool<class_bool>` **shaped_text_get_preserve_invalid** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1923. Returns ``true`` if text buffer is configured to display hexadecimal codes in place of invalid characters.
  1924. \ **Note:** If set to ``false``, nothing is displayed in place of invalid characters.
  1925. .. rst-class:: classref-item-separator
  1926. ----
  1927. .. _class_TextServer_method_shaped_text_get_range:
  1928. .. rst-class:: classref-method
  1929. :ref:`Vector2i<class_Vector2i>` **shaped_text_get_range** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1930. Returns substring buffer character range in the parent buffer.
  1931. .. rst-class:: classref-item-separator
  1932. ----
  1933. .. _class_TextServer_method_shaped_text_get_selection:
  1934. .. rst-class:: classref-method
  1935. :ref:`PackedVector2Array<class_PackedVector2Array>` **shaped_text_get_selection** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |const|
  1936. Returns selection rectangles for the specified character range.
  1937. .. rst-class:: classref-item-separator
  1938. ----
  1939. .. _class_TextServer_method_shaped_text_get_size:
  1940. .. rst-class:: classref-method
  1941. :ref:`Vector2<class_Vector2>` **shaped_text_get_size** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1942. Returns size of the text.
  1943. .. rst-class:: classref-item-separator
  1944. ----
  1945. .. _class_TextServer_method_shaped_text_get_spacing:
  1946. .. rst-class:: classref-method
  1947. :ref:`int<class_int>` **shaped_text_get_spacing** **(** :ref:`RID<class_RID>` shaped, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |const|
  1948. Returns extra spacing added between glyphs or lines in pixels.
  1949. .. rst-class:: classref-item-separator
  1950. ----
  1951. .. _class_TextServer_method_shaped_text_get_trim_pos:
  1952. .. rst-class:: classref-method
  1953. :ref:`int<class_int>` **shaped_text_get_trim_pos** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1954. Returns the position of the overrun trim.
  1955. .. rst-class:: classref-item-separator
  1956. ----
  1957. .. _class_TextServer_method_shaped_text_get_underline_position:
  1958. .. rst-class:: classref-method
  1959. :ref:`float<class_float>` **shaped_text_get_underline_position** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1960. Returns pixel offset of the underline below the baseline.
  1961. .. rst-class:: classref-item-separator
  1962. ----
  1963. .. _class_TextServer_method_shaped_text_get_underline_thickness:
  1964. .. rst-class:: classref-method
  1965. :ref:`float<class_float>` **shaped_text_get_underline_thickness** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1966. Returns thickness of the underline.
  1967. .. rst-class:: classref-item-separator
  1968. ----
  1969. .. _class_TextServer_method_shaped_text_get_width:
  1970. .. rst-class:: classref-method
  1971. :ref:`float<class_float>` **shaped_text_get_width** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1972. Returns width (for horizontal layout) or height (for vertical) of the text.
  1973. .. rst-class:: classref-item-separator
  1974. ----
  1975. .. _class_TextServer_method_shaped_text_get_word_breaks:
  1976. .. rst-class:: classref-method
  1977. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_word_breaks** **(** :ref:`RID<class_RID>` shaped, |bitfield|\<:ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`\> grapheme_flags=264 **)** |const|
  1978. 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>`).
  1979. .. rst-class:: classref-item-separator
  1980. ----
  1981. .. _class_TextServer_method_shaped_text_has_visible_chars:
  1982. .. rst-class:: classref-method
  1983. :ref:`bool<class_bool>` **shaped_text_has_visible_chars** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1984. Returns ``true``, if text buffer contents any visible characters.
  1985. .. rst-class:: classref-item-separator
  1986. ----
  1987. .. _class_TextServer_method_shaped_text_hit_test_grapheme:
  1988. .. rst-class:: classref-method
  1989. :ref:`int<class_int>` **shaped_text_hit_test_grapheme** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coords **)** |const|
  1990. Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` if none is found.
  1991. .. rst-class:: classref-item-separator
  1992. ----
  1993. .. _class_TextServer_method_shaped_text_hit_test_position:
  1994. .. rst-class:: classref-method
  1995. :ref:`int<class_int>` **shaped_text_hit_test_position** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coords **)** |const|
  1996. Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
  1997. .. rst-class:: classref-item-separator
  1998. ----
  1999. .. _class_TextServer_method_shaped_text_is_ready:
  2000. .. rst-class:: classref-method
  2001. :ref:`bool<class_bool>` **shaped_text_is_ready** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2002. Returns ``true`` if buffer is successfully shaped.
  2003. .. rst-class:: classref-item-separator
  2004. ----
  2005. .. _class_TextServer_method_shaped_text_next_grapheme_pos:
  2006. .. rst-class:: classref-method
  2007. :ref:`int<class_int>` **shaped_text_next_grapheme_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  2008. Returns composite character end position closest to the ``pos``.
  2009. .. rst-class:: classref-item-separator
  2010. ----
  2011. .. _class_TextServer_method_shaped_text_overrun_trim_to_width:
  2012. .. rst-class:: classref-method
  2013. void **shaped_text_overrun_trim_to_width** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width=0, |bitfield|\<:ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>`\> overrun_trim_flags=0 **)**
  2014. Trims text if it exceeds the given width.
  2015. .. rst-class:: classref-item-separator
  2016. ----
  2017. .. _class_TextServer_method_shaped_text_prev_grapheme_pos:
  2018. .. rst-class:: classref-method
  2019. :ref:`int<class_int>` **shaped_text_prev_grapheme_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  2020. Returns composite character start position closest to the ``pos``.
  2021. .. rst-class:: classref-item-separator
  2022. ----
  2023. .. _class_TextServer_method_shaped_text_resize_object:
  2024. .. rst-class:: classref-method
  2025. :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 **)**
  2026. Sets new size and alignment of embedded object.
  2027. .. rst-class:: classref-item-separator
  2028. ----
  2029. .. _class_TextServer_method_shaped_text_set_bidi_override:
  2030. .. rst-class:: classref-method
  2031. void **shaped_text_set_bidi_override** **(** :ref:`RID<class_RID>` shaped, :ref:`Array<class_Array>` override **)**
  2032. Overrides BiDi for the structured text.
  2033. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
  2034. .. rst-class:: classref-item-separator
  2035. ----
  2036. .. _class_TextServer_method_shaped_text_set_custom_punctuation:
  2037. .. rst-class:: classref-method
  2038. void **shaped_text_set_custom_punctuation** **(** :ref:`RID<class_RID>` shaped, :ref:`String<class_String>` punct **)**
  2039. Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  2040. .. rst-class:: classref-item-separator
  2041. ----
  2042. .. _class_TextServer_method_shaped_text_set_direction:
  2043. .. rst-class:: classref-method
  2044. void **shaped_text_set_direction** **(** :ref:`RID<class_RID>` shaped, :ref:`Direction<enum_TextServer_Direction>` direction=0 **)**
  2045. 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.
  2046. \ **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>`).
  2047. .. rst-class:: classref-item-separator
  2048. ----
  2049. .. _class_TextServer_method_shaped_text_set_orientation:
  2050. .. rst-class:: classref-method
  2051. void **shaped_text_set_orientation** **(** :ref:`RID<class_RID>` shaped, :ref:`Orientation<enum_TextServer_Orientation>` orientation=0 **)**
  2052. Sets desired text orientation.
  2053. \ **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>`).
  2054. .. rst-class:: classref-item-separator
  2055. ----
  2056. .. _class_TextServer_method_shaped_text_set_preserve_control:
  2057. .. rst-class:: classref-method
  2058. void **shaped_text_set_preserve_control** **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)**
  2059. If set to ``true`` text buffer will display control characters.
  2060. .. rst-class:: classref-item-separator
  2061. ----
  2062. .. _class_TextServer_method_shaped_text_set_preserve_invalid:
  2063. .. rst-class:: classref-method
  2064. void **shaped_text_set_preserve_invalid** **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)**
  2065. If set to ``true`` text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.
  2066. .. rst-class:: classref-item-separator
  2067. ----
  2068. .. _class_TextServer_method_shaped_text_set_spacing:
  2069. .. rst-class:: classref-method
  2070. void **shaped_text_set_spacing** **(** :ref:`RID<class_RID>` shaped, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)**
  2071. Sets extra spacing added between glyphs or lines in pixels.
  2072. .. rst-class:: classref-item-separator
  2073. ----
  2074. .. _class_TextServer_method_shaped_text_shape:
  2075. .. rst-class:: classref-method
  2076. :ref:`bool<class_bool>` **shaped_text_shape** **(** :ref:`RID<class_RID>` shaped **)**
  2077. Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped successfully.
  2078. \ **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.
  2079. .. rst-class:: classref-item-separator
  2080. ----
  2081. .. _class_TextServer_method_shaped_text_sort_logical:
  2082. .. rst-class:: classref-method
  2083. :ref:`Dictionary[]<class_Dictionary>` **shaped_text_sort_logical** **(** :ref:`RID<class_RID>` shaped **)**
  2084. Returns text glyphs in the logical order.
  2085. .. rst-class:: classref-item-separator
  2086. ----
  2087. .. _class_TextServer_method_shaped_text_substr:
  2088. .. rst-class:: classref-method
  2089. :ref:`RID<class_RID>` **shaped_text_substr** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` length **)** |const|
  2090. Returns text buffer for the substring of the text in the ``shaped`` text buffer (including inline objects).
  2091. .. rst-class:: classref-item-separator
  2092. ----
  2093. .. _class_TextServer_method_shaped_text_tab_align:
  2094. .. rst-class:: classref-method
  2095. :ref:`float<class_float>` **shaped_text_tab_align** **(** :ref:`RID<class_RID>` shaped, :ref:`PackedFloat32Array<class_PackedFloat32Array>` tab_stops **)**
  2096. Aligns shaped text to the given tab-stops.
  2097. .. rst-class:: classref-item-separator
  2098. ----
  2099. .. _class_TextServer_method_spoof_check:
  2100. .. rst-class:: classref-method
  2101. :ref:`bool<class_bool>` **spoof_check** **(** :ref:`String<class_String>` string **)** |const|
  2102. Returns ``true`` if ``string`` is likely to be an attempt at confusing the reader.
  2103. \ **Note:** Always returns ``false`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  2104. .. rst-class:: classref-item-separator
  2105. ----
  2106. .. _class_TextServer_method_string_get_word_breaks:
  2107. .. rst-class:: classref-method
  2108. :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|
  2109. 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.
  2110. When ``chars_per_line`` is greater than zero, line break boundaries are returned instead.
  2111. ::
  2112. var ts = TextServerManager.get_primary_interface()
  2113. print(ts.string_get_word_breaks("Godot Engine")) # Prints [0, 5, 6, 12]
  2114. print(ts.string_get_word_breaks("Godot Engine", "en", 5)) # Prints [0, 5, 6, 11, 11, 12]
  2115. .. rst-class:: classref-item-separator
  2116. ----
  2117. .. _class_TextServer_method_string_to_lower:
  2118. .. rst-class:: classref-method
  2119. :ref:`String<class_String>` **string_to_lower** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const|
  2120. Returns the string converted to lowercase.
  2121. \ **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>`).
  2122. \ **Note:** The result may be longer or shorter than the original.
  2123. .. rst-class:: classref-item-separator
  2124. ----
  2125. .. _class_TextServer_method_string_to_upper:
  2126. .. rst-class:: classref-method
  2127. :ref:`String<class_String>` **string_to_upper** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const|
  2128. Returns the string converted to uppercase.
  2129. \ **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>`).
  2130. \ **Note:** The result may be longer or shorter than the original.
  2131. .. rst-class:: classref-item-separator
  2132. ----
  2133. .. _class_TextServer_method_strip_diacritics:
  2134. .. rst-class:: classref-method
  2135. :ref:`String<class_String>` **strip_diacritics** **(** :ref:`String<class_String>` string **)** |const|
  2136. Strips diacritics from the string.
  2137. \ **Note:** The result may be longer or shorter than the original.
  2138. .. rst-class:: classref-item-separator
  2139. ----
  2140. .. _class_TextServer_method_tag_to_name:
  2141. .. rst-class:: classref-method
  2142. :ref:`String<class_String>` **tag_to_name** **(** :ref:`int<class_int>` tag **)** |const|
  2143. Converts OpenType tag to readable feature, variation, script or language name.
  2144. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2145. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2146. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2147. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2148. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2149. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  2150. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`