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/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TextServer.xml.
  6. .. _class_TextServer:
  7. TextServer
  8. ==========
  9. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`TextServerExtension<class_TextServerExtension>`
  11. 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. .. rst-class:: classref-item-separator
  479. ----
  480. .. _enum_TextServer_Direction:
  481. .. rst-class:: classref-enumeration
  482. enum **Direction**:
  483. .. _class_TextServer_constant_DIRECTION_AUTO:
  484. .. rst-class:: classref-enumeration-constant
  485. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_AUTO** = ``0``
  486. Text direction is determined based on contents and current locale.
  487. .. _class_TextServer_constant_DIRECTION_LTR:
  488. .. rst-class:: classref-enumeration-constant
  489. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_LTR** = ``1``
  490. Text is written from left to right.
  491. .. _class_TextServer_constant_DIRECTION_RTL:
  492. .. rst-class:: classref-enumeration-constant
  493. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_RTL** = ``2``
  494. Text is written from right to left.
  495. .. _class_TextServer_constant_DIRECTION_INHERITED:
  496. .. rst-class:: classref-enumeration-constant
  497. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_INHERITED** = ``3``
  498. Text writing direction is the same as base string writing direction. Used for BiDi override only.
  499. .. rst-class:: classref-item-separator
  500. ----
  501. .. _enum_TextServer_Orientation:
  502. .. rst-class:: classref-enumeration
  503. enum **Orientation**:
  504. .. _class_TextServer_constant_ORIENTATION_HORIZONTAL:
  505. .. rst-class:: classref-enumeration-constant
  506. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_HORIZONTAL** = ``0``
  507. Text is written horizontally.
  508. .. _class_TextServer_constant_ORIENTATION_VERTICAL:
  509. .. rst-class:: classref-enumeration-constant
  510. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_VERTICAL** = ``1``
  511. Left to right text is written vertically from top to bottom.
  512. Right to left text is written vertically from bottom to top.
  513. .. rst-class:: classref-item-separator
  514. ----
  515. .. _enum_TextServer_JustificationFlag:
  516. .. rst-class:: classref-enumeration
  517. flags **JustificationFlag**:
  518. .. _class_TextServer_constant_JUSTIFICATION_NONE:
  519. .. rst-class:: classref-enumeration-constant
  520. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_NONE** = ``0``
  521. Do not justify text.
  522. .. _class_TextServer_constant_JUSTIFICATION_KASHIDA:
  523. .. rst-class:: classref-enumeration-constant
  524. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_KASHIDA** = ``1``
  525. Justify text by adding and removing kashidas.
  526. .. _class_TextServer_constant_JUSTIFICATION_WORD_BOUND:
  527. .. rst-class:: classref-enumeration-constant
  528. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_WORD_BOUND** = ``2``
  529. Justify text by changing width of the spaces between the words.
  530. .. _class_TextServer_constant_JUSTIFICATION_TRIM_EDGE_SPACES:
  531. .. rst-class:: classref-enumeration-constant
  532. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_TRIM_EDGE_SPACES** = ``4``
  533. Remove trailing and leading spaces from the justified text.
  534. .. _class_TextServer_constant_JUSTIFICATION_AFTER_LAST_TAB:
  535. .. rst-class:: classref-enumeration-constant
  536. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_AFTER_LAST_TAB** = ``8``
  537. Only apply justification to the part of the text after the last tab.
  538. .. _class_TextServer_constant_JUSTIFICATION_CONSTRAIN_ELLIPSIS:
  539. .. rst-class:: classref-enumeration-constant
  540. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_CONSTRAIN_ELLIPSIS** = ``16``
  541. Apply justification to the trimmed line with ellipsis.
  542. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE:
  543. .. rst-class:: classref-enumeration-constant
  544. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE** = ``32``
  545. Do not apply justification to the last line of the paragraph.
  546. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS:
  547. .. rst-class:: classref-enumeration-constant
  548. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS** = ``64``
  549. 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>`).
  550. .. _class_TextServer_constant_JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE:
  551. .. rst-class:: classref-enumeration-constant
  552. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE** = ``128``
  553. 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).
  554. .. rst-class:: classref-item-separator
  555. ----
  556. .. _enum_TextServer_AutowrapMode:
  557. .. rst-class:: classref-enumeration
  558. enum **AutowrapMode**:
  559. .. _class_TextServer_constant_AUTOWRAP_OFF:
  560. .. rst-class:: classref-enumeration-constant
  561. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_OFF** = ``0``
  562. Autowrap is disabled.
  563. .. _class_TextServer_constant_AUTOWRAP_ARBITRARY:
  564. .. rst-class:: classref-enumeration-constant
  565. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_ARBITRARY** = ``1``
  566. 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.
  567. .. _class_TextServer_constant_AUTOWRAP_WORD:
  568. .. rst-class:: classref-enumeration-constant
  569. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD** = ``2``
  570. Wraps the text inside the node's bounding rectangle by soft-breaking between words.
  571. .. _class_TextServer_constant_AUTOWRAP_WORD_SMART:
  572. .. rst-class:: classref-enumeration-constant
  573. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD_SMART** = ``3``
  574. 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.
  575. .. rst-class:: classref-item-separator
  576. ----
  577. .. _enum_TextServer_LineBreakFlag:
  578. .. rst-class:: classref-enumeration
  579. flags **LineBreakFlag**:
  580. .. _class_TextServer_constant_BREAK_NONE:
  581. .. rst-class:: classref-enumeration-constant
  582. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_NONE** = ``0``
  583. Do not break the line.
  584. .. _class_TextServer_constant_BREAK_MANDATORY:
  585. .. rst-class:: classref-enumeration-constant
  586. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_MANDATORY** = ``1``
  587. Break the line at the line mandatory break characters (e.g. ``"\n"``).
  588. .. _class_TextServer_constant_BREAK_WORD_BOUND:
  589. .. rst-class:: classref-enumeration-constant
  590. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_WORD_BOUND** = ``2``
  591. Break the line between the words.
  592. .. _class_TextServer_constant_BREAK_GRAPHEME_BOUND:
  593. .. rst-class:: classref-enumeration-constant
  594. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_GRAPHEME_BOUND** = ``4``
  595. Break the line between any unconnected graphemes.
  596. .. _class_TextServer_constant_BREAK_ADAPTIVE:
  597. .. rst-class:: classref-enumeration-constant
  598. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_ADAPTIVE** = ``8``
  599. 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.
  600. .. _class_TextServer_constant_BREAK_TRIM_EDGE_SPACES:
  601. .. rst-class:: classref-enumeration-constant
  602. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_EDGE_SPACES** = ``16``
  603. Remove edge spaces from the broken line segments.
  604. .. rst-class:: classref-item-separator
  605. ----
  606. .. _enum_TextServer_VisibleCharactersBehavior:
  607. .. rst-class:: classref-enumeration
  608. enum **VisibleCharactersBehavior**:
  609. .. _class_TextServer_constant_VC_CHARS_BEFORE_SHAPING:
  610. .. rst-class:: classref-enumeration-constant
  611. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_BEFORE_SHAPING** = ``0``
  612. 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.
  613. .. _class_TextServer_constant_VC_CHARS_AFTER_SHAPING:
  614. .. rst-class:: classref-enumeration-constant
  615. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_AFTER_SHAPING** = ``1``
  616. 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.
  617. .. _class_TextServer_constant_VC_GLYPHS_AUTO:
  618. .. rst-class:: classref-enumeration-constant
  619. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_AUTO** = ``2``
  620. 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.
  621. .. _class_TextServer_constant_VC_GLYPHS_LTR:
  622. .. rst-class:: classref-enumeration-constant
  623. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_LTR** = ``3``
  624. 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.
  625. .. _class_TextServer_constant_VC_GLYPHS_RTL:
  626. .. rst-class:: classref-enumeration-constant
  627. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_RTL** = ``4``
  628. 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.
  629. .. rst-class:: classref-item-separator
  630. ----
  631. .. _enum_TextServer_OverrunBehavior:
  632. .. rst-class:: classref-enumeration
  633. enum **OverrunBehavior**:
  634. .. _class_TextServer_constant_OVERRUN_NO_TRIMMING:
  635. .. rst-class:: classref-enumeration-constant
  636. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_NO_TRIMMING** = ``0``
  637. No text trimming is performed.
  638. .. _class_TextServer_constant_OVERRUN_TRIM_CHAR:
  639. .. rst-class:: classref-enumeration-constant
  640. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_CHAR** = ``1``
  641. Trims the text per character.
  642. .. _class_TextServer_constant_OVERRUN_TRIM_WORD:
  643. .. rst-class:: classref-enumeration-constant
  644. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD** = ``2``
  645. Trims the text per word.
  646. .. _class_TextServer_constant_OVERRUN_TRIM_ELLIPSIS:
  647. .. rst-class:: classref-enumeration-constant
  648. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_ELLIPSIS** = ``3``
  649. Trims the text per character and adds an ellipsis to indicate that parts are hidden.
  650. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ELLIPSIS:
  651. .. rst-class:: classref-enumeration-constant
  652. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD_ELLIPSIS** = ``4``
  653. Trims the text per word and adds an ellipsis to indicate that parts are hidden.
  654. .. rst-class:: classref-item-separator
  655. ----
  656. .. _enum_TextServer_TextOverrunFlag:
  657. .. rst-class:: classref-enumeration
  658. flags **TextOverrunFlag**:
  659. .. _class_TextServer_constant_OVERRUN_NO_TRIM:
  660. .. rst-class:: classref-enumeration-constant
  661. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_NO_TRIM** = ``0``
  662. No trimming is performed.
  663. .. _class_TextServer_constant_OVERRUN_TRIM:
  664. .. rst-class:: classref-enumeration-constant
  665. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM** = ``1``
  666. Trims the text when it exceeds the given width.
  667. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ONLY:
  668. .. rst-class:: classref-enumeration-constant
  669. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM_WORD_ONLY** = ``2``
  670. Trims the text per word instead of per grapheme.
  671. .. _class_TextServer_constant_OVERRUN_ADD_ELLIPSIS:
  672. .. rst-class:: classref-enumeration-constant
  673. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ADD_ELLIPSIS** = ``4``
  674. Determines whether an ellipsis should be added at the end of the text.
  675. .. _class_TextServer_constant_OVERRUN_ENFORCE_ELLIPSIS:
  676. .. rst-class:: classref-enumeration-constant
  677. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ENFORCE_ELLIPSIS** = ``8``
  678. Determines whether the ellipsis at the end of the text is enforced and may not be hidden.
  679. .. _class_TextServer_constant_OVERRUN_JUSTIFICATION_AWARE:
  680. .. rst-class:: classref-enumeration-constant
  681. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_JUSTIFICATION_AWARE** = ``16``
  682. .. rst-class:: classref-item-separator
  683. ----
  684. .. _enum_TextServer_GraphemeFlag:
  685. .. rst-class:: classref-enumeration
  686. flags **GraphemeFlag**:
  687. .. _class_TextServer_constant_GRAPHEME_IS_VALID:
  688. .. rst-class:: classref-enumeration-constant
  689. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VALID** = ``1``
  690. Grapheme is supported by the font, and can be drawn.
  691. .. _class_TextServer_constant_GRAPHEME_IS_RTL:
  692. .. rst-class:: classref-enumeration-constant
  693. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_RTL** = ``2``
  694. Grapheme is part of right-to-left or bottom-to-top run.
  695. .. _class_TextServer_constant_GRAPHEME_IS_VIRTUAL:
  696. .. rst-class:: classref-enumeration-constant
  697. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VIRTUAL** = ``4``
  698. Grapheme is not part of source text, it was added by justification process.
  699. .. _class_TextServer_constant_GRAPHEME_IS_SPACE:
  700. .. rst-class:: classref-enumeration-constant
  701. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SPACE** = ``8``
  702. Grapheme is whitespace.
  703. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_HARD:
  704. .. rst-class:: classref-enumeration-constant
  705. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_HARD** = ``16``
  706. Grapheme is mandatory break point (e.g. ``"\n"``).
  707. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_SOFT:
  708. .. rst-class:: classref-enumeration-constant
  709. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_SOFT** = ``32``
  710. Grapheme is optional break point (e.g. space).
  711. .. _class_TextServer_constant_GRAPHEME_IS_TAB:
  712. .. rst-class:: classref-enumeration-constant
  713. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_TAB** = ``64``
  714. Grapheme is the tabulation character.
  715. .. _class_TextServer_constant_GRAPHEME_IS_ELONGATION:
  716. .. rst-class:: classref-enumeration-constant
  717. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_ELONGATION** = ``128``
  718. Grapheme is kashida.
  719. .. _class_TextServer_constant_GRAPHEME_IS_PUNCTUATION:
  720. .. rst-class:: classref-enumeration-constant
  721. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_PUNCTUATION** = ``256``
  722. Grapheme is punctuation character.
  723. .. _class_TextServer_constant_GRAPHEME_IS_UNDERSCORE:
  724. .. rst-class:: classref-enumeration-constant
  725. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_UNDERSCORE** = ``512``
  726. Grapheme is underscore character.
  727. .. _class_TextServer_constant_GRAPHEME_IS_CONNECTED:
  728. .. rst-class:: classref-enumeration-constant
  729. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_CONNECTED** = ``1024``
  730. Grapheme is connected to the previous grapheme. Breaking line before this grapheme is not safe.
  731. .. _class_TextServer_constant_GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL:
  732. .. rst-class:: classref-enumeration-constant
  733. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL** = ``2048``
  734. It is safe to insert a U+0640 before this grapheme for elongation.
  735. .. _class_TextServer_constant_GRAPHEME_IS_EMBEDDED_OBJECT:
  736. .. rst-class:: classref-enumeration-constant
  737. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_EMBEDDED_OBJECT** = ``4096``
  738. Grapheme is an object replacement character for the embedded object.
  739. .. rst-class:: classref-item-separator
  740. ----
  741. .. _enum_TextServer_Hinting:
  742. .. rst-class:: classref-enumeration
  743. enum **Hinting**:
  744. .. _class_TextServer_constant_HINTING_NONE:
  745. .. rst-class:: classref-enumeration-constant
  746. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NONE** = ``0``
  747. Disables font hinting (smoother but less crisp).
  748. .. _class_TextServer_constant_HINTING_LIGHT:
  749. .. rst-class:: classref-enumeration-constant
  750. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_LIGHT** = ``1``
  751. Use the light font hinting mode.
  752. .. _class_TextServer_constant_HINTING_NORMAL:
  753. .. rst-class:: classref-enumeration-constant
  754. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NORMAL** = ``2``
  755. Use the default font hinting mode (crisper but less smooth).
  756. \ **Note:** This hinting mode changes both horizontal and vertical glyph metrics. If applied to monospace font, some glyphs might have different width.
  757. .. rst-class:: classref-item-separator
  758. ----
  759. .. _enum_TextServer_SubpixelPositioning:
  760. .. rst-class:: classref-enumeration
  761. enum **SubpixelPositioning**:
  762. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_DISABLED:
  763. .. rst-class:: classref-enumeration-constant
  764. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_DISABLED** = ``0``
  765. Glyph horizontal position is rounded to the whole pixel size, each glyph is rasterized once.
  766. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO:
  767. .. rst-class:: classref-enumeration-constant
  768. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_AUTO** = ``1``
  769. Glyph horizontal position is rounded based on font size.
  770. - 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>`.
  771. - 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>`.
  772. - To the whole pixel size for larger fonts.
  773. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF:
  774. .. rst-class:: classref-enumeration-constant
  775. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF** = ``2``
  776. Glyph horizontal position is rounded to one half of the pixel size, each glyph is rasterized up to two times.
  777. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER:
  778. .. rst-class:: classref-enumeration-constant
  779. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER** = ``3``
  780. Glyph horizontal position is rounded to one quarter of the pixel size, each glyph is rasterized up to four times.
  781. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE:
  782. .. rst-class:: classref-enumeration-constant
  783. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE** = ``20``
  784. 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.
  785. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE:
  786. .. rst-class:: classref-enumeration-constant
  787. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE** = ``16``
  788. 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.
  789. .. rst-class:: classref-item-separator
  790. ----
  791. .. _enum_TextServer_Feature:
  792. .. rst-class:: classref-enumeration
  793. enum **Feature**:
  794. .. _class_TextServer_constant_FEATURE_SIMPLE_LAYOUT:
  795. .. rst-class:: classref-enumeration-constant
  796. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SIMPLE_LAYOUT** = ``1``
  797. TextServer supports simple text layouts.
  798. .. _class_TextServer_constant_FEATURE_BIDI_LAYOUT:
  799. .. rst-class:: classref-enumeration-constant
  800. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BIDI_LAYOUT** = ``2``
  801. TextServer supports bidirectional text layouts.
  802. .. _class_TextServer_constant_FEATURE_VERTICAL_LAYOUT:
  803. .. rst-class:: classref-enumeration-constant
  804. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_VERTICAL_LAYOUT** = ``4``
  805. TextServer supports vertical layouts.
  806. .. _class_TextServer_constant_FEATURE_SHAPING:
  807. .. rst-class:: classref-enumeration-constant
  808. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SHAPING** = ``8``
  809. TextServer supports complex text shaping.
  810. .. _class_TextServer_constant_FEATURE_KASHIDA_JUSTIFICATION:
  811. .. rst-class:: classref-enumeration-constant
  812. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_KASHIDA_JUSTIFICATION** = ``16``
  813. TextServer supports justification using kashidas.
  814. .. _class_TextServer_constant_FEATURE_BREAK_ITERATORS:
  815. .. rst-class:: classref-enumeration-constant
  816. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BREAK_ITERATORS** = ``32``
  817. TextServer supports complex line/word breaking rules (e.g. dictionary based).
  818. .. _class_TextServer_constant_FEATURE_FONT_BITMAP:
  819. .. rst-class:: classref-enumeration-constant
  820. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_BITMAP** = ``64``
  821. TextServer supports loading bitmap fonts.
  822. .. _class_TextServer_constant_FEATURE_FONT_DYNAMIC:
  823. .. rst-class:: classref-enumeration-constant
  824. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_DYNAMIC** = ``128``
  825. TextServer supports loading dynamic (TrueType, OpeType, etc.) fonts.
  826. .. _class_TextServer_constant_FEATURE_FONT_MSDF:
  827. .. rst-class:: classref-enumeration-constant
  828. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_MSDF** = ``256``
  829. TextServer supports multichannel signed distance field dynamic font rendering.
  830. .. _class_TextServer_constant_FEATURE_FONT_SYSTEM:
  831. .. rst-class:: classref-enumeration-constant
  832. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_SYSTEM** = ``512``
  833. TextServer supports loading system fonts.
  834. .. _class_TextServer_constant_FEATURE_FONT_VARIABLE:
  835. .. rst-class:: classref-enumeration-constant
  836. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_VARIABLE** = ``1024``
  837. TextServer supports variable fonts.
  838. .. _class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION:
  839. .. rst-class:: classref-enumeration-constant
  840. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION** = ``2048``
  841. TextServer supports locale dependent and context sensitive case conversion.
  842. .. _class_TextServer_constant_FEATURE_USE_SUPPORT_DATA:
  843. .. rst-class:: classref-enumeration-constant
  844. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_USE_SUPPORT_DATA** = ``4096``
  845. TextServer require external data file for some features, see :ref:`load_support_data<class_TextServer_method_load_support_data>`.
  846. .. _class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS:
  847. .. rst-class:: classref-enumeration-constant
  848. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_IDENTIFIERS** = ``8192``
  849. TextServer supports UAX #31 identifier validation, see :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>`.
  850. .. _class_TextServer_constant_FEATURE_UNICODE_SECURITY:
  851. .. rst-class:: classref-enumeration-constant
  852. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_SECURITY** = ``16384``
  853. 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.
  854. .. rst-class:: classref-item-separator
  855. ----
  856. .. _enum_TextServer_ContourPointTag:
  857. .. rst-class:: classref-enumeration
  858. enum **ContourPointTag**:
  859. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_ON:
  860. .. rst-class:: classref-enumeration-constant
  861. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_ON** = ``1``
  862. Contour point is on the curve.
  863. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC:
  864. .. rst-class:: classref-enumeration-constant
  865. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CONIC** = ``0``
  866. Contour point isn't on the curve, but serves as a control point for a conic (quadratic) Bézier arc.
  867. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CUBIC:
  868. .. rst-class:: classref-enumeration-constant
  869. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CUBIC** = ``2``
  870. Contour point isn't on the curve, but serves as a control point for a cubic Bézier arc.
  871. .. rst-class:: classref-item-separator
  872. ----
  873. .. _enum_TextServer_SpacingType:
  874. .. rst-class:: classref-enumeration
  875. enum **SpacingType**:
  876. .. _class_TextServer_constant_SPACING_GLYPH:
  877. .. rst-class:: classref-enumeration-constant
  878. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_GLYPH** = ``0``
  879. Spacing for each glyph.
  880. .. _class_TextServer_constant_SPACING_SPACE:
  881. .. rst-class:: classref-enumeration-constant
  882. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_SPACE** = ``1``
  883. Spacing for the space character.
  884. .. _class_TextServer_constant_SPACING_TOP:
  885. .. rst-class:: classref-enumeration-constant
  886. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_TOP** = ``2``
  887. Spacing at the top of the line.
  888. .. _class_TextServer_constant_SPACING_BOTTOM:
  889. .. rst-class:: classref-enumeration-constant
  890. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_BOTTOM** = ``3``
  891. Spacing at the bottom of the line.
  892. .. _class_TextServer_constant_SPACING_MAX:
  893. .. rst-class:: classref-enumeration-constant
  894. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_MAX** = ``4``
  895. .. rst-class:: classref-item-separator
  896. ----
  897. .. _enum_TextServer_FontStyle:
  898. .. rst-class:: classref-enumeration
  899. flags **FontStyle**:
  900. .. _class_TextServer_constant_FONT_BOLD:
  901. .. rst-class:: classref-enumeration-constant
  902. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_BOLD** = ``1``
  903. Font is bold.
  904. .. _class_TextServer_constant_FONT_ITALIC:
  905. .. rst-class:: classref-enumeration-constant
  906. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_ITALIC** = ``2``
  907. Font is italic or oblique.
  908. .. _class_TextServer_constant_FONT_FIXED_WIDTH:
  909. .. rst-class:: classref-enumeration-constant
  910. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_FIXED_WIDTH** = ``4``
  911. Font have fixed-width characters.
  912. .. rst-class:: classref-item-separator
  913. ----
  914. .. _enum_TextServer_StructuredTextParser:
  915. .. rst-class:: classref-enumeration
  916. enum **StructuredTextParser**:
  917. .. _class_TextServer_constant_STRUCTURED_TEXT_DEFAULT:
  918. .. rst-class:: classref-enumeration-constant
  919. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_DEFAULT** = ``0``
  920. Use default Unicode BiDi algorithm.
  921. .. _class_TextServer_constant_STRUCTURED_TEXT_URI:
  922. .. rst-class:: classref-enumeration-constant
  923. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_URI** = ``1``
  924. BiDi override for URI.
  925. .. _class_TextServer_constant_STRUCTURED_TEXT_FILE:
  926. .. rst-class:: classref-enumeration-constant
  927. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_FILE** = ``2``
  928. BiDi override for file path.
  929. .. _class_TextServer_constant_STRUCTURED_TEXT_EMAIL:
  930. .. rst-class:: classref-enumeration-constant
  931. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_EMAIL** = ``3``
  932. BiDi override for email.
  933. .. _class_TextServer_constant_STRUCTURED_TEXT_LIST:
  934. .. rst-class:: classref-enumeration-constant
  935. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_LIST** = ``4``
  936. BiDi override for lists. Structured text options: list separator :ref:`String<class_String>`.
  937. .. _class_TextServer_constant_STRUCTURED_TEXT_GDSCRIPT:
  938. .. rst-class:: classref-enumeration-constant
  939. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_GDSCRIPT** = ``5``
  940. BiDi override for GDScript.
  941. .. _class_TextServer_constant_STRUCTURED_TEXT_CUSTOM:
  942. .. rst-class:: classref-enumeration-constant
  943. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_CUSTOM** = ``6``
  944. User defined structured text BiDi override function.
  945. .. rst-class:: classref-item-separator
  946. ----
  947. .. _enum_TextServer_FixedSizeScaleMode:
  948. .. rst-class:: classref-enumeration
  949. enum **FixedSizeScaleMode**:
  950. .. _class_TextServer_constant_FIXED_SIZE_SCALE_DISABLE:
  951. .. rst-class:: classref-enumeration-constant
  952. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_DISABLE** = ``0``
  953. Bitmap font is not scaled.
  954. .. _class_TextServer_constant_FIXED_SIZE_SCALE_INTEGER_ONLY:
  955. .. rst-class:: classref-enumeration-constant
  956. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_INTEGER_ONLY** = ``1``
  957. Bitmap font is scaled to the closest integer multiple of the font's fixed size. This is the recommended option for pixel art fonts.
  958. .. _class_TextServer_constant_FIXED_SIZE_SCALE_ENABLED:
  959. .. rst-class:: classref-enumeration-constant
  960. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_ENABLED** = ``2``
  961. Bitmap font is scaled to an arbitrary (fractional) size. This is the recommended option for non-pixel art fonts.
  962. .. rst-class:: classref-section-separator
  963. ----
  964. .. rst-class:: classref-descriptions-group
  965. Method Descriptions
  966. -------------------
  967. .. _class_TextServer_method_create_font:
  968. .. rst-class:: classref-method
  969. :ref:`RID<class_RID>` **create_font** **(** **)**
  970. Creates a new, empty font cache entry resource. To free the resulting resource, use the :ref:`free_rid<class_TextServer_method_free_rid>` method.
  971. .. rst-class:: classref-item-separator
  972. ----
  973. .. _class_TextServer_method_create_font_linked_variation:
  974. .. rst-class:: classref-method
  975. :ref:`RID<class_RID>` **create_font_linked_variation** **(** :ref:`RID<class_RID>` font_rid **)**
  976. 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.
  977. .. rst-class:: classref-item-separator
  978. ----
  979. .. _class_TextServer_method_create_shaped_text:
  980. .. rst-class:: classref-method
  981. :ref:`RID<class_RID>` **create_shaped_text** **(** :ref:`Direction<enum_TextServer_Direction>` direction=0, :ref:`Orientation<enum_TextServer_Orientation>` orientation=0 **)**
  982. 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.
  983. \ **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>`).
  984. \ **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>`).
  985. .. rst-class:: classref-item-separator
  986. ----
  987. .. _class_TextServer_method_draw_hex_code_box:
  988. .. rst-class:: classref-method
  989. 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|
  990. Draws box displaying character hexadecimal code. Used for replacing missing characters.
  991. .. rst-class:: classref-item-separator
  992. ----
  993. .. _class_TextServer_method_font_clear_glyphs:
  994. .. rst-class:: classref-method
  995. void **font_clear_glyphs** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)**
  996. Removes all rendered glyphs information from the cache entry.
  997. \ **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.
  998. .. rst-class:: classref-item-separator
  999. ----
  1000. .. _class_TextServer_method_font_clear_kerning_map:
  1001. .. rst-class:: classref-method
  1002. void **font_clear_kerning_map** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)**
  1003. Removes all kerning overrides.
  1004. .. rst-class:: classref-item-separator
  1005. ----
  1006. .. _class_TextServer_method_font_clear_size_cache:
  1007. .. rst-class:: classref-method
  1008. void **font_clear_size_cache** **(** :ref:`RID<class_RID>` font_rid **)**
  1009. Removes all font sizes from the cache entry.
  1010. .. rst-class:: classref-item-separator
  1011. ----
  1012. .. _class_TextServer_method_font_clear_textures:
  1013. .. rst-class:: classref-method
  1014. void **font_clear_textures** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)**
  1015. Removes all textures from font cache entry.
  1016. \ **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.
  1017. .. rst-class:: classref-item-separator
  1018. ----
  1019. .. _class_TextServer_method_font_draw_glyph:
  1020. .. rst-class:: classref-method
  1021. 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|
  1022. Draws single glyph into a canvas item at the position, using ``font_rid`` at the size ``size``.
  1023. \ **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>`.
  1024. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1025. .. rst-class:: classref-item-separator
  1026. ----
  1027. .. _class_TextServer_method_font_draw_glyph_outline:
  1028. .. rst-class:: classref-method
  1029. 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|
  1030. Draws single glyph outline of size ``outline_size`` into a canvas item at the position, using ``font_rid`` at the size ``size``.
  1031. \ **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>`.
  1032. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1033. .. rst-class:: classref-item-separator
  1034. ----
  1035. .. _class_TextServer_method_font_get_antialiasing:
  1036. .. rst-class:: classref-method
  1037. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **font_get_antialiasing** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1038. Returns font anti-aliasing mode.
  1039. .. rst-class:: classref-item-separator
  1040. ----
  1041. .. _class_TextServer_method_font_get_ascent:
  1042. .. rst-class:: classref-method
  1043. :ref:`float<class_float>` **font_get_ascent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1044. Returns the font ascent (number of pixels above the baseline).
  1045. .. rst-class:: classref-item-separator
  1046. ----
  1047. .. _class_TextServer_method_font_get_char_from_glyph_index:
  1048. .. rst-class:: classref-method
  1049. :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|
  1050. 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>`.
  1051. .. rst-class:: classref-item-separator
  1052. ----
  1053. .. _class_TextServer_method_font_get_descent:
  1054. .. rst-class:: classref-method
  1055. :ref:`float<class_float>` **font_get_descent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1056. Returns the font descent (number of pixels below the baseline).
  1057. .. rst-class:: classref-item-separator
  1058. ----
  1059. .. _class_TextServer_method_font_get_embolden:
  1060. .. rst-class:: classref-method
  1061. :ref:`float<class_float>` **font_get_embolden** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1062. Returns font embolden strength.
  1063. .. rst-class:: classref-item-separator
  1064. ----
  1065. .. _class_TextServer_method_font_get_face_count:
  1066. .. rst-class:: classref-method
  1067. :ref:`int<class_int>` **font_get_face_count** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1068. Returns number of faces in the TrueType / OpenType collection.
  1069. .. rst-class:: classref-item-separator
  1070. ----
  1071. .. _class_TextServer_method_font_get_face_index:
  1072. .. rst-class:: classref-method
  1073. :ref:`int<class_int>` **font_get_face_index** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1074. Returns an active face index in the TrueType / OpenType collection.
  1075. .. rst-class:: classref-item-separator
  1076. ----
  1077. .. _class_TextServer_method_font_get_fixed_size:
  1078. .. rst-class:: classref-method
  1079. :ref:`int<class_int>` **font_get_fixed_size** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1080. Returns bitmap font fixed size.
  1081. .. rst-class:: classref-item-separator
  1082. ----
  1083. .. _class_TextServer_method_font_get_fixed_size_scale_mode:
  1084. .. rst-class:: classref-method
  1085. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **font_get_fixed_size_scale_mode** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1086. Returns bitmap font scaling mode.
  1087. .. rst-class:: classref-item-separator
  1088. ----
  1089. .. _class_TextServer_method_font_get_generate_mipmaps:
  1090. .. rst-class:: classref-method
  1091. :ref:`bool<class_bool>` **font_get_generate_mipmaps** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1092. Returns ``true`` if font texture mipmap generation is enabled.
  1093. .. rst-class:: classref-item-separator
  1094. ----
  1095. .. _class_TextServer_method_font_get_global_oversampling:
  1096. .. rst-class:: classref-method
  1097. :ref:`float<class_float>` **font_get_global_oversampling** **(** **)** |const|
  1098. Returns the font oversampling factor, shared by all fonts in the TextServer.
  1099. .. rst-class:: classref-item-separator
  1100. ----
  1101. .. _class_TextServer_method_font_get_glyph_advance:
  1102. .. rst-class:: classref-method
  1103. :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|
  1104. Returns glyph advance (offset of the next glyph).
  1105. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1106. .. rst-class:: classref-item-separator
  1107. ----
  1108. .. _class_TextServer_method_font_get_glyph_contours:
  1109. .. rst-class:: classref-method
  1110. :ref:`Dictionary<class_Dictionary>` **font_get_glyph_contours** **(** :ref:`RID<class_RID>` font, :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |const|
  1111. Returns outline contours of the glyph as a :ref:`Dictionary<class_Dictionary>` with the following contents:
  1112. \ ``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.
  1113. \ ``contours`` - :ref:`PackedInt32Array<class_PackedInt32Array>`, containing indices the end points of each contour.
  1114. \ ``orientation`` - :ref:`bool<class_bool>`, contour orientation. If ``true``, clockwise contours must be filled.
  1115. .. rst-class:: classref-item-separator
  1116. ----
  1117. .. _class_TextServer_method_font_get_glyph_index:
  1118. .. rst-class:: classref-method
  1119. :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|
  1120. 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>`.
  1121. .. rst-class:: classref-item-separator
  1122. ----
  1123. .. _class_TextServer_method_font_get_glyph_list:
  1124. .. rst-class:: classref-method
  1125. :ref:`PackedInt32Array<class_PackedInt32Array>` **font_get_glyph_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const|
  1126. Returns list of rendered glyphs in the cache entry.
  1127. .. rst-class:: classref-item-separator
  1128. ----
  1129. .. _class_TextServer_method_font_get_glyph_offset:
  1130. .. rst-class:: classref-method
  1131. :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|
  1132. Returns glyph offset from the baseline.
  1133. .. rst-class:: classref-item-separator
  1134. ----
  1135. .. _class_TextServer_method_font_get_glyph_size:
  1136. .. rst-class:: classref-method
  1137. :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|
  1138. Returns size of the glyph.
  1139. .. rst-class:: classref-item-separator
  1140. ----
  1141. .. _class_TextServer_method_font_get_glyph_texture_idx:
  1142. .. rst-class:: classref-method
  1143. :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|
  1144. Returns index of the cache texture containing the glyph.
  1145. .. rst-class:: classref-item-separator
  1146. ----
  1147. .. _class_TextServer_method_font_get_glyph_texture_rid:
  1148. .. rst-class:: classref-method
  1149. :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|
  1150. Returns resource ID of the cache texture containing the glyph.
  1151. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1152. .. rst-class:: classref-item-separator
  1153. ----
  1154. .. _class_TextServer_method_font_get_glyph_texture_size:
  1155. .. rst-class:: classref-method
  1156. :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|
  1157. Returns size of the cache texture containing the glyph.
  1158. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1159. .. rst-class:: classref-item-separator
  1160. ----
  1161. .. _class_TextServer_method_font_get_glyph_uv_rect:
  1162. .. rst-class:: classref-method
  1163. :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|
  1164. Returns rectangle in the cache texture containing the glyph.
  1165. .. rst-class:: classref-item-separator
  1166. ----
  1167. .. _class_TextServer_method_font_get_hinting:
  1168. .. rst-class:: classref-method
  1169. :ref:`Hinting<enum_TextServer_Hinting>` **font_get_hinting** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1170. Returns the font hinting mode. Used by dynamic fonts only.
  1171. .. rst-class:: classref-item-separator
  1172. ----
  1173. .. _class_TextServer_method_font_get_kerning:
  1174. .. rst-class:: classref-method
  1175. :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|
  1176. Returns kerning for the pair of glyphs.
  1177. .. rst-class:: classref-item-separator
  1178. ----
  1179. .. _class_TextServer_method_font_get_kerning_list:
  1180. .. rst-class:: classref-method
  1181. :ref:`Vector2i[]<class_Vector2i>` **font_get_kerning_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1182. Returns list of the kerning overrides.
  1183. .. rst-class:: classref-item-separator
  1184. ----
  1185. .. _class_TextServer_method_font_get_language_support_override:
  1186. .. rst-class:: classref-method
  1187. :ref:`bool<class_bool>` **font_get_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)**
  1188. Returns ``true`` if support override is enabled for the ``language``.
  1189. .. rst-class:: classref-item-separator
  1190. ----
  1191. .. _class_TextServer_method_font_get_language_support_overrides:
  1192. .. rst-class:: classref-method
  1193. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_language_support_overrides** **(** :ref:`RID<class_RID>` font_rid **)**
  1194. Returns list of language support overrides.
  1195. .. rst-class:: classref-item-separator
  1196. ----
  1197. .. _class_TextServer_method_font_get_msdf_pixel_range:
  1198. .. rst-class:: classref-method
  1199. :ref:`int<class_int>` **font_get_msdf_pixel_range** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1200. Returns the width of the range around the shape between the minimum and maximum representable signed distance.
  1201. .. rst-class:: classref-item-separator
  1202. ----
  1203. .. _class_TextServer_method_font_get_msdf_size:
  1204. .. rst-class:: classref-method
  1205. :ref:`int<class_int>` **font_get_msdf_size** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1206. Returns source font size used to generate MSDF textures.
  1207. .. rst-class:: classref-item-separator
  1208. ----
  1209. .. _class_TextServer_method_font_get_name:
  1210. .. rst-class:: classref-method
  1211. :ref:`String<class_String>` **font_get_name** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1212. Returns font family name.
  1213. .. rst-class:: classref-item-separator
  1214. ----
  1215. .. _class_TextServer_method_font_get_opentype_feature_overrides:
  1216. .. rst-class:: classref-method
  1217. :ref:`Dictionary<class_Dictionary>` **font_get_opentype_feature_overrides** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1218. Returns font OpenType feature set override.
  1219. .. rst-class:: classref-item-separator
  1220. ----
  1221. .. _class_TextServer_method_font_get_ot_name_strings:
  1222. .. rst-class:: classref-method
  1223. :ref:`Dictionary<class_Dictionary>` **font_get_ot_name_strings** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1224. Returns :ref:`Dictionary<class_Dictionary>` with OpenType font name strings (localized font names, version, description, license information, sample text, etc.).
  1225. .. rst-class:: classref-item-separator
  1226. ----
  1227. .. _class_TextServer_method_font_get_oversampling:
  1228. .. rst-class:: classref-method
  1229. :ref:`float<class_float>` **font_get_oversampling** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1230. Returns font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1231. .. rst-class:: classref-item-separator
  1232. ----
  1233. .. _class_TextServer_method_font_get_scale:
  1234. .. rst-class:: classref-method
  1235. :ref:`float<class_float>` **font_get_scale** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1236. Returns scaling factor of the color bitmap font.
  1237. .. rst-class:: classref-item-separator
  1238. ----
  1239. .. _class_TextServer_method_font_get_script_support_override:
  1240. .. rst-class:: classref-method
  1241. :ref:`bool<class_bool>` **font_get_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)**
  1242. Returns ``true`` if support override is enabled for the ``script``.
  1243. .. rst-class:: classref-item-separator
  1244. ----
  1245. .. _class_TextServer_method_font_get_script_support_overrides:
  1246. .. rst-class:: classref-method
  1247. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_script_support_overrides** **(** :ref:`RID<class_RID>` font_rid **)**
  1248. Returns list of script support overrides.
  1249. .. rst-class:: classref-item-separator
  1250. ----
  1251. .. _class_TextServer_method_font_get_size_cache_list:
  1252. .. rst-class:: classref-method
  1253. :ref:`Vector2i[]<class_Vector2i>` **font_get_size_cache_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1254. Returns list of the font sizes in the cache. Each size is :ref:`Vector2i<class_Vector2i>` with font size and outline size.
  1255. .. rst-class:: classref-item-separator
  1256. ----
  1257. .. _class_TextServer_method_font_get_spacing:
  1258. .. rst-class:: classref-method
  1259. :ref:`int<class_int>` **font_get_spacing** **(** :ref:`RID<class_RID>` font_rid, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |const|
  1260. Returns the spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) in pixels (not relative to the font size).
  1261. .. rst-class:: classref-item-separator
  1262. ----
  1263. .. _class_TextServer_method_font_get_stretch:
  1264. .. rst-class:: classref-method
  1265. :ref:`int<class_int>` **font_get_stretch** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1266. Returns font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1267. .. rst-class:: classref-item-separator
  1268. ----
  1269. .. _class_TextServer_method_font_get_style:
  1270. .. rst-class:: classref-method
  1271. |bitfield|\<:ref:`FontStyle<enum_TextServer_FontStyle>`\> **font_get_style** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1272. Returns font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1273. .. rst-class:: classref-item-separator
  1274. ----
  1275. .. _class_TextServer_method_font_get_style_name:
  1276. .. rst-class:: classref-method
  1277. :ref:`String<class_String>` **font_get_style_name** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1278. Returns font style name.
  1279. .. rst-class:: classref-item-separator
  1280. ----
  1281. .. _class_TextServer_method_font_get_subpixel_positioning:
  1282. .. rst-class:: classref-method
  1283. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **font_get_subpixel_positioning** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1284. Returns font subpixel glyph positioning mode.
  1285. .. rst-class:: classref-item-separator
  1286. ----
  1287. .. _class_TextServer_method_font_get_supported_chars:
  1288. .. rst-class:: classref-method
  1289. :ref:`String<class_String>` **font_get_supported_chars** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1290. Returns a string containing all the characters available in the font.
  1291. .. rst-class:: classref-item-separator
  1292. ----
  1293. .. _class_TextServer_method_font_get_texture_count:
  1294. .. rst-class:: classref-method
  1295. :ref:`int<class_int>` **font_get_texture_count** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const|
  1296. Returns number of textures used by font cache entry.
  1297. .. rst-class:: classref-item-separator
  1298. ----
  1299. .. _class_TextServer_method_font_get_texture_image:
  1300. .. rst-class:: classref-method
  1301. :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|
  1302. Returns font cache texture image data.
  1303. .. rst-class:: classref-item-separator
  1304. ----
  1305. .. _class_TextServer_method_font_get_texture_offsets:
  1306. .. rst-class:: classref-method
  1307. :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|
  1308. Returns array containing glyph packing data.
  1309. .. rst-class:: classref-item-separator
  1310. ----
  1311. .. _class_TextServer_method_font_get_transform:
  1312. .. rst-class:: classref-method
  1313. :ref:`Transform2D<class_Transform2D>` **font_get_transform** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1314. Returns 2D transform applied to the font outlines.
  1315. .. rst-class:: classref-item-separator
  1316. ----
  1317. .. _class_TextServer_method_font_get_underline_position:
  1318. .. rst-class:: classref-method
  1319. :ref:`float<class_float>` **font_get_underline_position** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1320. Returns pixel offset of the underline below the baseline.
  1321. .. rst-class:: classref-item-separator
  1322. ----
  1323. .. _class_TextServer_method_font_get_underline_thickness:
  1324. .. rst-class:: classref-method
  1325. :ref:`float<class_float>` **font_get_underline_thickness** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1326. Returns thickness of the underline in pixels.
  1327. .. rst-class:: classref-item-separator
  1328. ----
  1329. .. _class_TextServer_method_font_get_variation_coordinates:
  1330. .. rst-class:: classref-method
  1331. :ref:`Dictionary<class_Dictionary>` **font_get_variation_coordinates** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1332. 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.
  1333. .. rst-class:: classref-item-separator
  1334. ----
  1335. .. _class_TextServer_method_font_get_weight:
  1336. .. rst-class:: classref-method
  1337. :ref:`int<class_int>` **font_get_weight** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1338. Returns weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1339. .. rst-class:: classref-item-separator
  1340. ----
  1341. .. _class_TextServer_method_font_has_char:
  1342. .. rst-class:: classref-method
  1343. :ref:`bool<class_bool>` **font_has_char** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` char **)** |const|
  1344. Returns ``true`` if a Unicode ``char`` is available in the font.
  1345. .. rst-class:: classref-item-separator
  1346. ----
  1347. .. _class_TextServer_method_font_is_allow_system_fallback:
  1348. .. rst-class:: classref-method
  1349. :ref:`bool<class_bool>` **font_is_allow_system_fallback** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1350. Returns ``true`` if system fonts can be automatically used as fallbacks.
  1351. .. rst-class:: classref-item-separator
  1352. ----
  1353. .. _class_TextServer_method_font_is_force_autohinter:
  1354. .. rst-class:: classref-method
  1355. :ref:`bool<class_bool>` **font_is_force_autohinter** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1356. Returns ``true`` if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.
  1357. .. rst-class:: classref-item-separator
  1358. ----
  1359. .. _class_TextServer_method_font_is_language_supported:
  1360. .. rst-class:: classref-method
  1361. :ref:`bool<class_bool>` **font_is_language_supported** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |const|
  1362. Returns ``true``, if font supports given language (`ISO 639 <https://en.wikipedia.org/wiki/ISO_639-1>`__ code).
  1363. .. rst-class:: classref-item-separator
  1364. ----
  1365. .. _class_TextServer_method_font_is_multichannel_signed_distance_field:
  1366. .. rst-class:: classref-method
  1367. :ref:`bool<class_bool>` **font_is_multichannel_signed_distance_field** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1368. Returns ``true`` if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.
  1369. .. rst-class:: classref-item-separator
  1370. ----
  1371. .. _class_TextServer_method_font_is_script_supported:
  1372. .. rst-class:: classref-method
  1373. :ref:`bool<class_bool>` **font_is_script_supported** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |const|
  1374. Returns ``true``, if font supports given script (ISO 15924 code).
  1375. .. rst-class:: classref-item-separator
  1376. ----
  1377. .. _class_TextServer_method_font_remove_glyph:
  1378. .. rst-class:: classref-method
  1379. void **font_remove_glyph** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)**
  1380. Removes specified rendered glyph information from the cache entry.
  1381. \ **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.
  1382. .. rst-class:: classref-item-separator
  1383. ----
  1384. .. _class_TextServer_method_font_remove_kerning:
  1385. .. rst-class:: classref-method
  1386. void **font_remove_kerning** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)**
  1387. Removes kerning override for the pair of glyphs.
  1388. .. rst-class:: classref-item-separator
  1389. ----
  1390. .. _class_TextServer_method_font_remove_language_support_override:
  1391. .. rst-class:: classref-method
  1392. void **font_remove_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)**
  1393. Remove language support override.
  1394. .. rst-class:: classref-item-separator
  1395. ----
  1396. .. _class_TextServer_method_font_remove_script_support_override:
  1397. .. rst-class:: classref-method
  1398. void **font_remove_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)**
  1399. Removes script support override.
  1400. .. rst-class:: classref-item-separator
  1401. ----
  1402. .. _class_TextServer_method_font_remove_size_cache:
  1403. .. rst-class:: classref-method
  1404. void **font_remove_size_cache** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)**
  1405. Removes specified font size from the cache entry.
  1406. .. rst-class:: classref-item-separator
  1407. ----
  1408. .. _class_TextServer_method_font_remove_texture:
  1409. .. rst-class:: classref-method
  1410. void **font_remove_texture** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)**
  1411. Removes specified texture from the cache entry.
  1412. \ **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>`.
  1413. .. rst-class:: classref-item-separator
  1414. ----
  1415. .. _class_TextServer_method_font_render_glyph:
  1416. .. rst-class:: classref-method
  1417. void **font_render_glyph** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` index **)**
  1418. Renders specified glyph to the font cache texture.
  1419. .. rst-class:: classref-item-separator
  1420. ----
  1421. .. _class_TextServer_method_font_render_range:
  1422. .. rst-class:: classref-method
  1423. 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 **)**
  1424. Renders the range of characters to the font cache texture.
  1425. .. rst-class:: classref-item-separator
  1426. ----
  1427. .. _class_TextServer_method_font_set_allow_system_fallback:
  1428. .. rst-class:: classref-method
  1429. void **font_set_allow_system_fallback** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` allow_system_fallback **)**
  1430. If set to ``true``, system fonts can be automatically used as fallbacks.
  1431. .. rst-class:: classref-item-separator
  1432. ----
  1433. .. _class_TextServer_method_font_set_antialiasing:
  1434. .. rst-class:: classref-method
  1435. void **font_set_antialiasing** **(** :ref:`RID<class_RID>` font_rid, :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` antialiasing **)**
  1436. Sets font anti-aliasing mode.
  1437. .. rst-class:: classref-item-separator
  1438. ----
  1439. .. _class_TextServer_method_font_set_ascent:
  1440. .. rst-class:: classref-method
  1441. void **font_set_ascent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` ascent **)**
  1442. Sets the font ascent (number of pixels above the baseline).
  1443. .. rst-class:: classref-item-separator
  1444. ----
  1445. .. _class_TextServer_method_font_set_data:
  1446. .. rst-class:: classref-method
  1447. void **font_set_data** **(** :ref:`RID<class_RID>` font_rid, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
  1448. Sets font source data, e.g contents of the dynamic font source file.
  1449. .. rst-class:: classref-item-separator
  1450. ----
  1451. .. _class_TextServer_method_font_set_descent:
  1452. .. rst-class:: classref-method
  1453. void **font_set_descent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` descent **)**
  1454. Sets the font descent (number of pixels below the baseline).
  1455. .. rst-class:: classref-item-separator
  1456. ----
  1457. .. _class_TextServer_method_font_set_embolden:
  1458. .. rst-class:: classref-method
  1459. void **font_set_embolden** **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` strength **)**
  1460. Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
  1461. .. rst-class:: classref-item-separator
  1462. ----
  1463. .. _class_TextServer_method_font_set_face_index:
  1464. .. rst-class:: classref-method
  1465. void **font_set_face_index** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` face_index **)**
  1466. Sets an active face index in the TrueType / OpenType collection.
  1467. .. rst-class:: classref-item-separator
  1468. ----
  1469. .. _class_TextServer_method_font_set_fixed_size:
  1470. .. rst-class:: classref-method
  1471. void **font_set_fixed_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` fixed_size **)**
  1472. Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.
  1473. .. rst-class:: classref-item-separator
  1474. ----
  1475. .. _class_TextServer_method_font_set_fixed_size_scale_mode:
  1476. .. rst-class:: classref-method
  1477. void **font_set_fixed_size_scale_mode** **(** :ref:`RID<class_RID>` font_rid, :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` fixed_size_scale_mode **)**
  1478. Sets bitmap font scaling mode. This property is used only if ``fixed_size`` is greater than zero.
  1479. .. rst-class:: classref-item-separator
  1480. ----
  1481. .. _class_TextServer_method_font_set_force_autohinter:
  1482. .. rst-class:: classref-method
  1483. void **font_set_force_autohinter** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` force_autohinter **)**
  1484. If set to ``true`` auto-hinting is preferred over font built-in hinting.
  1485. .. rst-class:: classref-item-separator
  1486. ----
  1487. .. _class_TextServer_method_font_set_generate_mipmaps:
  1488. .. rst-class:: classref-method
  1489. void **font_set_generate_mipmaps** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` generate_mipmaps **)**
  1490. If set to ``true`` font texture mipmap generation is enabled.
  1491. .. rst-class:: classref-item-separator
  1492. ----
  1493. .. _class_TextServer_method_font_set_global_oversampling:
  1494. .. rst-class:: classref-method
  1495. void **font_set_global_oversampling** **(** :ref:`float<class_float>` oversampling **)**
  1496. Sets oversampling factor, shared by all font in the TextServer.
  1497. \ **Note:** This value can be automatically changed by display server.
  1498. .. rst-class:: classref-item-separator
  1499. ----
  1500. .. _class_TextServer_method_font_set_glyph_advance:
  1501. .. rst-class:: classref-method
  1502. 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 **)**
  1503. Sets glyph advance (offset of the next glyph).
  1504. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1505. .. rst-class:: classref-item-separator
  1506. ----
  1507. .. _class_TextServer_method_font_set_glyph_offset:
  1508. .. rst-class:: classref-method
  1509. 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 **)**
  1510. Sets glyph offset from the baseline.
  1511. .. rst-class:: classref-item-separator
  1512. ----
  1513. .. _class_TextServer_method_font_set_glyph_size:
  1514. .. rst-class:: classref-method
  1515. 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 **)**
  1516. Sets size of the glyph.
  1517. .. rst-class:: classref-item-separator
  1518. ----
  1519. .. _class_TextServer_method_font_set_glyph_texture_idx:
  1520. .. rst-class:: classref-method
  1521. 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 **)**
  1522. Sets index of the cache texture containing the glyph.
  1523. .. rst-class:: classref-item-separator
  1524. ----
  1525. .. _class_TextServer_method_font_set_glyph_uv_rect:
  1526. .. rst-class:: classref-method
  1527. 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 **)**
  1528. Sets rectangle in the cache texture containing the glyph.
  1529. .. rst-class:: classref-item-separator
  1530. ----
  1531. .. _class_TextServer_method_font_set_hinting:
  1532. .. rst-class:: classref-method
  1533. void **font_set_hinting** **(** :ref:`RID<class_RID>` font_rid, :ref:`Hinting<enum_TextServer_Hinting>` hinting **)**
  1534. Sets font hinting mode. Used by dynamic fonts only.
  1535. .. rst-class:: classref-item-separator
  1536. ----
  1537. .. _class_TextServer_method_font_set_kerning:
  1538. .. rst-class:: classref-method
  1539. 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 **)**
  1540. Sets kerning for the pair of glyphs.
  1541. .. rst-class:: classref-item-separator
  1542. ----
  1543. .. _class_TextServer_method_font_set_language_support_override:
  1544. .. rst-class:: classref-method
  1545. void **font_set_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language, :ref:`bool<class_bool>` supported **)**
  1546. Adds override for :ref:`font_is_language_supported<class_TextServer_method_font_is_language_supported>`.
  1547. .. rst-class:: classref-item-separator
  1548. ----
  1549. .. _class_TextServer_method_font_set_msdf_pixel_range:
  1550. .. rst-class:: classref-method
  1551. void **font_set_msdf_pixel_range** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_pixel_range **)**
  1552. Sets the width of the range around the shape between the minimum and maximum representable signed distance.
  1553. .. rst-class:: classref-item-separator
  1554. ----
  1555. .. _class_TextServer_method_font_set_msdf_size:
  1556. .. rst-class:: classref-method
  1557. void **font_set_msdf_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_size **)**
  1558. Sets source font size used to generate MSDF textures.
  1559. .. rst-class:: classref-item-separator
  1560. ----
  1561. .. _class_TextServer_method_font_set_multichannel_signed_distance_field:
  1562. .. rst-class:: classref-method
  1563. void **font_set_multichannel_signed_distance_field** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` msdf **)**
  1564. 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.
  1565. \ **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.
  1566. .. rst-class:: classref-item-separator
  1567. ----
  1568. .. _class_TextServer_method_font_set_name:
  1569. .. rst-class:: classref-method
  1570. void **font_set_name** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)**
  1571. Sets the font family name.
  1572. .. rst-class:: classref-item-separator
  1573. ----
  1574. .. _class_TextServer_method_font_set_opentype_feature_overrides:
  1575. .. rst-class:: classref-method
  1576. void **font_set_opentype_feature_overrides** **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` overrides **)**
  1577. Sets font OpenType feature set override.
  1578. .. rst-class:: classref-item-separator
  1579. ----
  1580. .. _class_TextServer_method_font_set_oversampling:
  1581. .. rst-class:: classref-method
  1582. void **font_set_oversampling** **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` oversampling **)**
  1583. Sets font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1584. .. rst-class:: classref-item-separator
  1585. ----
  1586. .. _class_TextServer_method_font_set_scale:
  1587. .. rst-class:: classref-method
  1588. void **font_set_scale** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` scale **)**
  1589. Sets scaling factor of the color bitmap font.
  1590. .. rst-class:: classref-item-separator
  1591. ----
  1592. .. _class_TextServer_method_font_set_script_support_override:
  1593. .. rst-class:: classref-method
  1594. void **font_set_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script, :ref:`bool<class_bool>` supported **)**
  1595. Adds override for :ref:`font_is_script_supported<class_TextServer_method_font_is_script_supported>`.
  1596. .. rst-class:: classref-item-separator
  1597. ----
  1598. .. _class_TextServer_method_font_set_spacing:
  1599. .. rst-class:: classref-method
  1600. void **font_set_spacing** **(** :ref:`RID<class_RID>` font_rid, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)**
  1601. Sets the spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) to ``value`` in pixels (not relative to the font size).
  1602. .. rst-class:: classref-item-separator
  1603. ----
  1604. .. _class_TextServer_method_font_set_stretch:
  1605. .. rst-class:: classref-method
  1606. void **font_set_stretch** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)**
  1607. Sets font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1608. \ **Note:** This value is used for font matching only and will not affect font rendering. Use :ref:`font_set_face_index<class_TextServer_method_font_set_face_index>`, :ref:`font_set_variation_coordinates<class_TextServer_method_font_set_variation_coordinates>`, or :ref:`font_set_transform<class_TextServer_method_font_set_transform>` instead.
  1609. .. rst-class:: classref-item-separator
  1610. ----
  1611. .. _class_TextServer_method_font_set_style:
  1612. .. rst-class:: classref-method
  1613. void **font_set_style** **(** :ref:`RID<class_RID>` font_rid, |bitfield|\<:ref:`FontStyle<enum_TextServer_FontStyle>`\> style **)**
  1614. Sets the font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1615. \ **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.
  1616. .. rst-class:: classref-item-separator
  1617. ----
  1618. .. _class_TextServer_method_font_set_style_name:
  1619. .. rst-class:: classref-method
  1620. void **font_set_style_name** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)**
  1621. Sets the font style name.
  1622. .. rst-class:: classref-item-separator
  1623. ----
  1624. .. _class_TextServer_method_font_set_subpixel_positioning:
  1625. .. rst-class:: classref-method
  1626. void **font_set_subpixel_positioning** **(** :ref:`RID<class_RID>` font_rid, :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` subpixel_positioning **)**
  1627. Sets font subpixel glyph positioning mode.
  1628. .. rst-class:: classref-item-separator
  1629. ----
  1630. .. _class_TextServer_method_font_set_texture_image:
  1631. .. rst-class:: classref-method
  1632. 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 **)**
  1633. Sets font cache texture image data.
  1634. .. rst-class:: classref-item-separator
  1635. ----
  1636. .. _class_TextServer_method_font_set_texture_offsets:
  1637. .. rst-class:: classref-method
  1638. 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 **)**
  1639. Sets array containing glyph packing data.
  1640. .. rst-class:: classref-item-separator
  1641. ----
  1642. .. _class_TextServer_method_font_set_transform:
  1643. .. rst-class:: classref-method
  1644. void **font_set_transform** **(** :ref:`RID<class_RID>` font_rid, :ref:`Transform2D<class_Transform2D>` transform **)**
  1645. Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs.
  1646. For example, to simulate italic typeface by slanting, apply the following transform ``Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)``.
  1647. .. rst-class:: classref-item-separator
  1648. ----
  1649. .. _class_TextServer_method_font_set_underline_position:
  1650. .. rst-class:: classref-method
  1651. void **font_set_underline_position** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_position **)**
  1652. Sets pixel offset of the underline below the baseline.
  1653. .. rst-class:: classref-item-separator
  1654. ----
  1655. .. _class_TextServer_method_font_set_underline_thickness:
  1656. .. rst-class:: classref-method
  1657. void **font_set_underline_thickness** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_thickness **)**
  1658. Sets thickness of the underline in pixels.
  1659. .. rst-class:: classref-item-separator
  1660. ----
  1661. .. _class_TextServer_method_font_set_variation_coordinates:
  1662. .. rst-class:: classref-method
  1663. void **font_set_variation_coordinates** **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` variation_coordinates **)**
  1664. 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.
  1665. .. rst-class:: classref-item-separator
  1666. ----
  1667. .. _class_TextServer_method_font_set_weight:
  1668. .. rst-class:: classref-method
  1669. void **font_set_weight** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)**
  1670. Sets weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1671. \ **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.
  1672. .. rst-class:: classref-item-separator
  1673. ----
  1674. .. _class_TextServer_method_font_supported_feature_list:
  1675. .. rst-class:: classref-method
  1676. :ref:`Dictionary<class_Dictionary>` **font_supported_feature_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1677. Returns the dictionary of the supported OpenType features.
  1678. .. rst-class:: classref-item-separator
  1679. ----
  1680. .. _class_TextServer_method_font_supported_variation_list:
  1681. .. rst-class:: classref-method
  1682. :ref:`Dictionary<class_Dictionary>` **font_supported_variation_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1683. Returns the dictionary of the supported OpenType variation coordinates.
  1684. .. rst-class:: classref-item-separator
  1685. ----
  1686. .. _class_TextServer_method_format_number:
  1687. .. rst-class:: classref-method
  1688. :ref:`String<class_String>` **format_number** **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const|
  1689. Converts a number from the Western Arabic (0..9) to the numeral systems used in ``language``.
  1690. If ``language`` is omitted, the active locale will be used.
  1691. .. rst-class:: classref-item-separator
  1692. ----
  1693. .. _class_TextServer_method_free_rid:
  1694. .. rst-class:: classref-method
  1695. void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
  1696. Frees an object created by this **TextServer**.
  1697. .. rst-class:: classref-item-separator
  1698. ----
  1699. .. _class_TextServer_method_get_features:
  1700. .. rst-class:: classref-method
  1701. :ref:`int<class_int>` **get_features** **(** **)** |const|
  1702. Returns text server features, see :ref:`Feature<enum_TextServer_Feature>`.
  1703. .. rst-class:: classref-item-separator
  1704. ----
  1705. .. _class_TextServer_method_get_hex_code_box_size:
  1706. .. rst-class:: classref-method
  1707. :ref:`Vector2<class_Vector2>` **get_hex_code_box_size** **(** :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |const|
  1708. Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).
  1709. .. rst-class:: classref-item-separator
  1710. ----
  1711. .. _class_TextServer_method_get_name:
  1712. .. rst-class:: classref-method
  1713. :ref:`String<class_String>` **get_name** **(** **)** |const|
  1714. Returns the name of the server interface.
  1715. .. rst-class:: classref-item-separator
  1716. ----
  1717. .. _class_TextServer_method_get_support_data_filename:
  1718. .. rst-class:: classref-method
  1719. :ref:`String<class_String>` **get_support_data_filename** **(** **)** |const|
  1720. Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename.
  1721. .. rst-class:: classref-item-separator
  1722. ----
  1723. .. _class_TextServer_method_get_support_data_info:
  1724. .. rst-class:: classref-method
  1725. :ref:`String<class_String>` **get_support_data_info** **(** **)** |const|
  1726. Returns TextServer database (e.g. ICU break iterators and dictionaries) description.
  1727. .. rst-class:: classref-item-separator
  1728. ----
  1729. .. _class_TextServer_method_has:
  1730. .. rst-class:: classref-method
  1731. :ref:`bool<class_bool>` **has** **(** :ref:`RID<class_RID>` rid **)**
  1732. Returns ``true`` if ``rid`` is valid resource owned by this text server.
  1733. .. rst-class:: classref-item-separator
  1734. ----
  1735. .. _class_TextServer_method_has_feature:
  1736. .. rst-class:: classref-method
  1737. :ref:`bool<class_bool>` **has_feature** **(** :ref:`Feature<enum_TextServer_Feature>` feature **)** |const|
  1738. Returns ``true`` if the server supports a feature.
  1739. .. rst-class:: classref-item-separator
  1740. ----
  1741. .. _class_TextServer_method_is_confusable:
  1742. .. rst-class:: classref-method
  1743. :ref:`int<class_int>` **is_confusable** **(** :ref:`String<class_String>` string, :ref:`PackedStringArray<class_PackedStringArray>` dict **)** |const|
  1744. Returns index of the first string in ``dict`` which is visually confusable with the ``string``, or ``-1`` if none is found.
  1745. \ **Note:** This method doesn't detect invisible characters, for spoof detection use it in combination with :ref:`spoof_check<class_TextServer_method_spoof_check>`.
  1746. \ **Note:** Always returns ``-1`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  1747. .. rst-class:: classref-item-separator
  1748. ----
  1749. .. _class_TextServer_method_is_locale_right_to_left:
  1750. .. rst-class:: classref-method
  1751. :ref:`bool<class_bool>` **is_locale_right_to_left** **(** :ref:`String<class_String>` locale **)** |const|
  1752. Returns ``true`` if locale is right-to-left.
  1753. .. rst-class:: classref-item-separator
  1754. ----
  1755. .. _class_TextServer_method_is_valid_identifier:
  1756. .. rst-class:: classref-method
  1757. :ref:`bool<class_bool>` **is_valid_identifier** **(** :ref:`String<class_String>` string **)** |const|
  1758. Returns ``true`` if ``string`` is a valid identifier.
  1759. If the text server supports the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature, a valid identifier must:
  1760. - Conform to normalization form C.
  1761. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1762. - May contain Unicode characters of class XID_Continue in the other positions.
  1763. - Use UAX #31 recommended scripts only (mixed scripts are allowed).
  1764. If the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature is not supported, a valid identifier must:
  1765. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1766. - May contain Unicode characters of class XID_Continue in the other positions.
  1767. .. rst-class:: classref-item-separator
  1768. ----
  1769. .. _class_TextServer_method_load_support_data:
  1770. .. rst-class:: classref-method
  1771. :ref:`bool<class_bool>` **load_support_data** **(** :ref:`String<class_String>` filename **)**
  1772. Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
  1773. \ **Note:** This function should be called before any other TextServer functions used, otherwise it won't have any effect.
  1774. .. rst-class:: classref-item-separator
  1775. ----
  1776. .. _class_TextServer_method_name_to_tag:
  1777. .. rst-class:: classref-method
  1778. :ref:`int<class_int>` **name_to_tag** **(** :ref:`String<class_String>` name **)** |const|
  1779. Converts readable feature, variation, script or language name to OpenType tag.
  1780. .. rst-class:: classref-item-separator
  1781. ----
  1782. .. _class_TextServer_method_parse_number:
  1783. .. rst-class:: classref-method
  1784. :ref:`String<class_String>` **parse_number** **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const|
  1785. Converts ``number`` from the numeral systems used in ``language`` to Western Arabic (0..9).
  1786. .. rst-class:: classref-item-separator
  1787. ----
  1788. .. _class_TextServer_method_parse_structured_text:
  1789. .. rst-class:: classref-method
  1790. :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|
  1791. Default implementation of the BiDi algorithm override function. See :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` for more info.
  1792. .. rst-class:: classref-item-separator
  1793. ----
  1794. .. _class_TextServer_method_percent_sign:
  1795. .. rst-class:: classref-method
  1796. :ref:`String<class_String>` **percent_sign** **(** :ref:`String<class_String>` language="" **)** |const|
  1797. Returns percent sign used in the ``language``.
  1798. .. rst-class:: classref-item-separator
  1799. ----
  1800. .. _class_TextServer_method_save_support_data:
  1801. .. rst-class:: classref-method
  1802. :ref:`bool<class_bool>` **save_support_data** **(** :ref:`String<class_String>` filename **)** |const|
  1803. Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.
  1804. \ **Note:** This function is used by during project export, to include TextServer database.
  1805. .. rst-class:: classref-item-separator
  1806. ----
  1807. .. _class_TextServer_method_shaped_get_span_count:
  1808. .. rst-class:: classref-method
  1809. :ref:`int<class_int>` **shaped_get_span_count** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1810. 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>`.
  1811. .. rst-class:: classref-item-separator
  1812. ----
  1813. .. _class_TextServer_method_shaped_get_span_meta:
  1814. .. rst-class:: classref-method
  1815. :ref:`Variant<class_Variant>` **shaped_get_span_meta** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` index **)** |const|
  1816. Returns text span metadata.
  1817. .. rst-class:: classref-item-separator
  1818. ----
  1819. .. _class_TextServer_method_shaped_set_span_update_font:
  1820. .. rst-class:: classref-method
  1821. 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={} **)**
  1822. Changes text span font, font size and OpenType features, without changing the text.
  1823. .. rst-class:: classref-item-separator
  1824. ----
  1825. .. _class_TextServer_method_shaped_text_add_object:
  1826. .. rst-class:: classref-method
  1827. :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 **)**
  1828. Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters.
  1829. .. rst-class:: classref-item-separator
  1830. ----
  1831. .. _class_TextServer_method_shaped_text_add_string:
  1832. .. rst-class:: classref-method
  1833. :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 **)**
  1834. Adds text span and font to draw it to the text buffer.
  1835. .. rst-class:: classref-item-separator
  1836. ----
  1837. .. _class_TextServer_method_shaped_text_clear:
  1838. .. rst-class:: classref-method
  1839. void **shaped_text_clear** **(** :ref:`RID<class_RID>` rid **)**
  1840. Clears text buffer (removes text and inline objects).
  1841. .. rst-class:: classref-item-separator
  1842. ----
  1843. .. _class_TextServer_method_shaped_text_closest_character_pos:
  1844. .. rst-class:: classref-method
  1845. :ref:`int<class_int>` **shaped_text_closest_character_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  1846. Returns composite character position closest to the ``pos``.
  1847. .. rst-class:: classref-item-separator
  1848. ----
  1849. .. _class_TextServer_method_shaped_text_draw:
  1850. .. rst-class:: classref-method
  1851. 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|
  1852. 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).
  1853. .. rst-class:: classref-item-separator
  1854. ----
  1855. .. _class_TextServer_method_shaped_text_draw_outline:
  1856. .. rst-class:: classref-method
  1857. 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|
  1858. 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).
  1859. .. rst-class:: classref-item-separator
  1860. ----
  1861. .. _class_TextServer_method_shaped_text_fit_to_width:
  1862. .. rst-class:: classref-method
  1863. :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 **)**
  1864. Adjusts text width to fit to specified width, returns new text width.
  1865. .. rst-class:: classref-item-separator
  1866. ----
  1867. .. _class_TextServer_method_shaped_text_get_ascent:
  1868. .. rst-class:: classref-method
  1869. :ref:`float<class_float>` **shaped_text_get_ascent** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1870. Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
  1871. \ **Note:** Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline.
  1872. .. rst-class:: classref-item-separator
  1873. ----
  1874. .. _class_TextServer_method_shaped_text_get_carets:
  1875. .. rst-class:: classref-method
  1876. :ref:`Dictionary<class_Dictionary>` **shaped_text_get_carets** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` position **)** |const|
  1877. Returns shapes of the carets corresponding to the character offset ``position`` in the text. Returned caret shape is 1 pixel wide rectangle.
  1878. .. rst-class:: classref-item-separator
  1879. ----
  1880. .. _class_TextServer_method_shaped_text_get_character_breaks:
  1881. .. rst-class:: classref-method
  1882. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_character_breaks** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1883. Returns array of the composite character boundaries.
  1884. .. rst-class:: classref-item-separator
  1885. ----
  1886. .. _class_TextServer_method_shaped_text_get_custom_punctuation:
  1887. .. rst-class:: classref-method
  1888. :ref:`String<class_String>` **shaped_text_get_custom_punctuation** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1889. Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  1890. .. rst-class:: classref-item-separator
  1891. ----
  1892. .. _class_TextServer_method_shaped_text_get_descent:
  1893. .. rst-class:: classref-method
  1894. :ref:`float<class_float>` **shaped_text_get_descent** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1895. Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
  1896. \ **Note:** Overall descent can be higher than font descent, if some glyphs are displaced from the baseline.
  1897. .. rst-class:: classref-item-separator
  1898. ----
  1899. .. _class_TextServer_method_shaped_text_get_direction:
  1900. .. rst-class:: classref-method
  1901. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_direction** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1902. Returns direction of the text.
  1903. .. rst-class:: classref-item-separator
  1904. ----
  1905. .. _class_TextServer_method_shaped_text_get_dominant_direction_in_range:
  1906. .. rst-class:: classref-method
  1907. :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|
  1908. Returns dominant direction of in the range of text.
  1909. .. rst-class:: classref-item-separator
  1910. ----
  1911. .. _class_TextServer_method_shaped_text_get_ellipsis_glyph_count:
  1912. .. rst-class:: classref-method
  1913. :ref:`int<class_int>` **shaped_text_get_ellipsis_glyph_count** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1914. Returns number of glyphs in the ellipsis.
  1915. .. rst-class:: classref-item-separator
  1916. ----
  1917. .. _class_TextServer_method_shaped_text_get_ellipsis_glyphs:
  1918. .. rst-class:: classref-method
  1919. :ref:`Dictionary[]<class_Dictionary>` **shaped_text_get_ellipsis_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1920. Returns array of the glyphs in the ellipsis.
  1921. .. rst-class:: classref-item-separator
  1922. ----
  1923. .. _class_TextServer_method_shaped_text_get_ellipsis_pos:
  1924. .. rst-class:: classref-method
  1925. :ref:`int<class_int>` **shaped_text_get_ellipsis_pos** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1926. Returns position of the ellipsis.
  1927. .. rst-class:: classref-item-separator
  1928. ----
  1929. .. _class_TextServer_method_shaped_text_get_glyph_count:
  1930. .. rst-class:: classref-method
  1931. :ref:`int<class_int>` **shaped_text_get_glyph_count** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1932. Returns number of glyphs in the buffer.
  1933. .. rst-class:: classref-item-separator
  1934. ----
  1935. .. _class_TextServer_method_shaped_text_get_glyphs:
  1936. .. rst-class:: classref-method
  1937. :ref:`Dictionary[]<class_Dictionary>` **shaped_text_get_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1938. Returns an array of glyphs in the visual order.
  1939. .. rst-class:: classref-item-separator
  1940. ----
  1941. .. _class_TextServer_method_shaped_text_get_grapheme_bounds:
  1942. .. rst-class:: classref-method
  1943. :ref:`Vector2<class_Vector2>` **shaped_text_get_grapheme_bounds** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  1944. Returns composite character's bounds as offsets from the start of the line.
  1945. .. rst-class:: classref-item-separator
  1946. ----
  1947. .. _class_TextServer_method_shaped_text_get_inferred_direction:
  1948. .. rst-class:: classref-method
  1949. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_inferred_direction** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1950. Returns direction of the text, inferred by the BiDi algorithm.
  1951. .. rst-class:: classref-item-separator
  1952. ----
  1953. .. _class_TextServer_method_shaped_text_get_line_breaks:
  1954. .. rst-class:: classref-method
  1955. :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|
  1956. Breaks text to the lines and returns character ranges for each line.
  1957. .. rst-class:: classref-item-separator
  1958. ----
  1959. .. _class_TextServer_method_shaped_text_get_line_breaks_adv:
  1960. .. rst-class:: classref-method
  1961. :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|
  1962. Breaks text to the lines and columns. Returns character ranges for each segment.
  1963. .. rst-class:: classref-item-separator
  1964. ----
  1965. .. _class_TextServer_method_shaped_text_get_object_rect:
  1966. .. rst-class:: classref-method
  1967. :ref:`Rect2<class_Rect2>` **shaped_text_get_object_rect** **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key **)** |const|
  1968. Returns bounding rectangle of the inline object.
  1969. .. rst-class:: classref-item-separator
  1970. ----
  1971. .. _class_TextServer_method_shaped_text_get_objects:
  1972. .. rst-class:: classref-method
  1973. :ref:`Array<class_Array>` **shaped_text_get_objects** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1974. Returns array of inline objects.
  1975. .. rst-class:: classref-item-separator
  1976. ----
  1977. .. _class_TextServer_method_shaped_text_get_orientation:
  1978. .. rst-class:: classref-method
  1979. :ref:`Orientation<enum_TextServer_Orientation>` **shaped_text_get_orientation** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1980. Returns text orientation.
  1981. .. rst-class:: classref-item-separator
  1982. ----
  1983. .. _class_TextServer_method_shaped_text_get_parent:
  1984. .. rst-class:: classref-method
  1985. :ref:`RID<class_RID>` **shaped_text_get_parent** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1986. Returns the parent buffer from which the substring originates.
  1987. .. rst-class:: classref-item-separator
  1988. ----
  1989. .. _class_TextServer_method_shaped_text_get_preserve_control:
  1990. .. rst-class:: classref-method
  1991. :ref:`bool<class_bool>` **shaped_text_get_preserve_control** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1992. Returns ``true`` if text buffer is configured to display control characters.
  1993. .. rst-class:: classref-item-separator
  1994. ----
  1995. .. _class_TextServer_method_shaped_text_get_preserve_invalid:
  1996. .. rst-class:: classref-method
  1997. :ref:`bool<class_bool>` **shaped_text_get_preserve_invalid** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1998. Returns ``true`` if text buffer is configured to display hexadecimal codes in place of invalid characters.
  1999. \ **Note:** If set to ``false``, nothing is displayed in place of invalid characters.
  2000. .. rst-class:: classref-item-separator
  2001. ----
  2002. .. _class_TextServer_method_shaped_text_get_range:
  2003. .. rst-class:: classref-method
  2004. :ref:`Vector2i<class_Vector2i>` **shaped_text_get_range** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2005. Returns substring buffer character range in the parent buffer.
  2006. .. rst-class:: classref-item-separator
  2007. ----
  2008. .. _class_TextServer_method_shaped_text_get_selection:
  2009. .. rst-class:: classref-method
  2010. :ref:`PackedVector2Array<class_PackedVector2Array>` **shaped_text_get_selection** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |const|
  2011. Returns selection rectangles for the specified character range.
  2012. .. rst-class:: classref-item-separator
  2013. ----
  2014. .. _class_TextServer_method_shaped_text_get_size:
  2015. .. rst-class:: classref-method
  2016. :ref:`Vector2<class_Vector2>` **shaped_text_get_size** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2017. Returns size of the text.
  2018. .. rst-class:: classref-item-separator
  2019. ----
  2020. .. _class_TextServer_method_shaped_text_get_spacing:
  2021. .. rst-class:: classref-method
  2022. :ref:`int<class_int>` **shaped_text_get_spacing** **(** :ref:`RID<class_RID>` shaped, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |const|
  2023. Returns extra spacing added between glyphs or lines in pixels.
  2024. .. rst-class:: classref-item-separator
  2025. ----
  2026. .. _class_TextServer_method_shaped_text_get_trim_pos:
  2027. .. rst-class:: classref-method
  2028. :ref:`int<class_int>` **shaped_text_get_trim_pos** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2029. Returns the position of the overrun trim.
  2030. .. rst-class:: classref-item-separator
  2031. ----
  2032. .. _class_TextServer_method_shaped_text_get_underline_position:
  2033. .. rst-class:: classref-method
  2034. :ref:`float<class_float>` **shaped_text_get_underline_position** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2035. Returns pixel offset of the underline below the baseline.
  2036. .. rst-class:: classref-item-separator
  2037. ----
  2038. .. _class_TextServer_method_shaped_text_get_underline_thickness:
  2039. .. rst-class:: classref-method
  2040. :ref:`float<class_float>` **shaped_text_get_underline_thickness** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2041. Returns thickness of the underline.
  2042. .. rst-class:: classref-item-separator
  2043. ----
  2044. .. _class_TextServer_method_shaped_text_get_width:
  2045. .. rst-class:: classref-method
  2046. :ref:`float<class_float>` **shaped_text_get_width** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2047. Returns width (for horizontal layout) or height (for vertical) of the text.
  2048. .. rst-class:: classref-item-separator
  2049. ----
  2050. .. _class_TextServer_method_shaped_text_get_word_breaks:
  2051. .. rst-class:: classref-method
  2052. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_word_breaks** **(** :ref:`RID<class_RID>` shaped, |bitfield|\<:ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`\> grapheme_flags=264 **)** |const|
  2053. 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>`).
  2054. .. rst-class:: classref-item-separator
  2055. ----
  2056. .. _class_TextServer_method_shaped_text_has_visible_chars:
  2057. .. rst-class:: classref-method
  2058. :ref:`bool<class_bool>` **shaped_text_has_visible_chars** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2059. Returns ``true`` if text buffer contains any visible characters.
  2060. .. rst-class:: classref-item-separator
  2061. ----
  2062. .. _class_TextServer_method_shaped_text_hit_test_grapheme:
  2063. .. rst-class:: classref-method
  2064. :ref:`int<class_int>` **shaped_text_hit_test_grapheme** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coords **)** |const|
  2065. Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` if none is found.
  2066. .. rst-class:: classref-item-separator
  2067. ----
  2068. .. _class_TextServer_method_shaped_text_hit_test_position:
  2069. .. rst-class:: classref-method
  2070. :ref:`int<class_int>` **shaped_text_hit_test_position** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coords **)** |const|
  2071. Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
  2072. .. rst-class:: classref-item-separator
  2073. ----
  2074. .. _class_TextServer_method_shaped_text_is_ready:
  2075. .. rst-class:: classref-method
  2076. :ref:`bool<class_bool>` **shaped_text_is_ready** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2077. Returns ``true`` if buffer is successfully shaped.
  2078. .. rst-class:: classref-item-separator
  2079. ----
  2080. .. _class_TextServer_method_shaped_text_next_character_pos:
  2081. .. rst-class:: classref-method
  2082. :ref:`int<class_int>` **shaped_text_next_character_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  2083. Returns composite character end position closest to the ``pos``.
  2084. .. rst-class:: classref-item-separator
  2085. ----
  2086. .. _class_TextServer_method_shaped_text_next_grapheme_pos:
  2087. .. rst-class:: classref-method
  2088. :ref:`int<class_int>` **shaped_text_next_grapheme_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  2089. Returns grapheme end position closest to the ``pos``.
  2090. .. rst-class:: classref-item-separator
  2091. ----
  2092. .. _class_TextServer_method_shaped_text_overrun_trim_to_width:
  2093. .. rst-class:: classref-method
  2094. 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 **)**
  2095. Trims text if it exceeds the given width.
  2096. .. rst-class:: classref-item-separator
  2097. ----
  2098. .. _class_TextServer_method_shaped_text_prev_character_pos:
  2099. .. rst-class:: classref-method
  2100. :ref:`int<class_int>` **shaped_text_prev_character_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  2101. Returns composite character start position closest to the ``pos``.
  2102. .. rst-class:: classref-item-separator
  2103. ----
  2104. .. _class_TextServer_method_shaped_text_prev_grapheme_pos:
  2105. .. rst-class:: classref-method
  2106. :ref:`int<class_int>` **shaped_text_prev_grapheme_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  2107. Returns grapheme start position closest to the ``pos``.
  2108. .. rst-class:: classref-item-separator
  2109. ----
  2110. .. _class_TextServer_method_shaped_text_resize_object:
  2111. .. rst-class:: classref-method
  2112. :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 **)**
  2113. Sets new size and alignment of embedded object.
  2114. .. rst-class:: classref-item-separator
  2115. ----
  2116. .. _class_TextServer_method_shaped_text_set_bidi_override:
  2117. .. rst-class:: classref-method
  2118. void **shaped_text_set_bidi_override** **(** :ref:`RID<class_RID>` shaped, :ref:`Array<class_Array>` override **)**
  2119. Overrides BiDi for the structured text.
  2120. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
  2121. .. rst-class:: classref-item-separator
  2122. ----
  2123. .. _class_TextServer_method_shaped_text_set_custom_punctuation:
  2124. .. rst-class:: classref-method
  2125. void **shaped_text_set_custom_punctuation** **(** :ref:`RID<class_RID>` shaped, :ref:`String<class_String>` punct **)**
  2126. Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  2127. .. rst-class:: classref-item-separator
  2128. ----
  2129. .. _class_TextServer_method_shaped_text_set_direction:
  2130. .. rst-class:: classref-method
  2131. void **shaped_text_set_direction** **(** :ref:`RID<class_RID>` shaped, :ref:`Direction<enum_TextServer_Direction>` direction=0 **)**
  2132. 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.
  2133. \ **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>`).
  2134. .. rst-class:: classref-item-separator
  2135. ----
  2136. .. _class_TextServer_method_shaped_text_set_orientation:
  2137. .. rst-class:: classref-method
  2138. void **shaped_text_set_orientation** **(** :ref:`RID<class_RID>` shaped, :ref:`Orientation<enum_TextServer_Orientation>` orientation=0 **)**
  2139. Sets desired text orientation.
  2140. \ **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>`).
  2141. .. rst-class:: classref-item-separator
  2142. ----
  2143. .. _class_TextServer_method_shaped_text_set_preserve_control:
  2144. .. rst-class:: classref-method
  2145. void **shaped_text_set_preserve_control** **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)**
  2146. If set to ``true`` text buffer will display control characters.
  2147. .. rst-class:: classref-item-separator
  2148. ----
  2149. .. _class_TextServer_method_shaped_text_set_preserve_invalid:
  2150. .. rst-class:: classref-method
  2151. void **shaped_text_set_preserve_invalid** **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)**
  2152. If set to ``true`` text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.
  2153. .. rst-class:: classref-item-separator
  2154. ----
  2155. .. _class_TextServer_method_shaped_text_set_spacing:
  2156. .. rst-class:: classref-method
  2157. void **shaped_text_set_spacing** **(** :ref:`RID<class_RID>` shaped, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)**
  2158. Sets extra spacing added between glyphs or lines in pixels.
  2159. .. rst-class:: classref-item-separator
  2160. ----
  2161. .. _class_TextServer_method_shaped_text_shape:
  2162. .. rst-class:: classref-method
  2163. :ref:`bool<class_bool>` **shaped_text_shape** **(** :ref:`RID<class_RID>` shaped **)**
  2164. Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped successfully.
  2165. \ **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.
  2166. .. rst-class:: classref-item-separator
  2167. ----
  2168. .. _class_TextServer_method_shaped_text_sort_logical:
  2169. .. rst-class:: classref-method
  2170. :ref:`Dictionary[]<class_Dictionary>` **shaped_text_sort_logical** **(** :ref:`RID<class_RID>` shaped **)**
  2171. Returns text glyphs in the logical order.
  2172. .. rst-class:: classref-item-separator
  2173. ----
  2174. .. _class_TextServer_method_shaped_text_substr:
  2175. .. rst-class:: classref-method
  2176. :ref:`RID<class_RID>` **shaped_text_substr** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` length **)** |const|
  2177. Returns text buffer for the substring of the text in the ``shaped`` text buffer (including inline objects).
  2178. .. rst-class:: classref-item-separator
  2179. ----
  2180. .. _class_TextServer_method_shaped_text_tab_align:
  2181. .. rst-class:: classref-method
  2182. :ref:`float<class_float>` **shaped_text_tab_align** **(** :ref:`RID<class_RID>` shaped, :ref:`PackedFloat32Array<class_PackedFloat32Array>` tab_stops **)**
  2183. Aligns shaped text to the given tab-stops.
  2184. .. rst-class:: classref-item-separator
  2185. ----
  2186. .. _class_TextServer_method_spoof_check:
  2187. .. rst-class:: classref-method
  2188. :ref:`bool<class_bool>` **spoof_check** **(** :ref:`String<class_String>` string **)** |const|
  2189. Returns ``true`` if ``string`` is likely to be an attempt at confusing the reader.
  2190. \ **Note:** Always returns ``false`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  2191. .. rst-class:: classref-item-separator
  2192. ----
  2193. .. _class_TextServer_method_string_get_character_breaks:
  2194. .. rst-class:: classref-method
  2195. :ref:`PackedInt32Array<class_PackedInt32Array>` **string_get_character_breaks** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const|
  2196. Returns array of the composite character boundaries.
  2197. ::
  2198. var ts = TextServerManager.get_primary_interface()
  2199. print(ts.string_get_word_breaks("Test ❤️‍🔥 Test")) # Prints [1, 2, 3, 4, 5, 9, 10, 11, 12, 13, 14]
  2200. .. rst-class:: classref-item-separator
  2201. ----
  2202. .. _class_TextServer_method_string_get_word_breaks:
  2203. .. rst-class:: classref-method
  2204. :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|
  2205. 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.
  2206. When ``chars_per_line`` is greater than zero, line break boundaries are returned instead.
  2207. ::
  2208. var ts = TextServerManager.get_primary_interface()
  2209. print(ts.string_get_word_breaks("Godot Engine")) # Prints [0, 5, 6, 12]
  2210. print(ts.string_get_word_breaks("Godot Engine", "en", 5)) # Prints [0, 5, 6, 11, 11, 12]
  2211. .. rst-class:: classref-item-separator
  2212. ----
  2213. .. _class_TextServer_method_string_to_lower:
  2214. .. rst-class:: classref-method
  2215. :ref:`String<class_String>` **string_to_lower** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const|
  2216. Returns the string converted to lowercase.
  2217. \ **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>`).
  2218. \ **Note:** The result may be longer or shorter than the original.
  2219. .. rst-class:: classref-item-separator
  2220. ----
  2221. .. _class_TextServer_method_string_to_upper:
  2222. .. rst-class:: classref-method
  2223. :ref:`String<class_String>` **string_to_upper** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const|
  2224. Returns the string converted to uppercase.
  2225. \ **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>`).
  2226. \ **Note:** The result may be longer or shorter than the original.
  2227. .. rst-class:: classref-item-separator
  2228. ----
  2229. .. _class_TextServer_method_strip_diacritics:
  2230. .. rst-class:: classref-method
  2231. :ref:`String<class_String>` **strip_diacritics** **(** :ref:`String<class_String>` string **)** |const|
  2232. Strips diacritics from the string.
  2233. \ **Note:** The result may be longer or shorter than the original.
  2234. .. rst-class:: classref-item-separator
  2235. ----
  2236. .. _class_TextServer_method_tag_to_name:
  2237. .. rst-class:: classref-method
  2238. :ref:`String<class_String>` **tag_to_name** **(** :ref:`int<class_int>` tag **)** |const|
  2239. Converts OpenType tag to readable feature, variation, script or language name.
  2240. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2241. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2242. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2243. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2244. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2245. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  2246. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`