class_textserver.rst 282 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074
  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.2/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.2/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_font_linked_variation<class_TextServer_method_create_font_linked_variation>` **(** :ref:`RID<class_RID>` font_rid **)** |
  25. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :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 **)** |
  27. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | 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| |
  29. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | void | :ref:`font_clear_glyphs<class_TextServer_method_font_clear_glyphs>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |
  31. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | void | :ref:`font_clear_kerning_map<class_TextServer_method_font_clear_kerning_map>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |
  33. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | void | :ref:`font_clear_size_cache<class_TextServer_method_font_clear_size_cache>` **(** :ref:`RID<class_RID>` font_rid **)** |
  35. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | void | :ref:`font_clear_textures<class_TextServer_method_font_clear_textures>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |
  37. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | 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| |
  39. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | 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| |
  41. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` | :ref:`font_get_antialiasing<class_TextServer_method_font_get_antialiasing>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  43. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :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| |
  45. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :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| |
  47. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :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| |
  49. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`float<class_float>` | :ref:`font_get_embolden<class_TextServer_method_font_get_embolden>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  51. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | :ref:`int<class_int>` | :ref:`font_get_face_count<class_TextServer_method_font_get_face_count>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  53. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :ref:`int<class_int>` | :ref:`font_get_face_index<class_TextServer_method_font_get_face_index>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  55. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`int<class_int>` | :ref:`font_get_fixed_size<class_TextServer_method_font_get_fixed_size>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  57. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` | :ref:`font_get_fixed_size_scale_mode<class_TextServer_method_font_get_fixed_size_scale_mode>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  59. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | :ref:`bool<class_bool>` | :ref:`font_get_generate_mipmaps<class_TextServer_method_font_get_generate_mipmaps>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  61. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`float<class_float>` | :ref:`font_get_global_oversampling<class_TextServer_method_font_get_global_oversampling>` **(** **)** |const| |
  63. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :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| |
  65. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :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| |
  67. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :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| |
  69. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :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| |
  71. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :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| |
  73. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :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| |
  75. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | :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| |
  77. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :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| |
  79. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | :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| |
  81. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | :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| |
  83. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | :ref:`Hinting<enum_TextServer_Hinting>` | :ref:`font_get_hinting<class_TextServer_method_font_get_hinting>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  85. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | :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| |
  87. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | :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| |
  89. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :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 **)** |
  91. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_language_support_overrides<class_TextServer_method_font_get_language_support_overrides>` **(** :ref:`RID<class_RID>` font_rid **)** |
  93. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :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| |
  95. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | :ref:`int<class_int>` | :ref:`font_get_msdf_size<class_TextServer_method_font_get_msdf_size>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  97. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | :ref:`String<class_String>` | :ref:`font_get_name<class_TextServer_method_font_get_name>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  99. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | :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| |
  101. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | :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| |
  103. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | :ref:`float<class_float>` | :ref:`font_get_oversampling<class_TextServer_method_font_get_oversampling>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  105. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | :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| |
  107. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | :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 **)** |
  109. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_script_support_overrides<class_TextServer_method_font_get_script_support_overrides>` **(** :ref:`RID<class_RID>` font_rid **)** |
  111. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | :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| |
  113. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | :ref:`int<class_int>` | :ref:`font_get_spacing<class_TextServer_method_font_get_spacing>` **(** :ref:`RID<class_RID>` font_rid, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |const| |
  115. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | :ref:`int<class_int>` | :ref:`font_get_stretch<class_TextServer_method_font_get_stretch>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  117. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | |bitfield|\<:ref:`FontStyle<enum_TextServer_FontStyle>`\> | :ref:`font_get_style<class_TextServer_method_font_get_style>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  119. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | :ref:`String<class_String>` | :ref:`font_get_style_name<class_TextServer_method_font_get_style_name>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  121. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` | :ref:`font_get_subpixel_positioning<class_TextServer_method_font_get_subpixel_positioning>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  123. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | :ref:`String<class_String>` | :ref:`font_get_supported_chars<class_TextServer_method_font_get_supported_chars>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  125. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | :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| |
  127. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | :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| |
  129. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | :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| |
  131. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | :ref:`Transform2D<class_Transform2D>` | :ref:`font_get_transform<class_TextServer_method_font_get_transform>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  133. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | :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| |
  135. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. | :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| |
  137. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  138. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_variation_coordinates<class_TextServer_method_font_get_variation_coordinates>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  139. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  140. | :ref:`int<class_int>` | :ref:`font_get_weight<class_TextServer_method_font_get_weight>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  141. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  142. | :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| |
  143. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  144. | :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| |
  145. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  146. | :ref:`bool<class_bool>` | :ref:`font_is_force_autohinter<class_TextServer_method_font_is_force_autohinter>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  147. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  148. | :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| |
  149. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  150. | :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| |
  151. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  152. | :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| |
  153. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  154. | 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 **)** |
  155. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  156. | 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 **)** |
  157. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  158. | 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 **)** |
  159. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  160. | 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 **)** |
  161. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  162. | void | :ref:`font_remove_size_cache<class_TextServer_method_font_remove_size_cache>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |
  163. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  164. | 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 **)** |
  165. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  166. | 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 **)** |
  167. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  168. | 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 **)** |
  169. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  170. | 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 **)** |
  171. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  172. | void | :ref:`font_set_antialiasing<class_TextServer_method_font_set_antialiasing>` **(** :ref:`RID<class_RID>` font_rid, :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` antialiasing **)** |
  173. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  174. | 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 **)** |
  175. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  176. | void | :ref:`font_set_data<class_TextServer_method_font_set_data>` **(** :ref:`RID<class_RID>` font_rid, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |
  177. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  178. | 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 **)** |
  179. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  180. | void | :ref:`font_set_embolden<class_TextServer_method_font_set_embolden>` **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` strength **)** |
  181. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  182. | 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 **)** |
  183. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  184. | 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 **)** |
  185. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  186. | void | :ref:`font_set_fixed_size_scale_mode<class_TextServer_method_font_set_fixed_size_scale_mode>` **(** :ref:`RID<class_RID>` font_rid, :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` fixed_size_scale_mode **)** |
  187. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  188. | 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 **)** |
  189. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  190. | 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 **)** |
  191. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  192. | void | :ref:`font_set_global_oversampling<class_TextServer_method_font_set_global_oversampling>` **(** :ref:`float<class_float>` oversampling **)** |
  193. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  194. | 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 **)** |
  195. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  196. | 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 **)** |
  197. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  198. | 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 **)** |
  199. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  200. | 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 **)** |
  201. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  202. | 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 **)** |
  203. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  204. | void | :ref:`font_set_hinting<class_TextServer_method_font_set_hinting>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Hinting<enum_TextServer_Hinting>` hinting **)** |
  205. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  206. | 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 **)** |
  207. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  208. | 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 **)** |
  209. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  210. | 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 **)** |
  211. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  212. | 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 **)** |
  213. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  214. | 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 **)** |
  215. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  216. | void | :ref:`font_set_name<class_TextServer_method_font_set_name>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)** |
  217. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  218. | 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 **)** |
  219. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  220. | void | :ref:`font_set_oversampling<class_TextServer_method_font_set_oversampling>` **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` oversampling **)** |
  221. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  222. | 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 **)** |
  223. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  224. | 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 **)** |
  225. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  226. | void | :ref:`font_set_spacing<class_TextServer_method_font_set_spacing>` **(** :ref:`RID<class_RID>` font_rid, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)** |
  227. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  228. | void | :ref:`font_set_stretch<class_TextServer_method_font_set_stretch>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)** |
  229. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  230. | void | :ref:`font_set_style<class_TextServer_method_font_set_style>` **(** :ref:`RID<class_RID>` font_rid, |bitfield|\<:ref:`FontStyle<enum_TextServer_FontStyle>`\> style **)** |
  231. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  232. | void | :ref:`font_set_style_name<class_TextServer_method_font_set_style_name>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)** |
  233. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  234. | 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 **)** |
  235. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  236. | 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 **)** |
  237. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  238. | 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 **)** |
  239. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  240. | void | :ref:`font_set_transform<class_TextServer_method_font_set_transform>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Transform2D<class_Transform2D>` transform **)** |
  241. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  242. | 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 **)** |
  243. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  244. | 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 **)** |
  245. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  246. | 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 **)** |
  247. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  248. | void | :ref:`font_set_weight<class_TextServer_method_font_set_weight>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)** |
  249. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  250. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_feature_list<class_TextServer_method_font_supported_feature_list>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  251. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  252. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_variation_list<class_TextServer_method_font_supported_variation_list>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  253. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  254. | :ref:`String<class_String>` | :ref:`format_number<class_TextServer_method_format_number>` **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const| |
  255. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  256. | void | :ref:`free_rid<class_TextServer_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
  257. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  258. | :ref:`int<class_int>` | :ref:`get_features<class_TextServer_method_get_features>` **(** **)** |const| |
  259. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  260. | :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| |
  261. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  262. | :ref:`String<class_String>` | :ref:`get_name<class_TextServer_method_get_name>` **(** **)** |const| |
  263. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  264. | :ref:`String<class_String>` | :ref:`get_support_data_filename<class_TextServer_method_get_support_data_filename>` **(** **)** |const| |
  265. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  266. | :ref:`String<class_String>` | :ref:`get_support_data_info<class_TextServer_method_get_support_data_info>` **(** **)** |const| |
  267. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  268. | :ref:`bool<class_bool>` | :ref:`has<class_TextServer_method_has>` **(** :ref:`RID<class_RID>` rid **)** |
  269. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  270. | :ref:`bool<class_bool>` | :ref:`has_feature<class_TextServer_method_has_feature>` **(** :ref:`Feature<enum_TextServer_Feature>` feature **)** |const| |
  271. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  272. | :ref:`int<class_int>` | :ref:`is_confusable<class_TextServer_method_is_confusable>` **(** :ref:`String<class_String>` string, :ref:`PackedStringArray<class_PackedStringArray>` dict **)** |const| |
  273. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  274. | :ref:`bool<class_bool>` | :ref:`is_locale_right_to_left<class_TextServer_method_is_locale_right_to_left>` **(** :ref:`String<class_String>` locale **)** |const| |
  275. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  276. | :ref:`bool<class_bool>` | :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>` **(** :ref:`String<class_String>` string **)** |const| |
  277. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  278. | :ref:`bool<class_bool>` | :ref:`load_support_data<class_TextServer_method_load_support_data>` **(** :ref:`String<class_String>` filename **)** |
  279. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  280. | :ref:`int<class_int>` | :ref:`name_to_tag<class_TextServer_method_name_to_tag>` **(** :ref:`String<class_String>` name **)** |const| |
  281. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  282. | :ref:`String<class_String>` | :ref:`parse_number<class_TextServer_method_parse_number>` **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const| |
  283. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  284. | :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| |
  285. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  286. | :ref:`String<class_String>` | :ref:`percent_sign<class_TextServer_method_percent_sign>` **(** :ref:`String<class_String>` language="" **)** |const| |
  287. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  288. | :ref:`bool<class_bool>` | :ref:`save_support_data<class_TextServer_method_save_support_data>` **(** :ref:`String<class_String>` filename **)** |const| |
  289. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  290. | :ref:`int<class_int>` | :ref:`shaped_get_span_count<class_TextServer_method_shaped_get_span_count>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  291. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  292. | :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| |
  293. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  294. | 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={} **)** |
  295. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  296. | :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 **)** |
  297. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  298. | :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 **)** |
  299. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  300. | void | :ref:`shaped_text_clear<class_TextServer_method_shaped_text_clear>` **(** :ref:`RID<class_RID>` rid **)** |
  301. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  302. | :ref:`int<class_int>` | :ref:`shaped_text_closest_character_pos<class_TextServer_method_shaped_text_closest_character_pos>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const| |
  303. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  304. | 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| |
  305. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  306. | 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| |
  307. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  308. | :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 **)** |
  309. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  310. | :ref:`float<class_float>` | :ref:`shaped_text_get_ascent<class_TextServer_method_shaped_text_get_ascent>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  311. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  312. | :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| |
  313. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  314. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_character_breaks<class_TextServer_method_shaped_text_get_character_breaks>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  315. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  316. | :ref:`String<class_String>` | :ref:`shaped_text_get_custom_punctuation<class_TextServer_method_shaped_text_get_custom_punctuation>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  317. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  318. | :ref:`float<class_float>` | :ref:`shaped_text_get_descent<class_TextServer_method_shaped_text_get_descent>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  319. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  320. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_direction<class_TextServer_method_shaped_text_get_direction>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  321. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  322. | :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| |
  323. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  324. | :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| |
  325. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  326. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`shaped_text_get_ellipsis_glyphs<class_TextServer_method_shaped_text_get_ellipsis_glyphs>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  327. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  328. | :ref:`int<class_int>` | :ref:`shaped_text_get_ellipsis_pos<class_TextServer_method_shaped_text_get_ellipsis_pos>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  329. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  330. | :ref:`int<class_int>` | :ref:`shaped_text_get_glyph_count<class_TextServer_method_shaped_text_get_glyph_count>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  331. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  332. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`shaped_text_get_glyphs<class_TextServer_method_shaped_text_get_glyphs>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  333. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  334. | :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| |
  335. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  336. | :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| |
  337. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  338. | :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| |
  339. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  340. | :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| |
  341. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  342. | :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| |
  343. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  344. | :ref:`Array<class_Array>` | :ref:`shaped_text_get_objects<class_TextServer_method_shaped_text_get_objects>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  345. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  346. | :ref:`Orientation<enum_TextServer_Orientation>` | :ref:`shaped_text_get_orientation<class_TextServer_method_shaped_text_get_orientation>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  347. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  348. | :ref:`RID<class_RID>` | :ref:`shaped_text_get_parent<class_TextServer_method_shaped_text_get_parent>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  349. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  350. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_control<class_TextServer_method_shaped_text_get_preserve_control>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  351. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  352. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_invalid<class_TextServer_method_shaped_text_get_preserve_invalid>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  353. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  354. | :ref:`Vector2i<class_Vector2i>` | :ref:`shaped_text_get_range<class_TextServer_method_shaped_text_get_range>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  355. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  356. | :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| |
  357. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  358. | :ref:`Vector2<class_Vector2>` | :ref:`shaped_text_get_size<class_TextServer_method_shaped_text_get_size>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  359. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  360. | :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| |
  361. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  362. | :ref:`int<class_int>` | :ref:`shaped_text_get_trim_pos<class_TextServer_method_shaped_text_get_trim_pos>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  363. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  364. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_position<class_TextServer_method_shaped_text_get_underline_position>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  365. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  366. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_thickness<class_TextServer_method_shaped_text_get_underline_thickness>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  367. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  368. | :ref:`float<class_float>` | :ref:`shaped_text_get_width<class_TextServer_method_shaped_text_get_width>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  369. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  370. | :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| |
  371. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  372. | :ref:`bool<class_bool>` | :ref:`shaped_text_has_visible_chars<class_TextServer_method_shaped_text_has_visible_chars>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  373. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  374. | :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| |
  375. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  376. | :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| |
  377. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  378. | :ref:`bool<class_bool>` | :ref:`shaped_text_is_ready<class_TextServer_method_shaped_text_is_ready>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  379. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  380. | :ref:`int<class_int>` | :ref:`shaped_text_next_character_pos<class_TextServer_method_shaped_text_next_character_pos>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const| |
  381. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  382. | :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| |
  383. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  384. | 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 **)** |
  385. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  386. | :ref:`int<class_int>` | :ref:`shaped_text_prev_character_pos<class_TextServer_method_shaped_text_prev_character_pos>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const| |
  387. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  388. | :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| |
  389. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  390. | :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 **)** |
  391. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  392. | 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 **)** |
  393. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  394. | 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 **)** |
  395. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  396. | 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 **)** |
  397. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  398. | 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 **)** |
  399. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  400. | 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 **)** |
  401. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  402. | 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 **)** |
  403. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  404. | 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 **)** |
  405. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  406. | :ref:`bool<class_bool>` | :ref:`shaped_text_shape<class_TextServer_method_shaped_text_shape>` **(** :ref:`RID<class_RID>` shaped **)** |
  407. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  408. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`shaped_text_sort_logical<class_TextServer_method_shaped_text_sort_logical>` **(** :ref:`RID<class_RID>` shaped **)** |
  409. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  410. | :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| |
  411. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  412. | :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 **)** |
  413. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  414. | :ref:`bool<class_bool>` | :ref:`spoof_check<class_TextServer_method_spoof_check>` **(** :ref:`String<class_String>` string **)** |const| |
  415. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  416. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`string_get_character_breaks<class_TextServer_method_string_get_character_breaks>` **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const| |
  417. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  418. | :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| |
  419. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  420. | :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| |
  421. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  422. | :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| |
  423. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  424. | :ref:`String<class_String>` | :ref:`strip_diacritics<class_TextServer_method_strip_diacritics>` **(** :ref:`String<class_String>` string **)** |const| |
  425. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  426. | :ref:`String<class_String>` | :ref:`tag_to_name<class_TextServer_method_tag_to_name>` **(** :ref:`int<class_int>` tag **)** |const| |
  427. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  428. .. rst-class:: classref-section-separator
  429. ----
  430. .. rst-class:: classref-descriptions-group
  431. Enumerations
  432. ------------
  433. .. _enum_TextServer_FontAntialiasing:
  434. .. rst-class:: classref-enumeration
  435. enum **FontAntialiasing**:
  436. .. _class_TextServer_constant_FONT_ANTIALIASING_NONE:
  437. .. rst-class:: classref-enumeration-constant
  438. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_NONE** = ``0``
  439. Font glyphs are rasterized as 1-bit bitmaps.
  440. .. _class_TextServer_constant_FONT_ANTIALIASING_GRAY:
  441. .. rst-class:: classref-enumeration-constant
  442. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_GRAY** = ``1``
  443. Font glyphs are rasterized as 8-bit grayscale anti-aliased bitmaps.
  444. .. _class_TextServer_constant_FONT_ANTIALIASING_LCD:
  445. .. rst-class:: classref-enumeration-constant
  446. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_LCD** = ``2``
  447. Font glyphs are rasterized for LCD screens.
  448. LCD subpixel layout is determined by the value of ``gui/theme/lcd_subpixel_layout`` project settings.
  449. LCD subpixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D.
  450. .. rst-class:: classref-item-separator
  451. ----
  452. .. _enum_TextServer_FontLCDSubpixelLayout:
  453. .. rst-class:: classref-enumeration
  454. enum **FontLCDSubpixelLayout**:
  455. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_NONE:
  456. .. rst-class:: classref-enumeration-constant
  457. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_NONE** = ``0``
  458. Unknown or unsupported subpixel layout, LCD subpixel antialiasing is disabled.
  459. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HRGB:
  460. .. rst-class:: classref-enumeration-constant
  461. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HRGB** = ``1``
  462. Horizontal RGB subpixel layout.
  463. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HBGR:
  464. .. rst-class:: classref-enumeration-constant
  465. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HBGR** = ``2``
  466. Horizontal BGR subpixel layout.
  467. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VRGB:
  468. .. rst-class:: classref-enumeration-constant
  469. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VRGB** = ``3``
  470. Vertical RGB subpixel layout.
  471. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VBGR:
  472. .. rst-class:: classref-enumeration-constant
  473. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VBGR** = ``4``
  474. Vertical BGR subpixel layout.
  475. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_MAX:
  476. .. rst-class:: classref-enumeration-constant
  477. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_MAX** = ``5``
  478. Represents the size of the :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` enum.
  479. .. rst-class:: classref-item-separator
  480. ----
  481. .. _enum_TextServer_Direction:
  482. .. rst-class:: classref-enumeration
  483. enum **Direction**:
  484. .. _class_TextServer_constant_DIRECTION_AUTO:
  485. .. rst-class:: classref-enumeration-constant
  486. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_AUTO** = ``0``
  487. Text direction is determined based on contents and current locale.
  488. .. _class_TextServer_constant_DIRECTION_LTR:
  489. .. rst-class:: classref-enumeration-constant
  490. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_LTR** = ``1``
  491. Text is written from left to right.
  492. .. _class_TextServer_constant_DIRECTION_RTL:
  493. .. rst-class:: classref-enumeration-constant
  494. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_RTL** = ``2``
  495. Text is written from right to left.
  496. .. _class_TextServer_constant_DIRECTION_INHERITED:
  497. .. rst-class:: classref-enumeration-constant
  498. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_INHERITED** = ``3``
  499. Text writing direction is the same as base string writing direction. Used for BiDi override only.
  500. .. rst-class:: classref-item-separator
  501. ----
  502. .. _enum_TextServer_Orientation:
  503. .. rst-class:: classref-enumeration
  504. enum **Orientation**:
  505. .. _class_TextServer_constant_ORIENTATION_HORIZONTAL:
  506. .. rst-class:: classref-enumeration-constant
  507. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_HORIZONTAL** = ``0``
  508. Text is written horizontally.
  509. .. _class_TextServer_constant_ORIENTATION_VERTICAL:
  510. .. rst-class:: classref-enumeration-constant
  511. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_VERTICAL** = ``1``
  512. Left to right text is written vertically from top to bottom.
  513. Right to left text is written vertically from bottom to top.
  514. .. rst-class:: classref-item-separator
  515. ----
  516. .. _enum_TextServer_JustificationFlag:
  517. .. rst-class:: classref-enumeration
  518. flags **JustificationFlag**:
  519. .. _class_TextServer_constant_JUSTIFICATION_NONE:
  520. .. rst-class:: classref-enumeration-constant
  521. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_NONE** = ``0``
  522. Do not justify text.
  523. .. _class_TextServer_constant_JUSTIFICATION_KASHIDA:
  524. .. rst-class:: classref-enumeration-constant
  525. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_KASHIDA** = ``1``
  526. Justify text by adding and removing kashidas.
  527. .. _class_TextServer_constant_JUSTIFICATION_WORD_BOUND:
  528. .. rst-class:: classref-enumeration-constant
  529. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_WORD_BOUND** = ``2``
  530. Justify text by changing width of the spaces between the words.
  531. .. _class_TextServer_constant_JUSTIFICATION_TRIM_EDGE_SPACES:
  532. .. rst-class:: classref-enumeration-constant
  533. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_TRIM_EDGE_SPACES** = ``4``
  534. Remove trailing and leading spaces from the justified text.
  535. .. _class_TextServer_constant_JUSTIFICATION_AFTER_LAST_TAB:
  536. .. rst-class:: classref-enumeration-constant
  537. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_AFTER_LAST_TAB** = ``8``
  538. Only apply justification to the part of the text after the last tab.
  539. .. _class_TextServer_constant_JUSTIFICATION_CONSTRAIN_ELLIPSIS:
  540. .. rst-class:: classref-enumeration-constant
  541. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_CONSTRAIN_ELLIPSIS** = ``16``
  542. Apply justification to the trimmed line with ellipsis.
  543. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE:
  544. .. rst-class:: classref-enumeration-constant
  545. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE** = ``32``
  546. Do not apply justification to the last line of the paragraph.
  547. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS:
  548. .. rst-class:: classref-enumeration-constant
  549. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS** = ``64``
  550. 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>`).
  551. .. _class_TextServer_constant_JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE:
  552. .. rst-class:: classref-enumeration-constant
  553. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE** = ``128``
  554. 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).
  555. .. rst-class:: classref-item-separator
  556. ----
  557. .. _enum_TextServer_AutowrapMode:
  558. .. rst-class:: classref-enumeration
  559. enum **AutowrapMode**:
  560. .. _class_TextServer_constant_AUTOWRAP_OFF:
  561. .. rst-class:: classref-enumeration-constant
  562. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_OFF** = ``0``
  563. Autowrap is disabled.
  564. .. _class_TextServer_constant_AUTOWRAP_ARBITRARY:
  565. .. rst-class:: classref-enumeration-constant
  566. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_ARBITRARY** = ``1``
  567. 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.
  568. .. _class_TextServer_constant_AUTOWRAP_WORD:
  569. .. rst-class:: classref-enumeration-constant
  570. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD** = ``2``
  571. Wraps the text inside the node's bounding rectangle by soft-breaking between words.
  572. .. _class_TextServer_constant_AUTOWRAP_WORD_SMART:
  573. .. rst-class:: classref-enumeration-constant
  574. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD_SMART** = ``3``
  575. 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.
  576. .. rst-class:: classref-item-separator
  577. ----
  578. .. _enum_TextServer_LineBreakFlag:
  579. .. rst-class:: classref-enumeration
  580. flags **LineBreakFlag**:
  581. .. _class_TextServer_constant_BREAK_NONE:
  582. .. rst-class:: classref-enumeration-constant
  583. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_NONE** = ``0``
  584. Do not break the line.
  585. .. _class_TextServer_constant_BREAK_MANDATORY:
  586. .. rst-class:: classref-enumeration-constant
  587. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_MANDATORY** = ``1``
  588. Break the line at the line mandatory break characters (e.g. ``"\n"``).
  589. .. _class_TextServer_constant_BREAK_WORD_BOUND:
  590. .. rst-class:: classref-enumeration-constant
  591. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_WORD_BOUND** = ``2``
  592. Break the line between the words.
  593. .. _class_TextServer_constant_BREAK_GRAPHEME_BOUND:
  594. .. rst-class:: classref-enumeration-constant
  595. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_GRAPHEME_BOUND** = ``4``
  596. Break the line between any unconnected graphemes.
  597. .. _class_TextServer_constant_BREAK_ADAPTIVE:
  598. .. rst-class:: classref-enumeration-constant
  599. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_ADAPTIVE** = ``8``
  600. 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.
  601. .. _class_TextServer_constant_BREAK_TRIM_EDGE_SPACES:
  602. .. rst-class:: classref-enumeration-constant
  603. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_EDGE_SPACES** = ``16``
  604. Remove edge spaces from the broken line segments.
  605. .. rst-class:: classref-item-separator
  606. ----
  607. .. _enum_TextServer_VisibleCharactersBehavior:
  608. .. rst-class:: classref-enumeration
  609. enum **VisibleCharactersBehavior**:
  610. .. _class_TextServer_constant_VC_CHARS_BEFORE_SHAPING:
  611. .. rst-class:: classref-enumeration-constant
  612. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_BEFORE_SHAPING** = ``0``
  613. 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.
  614. .. _class_TextServer_constant_VC_CHARS_AFTER_SHAPING:
  615. .. rst-class:: classref-enumeration-constant
  616. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_AFTER_SHAPING** = ``1``
  617. 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.
  618. .. _class_TextServer_constant_VC_GLYPHS_AUTO:
  619. .. rst-class:: classref-enumeration-constant
  620. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_AUTO** = ``2``
  621. 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.
  622. .. _class_TextServer_constant_VC_GLYPHS_LTR:
  623. .. rst-class:: classref-enumeration-constant
  624. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_LTR** = ``3``
  625. 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.
  626. .. _class_TextServer_constant_VC_GLYPHS_RTL:
  627. .. rst-class:: classref-enumeration-constant
  628. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_RTL** = ``4``
  629. 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.
  630. .. rst-class:: classref-item-separator
  631. ----
  632. .. _enum_TextServer_OverrunBehavior:
  633. .. rst-class:: classref-enumeration
  634. enum **OverrunBehavior**:
  635. .. _class_TextServer_constant_OVERRUN_NO_TRIMMING:
  636. .. rst-class:: classref-enumeration-constant
  637. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_NO_TRIMMING** = ``0``
  638. No text trimming is performed.
  639. .. _class_TextServer_constant_OVERRUN_TRIM_CHAR:
  640. .. rst-class:: classref-enumeration-constant
  641. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_CHAR** = ``1``
  642. Trims the text per character.
  643. .. _class_TextServer_constant_OVERRUN_TRIM_WORD:
  644. .. rst-class:: classref-enumeration-constant
  645. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD** = ``2``
  646. Trims the text per word.
  647. .. _class_TextServer_constant_OVERRUN_TRIM_ELLIPSIS:
  648. .. rst-class:: classref-enumeration-constant
  649. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_ELLIPSIS** = ``3``
  650. Trims the text per character and adds an ellipsis to indicate that parts are hidden.
  651. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ELLIPSIS:
  652. .. rst-class:: classref-enumeration-constant
  653. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD_ELLIPSIS** = ``4``
  654. Trims the text per word and adds an ellipsis to indicate that parts are hidden.
  655. .. rst-class:: classref-item-separator
  656. ----
  657. .. _enum_TextServer_TextOverrunFlag:
  658. .. rst-class:: classref-enumeration
  659. flags **TextOverrunFlag**:
  660. .. _class_TextServer_constant_OVERRUN_NO_TRIM:
  661. .. rst-class:: classref-enumeration-constant
  662. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_NO_TRIM** = ``0``
  663. No trimming is performed.
  664. .. _class_TextServer_constant_OVERRUN_TRIM:
  665. .. rst-class:: classref-enumeration-constant
  666. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM** = ``1``
  667. Trims the text when it exceeds the given width.
  668. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ONLY:
  669. .. rst-class:: classref-enumeration-constant
  670. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM_WORD_ONLY** = ``2``
  671. Trims the text per word instead of per grapheme.
  672. .. _class_TextServer_constant_OVERRUN_ADD_ELLIPSIS:
  673. .. rst-class:: classref-enumeration-constant
  674. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ADD_ELLIPSIS** = ``4``
  675. Determines whether an ellipsis should be added at the end of the text.
  676. .. _class_TextServer_constant_OVERRUN_ENFORCE_ELLIPSIS:
  677. .. rst-class:: classref-enumeration-constant
  678. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ENFORCE_ELLIPSIS** = ``8``
  679. Determines whether the ellipsis at the end of the text is enforced and may not be hidden.
  680. .. _class_TextServer_constant_OVERRUN_JUSTIFICATION_AWARE:
  681. .. rst-class:: classref-enumeration-constant
  682. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_JUSTIFICATION_AWARE** = ``16``
  683. Accounts for the text being justified before attempting to trim it (see :ref:`JustificationFlag<enum_TextServer_JustificationFlag>`).
  684. .. rst-class:: classref-item-separator
  685. ----
  686. .. _enum_TextServer_GraphemeFlag:
  687. .. rst-class:: classref-enumeration
  688. flags **GraphemeFlag**:
  689. .. _class_TextServer_constant_GRAPHEME_IS_VALID:
  690. .. rst-class:: classref-enumeration-constant
  691. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VALID** = ``1``
  692. Grapheme is supported by the font, and can be drawn.
  693. .. _class_TextServer_constant_GRAPHEME_IS_RTL:
  694. .. rst-class:: classref-enumeration-constant
  695. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_RTL** = ``2``
  696. Grapheme is part of right-to-left or bottom-to-top run.
  697. .. _class_TextServer_constant_GRAPHEME_IS_VIRTUAL:
  698. .. rst-class:: classref-enumeration-constant
  699. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VIRTUAL** = ``4``
  700. Grapheme is not part of source text, it was added by justification process.
  701. .. _class_TextServer_constant_GRAPHEME_IS_SPACE:
  702. .. rst-class:: classref-enumeration-constant
  703. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SPACE** = ``8``
  704. Grapheme is whitespace.
  705. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_HARD:
  706. .. rst-class:: classref-enumeration-constant
  707. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_HARD** = ``16``
  708. Grapheme is mandatory break point (e.g. ``"\n"``).
  709. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_SOFT:
  710. .. rst-class:: classref-enumeration-constant
  711. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_SOFT** = ``32``
  712. Grapheme is optional break point (e.g. space).
  713. .. _class_TextServer_constant_GRAPHEME_IS_TAB:
  714. .. rst-class:: classref-enumeration-constant
  715. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_TAB** = ``64``
  716. Grapheme is the tabulation character.
  717. .. _class_TextServer_constant_GRAPHEME_IS_ELONGATION:
  718. .. rst-class:: classref-enumeration-constant
  719. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_ELONGATION** = ``128``
  720. Grapheme is kashida.
  721. .. _class_TextServer_constant_GRAPHEME_IS_PUNCTUATION:
  722. .. rst-class:: classref-enumeration-constant
  723. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_PUNCTUATION** = ``256``
  724. Grapheme is punctuation character.
  725. .. _class_TextServer_constant_GRAPHEME_IS_UNDERSCORE:
  726. .. rst-class:: classref-enumeration-constant
  727. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_UNDERSCORE** = ``512``
  728. Grapheme is underscore character.
  729. .. _class_TextServer_constant_GRAPHEME_IS_CONNECTED:
  730. .. rst-class:: classref-enumeration-constant
  731. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_CONNECTED** = ``1024``
  732. Grapheme is connected to the previous grapheme. Breaking line before this grapheme is not safe.
  733. .. _class_TextServer_constant_GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL:
  734. .. rst-class:: classref-enumeration-constant
  735. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL** = ``2048``
  736. It is safe to insert a U+0640 before this grapheme for elongation.
  737. .. _class_TextServer_constant_GRAPHEME_IS_EMBEDDED_OBJECT:
  738. .. rst-class:: classref-enumeration-constant
  739. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_EMBEDDED_OBJECT** = ``4096``
  740. Grapheme is an object replacement character for the embedded object.
  741. .. rst-class:: classref-item-separator
  742. ----
  743. .. _enum_TextServer_Hinting:
  744. .. rst-class:: classref-enumeration
  745. enum **Hinting**:
  746. .. _class_TextServer_constant_HINTING_NONE:
  747. .. rst-class:: classref-enumeration-constant
  748. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NONE** = ``0``
  749. Disables font hinting (smoother but less crisp).
  750. .. _class_TextServer_constant_HINTING_LIGHT:
  751. .. rst-class:: classref-enumeration-constant
  752. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_LIGHT** = ``1``
  753. Use the light font hinting mode.
  754. .. _class_TextServer_constant_HINTING_NORMAL:
  755. .. rst-class:: classref-enumeration-constant
  756. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NORMAL** = ``2``
  757. Use the default font hinting mode (crisper but less smooth).
  758. \ **Note:** This hinting mode changes both horizontal and vertical glyph metrics. If applied to monospace font, some glyphs might have different width.
  759. .. rst-class:: classref-item-separator
  760. ----
  761. .. _enum_TextServer_SubpixelPositioning:
  762. .. rst-class:: classref-enumeration
  763. enum **SubpixelPositioning**:
  764. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_DISABLED:
  765. .. rst-class:: classref-enumeration-constant
  766. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_DISABLED** = ``0``
  767. Glyph horizontal position is rounded to the whole pixel size, each glyph is rasterized once.
  768. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO:
  769. .. rst-class:: classref-enumeration-constant
  770. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_AUTO** = ``1``
  771. Glyph horizontal position is rounded based on font size.
  772. - 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>`.
  773. - 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>`.
  774. - To the whole pixel size for larger fonts.
  775. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF:
  776. .. rst-class:: classref-enumeration-constant
  777. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF** = ``2``
  778. Glyph horizontal position is rounded to one half of the pixel size, each glyph is rasterized up to two times.
  779. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER:
  780. .. rst-class:: classref-enumeration-constant
  781. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER** = ``3``
  782. Glyph horizontal position is rounded to one quarter of the pixel size, each glyph is rasterized up to four times.
  783. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE:
  784. .. rst-class:: classref-enumeration-constant
  785. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE** = ``20``
  786. 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.
  787. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE:
  788. .. rst-class:: classref-enumeration-constant
  789. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE** = ``16``
  790. 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.
  791. .. rst-class:: classref-item-separator
  792. ----
  793. .. _enum_TextServer_Feature:
  794. .. rst-class:: classref-enumeration
  795. enum **Feature**:
  796. .. _class_TextServer_constant_FEATURE_SIMPLE_LAYOUT:
  797. .. rst-class:: classref-enumeration-constant
  798. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SIMPLE_LAYOUT** = ``1``
  799. TextServer supports simple text layouts.
  800. .. _class_TextServer_constant_FEATURE_BIDI_LAYOUT:
  801. .. rst-class:: classref-enumeration-constant
  802. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BIDI_LAYOUT** = ``2``
  803. TextServer supports bidirectional text layouts.
  804. .. _class_TextServer_constant_FEATURE_VERTICAL_LAYOUT:
  805. .. rst-class:: classref-enumeration-constant
  806. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_VERTICAL_LAYOUT** = ``4``
  807. TextServer supports vertical layouts.
  808. .. _class_TextServer_constant_FEATURE_SHAPING:
  809. .. rst-class:: classref-enumeration-constant
  810. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SHAPING** = ``8``
  811. TextServer supports complex text shaping.
  812. .. _class_TextServer_constant_FEATURE_KASHIDA_JUSTIFICATION:
  813. .. rst-class:: classref-enumeration-constant
  814. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_KASHIDA_JUSTIFICATION** = ``16``
  815. TextServer supports justification using kashidas.
  816. .. _class_TextServer_constant_FEATURE_BREAK_ITERATORS:
  817. .. rst-class:: classref-enumeration-constant
  818. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BREAK_ITERATORS** = ``32``
  819. TextServer supports complex line/word breaking rules (e.g. dictionary based).
  820. .. _class_TextServer_constant_FEATURE_FONT_BITMAP:
  821. .. rst-class:: classref-enumeration-constant
  822. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_BITMAP** = ``64``
  823. TextServer supports loading bitmap fonts.
  824. .. _class_TextServer_constant_FEATURE_FONT_DYNAMIC:
  825. .. rst-class:: classref-enumeration-constant
  826. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_DYNAMIC** = ``128``
  827. TextServer supports loading dynamic (TrueType, OpeType, etc.) fonts.
  828. .. _class_TextServer_constant_FEATURE_FONT_MSDF:
  829. .. rst-class:: classref-enumeration-constant
  830. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_MSDF** = ``256``
  831. TextServer supports multichannel signed distance field dynamic font rendering.
  832. .. _class_TextServer_constant_FEATURE_FONT_SYSTEM:
  833. .. rst-class:: classref-enumeration-constant
  834. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_SYSTEM** = ``512``
  835. TextServer supports loading system fonts.
  836. .. _class_TextServer_constant_FEATURE_FONT_VARIABLE:
  837. .. rst-class:: classref-enumeration-constant
  838. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_VARIABLE** = ``1024``
  839. TextServer supports variable fonts.
  840. .. _class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION:
  841. .. rst-class:: classref-enumeration-constant
  842. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION** = ``2048``
  843. TextServer supports locale dependent and context sensitive case conversion.
  844. .. _class_TextServer_constant_FEATURE_USE_SUPPORT_DATA:
  845. .. rst-class:: classref-enumeration-constant
  846. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_USE_SUPPORT_DATA** = ``4096``
  847. TextServer require external data file for some features, see :ref:`load_support_data<class_TextServer_method_load_support_data>`.
  848. .. _class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS:
  849. .. rst-class:: classref-enumeration-constant
  850. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_IDENTIFIERS** = ``8192``
  851. TextServer supports UAX #31 identifier validation, see :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>`.
  852. .. _class_TextServer_constant_FEATURE_UNICODE_SECURITY:
  853. .. rst-class:: classref-enumeration-constant
  854. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_SECURITY** = ``16384``
  855. 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.
  856. .. rst-class:: classref-item-separator
  857. ----
  858. .. _enum_TextServer_ContourPointTag:
  859. .. rst-class:: classref-enumeration
  860. enum **ContourPointTag**:
  861. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_ON:
  862. .. rst-class:: classref-enumeration-constant
  863. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_ON** = ``1``
  864. Contour point is on the curve.
  865. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC:
  866. .. rst-class:: classref-enumeration-constant
  867. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CONIC** = ``0``
  868. Contour point isn't on the curve, but serves as a control point for a conic (quadratic) Bézier arc.
  869. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CUBIC:
  870. .. rst-class:: classref-enumeration-constant
  871. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CUBIC** = ``2``
  872. Contour point isn't on the curve, but serves as a control point for a cubic Bézier arc.
  873. .. rst-class:: classref-item-separator
  874. ----
  875. .. _enum_TextServer_SpacingType:
  876. .. rst-class:: classref-enumeration
  877. enum **SpacingType**:
  878. .. _class_TextServer_constant_SPACING_GLYPH:
  879. .. rst-class:: classref-enumeration-constant
  880. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_GLYPH** = ``0``
  881. Spacing for each glyph.
  882. .. _class_TextServer_constant_SPACING_SPACE:
  883. .. rst-class:: classref-enumeration-constant
  884. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_SPACE** = ``1``
  885. Spacing for the space character.
  886. .. _class_TextServer_constant_SPACING_TOP:
  887. .. rst-class:: classref-enumeration-constant
  888. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_TOP** = ``2``
  889. Spacing at the top of the line.
  890. .. _class_TextServer_constant_SPACING_BOTTOM:
  891. .. rst-class:: classref-enumeration-constant
  892. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_BOTTOM** = ``3``
  893. Spacing at the bottom of the line.
  894. .. _class_TextServer_constant_SPACING_MAX:
  895. .. rst-class:: classref-enumeration-constant
  896. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_MAX** = ``4``
  897. Represents the size of the :ref:`SpacingType<enum_TextServer_SpacingType>` enum.
  898. .. rst-class:: classref-item-separator
  899. ----
  900. .. _enum_TextServer_FontStyle:
  901. .. rst-class:: classref-enumeration
  902. flags **FontStyle**:
  903. .. _class_TextServer_constant_FONT_BOLD:
  904. .. rst-class:: classref-enumeration-constant
  905. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_BOLD** = ``1``
  906. Font is bold.
  907. .. _class_TextServer_constant_FONT_ITALIC:
  908. .. rst-class:: classref-enumeration-constant
  909. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_ITALIC** = ``2``
  910. Font is italic or oblique.
  911. .. _class_TextServer_constant_FONT_FIXED_WIDTH:
  912. .. rst-class:: classref-enumeration-constant
  913. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_FIXED_WIDTH** = ``4``
  914. Font have fixed-width characters.
  915. .. rst-class:: classref-item-separator
  916. ----
  917. .. _enum_TextServer_StructuredTextParser:
  918. .. rst-class:: classref-enumeration
  919. enum **StructuredTextParser**:
  920. .. _class_TextServer_constant_STRUCTURED_TEXT_DEFAULT:
  921. .. rst-class:: classref-enumeration-constant
  922. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_DEFAULT** = ``0``
  923. Use default Unicode BiDi algorithm.
  924. .. _class_TextServer_constant_STRUCTURED_TEXT_URI:
  925. .. rst-class:: classref-enumeration-constant
  926. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_URI** = ``1``
  927. BiDi override for URI.
  928. .. _class_TextServer_constant_STRUCTURED_TEXT_FILE:
  929. .. rst-class:: classref-enumeration-constant
  930. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_FILE** = ``2``
  931. BiDi override for file path.
  932. .. _class_TextServer_constant_STRUCTURED_TEXT_EMAIL:
  933. .. rst-class:: classref-enumeration-constant
  934. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_EMAIL** = ``3``
  935. BiDi override for email.
  936. .. _class_TextServer_constant_STRUCTURED_TEXT_LIST:
  937. .. rst-class:: classref-enumeration-constant
  938. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_LIST** = ``4``
  939. BiDi override for lists. Structured text options: list separator :ref:`String<class_String>`.
  940. .. _class_TextServer_constant_STRUCTURED_TEXT_GDSCRIPT:
  941. .. rst-class:: classref-enumeration-constant
  942. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_GDSCRIPT** = ``5``
  943. BiDi override for GDScript.
  944. .. _class_TextServer_constant_STRUCTURED_TEXT_CUSTOM:
  945. .. rst-class:: classref-enumeration-constant
  946. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_CUSTOM** = ``6``
  947. User defined structured text BiDi override function.
  948. .. rst-class:: classref-item-separator
  949. ----
  950. .. _enum_TextServer_FixedSizeScaleMode:
  951. .. rst-class:: classref-enumeration
  952. enum **FixedSizeScaleMode**:
  953. .. _class_TextServer_constant_FIXED_SIZE_SCALE_DISABLE:
  954. .. rst-class:: classref-enumeration-constant
  955. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_DISABLE** = ``0``
  956. Bitmap font is not scaled.
  957. .. _class_TextServer_constant_FIXED_SIZE_SCALE_INTEGER_ONLY:
  958. .. rst-class:: classref-enumeration-constant
  959. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_INTEGER_ONLY** = ``1``
  960. Bitmap font is scaled to the closest integer multiple of the font's fixed size. This is the recommended option for pixel art fonts.
  961. .. _class_TextServer_constant_FIXED_SIZE_SCALE_ENABLED:
  962. .. rst-class:: classref-enumeration-constant
  963. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_ENABLED** = ``2``
  964. Bitmap font is scaled to an arbitrary (fractional) size. This is the recommended option for non-pixel art fonts.
  965. .. rst-class:: classref-section-separator
  966. ----
  967. .. rst-class:: classref-descriptions-group
  968. Method Descriptions
  969. -------------------
  970. .. _class_TextServer_method_create_font:
  971. .. rst-class:: classref-method
  972. :ref:`RID<class_RID>` **create_font** **(** **)**
  973. Creates a new, empty font cache entry resource. To free the resulting resource, use the :ref:`free_rid<class_TextServer_method_free_rid>` method.
  974. .. rst-class:: classref-item-separator
  975. ----
  976. .. _class_TextServer_method_create_font_linked_variation:
  977. .. rst-class:: classref-method
  978. :ref:`RID<class_RID>` **create_font_linked_variation** **(** :ref:`RID<class_RID>` font_rid **)**
  979. Creates a new variation existing font which is reusing the same glyph cache and font data. To free the resulting resource, use the :ref:`free_rid<class_TextServer_method_free_rid>` method.
  980. .. rst-class:: classref-item-separator
  981. ----
  982. .. _class_TextServer_method_create_shaped_text:
  983. .. rst-class:: classref-method
  984. :ref:`RID<class_RID>` **create_shaped_text** **(** :ref:`Direction<enum_TextServer_Direction>` direction=0, :ref:`Orientation<enum_TextServer_Orientation>` orientation=0 **)**
  985. 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.
  986. \ **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>`).
  987. \ **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>`).
  988. .. rst-class:: classref-item-separator
  989. ----
  990. .. _class_TextServer_method_draw_hex_code_box:
  991. .. rst-class:: classref-method
  992. 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|
  993. Draws box displaying character hexadecimal code. Used for replacing missing characters.
  994. .. rst-class:: classref-item-separator
  995. ----
  996. .. _class_TextServer_method_font_clear_glyphs:
  997. .. rst-class:: classref-method
  998. void **font_clear_glyphs** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)**
  999. Removes all rendered glyphs information from the cache entry.
  1000. \ **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.
  1001. .. rst-class:: classref-item-separator
  1002. ----
  1003. .. _class_TextServer_method_font_clear_kerning_map:
  1004. .. rst-class:: classref-method
  1005. void **font_clear_kerning_map** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)**
  1006. Removes all kerning overrides.
  1007. .. rst-class:: classref-item-separator
  1008. ----
  1009. .. _class_TextServer_method_font_clear_size_cache:
  1010. .. rst-class:: classref-method
  1011. void **font_clear_size_cache** **(** :ref:`RID<class_RID>` font_rid **)**
  1012. Removes all font sizes from the cache entry.
  1013. .. rst-class:: classref-item-separator
  1014. ----
  1015. .. _class_TextServer_method_font_clear_textures:
  1016. .. rst-class:: classref-method
  1017. void **font_clear_textures** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)**
  1018. Removes all textures from font cache entry.
  1019. \ **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.
  1020. .. rst-class:: classref-item-separator
  1021. ----
  1022. .. _class_TextServer_method_font_draw_glyph:
  1023. .. rst-class:: classref-method
  1024. 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|
  1025. Draws single glyph into a canvas item at the position, using ``font_rid`` at the size ``size``.
  1026. \ **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>`.
  1027. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1028. .. rst-class:: classref-item-separator
  1029. ----
  1030. .. _class_TextServer_method_font_draw_glyph_outline:
  1031. .. rst-class:: classref-method
  1032. 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|
  1033. Draws single glyph outline of size ``outline_size`` into a canvas item at the position, using ``font_rid`` at the size ``size``.
  1034. \ **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>`.
  1035. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1036. .. rst-class:: classref-item-separator
  1037. ----
  1038. .. _class_TextServer_method_font_get_antialiasing:
  1039. .. rst-class:: classref-method
  1040. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **font_get_antialiasing** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1041. Returns font anti-aliasing mode.
  1042. .. rst-class:: classref-item-separator
  1043. ----
  1044. .. _class_TextServer_method_font_get_ascent:
  1045. .. rst-class:: classref-method
  1046. :ref:`float<class_float>` **font_get_ascent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1047. Returns the font ascent (number of pixels above the baseline).
  1048. .. rst-class:: classref-item-separator
  1049. ----
  1050. .. _class_TextServer_method_font_get_char_from_glyph_index:
  1051. .. rst-class:: classref-method
  1052. :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|
  1053. 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>`.
  1054. .. rst-class:: classref-item-separator
  1055. ----
  1056. .. _class_TextServer_method_font_get_descent:
  1057. .. rst-class:: classref-method
  1058. :ref:`float<class_float>` **font_get_descent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1059. Returns the font descent (number of pixels below the baseline).
  1060. .. rst-class:: classref-item-separator
  1061. ----
  1062. .. _class_TextServer_method_font_get_embolden:
  1063. .. rst-class:: classref-method
  1064. :ref:`float<class_float>` **font_get_embolden** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1065. Returns font embolden strength.
  1066. .. rst-class:: classref-item-separator
  1067. ----
  1068. .. _class_TextServer_method_font_get_face_count:
  1069. .. rst-class:: classref-method
  1070. :ref:`int<class_int>` **font_get_face_count** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1071. Returns number of faces in the TrueType / OpenType collection.
  1072. .. rst-class:: classref-item-separator
  1073. ----
  1074. .. _class_TextServer_method_font_get_face_index:
  1075. .. rst-class:: classref-method
  1076. :ref:`int<class_int>` **font_get_face_index** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1077. Returns an active face index in the TrueType / OpenType collection.
  1078. .. rst-class:: classref-item-separator
  1079. ----
  1080. .. _class_TextServer_method_font_get_fixed_size:
  1081. .. rst-class:: classref-method
  1082. :ref:`int<class_int>` **font_get_fixed_size** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1083. Returns bitmap font fixed size.
  1084. .. rst-class:: classref-item-separator
  1085. ----
  1086. .. _class_TextServer_method_font_get_fixed_size_scale_mode:
  1087. .. rst-class:: classref-method
  1088. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **font_get_fixed_size_scale_mode** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1089. Returns bitmap font scaling mode.
  1090. .. rst-class:: classref-item-separator
  1091. ----
  1092. .. _class_TextServer_method_font_get_generate_mipmaps:
  1093. .. rst-class:: classref-method
  1094. :ref:`bool<class_bool>` **font_get_generate_mipmaps** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1095. Returns ``true`` if font texture mipmap generation is enabled.
  1096. .. rst-class:: classref-item-separator
  1097. ----
  1098. .. _class_TextServer_method_font_get_global_oversampling:
  1099. .. rst-class:: classref-method
  1100. :ref:`float<class_float>` **font_get_global_oversampling** **(** **)** |const|
  1101. Returns the font oversampling factor, shared by all fonts in the TextServer.
  1102. .. rst-class:: classref-item-separator
  1103. ----
  1104. .. _class_TextServer_method_font_get_glyph_advance:
  1105. .. rst-class:: classref-method
  1106. :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|
  1107. Returns glyph advance (offset of the next glyph).
  1108. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1109. .. rst-class:: classref-item-separator
  1110. ----
  1111. .. _class_TextServer_method_font_get_glyph_contours:
  1112. .. rst-class:: classref-method
  1113. :ref:`Dictionary<class_Dictionary>` **font_get_glyph_contours** **(** :ref:`RID<class_RID>` font, :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |const|
  1114. Returns outline contours of the glyph as a :ref:`Dictionary<class_Dictionary>` with the following contents:
  1115. \ ``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.
  1116. \ ``contours`` - :ref:`PackedInt32Array<class_PackedInt32Array>`, containing indices the end points of each contour.
  1117. \ ``orientation`` - :ref:`bool<class_bool>`, contour orientation. If ``true``, clockwise contours must be filled.
  1118. .. rst-class:: classref-item-separator
  1119. ----
  1120. .. _class_TextServer_method_font_get_glyph_index:
  1121. .. rst-class:: classref-method
  1122. :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|
  1123. 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>`.
  1124. .. rst-class:: classref-item-separator
  1125. ----
  1126. .. _class_TextServer_method_font_get_glyph_list:
  1127. .. rst-class:: classref-method
  1128. :ref:`PackedInt32Array<class_PackedInt32Array>` **font_get_glyph_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const|
  1129. Returns list of rendered glyphs in the cache entry.
  1130. .. rst-class:: classref-item-separator
  1131. ----
  1132. .. _class_TextServer_method_font_get_glyph_offset:
  1133. .. rst-class:: classref-method
  1134. :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|
  1135. Returns glyph offset from the baseline.
  1136. .. rst-class:: classref-item-separator
  1137. ----
  1138. .. _class_TextServer_method_font_get_glyph_size:
  1139. .. rst-class:: classref-method
  1140. :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|
  1141. Returns size of the glyph.
  1142. .. rst-class:: classref-item-separator
  1143. ----
  1144. .. _class_TextServer_method_font_get_glyph_texture_idx:
  1145. .. rst-class:: classref-method
  1146. :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|
  1147. Returns index of the cache texture containing the glyph.
  1148. .. rst-class:: classref-item-separator
  1149. ----
  1150. .. _class_TextServer_method_font_get_glyph_texture_rid:
  1151. .. rst-class:: classref-method
  1152. :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|
  1153. Returns resource ID of the cache texture containing the glyph.
  1154. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1155. .. rst-class:: classref-item-separator
  1156. ----
  1157. .. _class_TextServer_method_font_get_glyph_texture_size:
  1158. .. rst-class:: classref-method
  1159. :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|
  1160. Returns size of the cache texture containing the glyph.
  1161. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1162. .. rst-class:: classref-item-separator
  1163. ----
  1164. .. _class_TextServer_method_font_get_glyph_uv_rect:
  1165. .. rst-class:: classref-method
  1166. :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|
  1167. Returns rectangle in the cache texture containing the glyph.
  1168. .. rst-class:: classref-item-separator
  1169. ----
  1170. .. _class_TextServer_method_font_get_hinting:
  1171. .. rst-class:: classref-method
  1172. :ref:`Hinting<enum_TextServer_Hinting>` **font_get_hinting** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1173. Returns the font hinting mode. Used by dynamic fonts only.
  1174. .. rst-class:: classref-item-separator
  1175. ----
  1176. .. _class_TextServer_method_font_get_kerning:
  1177. .. rst-class:: classref-method
  1178. :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|
  1179. Returns kerning for the pair of glyphs.
  1180. .. rst-class:: classref-item-separator
  1181. ----
  1182. .. _class_TextServer_method_font_get_kerning_list:
  1183. .. rst-class:: classref-method
  1184. :ref:`Vector2i[]<class_Vector2i>` **font_get_kerning_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1185. Returns list of the kerning overrides.
  1186. .. rst-class:: classref-item-separator
  1187. ----
  1188. .. _class_TextServer_method_font_get_language_support_override:
  1189. .. rst-class:: classref-method
  1190. :ref:`bool<class_bool>` **font_get_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)**
  1191. Returns ``true`` if support override is enabled for the ``language``.
  1192. .. rst-class:: classref-item-separator
  1193. ----
  1194. .. _class_TextServer_method_font_get_language_support_overrides:
  1195. .. rst-class:: classref-method
  1196. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_language_support_overrides** **(** :ref:`RID<class_RID>` font_rid **)**
  1197. Returns list of language support overrides.
  1198. .. rst-class:: classref-item-separator
  1199. ----
  1200. .. _class_TextServer_method_font_get_msdf_pixel_range:
  1201. .. rst-class:: classref-method
  1202. :ref:`int<class_int>` **font_get_msdf_pixel_range** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1203. Returns the width of the range around the shape between the minimum and maximum representable signed distance.
  1204. .. rst-class:: classref-item-separator
  1205. ----
  1206. .. _class_TextServer_method_font_get_msdf_size:
  1207. .. rst-class:: classref-method
  1208. :ref:`int<class_int>` **font_get_msdf_size** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1209. Returns source font size used to generate MSDF textures.
  1210. .. rst-class:: classref-item-separator
  1211. ----
  1212. .. _class_TextServer_method_font_get_name:
  1213. .. rst-class:: classref-method
  1214. :ref:`String<class_String>` **font_get_name** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1215. Returns font family name.
  1216. .. rst-class:: classref-item-separator
  1217. ----
  1218. .. _class_TextServer_method_font_get_opentype_feature_overrides:
  1219. .. rst-class:: classref-method
  1220. :ref:`Dictionary<class_Dictionary>` **font_get_opentype_feature_overrides** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1221. Returns font OpenType feature set override.
  1222. .. rst-class:: classref-item-separator
  1223. ----
  1224. .. _class_TextServer_method_font_get_ot_name_strings:
  1225. .. rst-class:: classref-method
  1226. :ref:`Dictionary<class_Dictionary>` **font_get_ot_name_strings** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1227. Returns :ref:`Dictionary<class_Dictionary>` with OpenType font name strings (localized font names, version, description, license information, sample text, etc.).
  1228. .. rst-class:: classref-item-separator
  1229. ----
  1230. .. _class_TextServer_method_font_get_oversampling:
  1231. .. rst-class:: classref-method
  1232. :ref:`float<class_float>` **font_get_oversampling** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1233. Returns font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1234. .. rst-class:: classref-item-separator
  1235. ----
  1236. .. _class_TextServer_method_font_get_scale:
  1237. .. rst-class:: classref-method
  1238. :ref:`float<class_float>` **font_get_scale** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1239. Returns scaling factor of the color bitmap font.
  1240. .. rst-class:: classref-item-separator
  1241. ----
  1242. .. _class_TextServer_method_font_get_script_support_override:
  1243. .. rst-class:: classref-method
  1244. :ref:`bool<class_bool>` **font_get_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)**
  1245. Returns ``true`` if support override is enabled for the ``script``.
  1246. .. rst-class:: classref-item-separator
  1247. ----
  1248. .. _class_TextServer_method_font_get_script_support_overrides:
  1249. .. rst-class:: classref-method
  1250. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_script_support_overrides** **(** :ref:`RID<class_RID>` font_rid **)**
  1251. Returns list of script support overrides.
  1252. .. rst-class:: classref-item-separator
  1253. ----
  1254. .. _class_TextServer_method_font_get_size_cache_list:
  1255. .. rst-class:: classref-method
  1256. :ref:`Vector2i[]<class_Vector2i>` **font_get_size_cache_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1257. Returns list of the font sizes in the cache. Each size is :ref:`Vector2i<class_Vector2i>` with font size and outline size.
  1258. .. rst-class:: classref-item-separator
  1259. ----
  1260. .. _class_TextServer_method_font_get_spacing:
  1261. .. rst-class:: classref-method
  1262. :ref:`int<class_int>` **font_get_spacing** **(** :ref:`RID<class_RID>` font_rid, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |const|
  1263. Returns the spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) in pixels (not relative to the font size).
  1264. .. rst-class:: classref-item-separator
  1265. ----
  1266. .. _class_TextServer_method_font_get_stretch:
  1267. .. rst-class:: classref-method
  1268. :ref:`int<class_int>` **font_get_stretch** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1269. Returns font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1270. .. rst-class:: classref-item-separator
  1271. ----
  1272. .. _class_TextServer_method_font_get_style:
  1273. .. rst-class:: classref-method
  1274. |bitfield|\<:ref:`FontStyle<enum_TextServer_FontStyle>`\> **font_get_style** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1275. Returns font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1276. .. rst-class:: classref-item-separator
  1277. ----
  1278. .. _class_TextServer_method_font_get_style_name:
  1279. .. rst-class:: classref-method
  1280. :ref:`String<class_String>` **font_get_style_name** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1281. Returns font style name.
  1282. .. rst-class:: classref-item-separator
  1283. ----
  1284. .. _class_TextServer_method_font_get_subpixel_positioning:
  1285. .. rst-class:: classref-method
  1286. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **font_get_subpixel_positioning** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1287. Returns font subpixel glyph positioning mode.
  1288. .. rst-class:: classref-item-separator
  1289. ----
  1290. .. _class_TextServer_method_font_get_supported_chars:
  1291. .. rst-class:: classref-method
  1292. :ref:`String<class_String>` **font_get_supported_chars** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1293. Returns a string containing all the characters available in the font.
  1294. .. rst-class:: classref-item-separator
  1295. ----
  1296. .. _class_TextServer_method_font_get_texture_count:
  1297. .. rst-class:: classref-method
  1298. :ref:`int<class_int>` **font_get_texture_count** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const|
  1299. Returns number of textures used by font cache entry.
  1300. .. rst-class:: classref-item-separator
  1301. ----
  1302. .. _class_TextServer_method_font_get_texture_image:
  1303. .. rst-class:: classref-method
  1304. :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|
  1305. Returns font cache texture image data.
  1306. .. rst-class:: classref-item-separator
  1307. ----
  1308. .. _class_TextServer_method_font_get_texture_offsets:
  1309. .. rst-class:: classref-method
  1310. :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|
  1311. Returns array containing glyph packing data.
  1312. .. rst-class:: classref-item-separator
  1313. ----
  1314. .. _class_TextServer_method_font_get_transform:
  1315. .. rst-class:: classref-method
  1316. :ref:`Transform2D<class_Transform2D>` **font_get_transform** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1317. Returns 2D transform applied to the font outlines.
  1318. .. rst-class:: classref-item-separator
  1319. ----
  1320. .. _class_TextServer_method_font_get_underline_position:
  1321. .. rst-class:: classref-method
  1322. :ref:`float<class_float>` **font_get_underline_position** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1323. Returns pixel offset of the underline below the baseline.
  1324. .. rst-class:: classref-item-separator
  1325. ----
  1326. .. _class_TextServer_method_font_get_underline_thickness:
  1327. .. rst-class:: classref-method
  1328. :ref:`float<class_float>` **font_get_underline_thickness** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1329. Returns thickness of the underline in pixels.
  1330. .. rst-class:: classref-item-separator
  1331. ----
  1332. .. _class_TextServer_method_font_get_variation_coordinates:
  1333. .. rst-class:: classref-method
  1334. :ref:`Dictionary<class_Dictionary>` **font_get_variation_coordinates** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1335. 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.
  1336. .. rst-class:: classref-item-separator
  1337. ----
  1338. .. _class_TextServer_method_font_get_weight:
  1339. .. rst-class:: classref-method
  1340. :ref:`int<class_int>` **font_get_weight** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1341. Returns weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1342. .. rst-class:: classref-item-separator
  1343. ----
  1344. .. _class_TextServer_method_font_has_char:
  1345. .. rst-class:: classref-method
  1346. :ref:`bool<class_bool>` **font_has_char** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` char **)** |const|
  1347. Returns ``true`` if a Unicode ``char`` is available in the font.
  1348. .. rst-class:: classref-item-separator
  1349. ----
  1350. .. _class_TextServer_method_font_is_allow_system_fallback:
  1351. .. rst-class:: classref-method
  1352. :ref:`bool<class_bool>` **font_is_allow_system_fallback** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1353. Returns ``true`` if system fonts can be automatically used as fallbacks.
  1354. .. rst-class:: classref-item-separator
  1355. ----
  1356. .. _class_TextServer_method_font_is_force_autohinter:
  1357. .. rst-class:: classref-method
  1358. :ref:`bool<class_bool>` **font_is_force_autohinter** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1359. Returns ``true`` if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.
  1360. .. rst-class:: classref-item-separator
  1361. ----
  1362. .. _class_TextServer_method_font_is_language_supported:
  1363. .. rst-class:: classref-method
  1364. :ref:`bool<class_bool>` **font_is_language_supported** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |const|
  1365. Returns ``true``, if font supports given language (`ISO 639 <https://en.wikipedia.org/wiki/ISO_639-1>`__ code).
  1366. .. rst-class:: classref-item-separator
  1367. ----
  1368. .. _class_TextServer_method_font_is_multichannel_signed_distance_field:
  1369. .. rst-class:: classref-method
  1370. :ref:`bool<class_bool>` **font_is_multichannel_signed_distance_field** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1371. Returns ``true`` if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.
  1372. .. rst-class:: classref-item-separator
  1373. ----
  1374. .. _class_TextServer_method_font_is_script_supported:
  1375. .. rst-class:: classref-method
  1376. :ref:`bool<class_bool>` **font_is_script_supported** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |const|
  1377. Returns ``true``, if font supports given script (ISO 15924 code).
  1378. .. rst-class:: classref-item-separator
  1379. ----
  1380. .. _class_TextServer_method_font_remove_glyph:
  1381. .. rst-class:: classref-method
  1382. void **font_remove_glyph** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)**
  1383. Removes specified rendered glyph information from the cache entry.
  1384. \ **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.
  1385. .. rst-class:: classref-item-separator
  1386. ----
  1387. .. _class_TextServer_method_font_remove_kerning:
  1388. .. rst-class:: classref-method
  1389. void **font_remove_kerning** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)**
  1390. Removes kerning override for the pair of glyphs.
  1391. .. rst-class:: classref-item-separator
  1392. ----
  1393. .. _class_TextServer_method_font_remove_language_support_override:
  1394. .. rst-class:: classref-method
  1395. void **font_remove_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)**
  1396. Remove language support override.
  1397. .. rst-class:: classref-item-separator
  1398. ----
  1399. .. _class_TextServer_method_font_remove_script_support_override:
  1400. .. rst-class:: classref-method
  1401. void **font_remove_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)**
  1402. Removes script support override.
  1403. .. rst-class:: classref-item-separator
  1404. ----
  1405. .. _class_TextServer_method_font_remove_size_cache:
  1406. .. rst-class:: classref-method
  1407. void **font_remove_size_cache** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)**
  1408. Removes specified font size from the cache entry.
  1409. .. rst-class:: classref-item-separator
  1410. ----
  1411. .. _class_TextServer_method_font_remove_texture:
  1412. .. rst-class:: classref-method
  1413. void **font_remove_texture** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)**
  1414. Removes specified texture from the cache entry.
  1415. \ **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>`.
  1416. .. rst-class:: classref-item-separator
  1417. ----
  1418. .. _class_TextServer_method_font_render_glyph:
  1419. .. rst-class:: classref-method
  1420. void **font_render_glyph** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` index **)**
  1421. Renders specified glyph to the font cache texture.
  1422. .. rst-class:: classref-item-separator
  1423. ----
  1424. .. _class_TextServer_method_font_render_range:
  1425. .. rst-class:: classref-method
  1426. 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 **)**
  1427. Renders the range of characters to the font cache texture.
  1428. .. rst-class:: classref-item-separator
  1429. ----
  1430. .. _class_TextServer_method_font_set_allow_system_fallback:
  1431. .. rst-class:: classref-method
  1432. void **font_set_allow_system_fallback** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` allow_system_fallback **)**
  1433. If set to ``true``, system fonts can be automatically used as fallbacks.
  1434. .. rst-class:: classref-item-separator
  1435. ----
  1436. .. _class_TextServer_method_font_set_antialiasing:
  1437. .. rst-class:: classref-method
  1438. void **font_set_antialiasing** **(** :ref:`RID<class_RID>` font_rid, :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` antialiasing **)**
  1439. Sets font anti-aliasing mode.
  1440. .. rst-class:: classref-item-separator
  1441. ----
  1442. .. _class_TextServer_method_font_set_ascent:
  1443. .. rst-class:: classref-method
  1444. void **font_set_ascent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` ascent **)**
  1445. Sets the font ascent (number of pixels above the baseline).
  1446. .. rst-class:: classref-item-separator
  1447. ----
  1448. .. _class_TextServer_method_font_set_data:
  1449. .. rst-class:: classref-method
  1450. void **font_set_data** **(** :ref:`RID<class_RID>` font_rid, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
  1451. Sets font source data, e.g contents of the dynamic font source file.
  1452. .. rst-class:: classref-item-separator
  1453. ----
  1454. .. _class_TextServer_method_font_set_descent:
  1455. .. rst-class:: classref-method
  1456. void **font_set_descent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` descent **)**
  1457. Sets the font descent (number of pixels below the baseline).
  1458. .. rst-class:: classref-item-separator
  1459. ----
  1460. .. _class_TextServer_method_font_set_embolden:
  1461. .. rst-class:: classref-method
  1462. void **font_set_embolden** **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` strength **)**
  1463. Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
  1464. .. rst-class:: classref-item-separator
  1465. ----
  1466. .. _class_TextServer_method_font_set_face_index:
  1467. .. rst-class:: classref-method
  1468. void **font_set_face_index** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` face_index **)**
  1469. Sets an active face index in the TrueType / OpenType collection.
  1470. .. rst-class:: classref-item-separator
  1471. ----
  1472. .. _class_TextServer_method_font_set_fixed_size:
  1473. .. rst-class:: classref-method
  1474. void **font_set_fixed_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` fixed_size **)**
  1475. Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.
  1476. .. rst-class:: classref-item-separator
  1477. ----
  1478. .. _class_TextServer_method_font_set_fixed_size_scale_mode:
  1479. .. rst-class:: classref-method
  1480. void **font_set_fixed_size_scale_mode** **(** :ref:`RID<class_RID>` font_rid, :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` fixed_size_scale_mode **)**
  1481. Sets bitmap font scaling mode. This property is used only if ``fixed_size`` is greater than zero.
  1482. .. rst-class:: classref-item-separator
  1483. ----
  1484. .. _class_TextServer_method_font_set_force_autohinter:
  1485. .. rst-class:: classref-method
  1486. void **font_set_force_autohinter** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` force_autohinter **)**
  1487. If set to ``true`` auto-hinting is preferred over font built-in hinting.
  1488. .. rst-class:: classref-item-separator
  1489. ----
  1490. .. _class_TextServer_method_font_set_generate_mipmaps:
  1491. .. rst-class:: classref-method
  1492. void **font_set_generate_mipmaps** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` generate_mipmaps **)**
  1493. If set to ``true`` font texture mipmap generation is enabled.
  1494. .. rst-class:: classref-item-separator
  1495. ----
  1496. .. _class_TextServer_method_font_set_global_oversampling:
  1497. .. rst-class:: classref-method
  1498. void **font_set_global_oversampling** **(** :ref:`float<class_float>` oversampling **)**
  1499. Sets oversampling factor, shared by all font in the TextServer.
  1500. \ **Note:** This value can be automatically changed by display server.
  1501. .. rst-class:: classref-item-separator
  1502. ----
  1503. .. _class_TextServer_method_font_set_glyph_advance:
  1504. .. rst-class:: classref-method
  1505. 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 **)**
  1506. Sets glyph advance (offset of the next glyph).
  1507. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1508. .. rst-class:: classref-item-separator
  1509. ----
  1510. .. _class_TextServer_method_font_set_glyph_offset:
  1511. .. rst-class:: classref-method
  1512. 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 **)**
  1513. Sets glyph offset from the baseline.
  1514. .. rst-class:: classref-item-separator
  1515. ----
  1516. .. _class_TextServer_method_font_set_glyph_size:
  1517. .. rst-class:: classref-method
  1518. 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 **)**
  1519. Sets size of the glyph.
  1520. .. rst-class:: classref-item-separator
  1521. ----
  1522. .. _class_TextServer_method_font_set_glyph_texture_idx:
  1523. .. rst-class:: classref-method
  1524. 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 **)**
  1525. Sets index of the cache texture containing the glyph.
  1526. .. rst-class:: classref-item-separator
  1527. ----
  1528. .. _class_TextServer_method_font_set_glyph_uv_rect:
  1529. .. rst-class:: classref-method
  1530. 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 **)**
  1531. Sets rectangle in the cache texture containing the glyph.
  1532. .. rst-class:: classref-item-separator
  1533. ----
  1534. .. _class_TextServer_method_font_set_hinting:
  1535. .. rst-class:: classref-method
  1536. void **font_set_hinting** **(** :ref:`RID<class_RID>` font_rid, :ref:`Hinting<enum_TextServer_Hinting>` hinting **)**
  1537. Sets font hinting mode. Used by dynamic fonts only.
  1538. .. rst-class:: classref-item-separator
  1539. ----
  1540. .. _class_TextServer_method_font_set_kerning:
  1541. .. rst-class:: classref-method
  1542. 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 **)**
  1543. Sets kerning for the pair of glyphs.
  1544. .. rst-class:: classref-item-separator
  1545. ----
  1546. .. _class_TextServer_method_font_set_language_support_override:
  1547. .. rst-class:: classref-method
  1548. void **font_set_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language, :ref:`bool<class_bool>` supported **)**
  1549. Adds override for :ref:`font_is_language_supported<class_TextServer_method_font_is_language_supported>`.
  1550. .. rst-class:: classref-item-separator
  1551. ----
  1552. .. _class_TextServer_method_font_set_msdf_pixel_range:
  1553. .. rst-class:: classref-method
  1554. void **font_set_msdf_pixel_range** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_pixel_range **)**
  1555. Sets the width of the range around the shape between the minimum and maximum representable signed distance.
  1556. .. rst-class:: classref-item-separator
  1557. ----
  1558. .. _class_TextServer_method_font_set_msdf_size:
  1559. .. rst-class:: classref-method
  1560. void **font_set_msdf_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_size **)**
  1561. Sets source font size used to generate MSDF textures.
  1562. .. rst-class:: classref-item-separator
  1563. ----
  1564. .. _class_TextServer_method_font_set_multichannel_signed_distance_field:
  1565. .. rst-class:: classref-method
  1566. void **font_set_multichannel_signed_distance_field** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` msdf **)**
  1567. 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.
  1568. \ **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.
  1569. .. rst-class:: classref-item-separator
  1570. ----
  1571. .. _class_TextServer_method_font_set_name:
  1572. .. rst-class:: classref-method
  1573. void **font_set_name** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)**
  1574. Sets the font family name.
  1575. .. rst-class:: classref-item-separator
  1576. ----
  1577. .. _class_TextServer_method_font_set_opentype_feature_overrides:
  1578. .. rst-class:: classref-method
  1579. void **font_set_opentype_feature_overrides** **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` overrides **)**
  1580. Sets font OpenType feature set override.
  1581. .. rst-class:: classref-item-separator
  1582. ----
  1583. .. _class_TextServer_method_font_set_oversampling:
  1584. .. rst-class:: classref-method
  1585. void **font_set_oversampling** **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` oversampling **)**
  1586. Sets font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1587. .. rst-class:: classref-item-separator
  1588. ----
  1589. .. _class_TextServer_method_font_set_scale:
  1590. .. rst-class:: classref-method
  1591. void **font_set_scale** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` scale **)**
  1592. Sets scaling factor of the color bitmap font.
  1593. .. rst-class:: classref-item-separator
  1594. ----
  1595. .. _class_TextServer_method_font_set_script_support_override:
  1596. .. rst-class:: classref-method
  1597. void **font_set_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script, :ref:`bool<class_bool>` supported **)**
  1598. Adds override for :ref:`font_is_script_supported<class_TextServer_method_font_is_script_supported>`.
  1599. .. rst-class:: classref-item-separator
  1600. ----
  1601. .. _class_TextServer_method_font_set_spacing:
  1602. .. rst-class:: classref-method
  1603. void **font_set_spacing** **(** :ref:`RID<class_RID>` font_rid, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)**
  1604. Sets the spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) to ``value`` in pixels (not relative to the font size).
  1605. .. rst-class:: classref-item-separator
  1606. ----
  1607. .. _class_TextServer_method_font_set_stretch:
  1608. .. rst-class:: classref-method
  1609. void **font_set_stretch** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)**
  1610. Sets font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1611. \ **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.
  1612. .. rst-class:: classref-item-separator
  1613. ----
  1614. .. _class_TextServer_method_font_set_style:
  1615. .. rst-class:: classref-method
  1616. void **font_set_style** **(** :ref:`RID<class_RID>` font_rid, |bitfield|\<:ref:`FontStyle<enum_TextServer_FontStyle>`\> style **)**
  1617. Sets the font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1618. \ **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.
  1619. .. rst-class:: classref-item-separator
  1620. ----
  1621. .. _class_TextServer_method_font_set_style_name:
  1622. .. rst-class:: classref-method
  1623. void **font_set_style_name** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)**
  1624. Sets the font style name.
  1625. .. rst-class:: classref-item-separator
  1626. ----
  1627. .. _class_TextServer_method_font_set_subpixel_positioning:
  1628. .. rst-class:: classref-method
  1629. void **font_set_subpixel_positioning** **(** :ref:`RID<class_RID>` font_rid, :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` subpixel_positioning **)**
  1630. Sets font subpixel glyph positioning mode.
  1631. .. rst-class:: classref-item-separator
  1632. ----
  1633. .. _class_TextServer_method_font_set_texture_image:
  1634. .. rst-class:: classref-method
  1635. 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 **)**
  1636. Sets font cache texture image data.
  1637. .. rst-class:: classref-item-separator
  1638. ----
  1639. .. _class_TextServer_method_font_set_texture_offsets:
  1640. .. rst-class:: classref-method
  1641. 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 **)**
  1642. Sets array containing glyph packing data.
  1643. .. rst-class:: classref-item-separator
  1644. ----
  1645. .. _class_TextServer_method_font_set_transform:
  1646. .. rst-class:: classref-method
  1647. void **font_set_transform** **(** :ref:`RID<class_RID>` font_rid, :ref:`Transform2D<class_Transform2D>` transform **)**
  1648. Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs.
  1649. For example, to simulate italic typeface by slanting, apply the following transform ``Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)``.
  1650. .. rst-class:: classref-item-separator
  1651. ----
  1652. .. _class_TextServer_method_font_set_underline_position:
  1653. .. rst-class:: classref-method
  1654. void **font_set_underline_position** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_position **)**
  1655. Sets pixel offset of the underline below the baseline.
  1656. .. rst-class:: classref-item-separator
  1657. ----
  1658. .. _class_TextServer_method_font_set_underline_thickness:
  1659. .. rst-class:: classref-method
  1660. void **font_set_underline_thickness** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_thickness **)**
  1661. Sets thickness of the underline in pixels.
  1662. .. rst-class:: classref-item-separator
  1663. ----
  1664. .. _class_TextServer_method_font_set_variation_coordinates:
  1665. .. rst-class:: classref-method
  1666. void **font_set_variation_coordinates** **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` variation_coordinates **)**
  1667. 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.
  1668. .. rst-class:: classref-item-separator
  1669. ----
  1670. .. _class_TextServer_method_font_set_weight:
  1671. .. rst-class:: classref-method
  1672. void **font_set_weight** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)**
  1673. Sets weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1674. \ **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.
  1675. .. rst-class:: classref-item-separator
  1676. ----
  1677. .. _class_TextServer_method_font_supported_feature_list:
  1678. .. rst-class:: classref-method
  1679. :ref:`Dictionary<class_Dictionary>` **font_supported_feature_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1680. Returns the dictionary of the supported OpenType features.
  1681. .. rst-class:: classref-item-separator
  1682. ----
  1683. .. _class_TextServer_method_font_supported_variation_list:
  1684. .. rst-class:: classref-method
  1685. :ref:`Dictionary<class_Dictionary>` **font_supported_variation_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1686. Returns the dictionary of the supported OpenType variation coordinates.
  1687. .. rst-class:: classref-item-separator
  1688. ----
  1689. .. _class_TextServer_method_format_number:
  1690. .. rst-class:: classref-method
  1691. :ref:`String<class_String>` **format_number** **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const|
  1692. Converts a number from the Western Arabic (0..9) to the numeral systems used in ``language``.
  1693. If ``language`` is omitted, the active locale will be used.
  1694. .. rst-class:: classref-item-separator
  1695. ----
  1696. .. _class_TextServer_method_free_rid:
  1697. .. rst-class:: classref-method
  1698. void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
  1699. Frees an object created by this **TextServer**.
  1700. .. rst-class:: classref-item-separator
  1701. ----
  1702. .. _class_TextServer_method_get_features:
  1703. .. rst-class:: classref-method
  1704. :ref:`int<class_int>` **get_features** **(** **)** |const|
  1705. Returns text server features, see :ref:`Feature<enum_TextServer_Feature>`.
  1706. .. rst-class:: classref-item-separator
  1707. ----
  1708. .. _class_TextServer_method_get_hex_code_box_size:
  1709. .. rst-class:: classref-method
  1710. :ref:`Vector2<class_Vector2>` **get_hex_code_box_size** **(** :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |const|
  1711. Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).
  1712. .. rst-class:: classref-item-separator
  1713. ----
  1714. .. _class_TextServer_method_get_name:
  1715. .. rst-class:: classref-method
  1716. :ref:`String<class_String>` **get_name** **(** **)** |const|
  1717. Returns the name of the server interface.
  1718. .. rst-class:: classref-item-separator
  1719. ----
  1720. .. _class_TextServer_method_get_support_data_filename:
  1721. .. rst-class:: classref-method
  1722. :ref:`String<class_String>` **get_support_data_filename** **(** **)** |const|
  1723. Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename.
  1724. .. rst-class:: classref-item-separator
  1725. ----
  1726. .. _class_TextServer_method_get_support_data_info:
  1727. .. rst-class:: classref-method
  1728. :ref:`String<class_String>` **get_support_data_info** **(** **)** |const|
  1729. Returns TextServer database (e.g. ICU break iterators and dictionaries) description.
  1730. .. rst-class:: classref-item-separator
  1731. ----
  1732. .. _class_TextServer_method_has:
  1733. .. rst-class:: classref-method
  1734. :ref:`bool<class_bool>` **has** **(** :ref:`RID<class_RID>` rid **)**
  1735. Returns ``true`` if ``rid`` is valid resource owned by this text server.
  1736. .. rst-class:: classref-item-separator
  1737. ----
  1738. .. _class_TextServer_method_has_feature:
  1739. .. rst-class:: classref-method
  1740. :ref:`bool<class_bool>` **has_feature** **(** :ref:`Feature<enum_TextServer_Feature>` feature **)** |const|
  1741. Returns ``true`` if the server supports a feature.
  1742. .. rst-class:: classref-item-separator
  1743. ----
  1744. .. _class_TextServer_method_is_confusable:
  1745. .. rst-class:: classref-method
  1746. :ref:`int<class_int>` **is_confusable** **(** :ref:`String<class_String>` string, :ref:`PackedStringArray<class_PackedStringArray>` dict **)** |const|
  1747. Returns index of the first string in ``dict`` which is visually confusable with the ``string``, or ``-1`` if none is found.
  1748. \ **Note:** This method doesn't detect invisible characters, for spoof detection use it in combination with :ref:`spoof_check<class_TextServer_method_spoof_check>`.
  1749. \ **Note:** Always returns ``-1`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  1750. .. rst-class:: classref-item-separator
  1751. ----
  1752. .. _class_TextServer_method_is_locale_right_to_left:
  1753. .. rst-class:: classref-method
  1754. :ref:`bool<class_bool>` **is_locale_right_to_left** **(** :ref:`String<class_String>` locale **)** |const|
  1755. Returns ``true`` if locale is right-to-left.
  1756. .. rst-class:: classref-item-separator
  1757. ----
  1758. .. _class_TextServer_method_is_valid_identifier:
  1759. .. rst-class:: classref-method
  1760. :ref:`bool<class_bool>` **is_valid_identifier** **(** :ref:`String<class_String>` string **)** |const|
  1761. Returns ``true`` if ``string`` is a valid identifier.
  1762. If the text server supports the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature, a valid identifier must:
  1763. - Conform to normalization form C.
  1764. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1765. - May contain Unicode characters of class XID_Continue in the other positions.
  1766. - Use UAX #31 recommended scripts only (mixed scripts are allowed).
  1767. If the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature is not supported, a valid identifier must:
  1768. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1769. - May contain Unicode characters of class XID_Continue in the other positions.
  1770. .. rst-class:: classref-item-separator
  1771. ----
  1772. .. _class_TextServer_method_load_support_data:
  1773. .. rst-class:: classref-method
  1774. :ref:`bool<class_bool>` **load_support_data** **(** :ref:`String<class_String>` filename **)**
  1775. Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
  1776. \ **Note:** This function should be called before any other TextServer functions used, otherwise it won't have any effect.
  1777. .. rst-class:: classref-item-separator
  1778. ----
  1779. .. _class_TextServer_method_name_to_tag:
  1780. .. rst-class:: classref-method
  1781. :ref:`int<class_int>` **name_to_tag** **(** :ref:`String<class_String>` name **)** |const|
  1782. Converts readable feature, variation, script or language name to OpenType tag.
  1783. .. rst-class:: classref-item-separator
  1784. ----
  1785. .. _class_TextServer_method_parse_number:
  1786. .. rst-class:: classref-method
  1787. :ref:`String<class_String>` **parse_number** **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const|
  1788. Converts ``number`` from the numeral systems used in ``language`` to Western Arabic (0..9).
  1789. .. rst-class:: classref-item-separator
  1790. ----
  1791. .. _class_TextServer_method_parse_structured_text:
  1792. .. rst-class:: classref-method
  1793. :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|
  1794. Default implementation of the BiDi algorithm override function. See :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` for more info.
  1795. .. rst-class:: classref-item-separator
  1796. ----
  1797. .. _class_TextServer_method_percent_sign:
  1798. .. rst-class:: classref-method
  1799. :ref:`String<class_String>` **percent_sign** **(** :ref:`String<class_String>` language="" **)** |const|
  1800. Returns percent sign used in the ``language``.
  1801. .. rst-class:: classref-item-separator
  1802. ----
  1803. .. _class_TextServer_method_save_support_data:
  1804. .. rst-class:: classref-method
  1805. :ref:`bool<class_bool>` **save_support_data** **(** :ref:`String<class_String>` filename **)** |const|
  1806. Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.
  1807. \ **Note:** This function is used by during project export, to include TextServer database.
  1808. .. rst-class:: classref-item-separator
  1809. ----
  1810. .. _class_TextServer_method_shaped_get_span_count:
  1811. .. rst-class:: classref-method
  1812. :ref:`int<class_int>` **shaped_get_span_count** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1813. 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>`.
  1814. .. rst-class:: classref-item-separator
  1815. ----
  1816. .. _class_TextServer_method_shaped_get_span_meta:
  1817. .. rst-class:: classref-method
  1818. :ref:`Variant<class_Variant>` **shaped_get_span_meta** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` index **)** |const|
  1819. Returns text span metadata.
  1820. .. rst-class:: classref-item-separator
  1821. ----
  1822. .. _class_TextServer_method_shaped_set_span_update_font:
  1823. .. rst-class:: classref-method
  1824. 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={} **)**
  1825. Changes text span font, font size and OpenType features, without changing the text.
  1826. .. rst-class:: classref-item-separator
  1827. ----
  1828. .. _class_TextServer_method_shaped_text_add_object:
  1829. .. rst-class:: classref-method
  1830. :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 **)**
  1831. Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters.
  1832. .. rst-class:: classref-item-separator
  1833. ----
  1834. .. _class_TextServer_method_shaped_text_add_string:
  1835. .. rst-class:: classref-method
  1836. :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 **)**
  1837. Adds text span and font to draw it to the text buffer.
  1838. .. rst-class:: classref-item-separator
  1839. ----
  1840. .. _class_TextServer_method_shaped_text_clear:
  1841. .. rst-class:: classref-method
  1842. void **shaped_text_clear** **(** :ref:`RID<class_RID>` rid **)**
  1843. Clears text buffer (removes text and inline objects).
  1844. .. rst-class:: classref-item-separator
  1845. ----
  1846. .. _class_TextServer_method_shaped_text_closest_character_pos:
  1847. .. rst-class:: classref-method
  1848. :ref:`int<class_int>` **shaped_text_closest_character_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  1849. Returns composite character position closest to the ``pos``.
  1850. .. rst-class:: classref-item-separator
  1851. ----
  1852. .. _class_TextServer_method_shaped_text_draw:
  1853. .. rst-class:: classref-method
  1854. 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|
  1855. 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).
  1856. .. rst-class:: classref-item-separator
  1857. ----
  1858. .. _class_TextServer_method_shaped_text_draw_outline:
  1859. .. rst-class:: classref-method
  1860. 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|
  1861. 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).
  1862. .. rst-class:: classref-item-separator
  1863. ----
  1864. .. _class_TextServer_method_shaped_text_fit_to_width:
  1865. .. rst-class:: classref-method
  1866. :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 **)**
  1867. Adjusts text width to fit to specified width, returns new text width.
  1868. .. rst-class:: classref-item-separator
  1869. ----
  1870. .. _class_TextServer_method_shaped_text_get_ascent:
  1871. .. rst-class:: classref-method
  1872. :ref:`float<class_float>` **shaped_text_get_ascent** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1873. Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
  1874. \ **Note:** Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline.
  1875. .. rst-class:: classref-item-separator
  1876. ----
  1877. .. _class_TextServer_method_shaped_text_get_carets:
  1878. .. rst-class:: classref-method
  1879. :ref:`Dictionary<class_Dictionary>` **shaped_text_get_carets** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` position **)** |const|
  1880. Returns shapes of the carets corresponding to the character offset ``position`` in the text. Returned caret shape is 1 pixel wide rectangle.
  1881. .. rst-class:: classref-item-separator
  1882. ----
  1883. .. _class_TextServer_method_shaped_text_get_character_breaks:
  1884. .. rst-class:: classref-method
  1885. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_character_breaks** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1886. Returns array of the composite character boundaries.
  1887. .. rst-class:: classref-item-separator
  1888. ----
  1889. .. _class_TextServer_method_shaped_text_get_custom_punctuation:
  1890. .. rst-class:: classref-method
  1891. :ref:`String<class_String>` **shaped_text_get_custom_punctuation** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1892. Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  1893. .. rst-class:: classref-item-separator
  1894. ----
  1895. .. _class_TextServer_method_shaped_text_get_descent:
  1896. .. rst-class:: classref-method
  1897. :ref:`float<class_float>` **shaped_text_get_descent** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1898. Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
  1899. \ **Note:** Overall descent can be higher than font descent, if some glyphs are displaced from the baseline.
  1900. .. rst-class:: classref-item-separator
  1901. ----
  1902. .. _class_TextServer_method_shaped_text_get_direction:
  1903. .. rst-class:: classref-method
  1904. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_direction** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1905. Returns direction of the text.
  1906. .. rst-class:: classref-item-separator
  1907. ----
  1908. .. _class_TextServer_method_shaped_text_get_dominant_direction_in_range:
  1909. .. rst-class:: classref-method
  1910. :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|
  1911. Returns dominant direction of in the range of text.
  1912. .. rst-class:: classref-item-separator
  1913. ----
  1914. .. _class_TextServer_method_shaped_text_get_ellipsis_glyph_count:
  1915. .. rst-class:: classref-method
  1916. :ref:`int<class_int>` **shaped_text_get_ellipsis_glyph_count** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1917. Returns number of glyphs in the ellipsis.
  1918. .. rst-class:: classref-item-separator
  1919. ----
  1920. .. _class_TextServer_method_shaped_text_get_ellipsis_glyphs:
  1921. .. rst-class:: classref-method
  1922. :ref:`Dictionary[]<class_Dictionary>` **shaped_text_get_ellipsis_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1923. Returns array of the glyphs in the ellipsis.
  1924. .. rst-class:: classref-item-separator
  1925. ----
  1926. .. _class_TextServer_method_shaped_text_get_ellipsis_pos:
  1927. .. rst-class:: classref-method
  1928. :ref:`int<class_int>` **shaped_text_get_ellipsis_pos** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1929. Returns position of the ellipsis.
  1930. .. rst-class:: classref-item-separator
  1931. ----
  1932. .. _class_TextServer_method_shaped_text_get_glyph_count:
  1933. .. rst-class:: classref-method
  1934. :ref:`int<class_int>` **shaped_text_get_glyph_count** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1935. Returns number of glyphs in the buffer.
  1936. .. rst-class:: classref-item-separator
  1937. ----
  1938. .. _class_TextServer_method_shaped_text_get_glyphs:
  1939. .. rst-class:: classref-method
  1940. :ref:`Dictionary[]<class_Dictionary>` **shaped_text_get_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1941. Returns an array of glyphs in the visual order.
  1942. .. rst-class:: classref-item-separator
  1943. ----
  1944. .. _class_TextServer_method_shaped_text_get_grapheme_bounds:
  1945. .. rst-class:: classref-method
  1946. :ref:`Vector2<class_Vector2>` **shaped_text_get_grapheme_bounds** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  1947. Returns composite character's bounds as offsets from the start of the line.
  1948. .. rst-class:: classref-item-separator
  1949. ----
  1950. .. _class_TextServer_method_shaped_text_get_inferred_direction:
  1951. .. rst-class:: classref-method
  1952. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_inferred_direction** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1953. Returns direction of the text, inferred by the BiDi algorithm.
  1954. .. rst-class:: classref-item-separator
  1955. ----
  1956. .. _class_TextServer_method_shaped_text_get_line_breaks:
  1957. .. rst-class:: classref-method
  1958. :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|
  1959. Breaks text to the lines and returns character ranges for each line.
  1960. .. rst-class:: classref-item-separator
  1961. ----
  1962. .. _class_TextServer_method_shaped_text_get_line_breaks_adv:
  1963. .. rst-class:: classref-method
  1964. :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|
  1965. Breaks text to the lines and columns. Returns character ranges for each segment.
  1966. .. rst-class:: classref-item-separator
  1967. ----
  1968. .. _class_TextServer_method_shaped_text_get_object_rect:
  1969. .. rst-class:: classref-method
  1970. :ref:`Rect2<class_Rect2>` **shaped_text_get_object_rect** **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key **)** |const|
  1971. Returns bounding rectangle of the inline object.
  1972. .. rst-class:: classref-item-separator
  1973. ----
  1974. .. _class_TextServer_method_shaped_text_get_objects:
  1975. .. rst-class:: classref-method
  1976. :ref:`Array<class_Array>` **shaped_text_get_objects** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1977. Returns array of inline objects.
  1978. .. rst-class:: classref-item-separator
  1979. ----
  1980. .. _class_TextServer_method_shaped_text_get_orientation:
  1981. .. rst-class:: classref-method
  1982. :ref:`Orientation<enum_TextServer_Orientation>` **shaped_text_get_orientation** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1983. Returns text orientation.
  1984. .. rst-class:: classref-item-separator
  1985. ----
  1986. .. _class_TextServer_method_shaped_text_get_parent:
  1987. .. rst-class:: classref-method
  1988. :ref:`RID<class_RID>` **shaped_text_get_parent** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1989. Returns the parent buffer from which the substring originates.
  1990. .. rst-class:: classref-item-separator
  1991. ----
  1992. .. _class_TextServer_method_shaped_text_get_preserve_control:
  1993. .. rst-class:: classref-method
  1994. :ref:`bool<class_bool>` **shaped_text_get_preserve_control** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1995. Returns ``true`` if text buffer is configured to display control characters.
  1996. .. rst-class:: classref-item-separator
  1997. ----
  1998. .. _class_TextServer_method_shaped_text_get_preserve_invalid:
  1999. .. rst-class:: classref-method
  2000. :ref:`bool<class_bool>` **shaped_text_get_preserve_invalid** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2001. Returns ``true`` if text buffer is configured to display hexadecimal codes in place of invalid characters.
  2002. \ **Note:** If set to ``false``, nothing is displayed in place of invalid characters.
  2003. .. rst-class:: classref-item-separator
  2004. ----
  2005. .. _class_TextServer_method_shaped_text_get_range:
  2006. .. rst-class:: classref-method
  2007. :ref:`Vector2i<class_Vector2i>` **shaped_text_get_range** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2008. Returns substring buffer character range in the parent buffer.
  2009. .. rst-class:: classref-item-separator
  2010. ----
  2011. .. _class_TextServer_method_shaped_text_get_selection:
  2012. .. rst-class:: classref-method
  2013. :ref:`PackedVector2Array<class_PackedVector2Array>` **shaped_text_get_selection** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |const|
  2014. Returns selection rectangles for the specified character range.
  2015. .. rst-class:: classref-item-separator
  2016. ----
  2017. .. _class_TextServer_method_shaped_text_get_size:
  2018. .. rst-class:: classref-method
  2019. :ref:`Vector2<class_Vector2>` **shaped_text_get_size** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2020. Returns size of the text.
  2021. .. rst-class:: classref-item-separator
  2022. ----
  2023. .. _class_TextServer_method_shaped_text_get_spacing:
  2024. .. rst-class:: classref-method
  2025. :ref:`int<class_int>` **shaped_text_get_spacing** **(** :ref:`RID<class_RID>` shaped, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |const|
  2026. Returns extra spacing added between glyphs or lines in pixels.
  2027. .. rst-class:: classref-item-separator
  2028. ----
  2029. .. _class_TextServer_method_shaped_text_get_trim_pos:
  2030. .. rst-class:: classref-method
  2031. :ref:`int<class_int>` **shaped_text_get_trim_pos** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2032. Returns the position of the overrun trim.
  2033. .. rst-class:: classref-item-separator
  2034. ----
  2035. .. _class_TextServer_method_shaped_text_get_underline_position:
  2036. .. rst-class:: classref-method
  2037. :ref:`float<class_float>` **shaped_text_get_underline_position** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2038. Returns pixel offset of the underline below the baseline.
  2039. .. rst-class:: classref-item-separator
  2040. ----
  2041. .. _class_TextServer_method_shaped_text_get_underline_thickness:
  2042. .. rst-class:: classref-method
  2043. :ref:`float<class_float>` **shaped_text_get_underline_thickness** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2044. Returns thickness of the underline.
  2045. .. rst-class:: classref-item-separator
  2046. ----
  2047. .. _class_TextServer_method_shaped_text_get_width:
  2048. .. rst-class:: classref-method
  2049. :ref:`float<class_float>` **shaped_text_get_width** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2050. Returns width (for horizontal layout) or height (for vertical) of the text.
  2051. .. rst-class:: classref-item-separator
  2052. ----
  2053. .. _class_TextServer_method_shaped_text_get_word_breaks:
  2054. .. rst-class:: classref-method
  2055. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_word_breaks** **(** :ref:`RID<class_RID>` shaped, |bitfield|\<:ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`\> grapheme_flags=264 **)** |const|
  2056. 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>`).
  2057. .. rst-class:: classref-item-separator
  2058. ----
  2059. .. _class_TextServer_method_shaped_text_has_visible_chars:
  2060. .. rst-class:: classref-method
  2061. :ref:`bool<class_bool>` **shaped_text_has_visible_chars** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2062. Returns ``true`` if text buffer contains any visible characters.
  2063. .. rst-class:: classref-item-separator
  2064. ----
  2065. .. _class_TextServer_method_shaped_text_hit_test_grapheme:
  2066. .. rst-class:: classref-method
  2067. :ref:`int<class_int>` **shaped_text_hit_test_grapheme** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coords **)** |const|
  2068. Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` if none is found.
  2069. .. rst-class:: classref-item-separator
  2070. ----
  2071. .. _class_TextServer_method_shaped_text_hit_test_position:
  2072. .. rst-class:: classref-method
  2073. :ref:`int<class_int>` **shaped_text_hit_test_position** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coords **)** |const|
  2074. Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
  2075. .. rst-class:: classref-item-separator
  2076. ----
  2077. .. _class_TextServer_method_shaped_text_is_ready:
  2078. .. rst-class:: classref-method
  2079. :ref:`bool<class_bool>` **shaped_text_is_ready** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2080. Returns ``true`` if buffer is successfully shaped.
  2081. .. rst-class:: classref-item-separator
  2082. ----
  2083. .. _class_TextServer_method_shaped_text_next_character_pos:
  2084. .. rst-class:: classref-method
  2085. :ref:`int<class_int>` **shaped_text_next_character_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  2086. Returns composite character end position closest to the ``pos``.
  2087. .. rst-class:: classref-item-separator
  2088. ----
  2089. .. _class_TextServer_method_shaped_text_next_grapheme_pos:
  2090. .. rst-class:: classref-method
  2091. :ref:`int<class_int>` **shaped_text_next_grapheme_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  2092. Returns grapheme end position closest to the ``pos``.
  2093. .. rst-class:: classref-item-separator
  2094. ----
  2095. .. _class_TextServer_method_shaped_text_overrun_trim_to_width:
  2096. .. rst-class:: classref-method
  2097. 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 **)**
  2098. Trims text if it exceeds the given width.
  2099. .. rst-class:: classref-item-separator
  2100. ----
  2101. .. _class_TextServer_method_shaped_text_prev_character_pos:
  2102. .. rst-class:: classref-method
  2103. :ref:`int<class_int>` **shaped_text_prev_character_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  2104. Returns composite character start position closest to the ``pos``.
  2105. .. rst-class:: classref-item-separator
  2106. ----
  2107. .. _class_TextServer_method_shaped_text_prev_grapheme_pos:
  2108. .. rst-class:: classref-method
  2109. :ref:`int<class_int>` **shaped_text_prev_grapheme_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  2110. Returns grapheme start position closest to the ``pos``.
  2111. .. rst-class:: classref-item-separator
  2112. ----
  2113. .. _class_TextServer_method_shaped_text_resize_object:
  2114. .. rst-class:: classref-method
  2115. :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 **)**
  2116. Sets new size and alignment of embedded object.
  2117. .. rst-class:: classref-item-separator
  2118. ----
  2119. .. _class_TextServer_method_shaped_text_set_bidi_override:
  2120. .. rst-class:: classref-method
  2121. void **shaped_text_set_bidi_override** **(** :ref:`RID<class_RID>` shaped, :ref:`Array<class_Array>` override **)**
  2122. Overrides BiDi for the structured text.
  2123. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
  2124. .. rst-class:: classref-item-separator
  2125. ----
  2126. .. _class_TextServer_method_shaped_text_set_custom_punctuation:
  2127. .. rst-class:: classref-method
  2128. void **shaped_text_set_custom_punctuation** **(** :ref:`RID<class_RID>` shaped, :ref:`String<class_String>` punct **)**
  2129. Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  2130. .. rst-class:: classref-item-separator
  2131. ----
  2132. .. _class_TextServer_method_shaped_text_set_direction:
  2133. .. rst-class:: classref-method
  2134. void **shaped_text_set_direction** **(** :ref:`RID<class_RID>` shaped, :ref:`Direction<enum_TextServer_Direction>` direction=0 **)**
  2135. 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.
  2136. \ **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>`).
  2137. .. rst-class:: classref-item-separator
  2138. ----
  2139. .. _class_TextServer_method_shaped_text_set_orientation:
  2140. .. rst-class:: classref-method
  2141. void **shaped_text_set_orientation** **(** :ref:`RID<class_RID>` shaped, :ref:`Orientation<enum_TextServer_Orientation>` orientation=0 **)**
  2142. Sets desired text orientation.
  2143. \ **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>`).
  2144. .. rst-class:: classref-item-separator
  2145. ----
  2146. .. _class_TextServer_method_shaped_text_set_preserve_control:
  2147. .. rst-class:: classref-method
  2148. void **shaped_text_set_preserve_control** **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)**
  2149. If set to ``true`` text buffer will display control characters.
  2150. .. rst-class:: classref-item-separator
  2151. ----
  2152. .. _class_TextServer_method_shaped_text_set_preserve_invalid:
  2153. .. rst-class:: classref-method
  2154. void **shaped_text_set_preserve_invalid** **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)**
  2155. If set to ``true`` text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.
  2156. .. rst-class:: classref-item-separator
  2157. ----
  2158. .. _class_TextServer_method_shaped_text_set_spacing:
  2159. .. rst-class:: classref-method
  2160. void **shaped_text_set_spacing** **(** :ref:`RID<class_RID>` shaped, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)**
  2161. Sets extra spacing added between glyphs or lines in pixels.
  2162. .. rst-class:: classref-item-separator
  2163. ----
  2164. .. _class_TextServer_method_shaped_text_shape:
  2165. .. rst-class:: classref-method
  2166. :ref:`bool<class_bool>` **shaped_text_shape** **(** :ref:`RID<class_RID>` shaped **)**
  2167. Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped successfully.
  2168. \ **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.
  2169. .. rst-class:: classref-item-separator
  2170. ----
  2171. .. _class_TextServer_method_shaped_text_sort_logical:
  2172. .. rst-class:: classref-method
  2173. :ref:`Dictionary[]<class_Dictionary>` **shaped_text_sort_logical** **(** :ref:`RID<class_RID>` shaped **)**
  2174. Returns text glyphs in the logical order.
  2175. .. rst-class:: classref-item-separator
  2176. ----
  2177. .. _class_TextServer_method_shaped_text_substr:
  2178. .. rst-class:: classref-method
  2179. :ref:`RID<class_RID>` **shaped_text_substr** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` length **)** |const|
  2180. Returns text buffer for the substring of the text in the ``shaped`` text buffer (including inline objects).
  2181. .. rst-class:: classref-item-separator
  2182. ----
  2183. .. _class_TextServer_method_shaped_text_tab_align:
  2184. .. rst-class:: classref-method
  2185. :ref:`float<class_float>` **shaped_text_tab_align** **(** :ref:`RID<class_RID>` shaped, :ref:`PackedFloat32Array<class_PackedFloat32Array>` tab_stops **)**
  2186. Aligns shaped text to the given tab-stops.
  2187. .. rst-class:: classref-item-separator
  2188. ----
  2189. .. _class_TextServer_method_spoof_check:
  2190. .. rst-class:: classref-method
  2191. :ref:`bool<class_bool>` **spoof_check** **(** :ref:`String<class_String>` string **)** |const|
  2192. Returns ``true`` if ``string`` is likely to be an attempt at confusing the reader.
  2193. \ **Note:** Always returns ``false`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  2194. .. rst-class:: classref-item-separator
  2195. ----
  2196. .. _class_TextServer_method_string_get_character_breaks:
  2197. .. rst-class:: classref-method
  2198. :ref:`PackedInt32Array<class_PackedInt32Array>` **string_get_character_breaks** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const|
  2199. Returns array of the composite character boundaries.
  2200. ::
  2201. var ts = TextServerManager.get_primary_interface()
  2202. print(ts.string_get_word_breaks("Test ❤️‍🔥 Test")) # Prints [1, 2, 3, 4, 5, 9, 10, 11, 12, 13, 14]
  2203. .. rst-class:: classref-item-separator
  2204. ----
  2205. .. _class_TextServer_method_string_get_word_breaks:
  2206. .. rst-class:: classref-method
  2207. :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|
  2208. 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.
  2209. When ``chars_per_line`` is greater than zero, line break boundaries are returned instead.
  2210. ::
  2211. var ts = TextServerManager.get_primary_interface()
  2212. print(ts.string_get_word_breaks("Godot Engine")) # Prints [0, 5, 6, 12]
  2213. print(ts.string_get_word_breaks("Godot Engine", "en", 5)) # Prints [0, 5, 6, 11, 11, 12]
  2214. .. rst-class:: classref-item-separator
  2215. ----
  2216. .. _class_TextServer_method_string_to_lower:
  2217. .. rst-class:: classref-method
  2218. :ref:`String<class_String>` **string_to_lower** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const|
  2219. Returns the string converted to lowercase.
  2220. \ **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>`).
  2221. \ **Note:** The result may be longer or shorter than the original.
  2222. .. rst-class:: classref-item-separator
  2223. ----
  2224. .. _class_TextServer_method_string_to_upper:
  2225. .. rst-class:: classref-method
  2226. :ref:`String<class_String>` **string_to_upper** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const|
  2227. Returns the string converted to uppercase.
  2228. \ **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>`).
  2229. \ **Note:** The result may be longer or shorter than the original.
  2230. .. rst-class:: classref-item-separator
  2231. ----
  2232. .. _class_TextServer_method_strip_diacritics:
  2233. .. rst-class:: classref-method
  2234. :ref:`String<class_String>` **strip_diacritics** **(** :ref:`String<class_String>` string **)** |const|
  2235. Strips diacritics from the string.
  2236. \ **Note:** The result may be longer or shorter than the original.
  2237. .. rst-class:: classref-item-separator
  2238. ----
  2239. .. _class_TextServer_method_tag_to_name:
  2240. .. rst-class:: classref-method
  2241. :ref:`String<class_String>` **tag_to_name** **(** :ref:`int<class_int>` tag **)** |const|
  2242. Converts OpenType tag to readable feature, variation, script or language name.
  2243. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2244. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2245. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2246. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2247. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2248. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  2249. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`