class_textserver.rst 372 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630
  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. \ **Note:** This is a low-level API, consider using :ref:`TextLine<class_TextLine>`, :ref:`TextParagraph<class_TextParagraph>`, and :ref:`Font<class_Font>` classes instead.
  17. This is an abstract class, so to get the currently active **TextServer** instance, use the following code:
  18. .. tabs::
  19. .. code-tab:: gdscript
  20. var ts = TextServerManager.get_primary_interface()
  21. .. code-tab:: csharp
  22. var ts = TextServerManager.GetPrimaryInterface();
  23. .. rst-class:: classref-reftable-group
  24. Methods
  25. -------
  26. .. table::
  27. :widths: auto
  28. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`RID<class_RID>` | :ref:`create_font<class_TextServer_method_create_font>`\ (\ ) |
  30. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`RID<class_RID>` | :ref:`create_font_linked_variation<class_TextServer_method_create_font_linked_variation>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |
  32. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`RID<class_RID>` | :ref:`create_shaped_text<class_TextServer_method_create_shaped_text>`\ (\ direction\: :ref:`Direction<enum_TextServer_Direction>` = 0, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) |
  34. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | |void| | :ref:`draw_hex_code_box<class_TextServer_method_draw_hex_code_box>`\ (\ canvas\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, pos\: :ref:`Vector2<class_Vector2>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`\ ) |const| |
  36. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | |void| | :ref:`font_clear_glyphs<class_TextServer_method_font_clear_glyphs>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  38. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | |void| | :ref:`font_clear_kerning_map<class_TextServer_method_font_clear_kerning_map>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |
  40. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | |void| | :ref:`font_clear_size_cache<class_TextServer_method_font_clear_size_cache>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |
  42. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | |void| | :ref:`font_clear_system_fallback_cache<class_TextServer_method_font_clear_system_fallback_cache>`\ (\ ) |
  44. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | |void| | :ref:`font_clear_textures<class_TextServer_method_font_clear_textures>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  46. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | |void| | :ref:`font_draw_glyph<class_TextServer_method_font_draw_glyph>`\ (\ font_rid\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, pos\: :ref:`Vector2<class_Vector2>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), oversampling\: :ref:`float<class_float>` = 0.0\ ) |const| |
  48. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | |void| | :ref:`font_draw_glyph_outline<class_TextServer_method_font_draw_glyph_outline>`\ (\ font_rid\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, outline_size\: :ref:`int<class_int>`, pos\: :ref:`Vector2<class_Vector2>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), oversampling\: :ref:`float<class_float>` = 0.0\ ) |const| |
  50. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` | :ref:`font_get_antialiasing<class_TextServer_method_font_get_antialiasing>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  52. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`float<class_float>` | :ref:`font_get_ascent<class_TextServer_method_font_get_ascent>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| |
  54. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | :ref:`float<class_float>` | :ref:`font_get_baseline_offset<class_TextServer_method_font_get_baseline_offset>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  56. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`int<class_int>` | :ref:`font_get_char_from_glyph_index<class_TextServer_method_font_get_char_from_glyph_index>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_index\: :ref:`int<class_int>`\ ) |const| |
  58. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | :ref:`float<class_float>` | :ref:`font_get_descent<class_TextServer_method_font_get_descent>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| |
  60. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | :ref:`bool<class_bool>` | :ref:`font_get_disable_embedded_bitmaps<class_TextServer_method_font_get_disable_embedded_bitmaps>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  62. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | :ref:`float<class_float>` | :ref:`font_get_embolden<class_TextServer_method_font_get_embolden>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  64. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | :ref:`int<class_int>` | :ref:`font_get_face_count<class_TextServer_method_font_get_face_count>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  66. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`int<class_int>` | :ref:`font_get_face_index<class_TextServer_method_font_get_face_index>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  68. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | :ref:`int<class_int>` | :ref:`font_get_fixed_size<class_TextServer_method_font_get_fixed_size>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  70. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` | :ref:`font_get_fixed_size_scale_mode<class_TextServer_method_font_get_fixed_size_scale_mode>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  72. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | :ref:`bool<class_bool>` | :ref:`font_get_generate_mipmaps<class_TextServer_method_font_get_generate_mipmaps>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  74. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | :ref:`float<class_float>` | :ref:`font_get_global_oversampling<class_TextServer_method_font_get_global_oversampling>`\ (\ ) |const| |
  76. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_advance<class_TextServer_method_font_get_glyph_advance>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph\: :ref:`int<class_int>`\ ) |const| |
  78. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_glyph_contours<class_TextServer_method_font_get_glyph_contours>`\ (\ font\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, index\: :ref:`int<class_int>`\ ) |const| |
  80. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | :ref:`int<class_int>` | :ref:`font_get_glyph_index<class_TextServer_method_font_get_glyph_index>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, char\: :ref:`int<class_int>`, variation_selector\: :ref:`int<class_int>`\ ) |const| |
  82. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`font_get_glyph_list<class_TextServer_method_font_get_glyph_list>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
  84. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_offset<class_TextServer_method_font_get_glyph_offset>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
  86. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_size<class_TextServer_method_font_get_glyph_size>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
  88. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | :ref:`int<class_int>` | :ref:`font_get_glyph_texture_idx<class_TextServer_method_font_get_glyph_texture_idx>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
  90. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | :ref:`RID<class_RID>` | :ref:`font_get_glyph_texture_rid<class_TextServer_method_font_get_glyph_texture_rid>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
  92. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_texture_size<class_TextServer_method_font_get_glyph_texture_size>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
  94. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | :ref:`Rect2<class_Rect2>` | :ref:`font_get_glyph_uv_rect<class_TextServer_method_font_get_glyph_uv_rect>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
  96. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | :ref:`Hinting<enum_TextServer_Hinting>` | :ref:`font_get_hinting<class_TextServer_method_font_get_hinting>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  98. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | :ref:`bool<class_bool>` | :ref:`font_get_keep_rounding_remainders<class_TextServer_method_font_get_keep_rounding_remainders>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  100. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_kerning<class_TextServer_method_font_get_kerning>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
  102. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | :ref:`Array<class_Array>`\[:ref:`Vector2i<class_Vector2i>`\] | :ref:`font_get_kerning_list<class_TextServer_method_font_get_kerning_list>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| |
  104. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | :ref:`bool<class_bool>` | :ref:`font_get_language_support_override<class_TextServer_method_font_get_language_support_override>`\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) |
  106. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_language_support_overrides<class_TextServer_method_font_get_language_support_overrides>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |
  108. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`int<class_int>` | :ref:`font_get_msdf_pixel_range<class_TextServer_method_font_get_msdf_pixel_range>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  110. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`int<class_int>` | :ref:`font_get_msdf_size<class_TextServer_method_font_get_msdf_size>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  112. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`String<class_String>` | :ref:`font_get_name<class_TextServer_method_font_get_name>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  114. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_opentype_feature_overrides<class_TextServer_method_font_get_opentype_feature_overrides>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  116. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_ot_name_strings<class_TextServer_method_font_get_ot_name_strings>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  118. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`float<class_float>` | :ref:`font_get_oversampling<class_TextServer_method_font_get_oversampling>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  120. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`float<class_float>` | :ref:`font_get_scale<class_TextServer_method_font_get_scale>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| |
  122. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :ref:`bool<class_bool>` | :ref:`font_get_script_support_override<class_TextServer_method_font_get_script_support_override>`\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`\ ) |
  124. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_script_support_overrides<class_TextServer_method_font_get_script_support_overrides>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |
  126. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`font_get_size_cache_info<class_TextServer_method_font_get_size_cache_info>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  128. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | :ref:`Array<class_Array>`\[:ref:`Vector2i<class_Vector2i>`\] | :ref:`font_get_size_cache_list<class_TextServer_method_font_get_size_cache_list>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  130. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | :ref:`int<class_int>` | :ref:`font_get_spacing<class_TextServer_method_font_get_spacing>`\ (\ font_rid\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`\ ) |const| |
  132. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | :ref:`int<class_int>` | :ref:`font_get_stretch<class_TextServer_method_font_get_stretch>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  134. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\] | :ref:`font_get_style<class_TextServer_method_font_get_style>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  136. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | :ref:`String<class_String>` | :ref:`font_get_style_name<class_TextServer_method_font_get_style_name>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  138. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` | :ref:`font_get_subpixel_positioning<class_TextServer_method_font_get_subpixel_positioning>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  140. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | :ref:`String<class_String>` | :ref:`font_get_supported_chars<class_TextServer_method_font_get_supported_chars>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  142. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`font_get_supported_glyphs<class_TextServer_method_font_get_supported_glyphs>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  144. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | :ref:`int<class_int>` | :ref:`font_get_texture_count<class_TextServer_method_font_get_texture_count>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
  146. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | :ref:`Image<class_Image>` | :ref:`font_get_texture_image<class_TextServer_method_font_get_texture_image>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) |const| |
  148. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`font_get_texture_offsets<class_TextServer_method_font_get_texture_offsets>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) |const| |
  150. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | :ref:`Transform2D<class_Transform2D>` | :ref:`font_get_transform<class_TextServer_method_font_get_transform>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  152. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | :ref:`float<class_float>` | :ref:`font_get_underline_position<class_TextServer_method_font_get_underline_position>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| |
  154. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | :ref:`float<class_float>` | :ref:`font_get_underline_thickness<class_TextServer_method_font_get_underline_thickness>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| |
  156. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_variation_coordinates<class_TextServer_method_font_get_variation_coordinates>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  158. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | :ref:`int<class_int>` | :ref:`font_get_weight<class_TextServer_method_font_get_weight>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  160. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | :ref:`bool<class_bool>` | :ref:`font_has_char<class_TextServer_method_font_has_char>`\ (\ font_rid\: :ref:`RID<class_RID>`, char\: :ref:`int<class_int>`\ ) |const| |
  162. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | :ref:`bool<class_bool>` | :ref:`font_is_allow_system_fallback<class_TextServer_method_font_is_allow_system_fallback>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  164. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | :ref:`bool<class_bool>` | :ref:`font_is_force_autohinter<class_TextServer_method_font_is_force_autohinter>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  166. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | :ref:`bool<class_bool>` | :ref:`font_is_language_supported<class_TextServer_method_font_is_language_supported>`\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) |const| |
  168. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | :ref:`bool<class_bool>` | :ref:`font_is_modulate_color_glyphs<class_TextServer_method_font_is_modulate_color_glyphs>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  170. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | :ref:`bool<class_bool>` | :ref:`font_is_multichannel_signed_distance_field<class_TextServer_method_font_is_multichannel_signed_distance_field>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  172. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | :ref:`bool<class_bool>` | :ref:`font_is_script_supported<class_TextServer_method_font_is_script_supported>`\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`\ ) |const| |
  174. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | |void| | :ref:`font_remove_glyph<class_TextServer_method_font_remove_glyph>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |
  176. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | |void| | :ref:`font_remove_kerning<class_TextServer_method_font_remove_kerning>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`\ ) |
  178. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | |void| | :ref:`font_remove_language_support_override<class_TextServer_method_font_remove_language_support_override>`\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) |
  180. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | |void| | :ref:`font_remove_script_support_override<class_TextServer_method_font_remove_script_support_override>`\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`\ ) |
  182. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | |void| | :ref:`font_remove_size_cache<class_TextServer_method_font_remove_size_cache>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  184. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | |void| | :ref:`font_remove_texture<class_TextServer_method_font_remove_texture>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) |
  186. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | |void| | :ref:`font_render_glyph<class_TextServer_method_font_render_glyph>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, index\: :ref:`int<class_int>`\ ) |
  188. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | |void| | :ref:`font_render_range<class_TextServer_method_font_render_range>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, start\: :ref:`int<class_int>`, end\: :ref:`int<class_int>`\ ) |
  190. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | |void| | :ref:`font_set_allow_system_fallback<class_TextServer_method_font_set_allow_system_fallback>`\ (\ font_rid\: :ref:`RID<class_RID>`, allow_system_fallback\: :ref:`bool<class_bool>`\ ) |
  192. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | |void| | :ref:`font_set_antialiasing<class_TextServer_method_font_set_antialiasing>`\ (\ font_rid\: :ref:`RID<class_RID>`, antialiasing\: :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>`\ ) |
  194. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | |void| | :ref:`font_set_ascent<class_TextServer_method_font_set_ascent>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, ascent\: :ref:`float<class_float>`\ ) |
  196. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | |void| | :ref:`font_set_baseline_offset<class_TextServer_method_font_set_baseline_offset>`\ (\ font_rid\: :ref:`RID<class_RID>`, baseline_offset\: :ref:`float<class_float>`\ ) |
  198. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | |void| | :ref:`font_set_data<class_TextServer_method_font_set_data>`\ (\ font_rid\: :ref:`RID<class_RID>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |
  200. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | |void| | :ref:`font_set_descent<class_TextServer_method_font_set_descent>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, descent\: :ref:`float<class_float>`\ ) |
  202. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | |void| | :ref:`font_set_disable_embedded_bitmaps<class_TextServer_method_font_set_disable_embedded_bitmaps>`\ (\ font_rid\: :ref:`RID<class_RID>`, disable_embedded_bitmaps\: :ref:`bool<class_bool>`\ ) |
  204. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | |void| | :ref:`font_set_embolden<class_TextServer_method_font_set_embolden>`\ (\ font_rid\: :ref:`RID<class_RID>`, strength\: :ref:`float<class_float>`\ ) |
  206. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | |void| | :ref:`font_set_face_index<class_TextServer_method_font_set_face_index>`\ (\ font_rid\: :ref:`RID<class_RID>`, face_index\: :ref:`int<class_int>`\ ) |
  208. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | |void| | :ref:`font_set_fixed_size<class_TextServer_method_font_set_fixed_size>`\ (\ font_rid\: :ref:`RID<class_RID>`, fixed_size\: :ref:`int<class_int>`\ ) |
  210. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | |void| | :ref:`font_set_fixed_size_scale_mode<class_TextServer_method_font_set_fixed_size_scale_mode>`\ (\ font_rid\: :ref:`RID<class_RID>`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>`\ ) |
  212. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | |void| | :ref:`font_set_force_autohinter<class_TextServer_method_font_set_force_autohinter>`\ (\ font_rid\: :ref:`RID<class_RID>`, force_autohinter\: :ref:`bool<class_bool>`\ ) |
  214. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | |void| | :ref:`font_set_generate_mipmaps<class_TextServer_method_font_set_generate_mipmaps>`\ (\ font_rid\: :ref:`RID<class_RID>`, generate_mipmaps\: :ref:`bool<class_bool>`\ ) |
  216. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | |void| | :ref:`font_set_global_oversampling<class_TextServer_method_font_set_global_oversampling>`\ (\ oversampling\: :ref:`float<class_float>`\ ) |
  218. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | |void| | :ref:`font_set_glyph_advance<class_TextServer_method_font_set_glyph_advance>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph\: :ref:`int<class_int>`, advance\: :ref:`Vector2<class_Vector2>`\ ) |
  220. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | |void| | :ref:`font_set_glyph_offset<class_TextServer_method_font_set_glyph_offset>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, offset\: :ref:`Vector2<class_Vector2>`\ ) |
  222. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | |void| | :ref:`font_set_glyph_size<class_TextServer_method_font_set_glyph_size>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, gl_size\: :ref:`Vector2<class_Vector2>`\ ) |
  224. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | |void| | :ref:`font_set_glyph_texture_idx<class_TextServer_method_font_set_glyph_texture_idx>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, texture_idx\: :ref:`int<class_int>`\ ) |
  226. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | |void| | :ref:`font_set_glyph_uv_rect<class_TextServer_method_font_set_glyph_uv_rect>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, uv_rect\: :ref:`Rect2<class_Rect2>`\ ) |
  228. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | |void| | :ref:`font_set_hinting<class_TextServer_method_font_set_hinting>`\ (\ font_rid\: :ref:`RID<class_RID>`, hinting\: :ref:`Hinting<enum_TextServer_Hinting>`\ ) |
  230. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | |void| | :ref:`font_set_keep_rounding_remainders<class_TextServer_method_font_set_keep_rounding_remainders>`\ (\ font_rid\: :ref:`RID<class_RID>`, keep_rounding_remainders\: :ref:`bool<class_bool>`\ ) |
  232. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | |void| | :ref:`font_set_kerning<class_TextServer_method_font_set_kerning>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`, kerning\: :ref:`Vector2<class_Vector2>`\ ) |
  234. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | |void| | :ref:`font_set_language_support_override<class_TextServer_method_font_set_language_support_override>`\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`, supported\: :ref:`bool<class_bool>`\ ) |
  236. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. | |void| | :ref:`font_set_modulate_color_glyphs<class_TextServer_method_font_set_modulate_color_glyphs>`\ (\ font_rid\: :ref:`RID<class_RID>`, force_autohinter\: :ref:`bool<class_bool>`\ ) |
  238. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  239. | |void| | :ref:`font_set_msdf_pixel_range<class_TextServer_method_font_set_msdf_pixel_range>`\ (\ font_rid\: :ref:`RID<class_RID>`, msdf_pixel_range\: :ref:`int<class_int>`\ ) |
  240. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  241. | |void| | :ref:`font_set_msdf_size<class_TextServer_method_font_set_msdf_size>`\ (\ font_rid\: :ref:`RID<class_RID>`, msdf_size\: :ref:`int<class_int>`\ ) |
  242. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  243. | |void| | :ref:`font_set_multichannel_signed_distance_field<class_TextServer_method_font_set_multichannel_signed_distance_field>`\ (\ font_rid\: :ref:`RID<class_RID>`, msdf\: :ref:`bool<class_bool>`\ ) |
  244. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  245. | |void| | :ref:`font_set_name<class_TextServer_method_font_set_name>`\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) |
  246. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  247. | |void| | :ref:`font_set_opentype_feature_overrides<class_TextServer_method_font_set_opentype_feature_overrides>`\ (\ font_rid\: :ref:`RID<class_RID>`, overrides\: :ref:`Dictionary<class_Dictionary>`\ ) |
  248. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  249. | |void| | :ref:`font_set_oversampling<class_TextServer_method_font_set_oversampling>`\ (\ font_rid\: :ref:`RID<class_RID>`, oversampling\: :ref:`float<class_float>`\ ) |
  250. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  251. | |void| | :ref:`font_set_scale<class_TextServer_method_font_set_scale>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, scale\: :ref:`float<class_float>`\ ) |
  252. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  253. | |void| | :ref:`font_set_script_support_override<class_TextServer_method_font_set_script_support_override>`\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`, supported\: :ref:`bool<class_bool>`\ ) |
  254. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  255. | |void| | :ref:`font_set_spacing<class_TextServer_method_font_set_spacing>`\ (\ font_rid\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`, value\: :ref:`int<class_int>`\ ) |
  256. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  257. | |void| | :ref:`font_set_stretch<class_TextServer_method_font_set_stretch>`\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) |
  258. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  259. | |void| | :ref:`font_set_style<class_TextServer_method_font_set_style>`\ (\ font_rid\: :ref:`RID<class_RID>`, style\: |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\]\ ) |
  260. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  261. | |void| | :ref:`font_set_style_name<class_TextServer_method_font_set_style_name>`\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) |
  262. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  263. | |void| | :ref:`font_set_subpixel_positioning<class_TextServer_method_font_set_subpixel_positioning>`\ (\ font_rid\: :ref:`RID<class_RID>`, subpixel_positioning\: :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>`\ ) |
  264. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  265. | |void| | :ref:`font_set_texture_image<class_TextServer_method_font_set_texture_image>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`, image\: :ref:`Image<class_Image>`\ ) |
  266. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  267. | |void| | :ref:`font_set_texture_offsets<class_TextServer_method_font_set_texture_offsets>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`, offset\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) |
  268. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  269. | |void| | :ref:`font_set_transform<class_TextServer_method_font_set_transform>`\ (\ font_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  270. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  271. | |void| | :ref:`font_set_underline_position<class_TextServer_method_font_set_underline_position>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, underline_position\: :ref:`float<class_float>`\ ) |
  272. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  273. | |void| | :ref:`font_set_underline_thickness<class_TextServer_method_font_set_underline_thickness>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, underline_thickness\: :ref:`float<class_float>`\ ) |
  274. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  275. | |void| | :ref:`font_set_variation_coordinates<class_TextServer_method_font_set_variation_coordinates>`\ (\ font_rid\: :ref:`RID<class_RID>`, variation_coordinates\: :ref:`Dictionary<class_Dictionary>`\ ) |
  276. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  277. | |void| | :ref:`font_set_weight<class_TextServer_method_font_set_weight>`\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) |
  278. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  279. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_feature_list<class_TextServer_method_font_supported_feature_list>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  280. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  281. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_variation_list<class_TextServer_method_font_supported_variation_list>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  282. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  283. | :ref:`String<class_String>` | :ref:`format_number<class_TextServer_method_format_number>`\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  284. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  285. | |void| | :ref:`free_rid<class_TextServer_method_free_rid>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  286. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  287. | :ref:`int<class_int>` | :ref:`get_features<class_TextServer_method_get_features>`\ (\ ) |const| |
  288. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  289. | :ref:`Vector2<class_Vector2>` | :ref:`get_hex_code_box_size<class_TextServer_method_get_hex_code_box_size>`\ (\ size\: :ref:`int<class_int>`, index\: :ref:`int<class_int>`\ ) |const| |
  290. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  291. | :ref:`String<class_String>` | :ref:`get_name<class_TextServer_method_get_name>`\ (\ ) |const| |
  292. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  293. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`get_support_data<class_TextServer_method_get_support_data>`\ (\ ) |const| |
  294. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  295. | :ref:`String<class_String>` | :ref:`get_support_data_filename<class_TextServer_method_get_support_data_filename>`\ (\ ) |const| |
  296. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  297. | :ref:`String<class_String>` | :ref:`get_support_data_info<class_TextServer_method_get_support_data_info>`\ (\ ) |const| |
  298. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  299. | :ref:`bool<class_bool>` | :ref:`has<class_TextServer_method_has>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  300. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  301. | :ref:`bool<class_bool>` | :ref:`has_feature<class_TextServer_method_has_feature>`\ (\ feature\: :ref:`Feature<enum_TextServer_Feature>`\ ) |const| |
  302. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  303. | :ref:`int<class_int>` | :ref:`is_confusable<class_TextServer_method_is_confusable>`\ (\ string\: :ref:`String<class_String>`, dict\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |const| |
  304. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  305. | :ref:`bool<class_bool>` | :ref:`is_locale_right_to_left<class_TextServer_method_is_locale_right_to_left>`\ (\ locale\: :ref:`String<class_String>`\ ) |const| |
  306. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  307. | :ref:`bool<class_bool>` | :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>`\ (\ string\: :ref:`String<class_String>`\ ) |const| |
  308. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  309. | :ref:`bool<class_bool>` | :ref:`is_valid_letter<class_TextServer_method_is_valid_letter>`\ (\ unicode\: :ref:`int<class_int>`\ ) |const| |
  310. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  311. | :ref:`bool<class_bool>` | :ref:`load_support_data<class_TextServer_method_load_support_data>`\ (\ filename\: :ref:`String<class_String>`\ ) |
  312. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  313. | :ref:`int<class_int>` | :ref:`name_to_tag<class_TextServer_method_name_to_tag>`\ (\ name\: :ref:`String<class_String>`\ ) |const| |
  314. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  315. | :ref:`String<class_String>` | :ref:`parse_number<class_TextServer_method_parse_number>`\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  316. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  317. | :ref:`Array<class_Array>`\[:ref:`Vector3i<class_Vector3i>`\] | :ref:`parse_structured_text<class_TextServer_method_parse_structured_text>`\ (\ parser_type\: :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>`, args\: :ref:`Array<class_Array>`, text\: :ref:`String<class_String>`\ ) |const| |
  318. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  319. | :ref:`String<class_String>` | :ref:`percent_sign<class_TextServer_method_percent_sign>`\ (\ language\: :ref:`String<class_String>` = ""\ ) |const| |
  320. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  321. | :ref:`bool<class_bool>` | :ref:`save_support_data<class_TextServer_method_save_support_data>`\ (\ filename\: :ref:`String<class_String>`\ ) |const| |
  322. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  323. | :ref:`int<class_int>` | :ref:`shaped_get_run_count<class_TextServer_method_shaped_get_run_count>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  324. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  325. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_get_run_direction<class_TextServer_method_shaped_get_run_direction>`\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  326. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  327. | :ref:`RID<class_RID>` | :ref:`shaped_get_run_font_rid<class_TextServer_method_shaped_get_run_font_rid>`\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  328. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  329. | :ref:`int<class_int>` | :ref:`shaped_get_run_font_size<class_TextServer_method_shaped_get_run_font_size>`\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  330. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  331. | :ref:`String<class_String>` | :ref:`shaped_get_run_language<class_TextServer_method_shaped_get_run_language>`\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  332. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  333. | :ref:`Variant<class_Variant>` | :ref:`shaped_get_run_object<class_TextServer_method_shaped_get_run_object>`\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  334. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  335. | :ref:`Vector2i<class_Vector2i>` | :ref:`shaped_get_run_range<class_TextServer_method_shaped_get_run_range>`\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  336. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  337. | :ref:`String<class_String>` | :ref:`shaped_get_run_text<class_TextServer_method_shaped_get_run_text>`\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  338. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  339. | :ref:`int<class_int>` | :ref:`shaped_get_span_count<class_TextServer_method_shaped_get_span_count>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  340. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  341. | :ref:`Variant<class_Variant>` | :ref:`shaped_get_span_embedded_object<class_TextServer_method_shaped_get_span_embedded_object>`\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  342. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  343. | :ref:`Variant<class_Variant>` | :ref:`shaped_get_span_meta<class_TextServer_method_shaped_get_span_meta>`\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  344. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  345. | :ref:`Variant<class_Variant>` | :ref:`shaped_get_span_object<class_TextServer_method_shaped_get_span_object>`\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  346. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  347. | :ref:`String<class_String>` | :ref:`shaped_get_span_text<class_TextServer_method_shaped_get_span_text>`\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  348. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  349. | :ref:`String<class_String>` | :ref:`shaped_get_text<class_TextServer_method_shaped_get_text>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  350. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  351. | |void| | :ref:`shaped_set_span_update_font<class_TextServer_method_shaped_set_span_update_font>`\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, fonts\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], size\: :ref:`int<class_int>`, opentype_features\: :ref:`Dictionary<class_Dictionary>` = {}\ ) |
  352. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  353. | :ref:`bool<class_bool>` | :ref:`shaped_text_add_object<class_TextServer_method_shaped_text_add_object>`\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`, size\: :ref:`Vector2<class_Vector2>`, inline_align\: :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` = 5, length\: :ref:`int<class_int>` = 1, baseline\: :ref:`float<class_float>` = 0.0\ ) |
  354. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  355. | :ref:`bool<class_bool>` | :ref:`shaped_text_add_string<class_TextServer_method_shaped_text_add_string>`\ (\ shaped\: :ref:`RID<class_RID>`, text\: :ref:`String<class_String>`, fonts\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], size\: :ref:`int<class_int>`, opentype_features\: :ref:`Dictionary<class_Dictionary>` = {}, language\: :ref:`String<class_String>` = "", meta\: :ref:`Variant<class_Variant>` = null\ ) |
  356. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  357. | |void| | :ref:`shaped_text_clear<class_TextServer_method_shaped_text_clear>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  358. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  359. | :ref:`int<class_int>` | :ref:`shaped_text_closest_character_pos<class_TextServer_method_shaped_text_closest_character_pos>`\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| |
  360. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  361. | |void| | :ref:`shaped_text_draw<class_TextServer_method_shaped_text_draw>`\ (\ shaped\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, pos\: :ref:`Vector2<class_Vector2>`, clip_l\: :ref:`float<class_float>` = -1, clip_r\: :ref:`float<class_float>` = -1, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), oversampling\: :ref:`float<class_float>` = 0.0\ ) |const| |
  362. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  363. | |void| | :ref:`shaped_text_draw_outline<class_TextServer_method_shaped_text_draw_outline>`\ (\ shaped\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, pos\: :ref:`Vector2<class_Vector2>`, clip_l\: :ref:`float<class_float>` = -1, clip_r\: :ref:`float<class_float>` = -1, outline_size\: :ref:`int<class_int>` = 1, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), oversampling\: :ref:`float<class_float>` = 0.0\ ) |const| |
  364. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  365. | :ref:`RID<class_RID>` | :ref:`shaped_text_duplicate<class_TextServer_method_shaped_text_duplicate>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  366. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  367. | :ref:`float<class_float>` | :ref:`shaped_text_fit_to_width<class_TextServer_method_shaped_text_fit_to_width>`\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`float<class_float>`, justification_flags\: |bitfield|\[:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\] = 3\ ) |
  368. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  369. | :ref:`float<class_float>` | :ref:`shaped_text_get_ascent<class_TextServer_method_shaped_text_get_ascent>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  370. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  371. | :ref:`Dictionary<class_Dictionary>` | :ref:`shaped_text_get_carets<class_TextServer_method_shaped_text_get_carets>`\ (\ shaped\: :ref:`RID<class_RID>`, position\: :ref:`int<class_int>`\ ) |const| |
  372. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  373. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_character_breaks<class_TextServer_method_shaped_text_get_character_breaks>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  374. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  375. | :ref:`int<class_int>` | :ref:`shaped_text_get_custom_ellipsis<class_TextServer_method_shaped_text_get_custom_ellipsis>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  376. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  377. | :ref:`String<class_String>` | :ref:`shaped_text_get_custom_punctuation<class_TextServer_method_shaped_text_get_custom_punctuation>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  378. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  379. | :ref:`float<class_float>` | :ref:`shaped_text_get_descent<class_TextServer_method_shaped_text_get_descent>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  380. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  381. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_direction<class_TextServer_method_shaped_text_get_direction>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  382. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  383. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_dominant_direction_in_range<class_TextServer_method_shaped_text_get_dominant_direction_in_range>`\ (\ shaped\: :ref:`RID<class_RID>`, start\: :ref:`int<class_int>`, end\: :ref:`int<class_int>`\ ) |const| |
  384. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  385. | :ref:`int<class_int>` | :ref:`shaped_text_get_ellipsis_glyph_count<class_TextServer_method_shaped_text_get_ellipsis_glyph_count>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  386. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  387. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`shaped_text_get_ellipsis_glyphs<class_TextServer_method_shaped_text_get_ellipsis_glyphs>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  388. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  389. | :ref:`int<class_int>` | :ref:`shaped_text_get_ellipsis_pos<class_TextServer_method_shaped_text_get_ellipsis_pos>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  390. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  391. | :ref:`int<class_int>` | :ref:`shaped_text_get_glyph_count<class_TextServer_method_shaped_text_get_glyph_count>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  392. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  393. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`shaped_text_get_glyphs<class_TextServer_method_shaped_text_get_glyphs>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  394. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  395. | :ref:`Vector2<class_Vector2>` | :ref:`shaped_text_get_grapheme_bounds<class_TextServer_method_shaped_text_get_grapheme_bounds>`\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| |
  396. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  397. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_inferred_direction<class_TextServer_method_shaped_text_get_inferred_direction>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  398. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  399. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_line_breaks<class_TextServer_method_shaped_text_get_line_breaks>`\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`float<class_float>`, start\: :ref:`int<class_int>` = 0, break_flags\: |bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\] = 3\ ) |const| |
  400. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  401. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_line_breaks_adv<class_TextServer_method_shaped_text_get_line_breaks_adv>`\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`, start\: :ref:`int<class_int>` = 0, once\: :ref:`bool<class_bool>` = true, break_flags\: |bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\] = 3\ ) |const| |
  402. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  403. | :ref:`int<class_int>` | :ref:`shaped_text_get_object_glyph<class_TextServer_method_shaped_text_get_object_glyph>`\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`\ ) |const| |
  404. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  405. | :ref:`Vector2i<class_Vector2i>` | :ref:`shaped_text_get_object_range<class_TextServer_method_shaped_text_get_object_range>`\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`\ ) |const| |
  406. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  407. | :ref:`Rect2<class_Rect2>` | :ref:`shaped_text_get_object_rect<class_TextServer_method_shaped_text_get_object_rect>`\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`\ ) |const| |
  408. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  409. | :ref:`Array<class_Array>` | :ref:`shaped_text_get_objects<class_TextServer_method_shaped_text_get_objects>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  410. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  411. | :ref:`Orientation<enum_TextServer_Orientation>` | :ref:`shaped_text_get_orientation<class_TextServer_method_shaped_text_get_orientation>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  412. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  413. | :ref:`RID<class_RID>` | :ref:`shaped_text_get_parent<class_TextServer_method_shaped_text_get_parent>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  414. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  415. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_control<class_TextServer_method_shaped_text_get_preserve_control>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  416. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  417. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_invalid<class_TextServer_method_shaped_text_get_preserve_invalid>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  418. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  419. | :ref:`Vector2i<class_Vector2i>` | :ref:`shaped_text_get_range<class_TextServer_method_shaped_text_get_range>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  420. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  421. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`shaped_text_get_selection<class_TextServer_method_shaped_text_get_selection>`\ (\ shaped\: :ref:`RID<class_RID>`, start\: :ref:`int<class_int>`, end\: :ref:`int<class_int>`\ ) |const| |
  422. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  423. | :ref:`Vector2<class_Vector2>` | :ref:`shaped_text_get_size<class_TextServer_method_shaped_text_get_size>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  424. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  425. | :ref:`int<class_int>` | :ref:`shaped_text_get_spacing<class_TextServer_method_shaped_text_get_spacing>`\ (\ shaped\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`\ ) |const| |
  426. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  427. | :ref:`int<class_int>` | :ref:`shaped_text_get_trim_pos<class_TextServer_method_shaped_text_get_trim_pos>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  428. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  429. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_position<class_TextServer_method_shaped_text_get_underline_position>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  430. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  431. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_thickness<class_TextServer_method_shaped_text_get_underline_thickness>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  432. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  433. | :ref:`float<class_float>` | :ref:`shaped_text_get_width<class_TextServer_method_shaped_text_get_width>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  434. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  435. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_word_breaks<class_TextServer_method_shaped_text_get_word_breaks>`\ (\ shaped\: :ref:`RID<class_RID>`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`\] = 264, skip_grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`\] = 4\ ) |const| |
  436. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  437. | :ref:`bool<class_bool>` | :ref:`shaped_text_has_object<class_TextServer_method_shaped_text_has_object>`\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`\ ) |const| |
  438. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  439. | :ref:`bool<class_bool>` | :ref:`shaped_text_has_visible_chars<class_TextServer_method_shaped_text_has_visible_chars>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  440. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  441. | :ref:`int<class_int>` | :ref:`shaped_text_hit_test_grapheme<class_TextServer_method_shaped_text_hit_test_grapheme>`\ (\ shaped\: :ref:`RID<class_RID>`, coords\: :ref:`float<class_float>`\ ) |const| |
  442. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  443. | :ref:`int<class_int>` | :ref:`shaped_text_hit_test_position<class_TextServer_method_shaped_text_hit_test_position>`\ (\ shaped\: :ref:`RID<class_RID>`, coords\: :ref:`float<class_float>`\ ) |const| |
  444. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  445. | :ref:`bool<class_bool>` | :ref:`shaped_text_is_ready<class_TextServer_method_shaped_text_is_ready>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  446. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  447. | :ref:`int<class_int>` | :ref:`shaped_text_next_character_pos<class_TextServer_method_shaped_text_next_character_pos>`\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| |
  448. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  449. | :ref:`int<class_int>` | :ref:`shaped_text_next_grapheme_pos<class_TextServer_method_shaped_text_next_grapheme_pos>`\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| |
  450. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  451. | |void| | :ref:`shaped_text_overrun_trim_to_width<class_TextServer_method_shaped_text_overrun_trim_to_width>`\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`float<class_float>` = 0, overrun_trim_flags\: |bitfield|\[:ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>`\] = 0\ ) |
  452. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  453. | :ref:`int<class_int>` | :ref:`shaped_text_prev_character_pos<class_TextServer_method_shaped_text_prev_character_pos>`\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| |
  454. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  455. | :ref:`int<class_int>` | :ref:`shaped_text_prev_grapheme_pos<class_TextServer_method_shaped_text_prev_grapheme_pos>`\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| |
  456. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  457. | :ref:`bool<class_bool>` | :ref:`shaped_text_resize_object<class_TextServer_method_shaped_text_resize_object>`\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`, size\: :ref:`Vector2<class_Vector2>`, inline_align\: :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` = 5, baseline\: :ref:`float<class_float>` = 0.0\ ) |
  458. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  459. | |void| | :ref:`shaped_text_set_bidi_override<class_TextServer_method_shaped_text_set_bidi_override>`\ (\ shaped\: :ref:`RID<class_RID>`, override\: :ref:`Array<class_Array>`\ ) |
  460. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  461. | |void| | :ref:`shaped_text_set_custom_ellipsis<class_TextServer_method_shaped_text_set_custom_ellipsis>`\ (\ shaped\: :ref:`RID<class_RID>`, char\: :ref:`int<class_int>`\ ) |
  462. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  463. | |void| | :ref:`shaped_text_set_custom_punctuation<class_TextServer_method_shaped_text_set_custom_punctuation>`\ (\ shaped\: :ref:`RID<class_RID>`, punct\: :ref:`String<class_String>`\ ) |
  464. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  465. | |void| | :ref:`shaped_text_set_direction<class_TextServer_method_shaped_text_set_direction>`\ (\ shaped\: :ref:`RID<class_RID>`, direction\: :ref:`Direction<enum_TextServer_Direction>` = 0\ ) |
  466. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  467. | |void| | :ref:`shaped_text_set_orientation<class_TextServer_method_shaped_text_set_orientation>`\ (\ shaped\: :ref:`RID<class_RID>`, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) |
  468. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  469. | |void| | :ref:`shaped_text_set_preserve_control<class_TextServer_method_shaped_text_set_preserve_control>`\ (\ shaped\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  470. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  471. | |void| | :ref:`shaped_text_set_preserve_invalid<class_TextServer_method_shaped_text_set_preserve_invalid>`\ (\ shaped\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  472. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  473. | |void| | :ref:`shaped_text_set_spacing<class_TextServer_method_shaped_text_set_spacing>`\ (\ shaped\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`, value\: :ref:`int<class_int>`\ ) |
  474. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  475. | :ref:`bool<class_bool>` | :ref:`shaped_text_shape<class_TextServer_method_shaped_text_shape>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |
  476. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  477. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`shaped_text_sort_logical<class_TextServer_method_shaped_text_sort_logical>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |
  478. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  479. | :ref:`RID<class_RID>` | :ref:`shaped_text_substr<class_TextServer_method_shaped_text_substr>`\ (\ shaped\: :ref:`RID<class_RID>`, start\: :ref:`int<class_int>`, length\: :ref:`int<class_int>`\ ) |const| |
  480. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  481. | :ref:`float<class_float>` | :ref:`shaped_text_tab_align<class_TextServer_method_shaped_text_tab_align>`\ (\ shaped\: :ref:`RID<class_RID>`, tab_stops\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) |
  482. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  483. | :ref:`bool<class_bool>` | :ref:`spoof_check<class_TextServer_method_spoof_check>`\ (\ string\: :ref:`String<class_String>`\ ) |const| |
  484. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  485. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`string_get_character_breaks<class_TextServer_method_string_get_character_breaks>`\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  486. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  487. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`string_get_word_breaks<class_TextServer_method_string_get_word_breaks>`\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = "", chars_per_line\: :ref:`int<class_int>` = 0\ ) |const| |
  488. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  489. | :ref:`String<class_String>` | :ref:`string_to_lower<class_TextServer_method_string_to_lower>`\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  490. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  491. | :ref:`String<class_String>` | :ref:`string_to_title<class_TextServer_method_string_to_title>`\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  492. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  493. | :ref:`String<class_String>` | :ref:`string_to_upper<class_TextServer_method_string_to_upper>`\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  494. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  495. | :ref:`String<class_String>` | :ref:`strip_diacritics<class_TextServer_method_strip_diacritics>`\ (\ string\: :ref:`String<class_String>`\ ) |const| |
  496. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  497. | :ref:`String<class_String>` | :ref:`tag_to_name<class_TextServer_method_tag_to_name>`\ (\ tag\: :ref:`int<class_int>`\ ) |const| |
  498. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  499. .. rst-class:: classref-section-separator
  500. ----
  501. .. rst-class:: classref-descriptions-group
  502. Enumerations
  503. ------------
  504. .. _enum_TextServer_FontAntialiasing:
  505. .. rst-class:: classref-enumeration
  506. enum **FontAntialiasing**: :ref:`๐Ÿ”—<enum_TextServer_FontAntialiasing>`
  507. .. _class_TextServer_constant_FONT_ANTIALIASING_NONE:
  508. .. rst-class:: classref-enumeration-constant
  509. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_NONE** = ``0``
  510. Font glyphs are rasterized as 1-bit bitmaps.
  511. .. _class_TextServer_constant_FONT_ANTIALIASING_GRAY:
  512. .. rst-class:: classref-enumeration-constant
  513. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_GRAY** = ``1``
  514. Font glyphs are rasterized as 8-bit grayscale anti-aliased bitmaps.
  515. .. _class_TextServer_constant_FONT_ANTIALIASING_LCD:
  516. .. rst-class:: classref-enumeration-constant
  517. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_LCD** = ``2``
  518. Font glyphs are rasterized for LCD screens.
  519. LCD subpixel layout is determined by the value of the :ref:`ProjectSettings.gui/theme/lcd_subpixel_layout<class_ProjectSettings_property_gui/theme/lcd_subpixel_layout>` setting.
  520. LCD subpixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D.
  521. .. rst-class:: classref-item-separator
  522. ----
  523. .. _enum_TextServer_FontLCDSubpixelLayout:
  524. .. rst-class:: classref-enumeration
  525. enum **FontLCDSubpixelLayout**: :ref:`๐Ÿ”—<enum_TextServer_FontLCDSubpixelLayout>`
  526. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_NONE:
  527. .. rst-class:: classref-enumeration-constant
  528. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_NONE** = ``0``
  529. Unknown or unsupported subpixel layout, LCD subpixel antialiasing is disabled.
  530. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HRGB:
  531. .. rst-class:: classref-enumeration-constant
  532. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HRGB** = ``1``
  533. Horizontal RGB subpixel layout.
  534. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HBGR:
  535. .. rst-class:: classref-enumeration-constant
  536. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HBGR** = ``2``
  537. Horizontal BGR subpixel layout.
  538. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VRGB:
  539. .. rst-class:: classref-enumeration-constant
  540. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VRGB** = ``3``
  541. Vertical RGB subpixel layout.
  542. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VBGR:
  543. .. rst-class:: classref-enumeration-constant
  544. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VBGR** = ``4``
  545. Vertical BGR subpixel layout.
  546. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_MAX:
  547. .. rst-class:: classref-enumeration-constant
  548. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_MAX** = ``5``
  549. Represents the size of the :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` enum.
  550. .. rst-class:: classref-item-separator
  551. ----
  552. .. _enum_TextServer_Direction:
  553. .. rst-class:: classref-enumeration
  554. enum **Direction**: :ref:`๐Ÿ”—<enum_TextServer_Direction>`
  555. .. _class_TextServer_constant_DIRECTION_AUTO:
  556. .. rst-class:: classref-enumeration-constant
  557. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_AUTO** = ``0``
  558. Text direction is determined based on contents and current locale.
  559. .. _class_TextServer_constant_DIRECTION_LTR:
  560. .. rst-class:: classref-enumeration-constant
  561. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_LTR** = ``1``
  562. Text is written from left to right.
  563. .. _class_TextServer_constant_DIRECTION_RTL:
  564. .. rst-class:: classref-enumeration-constant
  565. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_RTL** = ``2``
  566. Text is written from right to left.
  567. .. _class_TextServer_constant_DIRECTION_INHERITED:
  568. .. rst-class:: classref-enumeration-constant
  569. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_INHERITED** = ``3``
  570. Text writing direction is the same as base string writing direction. Used for BiDi override only.
  571. .. rst-class:: classref-item-separator
  572. ----
  573. .. _enum_TextServer_Orientation:
  574. .. rst-class:: classref-enumeration
  575. enum **Orientation**: :ref:`๐Ÿ”—<enum_TextServer_Orientation>`
  576. .. _class_TextServer_constant_ORIENTATION_HORIZONTAL:
  577. .. rst-class:: classref-enumeration-constant
  578. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_HORIZONTAL** = ``0``
  579. Text is written horizontally.
  580. .. _class_TextServer_constant_ORIENTATION_VERTICAL:
  581. .. rst-class:: classref-enumeration-constant
  582. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_VERTICAL** = ``1``
  583. Left to right text is written vertically from top to bottom.
  584. Right to left text is written vertically from bottom to top.
  585. .. rst-class:: classref-item-separator
  586. ----
  587. .. _enum_TextServer_JustificationFlag:
  588. .. rst-class:: classref-enumeration
  589. flags **JustificationFlag**: :ref:`๐Ÿ”—<enum_TextServer_JustificationFlag>`
  590. .. _class_TextServer_constant_JUSTIFICATION_NONE:
  591. .. rst-class:: classref-enumeration-constant
  592. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_NONE** = ``0``
  593. Do not justify text.
  594. .. _class_TextServer_constant_JUSTIFICATION_KASHIDA:
  595. .. rst-class:: classref-enumeration-constant
  596. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_KASHIDA** = ``1``
  597. Justify text by adding and removing kashidas.
  598. .. _class_TextServer_constant_JUSTIFICATION_WORD_BOUND:
  599. .. rst-class:: classref-enumeration-constant
  600. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_WORD_BOUND** = ``2``
  601. Justify text by changing width of the spaces between the words.
  602. .. _class_TextServer_constant_JUSTIFICATION_TRIM_EDGE_SPACES:
  603. .. rst-class:: classref-enumeration-constant
  604. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_TRIM_EDGE_SPACES** = ``4``
  605. Remove trailing and leading spaces from the justified text.
  606. .. _class_TextServer_constant_JUSTIFICATION_AFTER_LAST_TAB:
  607. .. rst-class:: classref-enumeration-constant
  608. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_AFTER_LAST_TAB** = ``8``
  609. Only apply justification to the part of the text after the last tab.
  610. .. _class_TextServer_constant_JUSTIFICATION_CONSTRAIN_ELLIPSIS:
  611. .. rst-class:: classref-enumeration-constant
  612. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_CONSTRAIN_ELLIPSIS** = ``16``
  613. Apply justification to the trimmed line with ellipsis.
  614. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE:
  615. .. rst-class:: classref-enumeration-constant
  616. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE** = ``32``
  617. Do not apply justification to the last line of the paragraph.
  618. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS:
  619. .. rst-class:: classref-enumeration-constant
  620. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS** = ``64``
  621. 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>`).
  622. .. _class_TextServer_constant_JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE:
  623. .. rst-class:: classref-enumeration-constant
  624. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE** = ``128``
  625. 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).
  626. .. rst-class:: classref-item-separator
  627. ----
  628. .. _enum_TextServer_AutowrapMode:
  629. .. rst-class:: classref-enumeration
  630. enum **AutowrapMode**: :ref:`๐Ÿ”—<enum_TextServer_AutowrapMode>`
  631. .. _class_TextServer_constant_AUTOWRAP_OFF:
  632. .. rst-class:: classref-enumeration-constant
  633. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_OFF** = ``0``
  634. Autowrap is disabled.
  635. .. _class_TextServer_constant_AUTOWRAP_ARBITRARY:
  636. .. rst-class:: classref-enumeration-constant
  637. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_ARBITRARY** = ``1``
  638. 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.
  639. .. _class_TextServer_constant_AUTOWRAP_WORD:
  640. .. rst-class:: classref-enumeration-constant
  641. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD** = ``2``
  642. Wraps the text inside the node's bounding rectangle by soft-breaking between words.
  643. .. _class_TextServer_constant_AUTOWRAP_WORD_SMART:
  644. .. rst-class:: classref-enumeration-constant
  645. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD_SMART** = ``3``
  646. 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.
  647. .. rst-class:: classref-item-separator
  648. ----
  649. .. _enum_TextServer_LineBreakFlag:
  650. .. rst-class:: classref-enumeration
  651. flags **LineBreakFlag**: :ref:`๐Ÿ”—<enum_TextServer_LineBreakFlag>`
  652. .. _class_TextServer_constant_BREAK_NONE:
  653. .. rst-class:: classref-enumeration-constant
  654. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_NONE** = ``0``
  655. Do not break the line.
  656. .. _class_TextServer_constant_BREAK_MANDATORY:
  657. .. rst-class:: classref-enumeration-constant
  658. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_MANDATORY** = ``1``
  659. Break the line at the line mandatory break characters (e.g. ``"\n"``).
  660. .. _class_TextServer_constant_BREAK_WORD_BOUND:
  661. .. rst-class:: classref-enumeration-constant
  662. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_WORD_BOUND** = ``2``
  663. Break the line between the words.
  664. .. _class_TextServer_constant_BREAK_GRAPHEME_BOUND:
  665. .. rst-class:: classref-enumeration-constant
  666. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_GRAPHEME_BOUND** = ``4``
  667. Break the line between any unconnected graphemes.
  668. .. _class_TextServer_constant_BREAK_ADAPTIVE:
  669. .. rst-class:: classref-enumeration-constant
  670. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_ADAPTIVE** = ``8``
  671. 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.
  672. .. _class_TextServer_constant_BREAK_TRIM_EDGE_SPACES:
  673. .. rst-class:: classref-enumeration-constant
  674. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_EDGE_SPACES** = ``16``
  675. **Deprecated:** Use ``BREAK_TRIM_START_EDGE_SPACES | BREAK_TRIM_END_EDGE_SPACES`` instead.
  676. Remove edge spaces from the broken line segments.
  677. .. _class_TextServer_constant_BREAK_TRIM_INDENT:
  678. .. rst-class:: classref-enumeration-constant
  679. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_INDENT** = ``32``
  680. Subtract first line indentation width from all lines after the first one.
  681. .. _class_TextServer_constant_BREAK_TRIM_START_EDGE_SPACES:
  682. .. rst-class:: classref-enumeration-constant
  683. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_START_EDGE_SPACES** = ``64``
  684. Remove spaces and line break characters from the start of broken line segments.
  685. E.g, after line breaking, the second segment of the following text ``test \n next``, is ``next`` if the flag is set, and `` next`` if it is not.
  686. .. _class_TextServer_constant_BREAK_TRIM_END_EDGE_SPACES:
  687. .. rst-class:: classref-enumeration-constant
  688. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_END_EDGE_SPACES** = ``128``
  689. Remove spaces and line break characters from the end of broken line segments.
  690. E.g, after line breaking, the first segment of the following text ``test \n next``, is ``test`` if the flag is set, and ``test \n`` if it is not.
  691. .. rst-class:: classref-item-separator
  692. ----
  693. .. _enum_TextServer_VisibleCharactersBehavior:
  694. .. rst-class:: classref-enumeration
  695. enum **VisibleCharactersBehavior**: :ref:`๐Ÿ”—<enum_TextServer_VisibleCharactersBehavior>`
  696. .. _class_TextServer_constant_VC_CHARS_BEFORE_SHAPING:
  697. .. rst-class:: classref-enumeration-constant
  698. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_BEFORE_SHAPING** = ``0``
  699. 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.
  700. \ **Note:** In this mode, trimmed text is not processed at all. It is not accounted for in line breaking and size calculations.
  701. .. _class_TextServer_constant_VC_CHARS_AFTER_SHAPING:
  702. .. rst-class:: classref-enumeration-constant
  703. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_AFTER_SHAPING** = ``1``
  704. 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.
  705. .. _class_TextServer_constant_VC_GLYPHS_AUTO:
  706. .. rst-class:: classref-enumeration-constant
  707. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_AUTO** = ``2``
  708. 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.
  709. .. _class_TextServer_constant_VC_GLYPHS_LTR:
  710. .. rst-class:: classref-enumeration-constant
  711. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_LTR** = ``3``
  712. 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.
  713. .. _class_TextServer_constant_VC_GLYPHS_RTL:
  714. .. rst-class:: classref-enumeration-constant
  715. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_RTL** = ``4``
  716. 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.
  717. .. rst-class:: classref-item-separator
  718. ----
  719. .. _enum_TextServer_OverrunBehavior:
  720. .. rst-class:: classref-enumeration
  721. enum **OverrunBehavior**: :ref:`๐Ÿ”—<enum_TextServer_OverrunBehavior>`
  722. .. _class_TextServer_constant_OVERRUN_NO_TRIMMING:
  723. .. rst-class:: classref-enumeration-constant
  724. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_NO_TRIMMING** = ``0``
  725. No text trimming is performed.
  726. .. _class_TextServer_constant_OVERRUN_TRIM_CHAR:
  727. .. rst-class:: classref-enumeration-constant
  728. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_CHAR** = ``1``
  729. Trims the text per character.
  730. .. _class_TextServer_constant_OVERRUN_TRIM_WORD:
  731. .. rst-class:: classref-enumeration-constant
  732. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD** = ``2``
  733. Trims the text per word.
  734. .. _class_TextServer_constant_OVERRUN_TRIM_ELLIPSIS:
  735. .. rst-class:: classref-enumeration-constant
  736. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_ELLIPSIS** = ``3``
  737. Trims the text per character and adds an ellipsis to indicate that parts are hidden if trimmed text is 6 characters or longer.
  738. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ELLIPSIS:
  739. .. rst-class:: classref-enumeration-constant
  740. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD_ELLIPSIS** = ``4``
  741. Trims the text per word and adds an ellipsis to indicate that parts are hidden if trimmed text is 6 characters or longer.
  742. .. _class_TextServer_constant_OVERRUN_TRIM_ELLIPSIS_FORCE:
  743. .. rst-class:: classref-enumeration-constant
  744. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_ELLIPSIS_FORCE** = ``5``
  745. Trims the text per character and adds an ellipsis to indicate that parts are hidden regardless of trimmed text length.
  746. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ELLIPSIS_FORCE:
  747. .. rst-class:: classref-enumeration-constant
  748. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD_ELLIPSIS_FORCE** = ``6``
  749. Trims the text per word and adds an ellipsis to indicate that parts are hidden regardless of trimmed text length.
  750. .. rst-class:: classref-item-separator
  751. ----
  752. .. _enum_TextServer_TextOverrunFlag:
  753. .. rst-class:: classref-enumeration
  754. flags **TextOverrunFlag**: :ref:`๐Ÿ”—<enum_TextServer_TextOverrunFlag>`
  755. .. _class_TextServer_constant_OVERRUN_NO_TRIM:
  756. .. rst-class:: classref-enumeration-constant
  757. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_NO_TRIM** = ``0``
  758. No trimming is performed.
  759. .. _class_TextServer_constant_OVERRUN_TRIM:
  760. .. rst-class:: classref-enumeration-constant
  761. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM** = ``1``
  762. Trims the text when it exceeds the given width.
  763. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ONLY:
  764. .. rst-class:: classref-enumeration-constant
  765. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM_WORD_ONLY** = ``2``
  766. Trims the text per word instead of per grapheme.
  767. .. _class_TextServer_constant_OVERRUN_ADD_ELLIPSIS:
  768. .. rst-class:: classref-enumeration-constant
  769. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ADD_ELLIPSIS** = ``4``
  770. Determines whether an ellipsis should be added at the end of the text.
  771. .. _class_TextServer_constant_OVERRUN_ENFORCE_ELLIPSIS:
  772. .. rst-class:: classref-enumeration-constant
  773. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ENFORCE_ELLIPSIS** = ``8``
  774. Determines whether the ellipsis at the end of the text is enforced and may not be hidden.
  775. .. _class_TextServer_constant_OVERRUN_JUSTIFICATION_AWARE:
  776. .. rst-class:: classref-enumeration-constant
  777. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_JUSTIFICATION_AWARE** = ``16``
  778. Accounts for the text being justified before attempting to trim it (see :ref:`JustificationFlag<enum_TextServer_JustificationFlag>`).
  779. .. rst-class:: classref-item-separator
  780. ----
  781. .. _enum_TextServer_GraphemeFlag:
  782. .. rst-class:: classref-enumeration
  783. flags **GraphemeFlag**: :ref:`๐Ÿ”—<enum_TextServer_GraphemeFlag>`
  784. .. _class_TextServer_constant_GRAPHEME_IS_VALID:
  785. .. rst-class:: classref-enumeration-constant
  786. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VALID** = ``1``
  787. Grapheme is supported by the font, and can be drawn.
  788. .. _class_TextServer_constant_GRAPHEME_IS_RTL:
  789. .. rst-class:: classref-enumeration-constant
  790. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_RTL** = ``2``
  791. Grapheme is part of right-to-left or bottom-to-top run.
  792. .. _class_TextServer_constant_GRAPHEME_IS_VIRTUAL:
  793. .. rst-class:: classref-enumeration-constant
  794. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VIRTUAL** = ``4``
  795. Grapheme is not part of source text, it was added by justification process.
  796. .. _class_TextServer_constant_GRAPHEME_IS_SPACE:
  797. .. rst-class:: classref-enumeration-constant
  798. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SPACE** = ``8``
  799. Grapheme is whitespace.
  800. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_HARD:
  801. .. rst-class:: classref-enumeration-constant
  802. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_HARD** = ``16``
  803. Grapheme is mandatory break point (e.g. ``"\n"``).
  804. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_SOFT:
  805. .. rst-class:: classref-enumeration-constant
  806. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_SOFT** = ``32``
  807. Grapheme is optional break point (e.g. space).
  808. .. _class_TextServer_constant_GRAPHEME_IS_TAB:
  809. .. rst-class:: classref-enumeration-constant
  810. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_TAB** = ``64``
  811. Grapheme is the tabulation character.
  812. .. _class_TextServer_constant_GRAPHEME_IS_ELONGATION:
  813. .. rst-class:: classref-enumeration-constant
  814. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_ELONGATION** = ``128``
  815. Grapheme is kashida.
  816. .. _class_TextServer_constant_GRAPHEME_IS_PUNCTUATION:
  817. .. rst-class:: classref-enumeration-constant
  818. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_PUNCTUATION** = ``256``
  819. Grapheme is punctuation character.
  820. .. _class_TextServer_constant_GRAPHEME_IS_UNDERSCORE:
  821. .. rst-class:: classref-enumeration-constant
  822. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_UNDERSCORE** = ``512``
  823. Grapheme is underscore character.
  824. .. _class_TextServer_constant_GRAPHEME_IS_CONNECTED:
  825. .. rst-class:: classref-enumeration-constant
  826. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_CONNECTED** = ``1024``
  827. Grapheme is connected to the previous grapheme. Breaking line before this grapheme is not safe.
  828. .. _class_TextServer_constant_GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL:
  829. .. rst-class:: classref-enumeration-constant
  830. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL** = ``2048``
  831. It is safe to insert a U+0640 before this grapheme for elongation.
  832. .. _class_TextServer_constant_GRAPHEME_IS_EMBEDDED_OBJECT:
  833. .. rst-class:: classref-enumeration-constant
  834. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_EMBEDDED_OBJECT** = ``4096``
  835. Grapheme is an object replacement character for the embedded object.
  836. .. _class_TextServer_constant_GRAPHEME_IS_SOFT_HYPHEN:
  837. .. rst-class:: classref-enumeration-constant
  838. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SOFT_HYPHEN** = ``8192``
  839. Grapheme is a soft hyphen.
  840. .. rst-class:: classref-item-separator
  841. ----
  842. .. _enum_TextServer_Hinting:
  843. .. rst-class:: classref-enumeration
  844. enum **Hinting**: :ref:`๐Ÿ”—<enum_TextServer_Hinting>`
  845. .. _class_TextServer_constant_HINTING_NONE:
  846. .. rst-class:: classref-enumeration-constant
  847. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NONE** = ``0``
  848. Disables font hinting (smoother but less crisp).
  849. .. _class_TextServer_constant_HINTING_LIGHT:
  850. .. rst-class:: classref-enumeration-constant
  851. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_LIGHT** = ``1``
  852. Use the light font hinting mode.
  853. .. _class_TextServer_constant_HINTING_NORMAL:
  854. .. rst-class:: classref-enumeration-constant
  855. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NORMAL** = ``2``
  856. Use the default font hinting mode (crisper but less smooth).
  857. \ **Note:** This hinting mode changes both horizontal and vertical glyph metrics. If applied to monospace font, some glyphs might have different width.
  858. .. rst-class:: classref-item-separator
  859. ----
  860. .. _enum_TextServer_SubpixelPositioning:
  861. .. rst-class:: classref-enumeration
  862. enum **SubpixelPositioning**: :ref:`๐Ÿ”—<enum_TextServer_SubpixelPositioning>`
  863. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_DISABLED:
  864. .. rst-class:: classref-enumeration-constant
  865. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_DISABLED** = ``0``
  866. Glyph horizontal position is rounded to the whole pixel size, each glyph is rasterized once.
  867. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO:
  868. .. rst-class:: classref-enumeration-constant
  869. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_AUTO** = ``1``
  870. Glyph horizontal position is rounded based on font size.
  871. - 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>`.
  872. - 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>`.
  873. - To the whole pixel size for larger fonts.
  874. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF:
  875. .. rst-class:: classref-enumeration-constant
  876. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF** = ``2``
  877. Glyph horizontal position is rounded to one half of the pixel size, each glyph is rasterized up to two times.
  878. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER:
  879. .. rst-class:: classref-enumeration-constant
  880. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER** = ``3``
  881. Glyph horizontal position is rounded to one quarter of the pixel size, each glyph is rasterized up to four times.
  882. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE:
  883. .. rst-class:: classref-enumeration-constant
  884. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE** = ``20``
  885. 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.
  886. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE:
  887. .. rst-class:: classref-enumeration-constant
  888. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE** = ``16``
  889. 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.
  890. .. rst-class:: classref-item-separator
  891. ----
  892. .. _enum_TextServer_Feature:
  893. .. rst-class:: classref-enumeration
  894. enum **Feature**: :ref:`๐Ÿ”—<enum_TextServer_Feature>`
  895. .. _class_TextServer_constant_FEATURE_SIMPLE_LAYOUT:
  896. .. rst-class:: classref-enumeration-constant
  897. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SIMPLE_LAYOUT** = ``1``
  898. TextServer supports simple text layouts.
  899. .. _class_TextServer_constant_FEATURE_BIDI_LAYOUT:
  900. .. rst-class:: classref-enumeration-constant
  901. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BIDI_LAYOUT** = ``2``
  902. TextServer supports bidirectional text layouts.
  903. .. _class_TextServer_constant_FEATURE_VERTICAL_LAYOUT:
  904. .. rst-class:: classref-enumeration-constant
  905. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_VERTICAL_LAYOUT** = ``4``
  906. TextServer supports vertical layouts.
  907. .. _class_TextServer_constant_FEATURE_SHAPING:
  908. .. rst-class:: classref-enumeration-constant
  909. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SHAPING** = ``8``
  910. TextServer supports complex text shaping.
  911. .. _class_TextServer_constant_FEATURE_KASHIDA_JUSTIFICATION:
  912. .. rst-class:: classref-enumeration-constant
  913. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_KASHIDA_JUSTIFICATION** = ``16``
  914. TextServer supports justification using kashidas.
  915. .. _class_TextServer_constant_FEATURE_BREAK_ITERATORS:
  916. .. rst-class:: classref-enumeration-constant
  917. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BREAK_ITERATORS** = ``32``
  918. TextServer supports complex line/word breaking rules (e.g. dictionary based).
  919. .. _class_TextServer_constant_FEATURE_FONT_BITMAP:
  920. .. rst-class:: classref-enumeration-constant
  921. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_BITMAP** = ``64``
  922. TextServer supports loading bitmap fonts.
  923. .. _class_TextServer_constant_FEATURE_FONT_DYNAMIC:
  924. .. rst-class:: classref-enumeration-constant
  925. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_DYNAMIC** = ``128``
  926. TextServer supports loading dynamic (TrueType, OpeType, etc.) fonts.
  927. .. _class_TextServer_constant_FEATURE_FONT_MSDF:
  928. .. rst-class:: classref-enumeration-constant
  929. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_MSDF** = ``256``
  930. TextServer supports multichannel signed distance field dynamic font rendering.
  931. .. _class_TextServer_constant_FEATURE_FONT_SYSTEM:
  932. .. rst-class:: classref-enumeration-constant
  933. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_SYSTEM** = ``512``
  934. TextServer supports loading system fonts.
  935. .. _class_TextServer_constant_FEATURE_FONT_VARIABLE:
  936. .. rst-class:: classref-enumeration-constant
  937. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_VARIABLE** = ``1024``
  938. TextServer supports variable fonts.
  939. .. _class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION:
  940. .. rst-class:: classref-enumeration-constant
  941. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION** = ``2048``
  942. TextServer supports locale dependent and context sensitive case conversion.
  943. .. _class_TextServer_constant_FEATURE_USE_SUPPORT_DATA:
  944. .. rst-class:: classref-enumeration-constant
  945. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_USE_SUPPORT_DATA** = ``4096``
  946. TextServer require external data file for some features, see :ref:`load_support_data()<class_TextServer_method_load_support_data>`.
  947. .. _class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS:
  948. .. rst-class:: classref-enumeration-constant
  949. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_IDENTIFIERS** = ``8192``
  950. TextServer supports UAX #31 identifier validation, see :ref:`is_valid_identifier()<class_TextServer_method_is_valid_identifier>`.
  951. .. _class_TextServer_constant_FEATURE_UNICODE_SECURITY:
  952. .. rst-class:: classref-enumeration-constant
  953. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_SECURITY** = ``16384``
  954. 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.
  955. .. rst-class:: classref-item-separator
  956. ----
  957. .. _enum_TextServer_ContourPointTag:
  958. .. rst-class:: classref-enumeration
  959. enum **ContourPointTag**: :ref:`๐Ÿ”—<enum_TextServer_ContourPointTag>`
  960. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_ON:
  961. .. rst-class:: classref-enumeration-constant
  962. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_ON** = ``1``
  963. Contour point is on the curve.
  964. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC:
  965. .. rst-class:: classref-enumeration-constant
  966. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CONIC** = ``0``
  967. Contour point isn't on the curve, but serves as a control point for a conic (quadratic) Bรฉzier arc.
  968. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CUBIC:
  969. .. rst-class:: classref-enumeration-constant
  970. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CUBIC** = ``2``
  971. Contour point isn't on the curve, but serves as a control point for a cubic Bรฉzier arc.
  972. .. rst-class:: classref-item-separator
  973. ----
  974. .. _enum_TextServer_SpacingType:
  975. .. rst-class:: classref-enumeration
  976. enum **SpacingType**: :ref:`๐Ÿ”—<enum_TextServer_SpacingType>`
  977. .. _class_TextServer_constant_SPACING_GLYPH:
  978. .. rst-class:: classref-enumeration-constant
  979. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_GLYPH** = ``0``
  980. Spacing for each glyph.
  981. .. _class_TextServer_constant_SPACING_SPACE:
  982. .. rst-class:: classref-enumeration-constant
  983. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_SPACE** = ``1``
  984. Spacing for the space character.
  985. .. _class_TextServer_constant_SPACING_TOP:
  986. .. rst-class:: classref-enumeration-constant
  987. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_TOP** = ``2``
  988. Spacing at the top of the line.
  989. .. _class_TextServer_constant_SPACING_BOTTOM:
  990. .. rst-class:: classref-enumeration-constant
  991. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_BOTTOM** = ``3``
  992. Spacing at the bottom of the line.
  993. .. _class_TextServer_constant_SPACING_MAX:
  994. .. rst-class:: classref-enumeration-constant
  995. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_MAX** = ``4``
  996. Represents the size of the :ref:`SpacingType<enum_TextServer_SpacingType>` enum.
  997. .. rst-class:: classref-item-separator
  998. ----
  999. .. _enum_TextServer_FontStyle:
  1000. .. rst-class:: classref-enumeration
  1001. flags **FontStyle**: :ref:`๐Ÿ”—<enum_TextServer_FontStyle>`
  1002. .. _class_TextServer_constant_FONT_BOLD:
  1003. .. rst-class:: classref-enumeration-constant
  1004. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_BOLD** = ``1``
  1005. Font is bold.
  1006. .. _class_TextServer_constant_FONT_ITALIC:
  1007. .. rst-class:: classref-enumeration-constant
  1008. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_ITALIC** = ``2``
  1009. Font is italic or oblique.
  1010. .. _class_TextServer_constant_FONT_FIXED_WIDTH:
  1011. .. rst-class:: classref-enumeration-constant
  1012. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_FIXED_WIDTH** = ``4``
  1013. Font has fixed-width characters (also known as monospace).
  1014. .. rst-class:: classref-item-separator
  1015. ----
  1016. .. _enum_TextServer_StructuredTextParser:
  1017. .. rst-class:: classref-enumeration
  1018. enum **StructuredTextParser**: :ref:`๐Ÿ”—<enum_TextServer_StructuredTextParser>`
  1019. .. _class_TextServer_constant_STRUCTURED_TEXT_DEFAULT:
  1020. .. rst-class:: classref-enumeration-constant
  1021. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_DEFAULT** = ``0``
  1022. Use default Unicode BiDi algorithm.
  1023. .. _class_TextServer_constant_STRUCTURED_TEXT_URI:
  1024. .. rst-class:: classref-enumeration-constant
  1025. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_URI** = ``1``
  1026. BiDi override for URI.
  1027. .. _class_TextServer_constant_STRUCTURED_TEXT_FILE:
  1028. .. rst-class:: classref-enumeration-constant
  1029. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_FILE** = ``2``
  1030. BiDi override for file path.
  1031. .. _class_TextServer_constant_STRUCTURED_TEXT_EMAIL:
  1032. .. rst-class:: classref-enumeration-constant
  1033. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_EMAIL** = ``3``
  1034. BiDi override for email.
  1035. .. _class_TextServer_constant_STRUCTURED_TEXT_LIST:
  1036. .. rst-class:: classref-enumeration-constant
  1037. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_LIST** = ``4``
  1038. BiDi override for lists. Structured text options: list separator :ref:`String<class_String>`.
  1039. .. _class_TextServer_constant_STRUCTURED_TEXT_GDSCRIPT:
  1040. .. rst-class:: classref-enumeration-constant
  1041. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_GDSCRIPT** = ``5``
  1042. BiDi override for GDScript.
  1043. .. _class_TextServer_constant_STRUCTURED_TEXT_CUSTOM:
  1044. .. rst-class:: classref-enumeration-constant
  1045. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_CUSTOM** = ``6``
  1046. User defined structured text BiDi override function.
  1047. .. rst-class:: classref-item-separator
  1048. ----
  1049. .. _enum_TextServer_FixedSizeScaleMode:
  1050. .. rst-class:: classref-enumeration
  1051. enum **FixedSizeScaleMode**: :ref:`๐Ÿ”—<enum_TextServer_FixedSizeScaleMode>`
  1052. .. _class_TextServer_constant_FIXED_SIZE_SCALE_DISABLE:
  1053. .. rst-class:: classref-enumeration-constant
  1054. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_DISABLE** = ``0``
  1055. Bitmap font is not scaled.
  1056. .. _class_TextServer_constant_FIXED_SIZE_SCALE_INTEGER_ONLY:
  1057. .. rst-class:: classref-enumeration-constant
  1058. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_INTEGER_ONLY** = ``1``
  1059. Bitmap font is scaled to the closest integer multiple of the font's fixed size. This is the recommended option for pixel art fonts.
  1060. .. _class_TextServer_constant_FIXED_SIZE_SCALE_ENABLED:
  1061. .. rst-class:: classref-enumeration-constant
  1062. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_ENABLED** = ``2``
  1063. Bitmap font is scaled to an arbitrary (fractional) size. This is the recommended option for non-pixel art fonts.
  1064. .. rst-class:: classref-section-separator
  1065. ----
  1066. .. rst-class:: classref-descriptions-group
  1067. Method Descriptions
  1068. -------------------
  1069. .. _class_TextServer_method_create_font:
  1070. .. rst-class:: classref-method
  1071. :ref:`RID<class_RID>` **create_font**\ (\ ) :ref:`๐Ÿ”—<class_TextServer_method_create_font>`
  1072. Creates a new, empty font cache entry resource. To free the resulting resource, use the :ref:`free_rid()<class_TextServer_method_free_rid>` method.
  1073. .. rst-class:: classref-item-separator
  1074. ----
  1075. .. _class_TextServer_method_create_font_linked_variation:
  1076. .. rst-class:: classref-method
  1077. :ref:`RID<class_RID>` **create_font_linked_variation**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_create_font_linked_variation>`
  1078. 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.
  1079. .. rst-class:: classref-item-separator
  1080. ----
  1081. .. _class_TextServer_method_create_shaped_text:
  1082. .. rst-class:: classref-method
  1083. :ref:`RID<class_RID>` **create_shaped_text**\ (\ direction\: :ref:`Direction<enum_TextServer_Direction>` = 0, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) :ref:`๐Ÿ”—<class_TextServer_method_create_shaped_text>`
  1084. Creates a 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.
  1085. \ **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>`).
  1086. \ **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>`).
  1087. .. rst-class:: classref-item-separator
  1088. ----
  1089. .. _class_TextServer_method_draw_hex_code_box:
  1090. .. rst-class:: classref-method
  1091. |void| **draw_hex_code_box**\ (\ canvas\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, pos\: :ref:`Vector2<class_Vector2>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_draw_hex_code_box>`
  1092. Draws box displaying character hexadecimal code. Used for replacing missing characters.
  1093. .. rst-class:: classref-item-separator
  1094. ----
  1095. .. _class_TextServer_method_font_clear_glyphs:
  1096. .. rst-class:: classref-method
  1097. |void| **font_clear_glyphs**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_glyphs>`
  1098. Removes all rendered glyph information from the cache entry.
  1099. \ **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.
  1100. .. rst-class:: classref-item-separator
  1101. ----
  1102. .. _class_TextServer_method_font_clear_kerning_map:
  1103. .. rst-class:: classref-method
  1104. |void| **font_clear_kerning_map**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_kerning_map>`
  1105. Removes all kerning overrides.
  1106. .. rst-class:: classref-item-separator
  1107. ----
  1108. .. _class_TextServer_method_font_clear_size_cache:
  1109. .. rst-class:: classref-method
  1110. |void| **font_clear_size_cache**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_size_cache>`
  1111. Removes all font sizes from the cache entry.
  1112. .. rst-class:: classref-item-separator
  1113. ----
  1114. .. _class_TextServer_method_font_clear_system_fallback_cache:
  1115. .. rst-class:: classref-method
  1116. |void| **font_clear_system_fallback_cache**\ (\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_system_fallback_cache>`
  1117. Frees all automatically loaded system fonts.
  1118. .. rst-class:: classref-item-separator
  1119. ----
  1120. .. _class_TextServer_method_font_clear_textures:
  1121. .. rst-class:: classref-method
  1122. |void| **font_clear_textures**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_textures>`
  1123. Removes all textures from font cache entry.
  1124. \ **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.
  1125. .. rst-class:: classref-item-separator
  1126. ----
  1127. .. _class_TextServer_method_font_draw_glyph:
  1128. .. rst-class:: classref-method
  1129. |void| **font_draw_glyph**\ (\ font_rid\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, pos\: :ref:`Vector2<class_Vector2>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), oversampling\: :ref:`float<class_float>` = 0.0\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_draw_glyph>`
  1130. Draws single glyph into a canvas item at the position, using ``font_rid`` at the size ``size``. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
  1131. \ **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>`.
  1132. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1133. .. rst-class:: classref-item-separator
  1134. ----
  1135. .. _class_TextServer_method_font_draw_glyph_outline:
  1136. .. rst-class:: classref-method
  1137. |void| **font_draw_glyph_outline**\ (\ font_rid\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, outline_size\: :ref:`int<class_int>`, pos\: :ref:`Vector2<class_Vector2>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), oversampling\: :ref:`float<class_float>` = 0.0\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_draw_glyph_outline>`
  1138. Draws single glyph outline of size ``outline_size`` into a canvas item at the position, using ``font_rid`` at the size ``size``. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
  1139. \ **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>`.
  1140. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1141. .. rst-class:: classref-item-separator
  1142. ----
  1143. .. _class_TextServer_method_font_get_antialiasing:
  1144. .. rst-class:: classref-method
  1145. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **font_get_antialiasing**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_antialiasing>`
  1146. Returns font anti-aliasing mode.
  1147. .. rst-class:: classref-item-separator
  1148. ----
  1149. .. _class_TextServer_method_font_get_ascent:
  1150. .. rst-class:: classref-method
  1151. :ref:`float<class_float>` **font_get_ascent**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_ascent>`
  1152. Returns the font ascent (number of pixels above the baseline).
  1153. .. rst-class:: classref-item-separator
  1154. ----
  1155. .. _class_TextServer_method_font_get_baseline_offset:
  1156. .. rst-class:: classref-method
  1157. :ref:`float<class_float>` **font_get_baseline_offset**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_baseline_offset>`
  1158. Returns extra baseline offset (as a fraction of font height).
  1159. .. rst-class:: classref-item-separator
  1160. ----
  1161. .. _class_TextServer_method_font_get_char_from_glyph_index:
  1162. .. rst-class:: classref-method
  1163. :ref:`int<class_int>` **font_get_char_from_glyph_index**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_char_from_glyph_index>`
  1164. 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>`.
  1165. .. rst-class:: classref-item-separator
  1166. ----
  1167. .. _class_TextServer_method_font_get_descent:
  1168. .. rst-class:: classref-method
  1169. :ref:`float<class_float>` **font_get_descent**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_descent>`
  1170. Returns the font descent (number of pixels below the baseline).
  1171. .. rst-class:: classref-item-separator
  1172. ----
  1173. .. _class_TextServer_method_font_get_disable_embedded_bitmaps:
  1174. .. rst-class:: classref-method
  1175. :ref:`bool<class_bool>` **font_get_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_disable_embedded_bitmaps>`
  1176. Returns whether the font's embedded bitmap loading is disabled.
  1177. .. rst-class:: classref-item-separator
  1178. ----
  1179. .. _class_TextServer_method_font_get_embolden:
  1180. .. rst-class:: classref-method
  1181. :ref:`float<class_float>` **font_get_embolden**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_embolden>`
  1182. Returns font embolden strength.
  1183. .. rst-class:: classref-item-separator
  1184. ----
  1185. .. _class_TextServer_method_font_get_face_count:
  1186. .. rst-class:: classref-method
  1187. :ref:`int<class_int>` **font_get_face_count**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_face_count>`
  1188. Returns number of faces in the TrueType / OpenType collection.
  1189. .. rst-class:: classref-item-separator
  1190. ----
  1191. .. _class_TextServer_method_font_get_face_index:
  1192. .. rst-class:: classref-method
  1193. :ref:`int<class_int>` **font_get_face_index**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_face_index>`
  1194. Returns an active face index in the TrueType / OpenType collection.
  1195. .. rst-class:: classref-item-separator
  1196. ----
  1197. .. _class_TextServer_method_font_get_fixed_size:
  1198. .. rst-class:: classref-method
  1199. :ref:`int<class_int>` **font_get_fixed_size**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_fixed_size>`
  1200. Returns bitmap font fixed size.
  1201. .. rst-class:: classref-item-separator
  1202. ----
  1203. .. _class_TextServer_method_font_get_fixed_size_scale_mode:
  1204. .. rst-class:: classref-method
  1205. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **font_get_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_fixed_size_scale_mode>`
  1206. Returns bitmap font scaling mode.
  1207. .. rst-class:: classref-item-separator
  1208. ----
  1209. .. _class_TextServer_method_font_get_generate_mipmaps:
  1210. .. rst-class:: classref-method
  1211. :ref:`bool<class_bool>` **font_get_generate_mipmaps**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_generate_mipmaps>`
  1212. Returns ``true`` if font texture mipmap generation is enabled.
  1213. .. rst-class:: classref-item-separator
  1214. ----
  1215. .. _class_TextServer_method_font_get_global_oversampling:
  1216. .. rst-class:: classref-method
  1217. :ref:`float<class_float>` **font_get_global_oversampling**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_global_oversampling>`
  1218. **Deprecated:** Use :ref:`Viewport<class_Viewport>` oversampling, or the ``oversampling`` argument of the ``draw_*`` methods instead.
  1219. Deprecated. This method always returns ``1.0``.
  1220. .. rst-class:: classref-item-separator
  1221. ----
  1222. .. _class_TextServer_method_font_get_glyph_advance:
  1223. .. rst-class:: classref-method
  1224. :ref:`Vector2<class_Vector2>` **font_get_glyph_advance**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_advance>`
  1225. Returns glyph advance (offset of the next glyph).
  1226. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1227. .. rst-class:: classref-item-separator
  1228. ----
  1229. .. _class_TextServer_method_font_get_glyph_contours:
  1230. .. rst-class:: classref-method
  1231. :ref:`Dictionary<class_Dictionary>` **font_get_glyph_contours**\ (\ font\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_contours>`
  1232. Returns outline contours of the glyph as a :ref:`Dictionary<class_Dictionary>` with the following contents:
  1233. \ ``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.
  1234. \ ``contours`` - :ref:`PackedInt32Array<class_PackedInt32Array>`, containing indices the end points of each contour.
  1235. \ ``orientation`` - :ref:`bool<class_bool>`, contour orientation. If ``true``, clockwise contours must be filled.
  1236. - Two successive :ref:`CONTOUR_CURVE_TAG_ON<class_TextServer_constant_CONTOUR_CURVE_TAG_ON>` points indicate a line segment.
  1237. - One :ref:`CONTOUR_CURVE_TAG_OFF_CONIC<class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC>` point between two :ref:`CONTOUR_CURVE_TAG_ON<class_TextServer_constant_CONTOUR_CURVE_TAG_ON>` points indicates a single conic (quadratic) Bรฉzier arc.
  1238. - Two :ref:`CONTOUR_CURVE_TAG_OFF_CUBIC<class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CUBIC>` points between two :ref:`CONTOUR_CURVE_TAG_ON<class_TextServer_constant_CONTOUR_CURVE_TAG_ON>` points indicate a single cubic Bรฉzier arc.
  1239. - Two successive :ref:`CONTOUR_CURVE_TAG_OFF_CONIC<class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC>` points indicate two successive conic (quadratic) Bรฉzier arcs with a virtual :ref:`CONTOUR_CURVE_TAG_ON<class_TextServer_constant_CONTOUR_CURVE_TAG_ON>` point at their middle.
  1240. - Each contour is closed. The last point of a contour uses the first point of a contour as its next point, and vice versa. The first point can be :ref:`CONTOUR_CURVE_TAG_OFF_CONIC<class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC>` point.
  1241. .. rst-class:: classref-item-separator
  1242. ----
  1243. .. _class_TextServer_method_font_get_glyph_index:
  1244. .. rst-class:: classref-method
  1245. :ref:`int<class_int>` **font_get_glyph_index**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, char\: :ref:`int<class_int>`, variation_selector\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_index>`
  1246. 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>`.
  1247. .. rst-class:: classref-item-separator
  1248. ----
  1249. .. _class_TextServer_method_font_get_glyph_list:
  1250. .. rst-class:: classref-method
  1251. :ref:`PackedInt32Array<class_PackedInt32Array>` **font_get_glyph_list**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_list>`
  1252. Returns list of rendered glyphs in the cache entry.
  1253. .. rst-class:: classref-item-separator
  1254. ----
  1255. .. _class_TextServer_method_font_get_glyph_offset:
  1256. .. rst-class:: classref-method
  1257. :ref:`Vector2<class_Vector2>` **font_get_glyph_offset**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_offset>`
  1258. Returns glyph offset from the baseline.
  1259. .. rst-class:: classref-item-separator
  1260. ----
  1261. .. _class_TextServer_method_font_get_glyph_size:
  1262. .. rst-class:: classref-method
  1263. :ref:`Vector2<class_Vector2>` **font_get_glyph_size**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_size>`
  1264. Returns size of the glyph.
  1265. .. rst-class:: classref-item-separator
  1266. ----
  1267. .. _class_TextServer_method_font_get_glyph_texture_idx:
  1268. .. rst-class:: classref-method
  1269. :ref:`int<class_int>` **font_get_glyph_texture_idx**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_texture_idx>`
  1270. Returns index of the cache texture containing the glyph.
  1271. .. rst-class:: classref-item-separator
  1272. ----
  1273. .. _class_TextServer_method_font_get_glyph_texture_rid:
  1274. .. rst-class:: classref-method
  1275. :ref:`RID<class_RID>` **font_get_glyph_texture_rid**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_texture_rid>`
  1276. Returns resource ID of the cache texture containing the glyph.
  1277. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1278. .. rst-class:: classref-item-separator
  1279. ----
  1280. .. _class_TextServer_method_font_get_glyph_texture_size:
  1281. .. rst-class:: classref-method
  1282. :ref:`Vector2<class_Vector2>` **font_get_glyph_texture_size**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_texture_size>`
  1283. Returns size of the cache texture containing the glyph.
  1284. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1285. .. rst-class:: classref-item-separator
  1286. ----
  1287. .. _class_TextServer_method_font_get_glyph_uv_rect:
  1288. .. rst-class:: classref-method
  1289. :ref:`Rect2<class_Rect2>` **font_get_glyph_uv_rect**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_uv_rect>`
  1290. Returns rectangle in the cache texture containing the glyph.
  1291. .. rst-class:: classref-item-separator
  1292. ----
  1293. .. _class_TextServer_method_font_get_hinting:
  1294. .. rst-class:: classref-method
  1295. :ref:`Hinting<enum_TextServer_Hinting>` **font_get_hinting**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_hinting>`
  1296. Returns the font hinting mode. Used by dynamic fonts only.
  1297. .. rst-class:: classref-item-separator
  1298. ----
  1299. .. _class_TextServer_method_font_get_keep_rounding_remainders:
  1300. .. rst-class:: classref-method
  1301. :ref:`bool<class_bool>` **font_get_keep_rounding_remainders**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_keep_rounding_remainders>`
  1302. Returns glyph position rounding behavior. If set to ``true``, when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled.
  1303. .. rst-class:: classref-item-separator
  1304. ----
  1305. .. _class_TextServer_method_font_get_kerning:
  1306. .. rst-class:: classref-method
  1307. :ref:`Vector2<class_Vector2>` **font_get_kerning**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_kerning>`
  1308. Returns kerning for the pair of glyphs.
  1309. .. rst-class:: classref-item-separator
  1310. ----
  1311. .. _class_TextServer_method_font_get_kerning_list:
  1312. .. rst-class:: classref-method
  1313. :ref:`Array<class_Array>`\[:ref:`Vector2i<class_Vector2i>`\] **font_get_kerning_list**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_kerning_list>`
  1314. Returns list of the kerning overrides.
  1315. .. rst-class:: classref-item-separator
  1316. ----
  1317. .. _class_TextServer_method_font_get_language_support_override:
  1318. .. rst-class:: classref-method
  1319. :ref:`bool<class_bool>` **font_get_language_support_override**\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_get_language_support_override>`
  1320. Returns ``true`` if support override is enabled for the ``language``.
  1321. .. rst-class:: classref-item-separator
  1322. ----
  1323. .. _class_TextServer_method_font_get_language_support_overrides:
  1324. .. rst-class:: classref-method
  1325. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_language_support_overrides**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_get_language_support_overrides>`
  1326. Returns list of language support overrides.
  1327. .. rst-class:: classref-item-separator
  1328. ----
  1329. .. _class_TextServer_method_font_get_msdf_pixel_range:
  1330. .. rst-class:: classref-method
  1331. :ref:`int<class_int>` **font_get_msdf_pixel_range**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_msdf_pixel_range>`
  1332. Returns the width of the range around the shape between the minimum and maximum representable signed distance.
  1333. .. rst-class:: classref-item-separator
  1334. ----
  1335. .. _class_TextServer_method_font_get_msdf_size:
  1336. .. rst-class:: classref-method
  1337. :ref:`int<class_int>` **font_get_msdf_size**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_msdf_size>`
  1338. Returns source font size used to generate MSDF textures.
  1339. .. rst-class:: classref-item-separator
  1340. ----
  1341. .. _class_TextServer_method_font_get_name:
  1342. .. rst-class:: classref-method
  1343. :ref:`String<class_String>` **font_get_name**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_name>`
  1344. Returns font family name.
  1345. .. rst-class:: classref-item-separator
  1346. ----
  1347. .. _class_TextServer_method_font_get_opentype_feature_overrides:
  1348. .. rst-class:: classref-method
  1349. :ref:`Dictionary<class_Dictionary>` **font_get_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_opentype_feature_overrides>`
  1350. Returns font OpenType feature set override.
  1351. .. rst-class:: classref-item-separator
  1352. ----
  1353. .. _class_TextServer_method_font_get_ot_name_strings:
  1354. .. rst-class:: classref-method
  1355. :ref:`Dictionary<class_Dictionary>` **font_get_ot_name_strings**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_ot_name_strings>`
  1356. Returns :ref:`Dictionary<class_Dictionary>` with OpenType font name strings (localized font names, version, description, license information, sample text, etc.).
  1357. .. rst-class:: classref-item-separator
  1358. ----
  1359. .. _class_TextServer_method_font_get_oversampling:
  1360. .. rst-class:: classref-method
  1361. :ref:`float<class_float>` **font_get_oversampling**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_oversampling>`
  1362. Returns oversampling factor override. If set to a positive value, overrides the oversampling factor of the viewport this font is used in. See :ref:`Viewport.oversampling<class_Viewport_property_oversampling>`. This value doesn't override the ``oversampling`` parameter of ``draw_*`` methods. Used by dynamic fonts only.
  1363. .. rst-class:: classref-item-separator
  1364. ----
  1365. .. _class_TextServer_method_font_get_scale:
  1366. .. rst-class:: classref-method
  1367. :ref:`float<class_float>` **font_get_scale**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_scale>`
  1368. Returns scaling factor of the color bitmap font.
  1369. .. rst-class:: classref-item-separator
  1370. ----
  1371. .. _class_TextServer_method_font_get_script_support_override:
  1372. .. rst-class:: classref-method
  1373. :ref:`bool<class_bool>` **font_get_script_support_override**\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_get_script_support_override>`
  1374. Returns ``true`` if support override is enabled for the ``script``.
  1375. .. rst-class:: classref-item-separator
  1376. ----
  1377. .. _class_TextServer_method_font_get_script_support_overrides:
  1378. .. rst-class:: classref-method
  1379. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_script_support_overrides**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_get_script_support_overrides>`
  1380. Returns list of script support overrides.
  1381. .. rst-class:: classref-item-separator
  1382. ----
  1383. .. _class_TextServer_method_font_get_size_cache_info:
  1384. .. rst-class:: classref-method
  1385. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **font_get_size_cache_info**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_size_cache_info>`
  1386. Returns font cache information, each entry contains the following fields: ``Vector2i size_px`` - font size in pixels, ``float viewport_oversampling`` - viewport oversampling factor, ``int glyphs`` - number of rendered glyphs, ``int textures`` - number of used textures, ``int textures_size`` - size of texture data in bytes.
  1387. .. rst-class:: classref-item-separator
  1388. ----
  1389. .. _class_TextServer_method_font_get_size_cache_list:
  1390. .. rst-class:: classref-method
  1391. :ref:`Array<class_Array>`\[:ref:`Vector2i<class_Vector2i>`\] **font_get_size_cache_list**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_size_cache_list>`
  1392. Returns list of the font sizes in the cache. Each size is :ref:`Vector2i<class_Vector2i>` with font size and outline size.
  1393. .. rst-class:: classref-item-separator
  1394. ----
  1395. .. _class_TextServer_method_font_get_spacing:
  1396. .. rst-class:: classref-method
  1397. :ref:`int<class_int>` **font_get_spacing**\ (\ font_rid\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_spacing>`
  1398. Returns the spacing for ``spacing`` in pixels (not relative to the font size).
  1399. .. rst-class:: classref-item-separator
  1400. ----
  1401. .. _class_TextServer_method_font_get_stretch:
  1402. .. rst-class:: classref-method
  1403. :ref:`int<class_int>` **font_get_stretch**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_stretch>`
  1404. Returns font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1405. .. rst-class:: classref-item-separator
  1406. ----
  1407. .. _class_TextServer_method_font_get_style:
  1408. .. rst-class:: classref-method
  1409. |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\] **font_get_style**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_style>`
  1410. Returns font style flags.
  1411. .. rst-class:: classref-item-separator
  1412. ----
  1413. .. _class_TextServer_method_font_get_style_name:
  1414. .. rst-class:: classref-method
  1415. :ref:`String<class_String>` **font_get_style_name**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_style_name>`
  1416. Returns font style name.
  1417. .. rst-class:: classref-item-separator
  1418. ----
  1419. .. _class_TextServer_method_font_get_subpixel_positioning:
  1420. .. rst-class:: classref-method
  1421. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **font_get_subpixel_positioning**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_subpixel_positioning>`
  1422. Returns font subpixel glyph positioning mode.
  1423. .. rst-class:: classref-item-separator
  1424. ----
  1425. .. _class_TextServer_method_font_get_supported_chars:
  1426. .. rst-class:: classref-method
  1427. :ref:`String<class_String>` **font_get_supported_chars**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_supported_chars>`
  1428. Returns a string containing all the characters available in the font.
  1429. .. rst-class:: classref-item-separator
  1430. ----
  1431. .. _class_TextServer_method_font_get_supported_glyphs:
  1432. .. rst-class:: classref-method
  1433. :ref:`PackedInt32Array<class_PackedInt32Array>` **font_get_supported_glyphs**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_supported_glyphs>`
  1434. Returns an array containing all glyph indices in the font.
  1435. .. rst-class:: classref-item-separator
  1436. ----
  1437. .. _class_TextServer_method_font_get_texture_count:
  1438. .. rst-class:: classref-method
  1439. :ref:`int<class_int>` **font_get_texture_count**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_texture_count>`
  1440. Returns number of textures used by font cache entry.
  1441. .. rst-class:: classref-item-separator
  1442. ----
  1443. .. _class_TextServer_method_font_get_texture_image:
  1444. .. rst-class:: classref-method
  1445. :ref:`Image<class_Image>` **font_get_texture_image**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_texture_image>`
  1446. Returns font cache texture image data.
  1447. .. rst-class:: classref-item-separator
  1448. ----
  1449. .. _class_TextServer_method_font_get_texture_offsets:
  1450. .. rst-class:: classref-method
  1451. :ref:`PackedInt32Array<class_PackedInt32Array>` **font_get_texture_offsets**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_texture_offsets>`
  1452. Returns array containing glyph packing data.
  1453. .. rst-class:: classref-item-separator
  1454. ----
  1455. .. _class_TextServer_method_font_get_transform:
  1456. .. rst-class:: classref-method
  1457. :ref:`Transform2D<class_Transform2D>` **font_get_transform**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_transform>`
  1458. Returns 2D transform applied to the font outlines.
  1459. .. rst-class:: classref-item-separator
  1460. ----
  1461. .. _class_TextServer_method_font_get_underline_position:
  1462. .. rst-class:: classref-method
  1463. :ref:`float<class_float>` **font_get_underline_position**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_underline_position>`
  1464. Returns pixel offset of the underline below the baseline.
  1465. .. rst-class:: classref-item-separator
  1466. ----
  1467. .. _class_TextServer_method_font_get_underline_thickness:
  1468. .. rst-class:: classref-method
  1469. :ref:`float<class_float>` **font_get_underline_thickness**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_underline_thickness>`
  1470. Returns thickness of the underline in pixels.
  1471. .. rst-class:: classref-item-separator
  1472. ----
  1473. .. _class_TextServer_method_font_get_variation_coordinates:
  1474. .. rst-class:: classref-method
  1475. :ref:`Dictionary<class_Dictionary>` **font_get_variation_coordinates**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_variation_coordinates>`
  1476. 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.
  1477. .. rst-class:: classref-item-separator
  1478. ----
  1479. .. _class_TextServer_method_font_get_weight:
  1480. .. rst-class:: classref-method
  1481. :ref:`int<class_int>` **font_get_weight**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_weight>`
  1482. Returns weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1483. .. rst-class:: classref-item-separator
  1484. ----
  1485. .. _class_TextServer_method_font_has_char:
  1486. .. rst-class:: classref-method
  1487. :ref:`bool<class_bool>` **font_has_char**\ (\ font_rid\: :ref:`RID<class_RID>`, char\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_has_char>`
  1488. Returns ``true`` if a Unicode ``char`` is available in the font.
  1489. .. rst-class:: classref-item-separator
  1490. ----
  1491. .. _class_TextServer_method_font_is_allow_system_fallback:
  1492. .. rst-class:: classref-method
  1493. :ref:`bool<class_bool>` **font_is_allow_system_fallback**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_is_allow_system_fallback>`
  1494. Returns ``true`` if system fonts can be automatically used as fallbacks.
  1495. .. rst-class:: classref-item-separator
  1496. ----
  1497. .. _class_TextServer_method_font_is_force_autohinter:
  1498. .. rst-class:: classref-method
  1499. :ref:`bool<class_bool>` **font_is_force_autohinter**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_is_force_autohinter>`
  1500. Returns ``true`` if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.
  1501. .. rst-class:: classref-item-separator
  1502. ----
  1503. .. _class_TextServer_method_font_is_language_supported:
  1504. .. rst-class:: classref-method
  1505. :ref:`bool<class_bool>` **font_is_language_supported**\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_is_language_supported>`
  1506. Returns ``true``, if font supports given language (`ISO 639 <https://en.wikipedia.org/wiki/ISO_639-1>`__ code).
  1507. .. rst-class:: classref-item-separator
  1508. ----
  1509. .. _class_TextServer_method_font_is_modulate_color_glyphs:
  1510. .. rst-class:: classref-method
  1511. :ref:`bool<class_bool>` **font_is_modulate_color_glyphs**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_is_modulate_color_glyphs>`
  1512. Returns ``true``, if color modulation is applied when drawing colored glyphs.
  1513. .. rst-class:: classref-item-separator
  1514. ----
  1515. .. _class_TextServer_method_font_is_multichannel_signed_distance_field:
  1516. .. rst-class:: classref-method
  1517. :ref:`bool<class_bool>` **font_is_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_is_multichannel_signed_distance_field>`
  1518. Returns ``true`` if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.
  1519. .. rst-class:: classref-item-separator
  1520. ----
  1521. .. _class_TextServer_method_font_is_script_supported:
  1522. .. rst-class:: classref-method
  1523. :ref:`bool<class_bool>` **font_is_script_supported**\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_is_script_supported>`
  1524. Returns ``true``, if font supports given script (ISO 15924 code).
  1525. .. rst-class:: classref-item-separator
  1526. ----
  1527. .. _class_TextServer_method_font_remove_glyph:
  1528. .. rst-class:: classref-method
  1529. |void| **font_remove_glyph**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_remove_glyph>`
  1530. Removes specified rendered glyph information from the cache entry.
  1531. \ **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.
  1532. .. rst-class:: classref-item-separator
  1533. ----
  1534. .. _class_TextServer_method_font_remove_kerning:
  1535. .. rst-class:: classref-method
  1536. |void| **font_remove_kerning**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_remove_kerning>`
  1537. Removes kerning override for the pair of glyphs.
  1538. .. rst-class:: classref-item-separator
  1539. ----
  1540. .. _class_TextServer_method_font_remove_language_support_override:
  1541. .. rst-class:: classref-method
  1542. |void| **font_remove_language_support_override**\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_remove_language_support_override>`
  1543. Remove language support override.
  1544. .. rst-class:: classref-item-separator
  1545. ----
  1546. .. _class_TextServer_method_font_remove_script_support_override:
  1547. .. rst-class:: classref-method
  1548. |void| **font_remove_script_support_override**\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_remove_script_support_override>`
  1549. Removes script support override.
  1550. .. rst-class:: classref-item-separator
  1551. ----
  1552. .. _class_TextServer_method_font_remove_size_cache:
  1553. .. rst-class:: classref-method
  1554. |void| **font_remove_size_cache**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_remove_size_cache>`
  1555. Removes specified font size from the cache entry.
  1556. .. rst-class:: classref-item-separator
  1557. ----
  1558. .. _class_TextServer_method_font_remove_texture:
  1559. .. rst-class:: classref-method
  1560. |void| **font_remove_texture**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_remove_texture>`
  1561. Removes specified texture from the cache entry.
  1562. \ **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>`.
  1563. .. rst-class:: classref-item-separator
  1564. ----
  1565. .. _class_TextServer_method_font_render_glyph:
  1566. .. rst-class:: classref-method
  1567. |void| **font_render_glyph**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_render_glyph>`
  1568. Renders specified glyph to the font cache texture.
  1569. .. rst-class:: classref-item-separator
  1570. ----
  1571. .. _class_TextServer_method_font_render_range:
  1572. .. rst-class:: classref-method
  1573. |void| **font_render_range**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, start\: :ref:`int<class_int>`, end\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_render_range>`
  1574. Renders the range of characters to the font cache texture.
  1575. .. rst-class:: classref-item-separator
  1576. ----
  1577. .. _class_TextServer_method_font_set_allow_system_fallback:
  1578. .. rst-class:: classref-method
  1579. |void| **font_set_allow_system_fallback**\ (\ font_rid\: :ref:`RID<class_RID>`, allow_system_fallback\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_allow_system_fallback>`
  1580. If set to ``true``, system fonts can be automatically used as fallbacks.
  1581. .. rst-class:: classref-item-separator
  1582. ----
  1583. .. _class_TextServer_method_font_set_antialiasing:
  1584. .. rst-class:: classref-method
  1585. |void| **font_set_antialiasing**\ (\ font_rid\: :ref:`RID<class_RID>`, antialiasing\: :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_antialiasing>`
  1586. Sets font anti-aliasing mode.
  1587. .. rst-class:: classref-item-separator
  1588. ----
  1589. .. _class_TextServer_method_font_set_ascent:
  1590. .. rst-class:: classref-method
  1591. |void| **font_set_ascent**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, ascent\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_ascent>`
  1592. Sets the font ascent (number of pixels above the baseline).
  1593. .. rst-class:: classref-item-separator
  1594. ----
  1595. .. _class_TextServer_method_font_set_baseline_offset:
  1596. .. rst-class:: classref-method
  1597. |void| **font_set_baseline_offset**\ (\ font_rid\: :ref:`RID<class_RID>`, baseline_offset\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_baseline_offset>`
  1598. Sets extra baseline offset (as a fraction of font height).
  1599. .. rst-class:: classref-item-separator
  1600. ----
  1601. .. _class_TextServer_method_font_set_data:
  1602. .. rst-class:: classref-method
  1603. |void| **font_set_data**\ (\ font_rid\: :ref:`RID<class_RID>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_data>`
  1604. Sets font source data, e.g contents of the dynamic font source file.
  1605. .. rst-class:: classref-item-separator
  1606. ----
  1607. .. _class_TextServer_method_font_set_descent:
  1608. .. rst-class:: classref-method
  1609. |void| **font_set_descent**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, descent\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_descent>`
  1610. Sets the font descent (number of pixels below the baseline).
  1611. .. rst-class:: classref-item-separator
  1612. ----
  1613. .. _class_TextServer_method_font_set_disable_embedded_bitmaps:
  1614. .. rst-class:: classref-method
  1615. |void| **font_set_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID<class_RID>`, disable_embedded_bitmaps\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_disable_embedded_bitmaps>`
  1616. If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property).
  1617. .. rst-class:: classref-item-separator
  1618. ----
  1619. .. _class_TextServer_method_font_set_embolden:
  1620. .. rst-class:: classref-method
  1621. |void| **font_set_embolden**\ (\ font_rid\: :ref:`RID<class_RID>`, strength\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_embolden>`
  1622. Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
  1623. .. rst-class:: classref-item-separator
  1624. ----
  1625. .. _class_TextServer_method_font_set_face_index:
  1626. .. rst-class:: classref-method
  1627. |void| **font_set_face_index**\ (\ font_rid\: :ref:`RID<class_RID>`, face_index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_face_index>`
  1628. Sets an active face index in the TrueType / OpenType collection.
  1629. .. rst-class:: classref-item-separator
  1630. ----
  1631. .. _class_TextServer_method_font_set_fixed_size:
  1632. .. rst-class:: classref-method
  1633. |void| **font_set_fixed_size**\ (\ font_rid\: :ref:`RID<class_RID>`, fixed_size\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_fixed_size>`
  1634. Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.
  1635. .. rst-class:: classref-item-separator
  1636. ----
  1637. .. _class_TextServer_method_font_set_fixed_size_scale_mode:
  1638. .. rst-class:: classref-method
  1639. |void| **font_set_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID<class_RID>`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_fixed_size_scale_mode>`
  1640. Sets bitmap font scaling mode. This property is used only if ``fixed_size`` is greater than zero.
  1641. .. rst-class:: classref-item-separator
  1642. ----
  1643. .. _class_TextServer_method_font_set_force_autohinter:
  1644. .. rst-class:: classref-method
  1645. |void| **font_set_force_autohinter**\ (\ font_rid\: :ref:`RID<class_RID>`, force_autohinter\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_force_autohinter>`
  1646. If set to ``true`` auto-hinting is preferred over font built-in hinting.
  1647. .. rst-class:: classref-item-separator
  1648. ----
  1649. .. _class_TextServer_method_font_set_generate_mipmaps:
  1650. .. rst-class:: classref-method
  1651. |void| **font_set_generate_mipmaps**\ (\ font_rid\: :ref:`RID<class_RID>`, generate_mipmaps\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_generate_mipmaps>`
  1652. If set to ``true`` font texture mipmap generation is enabled.
  1653. .. rst-class:: classref-item-separator
  1654. ----
  1655. .. _class_TextServer_method_font_set_global_oversampling:
  1656. .. rst-class:: classref-method
  1657. |void| **font_set_global_oversampling**\ (\ oversampling\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_global_oversampling>`
  1658. **Deprecated:** Use :ref:`Viewport<class_Viewport>` oversampling, or the ``oversampling`` argument of the ``draw_*`` methods instead.
  1659. Deprecated. This method does nothing.
  1660. .. rst-class:: classref-item-separator
  1661. ----
  1662. .. _class_TextServer_method_font_set_glyph_advance:
  1663. .. rst-class:: classref-method
  1664. |void| **font_set_glyph_advance**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph\: :ref:`int<class_int>`, advance\: :ref:`Vector2<class_Vector2>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_glyph_advance>`
  1665. Sets glyph advance (offset of the next glyph).
  1666. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1667. .. rst-class:: classref-item-separator
  1668. ----
  1669. .. _class_TextServer_method_font_set_glyph_offset:
  1670. .. rst-class:: classref-method
  1671. |void| **font_set_glyph_offset**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, offset\: :ref:`Vector2<class_Vector2>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_glyph_offset>`
  1672. Sets glyph offset from the baseline.
  1673. .. rst-class:: classref-item-separator
  1674. ----
  1675. .. _class_TextServer_method_font_set_glyph_size:
  1676. .. rst-class:: classref-method
  1677. |void| **font_set_glyph_size**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, gl_size\: :ref:`Vector2<class_Vector2>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_glyph_size>`
  1678. Sets size of the glyph.
  1679. .. rst-class:: classref-item-separator
  1680. ----
  1681. .. _class_TextServer_method_font_set_glyph_texture_idx:
  1682. .. rst-class:: classref-method
  1683. |void| **font_set_glyph_texture_idx**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, texture_idx\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_glyph_texture_idx>`
  1684. Sets index of the cache texture containing the glyph.
  1685. .. rst-class:: classref-item-separator
  1686. ----
  1687. .. _class_TextServer_method_font_set_glyph_uv_rect:
  1688. .. rst-class:: classref-method
  1689. |void| **font_set_glyph_uv_rect**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, uv_rect\: :ref:`Rect2<class_Rect2>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_glyph_uv_rect>`
  1690. Sets rectangle in the cache texture containing the glyph.
  1691. .. rst-class:: classref-item-separator
  1692. ----
  1693. .. _class_TextServer_method_font_set_hinting:
  1694. .. rst-class:: classref-method
  1695. |void| **font_set_hinting**\ (\ font_rid\: :ref:`RID<class_RID>`, hinting\: :ref:`Hinting<enum_TextServer_Hinting>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_hinting>`
  1696. Sets font hinting mode. Used by dynamic fonts only.
  1697. .. rst-class:: classref-item-separator
  1698. ----
  1699. .. _class_TextServer_method_font_set_keep_rounding_remainders:
  1700. .. rst-class:: classref-method
  1701. |void| **font_set_keep_rounding_remainders**\ (\ font_rid\: :ref:`RID<class_RID>`, keep_rounding_remainders\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_keep_rounding_remainders>`
  1702. Sets glyph position rounding behavior. If set to ``true``, when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled.
  1703. .. rst-class:: classref-item-separator
  1704. ----
  1705. .. _class_TextServer_method_font_set_kerning:
  1706. .. rst-class:: classref-method
  1707. |void| **font_set_kerning**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`, kerning\: :ref:`Vector2<class_Vector2>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_kerning>`
  1708. Sets kerning for the pair of glyphs.
  1709. .. rst-class:: classref-item-separator
  1710. ----
  1711. .. _class_TextServer_method_font_set_language_support_override:
  1712. .. rst-class:: classref-method
  1713. |void| **font_set_language_support_override**\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`, supported\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_language_support_override>`
  1714. Adds override for :ref:`font_is_language_supported()<class_TextServer_method_font_is_language_supported>`.
  1715. .. rst-class:: classref-item-separator
  1716. ----
  1717. .. _class_TextServer_method_font_set_modulate_color_glyphs:
  1718. .. rst-class:: classref-method
  1719. |void| **font_set_modulate_color_glyphs**\ (\ font_rid\: :ref:`RID<class_RID>`, force_autohinter\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_modulate_color_glyphs>`
  1720. If set to ``true``, color modulation is applied when drawing colored glyphs, otherwise it's applied to the monochrome glyphs only.
  1721. .. rst-class:: classref-item-separator
  1722. ----
  1723. .. _class_TextServer_method_font_set_msdf_pixel_range:
  1724. .. rst-class:: classref-method
  1725. |void| **font_set_msdf_pixel_range**\ (\ font_rid\: :ref:`RID<class_RID>`, msdf_pixel_range\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_msdf_pixel_range>`
  1726. Sets the width of the range around the shape between the minimum and maximum representable signed distance.
  1727. .. rst-class:: classref-item-separator
  1728. ----
  1729. .. _class_TextServer_method_font_set_msdf_size:
  1730. .. rst-class:: classref-method
  1731. |void| **font_set_msdf_size**\ (\ font_rid\: :ref:`RID<class_RID>`, msdf_size\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_msdf_size>`
  1732. Sets source font size used to generate MSDF textures.
  1733. .. rst-class:: classref-item-separator
  1734. ----
  1735. .. _class_TextServer_method_font_set_multichannel_signed_distance_field:
  1736. .. rst-class:: classref-method
  1737. |void| **font_set_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID<class_RID>`, msdf\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_multichannel_signed_distance_field>`
  1738. 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.
  1739. \ **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.
  1740. .. rst-class:: classref-item-separator
  1741. ----
  1742. .. _class_TextServer_method_font_set_name:
  1743. .. rst-class:: classref-method
  1744. |void| **font_set_name**\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_name>`
  1745. Sets the font family name.
  1746. .. rst-class:: classref-item-separator
  1747. ----
  1748. .. _class_TextServer_method_font_set_opentype_feature_overrides:
  1749. .. rst-class:: classref-method
  1750. |void| **font_set_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID<class_RID>`, overrides\: :ref:`Dictionary<class_Dictionary>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_opentype_feature_overrides>`
  1751. Sets font OpenType feature set override.
  1752. .. rst-class:: classref-item-separator
  1753. ----
  1754. .. _class_TextServer_method_font_set_oversampling:
  1755. .. rst-class:: classref-method
  1756. |void| **font_set_oversampling**\ (\ font_rid\: :ref:`RID<class_RID>`, oversampling\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_oversampling>`
  1757. If set to a positive value, overrides the oversampling factor of the viewport this font is used in. See :ref:`Viewport.oversampling<class_Viewport_property_oversampling>`. This value doesn't override the ``oversampling`` parameter of ``draw_*`` methods. Used by dynamic fonts only.
  1758. .. rst-class:: classref-item-separator
  1759. ----
  1760. .. _class_TextServer_method_font_set_scale:
  1761. .. rst-class:: classref-method
  1762. |void| **font_set_scale**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, scale\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_scale>`
  1763. Sets scaling factor of the color bitmap font.
  1764. .. rst-class:: classref-item-separator
  1765. ----
  1766. .. _class_TextServer_method_font_set_script_support_override:
  1767. .. rst-class:: classref-method
  1768. |void| **font_set_script_support_override**\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`, supported\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_script_support_override>`
  1769. Adds override for :ref:`font_is_script_supported()<class_TextServer_method_font_is_script_supported>`.
  1770. .. rst-class:: classref-item-separator
  1771. ----
  1772. .. _class_TextServer_method_font_set_spacing:
  1773. .. rst-class:: classref-method
  1774. |void| **font_set_spacing**\ (\ font_rid\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`, value\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_spacing>`
  1775. Sets the spacing for ``spacing`` to ``value`` in pixels (not relative to the font size).
  1776. .. rst-class:: classref-item-separator
  1777. ----
  1778. .. _class_TextServer_method_font_set_stretch:
  1779. .. rst-class:: classref-method
  1780. |void| **font_set_stretch**\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_stretch>`
  1781. Sets font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1782. \ **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.
  1783. .. rst-class:: classref-item-separator
  1784. ----
  1785. .. _class_TextServer_method_font_set_style:
  1786. .. rst-class:: classref-method
  1787. |void| **font_set_style**\ (\ font_rid\: :ref:`RID<class_RID>`, style\: |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\]\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_style>`
  1788. Sets the font style flags.
  1789. \ **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.
  1790. .. rst-class:: classref-item-separator
  1791. ----
  1792. .. _class_TextServer_method_font_set_style_name:
  1793. .. rst-class:: classref-method
  1794. |void| **font_set_style_name**\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_style_name>`
  1795. Sets the font style name.
  1796. .. rst-class:: classref-item-separator
  1797. ----
  1798. .. _class_TextServer_method_font_set_subpixel_positioning:
  1799. .. rst-class:: classref-method
  1800. |void| **font_set_subpixel_positioning**\ (\ font_rid\: :ref:`RID<class_RID>`, subpixel_positioning\: :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_subpixel_positioning>`
  1801. Sets font subpixel glyph positioning mode.
  1802. .. rst-class:: classref-item-separator
  1803. ----
  1804. .. _class_TextServer_method_font_set_texture_image:
  1805. .. rst-class:: classref-method
  1806. |void| **font_set_texture_image**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`, image\: :ref:`Image<class_Image>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_texture_image>`
  1807. Sets font cache texture image data.
  1808. .. rst-class:: classref-item-separator
  1809. ----
  1810. .. _class_TextServer_method_font_set_texture_offsets:
  1811. .. rst-class:: classref-method
  1812. |void| **font_set_texture_offsets**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`, offset\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_texture_offsets>`
  1813. Sets array containing glyph packing data.
  1814. .. rst-class:: classref-item-separator
  1815. ----
  1816. .. _class_TextServer_method_font_set_transform:
  1817. .. rst-class:: classref-method
  1818. |void| **font_set_transform**\ (\ font_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_transform>`
  1819. Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs.
  1820. For example, to simulate italic typeface by slanting, apply the following transform ``Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)``.
  1821. .. rst-class:: classref-item-separator
  1822. ----
  1823. .. _class_TextServer_method_font_set_underline_position:
  1824. .. rst-class:: classref-method
  1825. |void| **font_set_underline_position**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, underline_position\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_underline_position>`
  1826. Sets pixel offset of the underline below the baseline.
  1827. .. rst-class:: classref-item-separator
  1828. ----
  1829. .. _class_TextServer_method_font_set_underline_thickness:
  1830. .. rst-class:: classref-method
  1831. |void| **font_set_underline_thickness**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, underline_thickness\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_underline_thickness>`
  1832. Sets thickness of the underline in pixels.
  1833. .. rst-class:: classref-item-separator
  1834. ----
  1835. .. _class_TextServer_method_font_set_variation_coordinates:
  1836. .. rst-class:: classref-method
  1837. |void| **font_set_variation_coordinates**\ (\ font_rid\: :ref:`RID<class_RID>`, variation_coordinates\: :ref:`Dictionary<class_Dictionary>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_variation_coordinates>`
  1838. 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.
  1839. .. rst-class:: classref-item-separator
  1840. ----
  1841. .. _class_TextServer_method_font_set_weight:
  1842. .. rst-class:: classref-method
  1843. |void| **font_set_weight**\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_weight>`
  1844. Sets weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1845. \ **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.
  1846. .. rst-class:: classref-item-separator
  1847. ----
  1848. .. _class_TextServer_method_font_supported_feature_list:
  1849. .. rst-class:: classref-method
  1850. :ref:`Dictionary<class_Dictionary>` **font_supported_feature_list**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_supported_feature_list>`
  1851. Returns the dictionary of the supported OpenType features.
  1852. .. rst-class:: classref-item-separator
  1853. ----
  1854. .. _class_TextServer_method_font_supported_variation_list:
  1855. .. rst-class:: classref-method
  1856. :ref:`Dictionary<class_Dictionary>` **font_supported_variation_list**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_supported_variation_list>`
  1857. Returns the dictionary of the supported OpenType variation coordinates.
  1858. .. rst-class:: classref-item-separator
  1859. ----
  1860. .. _class_TextServer_method_format_number:
  1861. .. rst-class:: classref-method
  1862. :ref:`String<class_String>` **format_number**\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_format_number>`
  1863. **Deprecated:** Use :ref:`TranslationServer.format_number()<class_TranslationServer_method_format_number>` instead.
  1864. Converts a number from Western Arabic (0..9) to the numeral system used in the given ``language``.
  1865. If ``language`` is an empty string, the active locale will be used.
  1866. .. rst-class:: classref-item-separator
  1867. ----
  1868. .. _class_TextServer_method_free_rid:
  1869. .. rst-class:: classref-method
  1870. |void| **free_rid**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_free_rid>`
  1871. Frees an object created by this **TextServer**.
  1872. .. rst-class:: classref-item-separator
  1873. ----
  1874. .. _class_TextServer_method_get_features:
  1875. .. rst-class:: classref-method
  1876. :ref:`int<class_int>` **get_features**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_features>`
  1877. Returns text server features, see :ref:`Feature<enum_TextServer_Feature>`.
  1878. .. rst-class:: classref-item-separator
  1879. ----
  1880. .. _class_TextServer_method_get_hex_code_box_size:
  1881. .. rst-class:: classref-method
  1882. :ref:`Vector2<class_Vector2>` **get_hex_code_box_size**\ (\ size\: :ref:`int<class_int>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_hex_code_box_size>`
  1883. Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).
  1884. .. rst-class:: classref-item-separator
  1885. ----
  1886. .. _class_TextServer_method_get_name:
  1887. .. rst-class:: classref-method
  1888. :ref:`String<class_String>` **get_name**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_name>`
  1889. Returns the name of the server interface.
  1890. .. rst-class:: classref-item-separator
  1891. ----
  1892. .. _class_TextServer_method_get_support_data:
  1893. .. rst-class:: classref-method
  1894. :ref:`PackedByteArray<class_PackedByteArray>` **get_support_data**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_support_data>`
  1895. Returns default TextServer database (e.g. ICU break iterators and dictionaries).
  1896. .. rst-class:: classref-item-separator
  1897. ----
  1898. .. _class_TextServer_method_get_support_data_filename:
  1899. .. rst-class:: classref-method
  1900. :ref:`String<class_String>` **get_support_data_filename**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_support_data_filename>`
  1901. Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename.
  1902. .. rst-class:: classref-item-separator
  1903. ----
  1904. .. _class_TextServer_method_get_support_data_info:
  1905. .. rst-class:: classref-method
  1906. :ref:`String<class_String>` **get_support_data_info**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_support_data_info>`
  1907. Returns TextServer database (e.g. ICU break iterators and dictionaries) description.
  1908. .. rst-class:: classref-item-separator
  1909. ----
  1910. .. _class_TextServer_method_has:
  1911. .. rst-class:: classref-method
  1912. :ref:`bool<class_bool>` **has**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_has>`
  1913. Returns ``true`` if ``rid`` is valid resource owned by this text server.
  1914. .. rst-class:: classref-item-separator
  1915. ----
  1916. .. _class_TextServer_method_has_feature:
  1917. .. rst-class:: classref-method
  1918. :ref:`bool<class_bool>` **has_feature**\ (\ feature\: :ref:`Feature<enum_TextServer_Feature>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_has_feature>`
  1919. Returns ``true`` if the server supports a feature.
  1920. .. rst-class:: classref-item-separator
  1921. ----
  1922. .. _class_TextServer_method_is_confusable:
  1923. .. rst-class:: classref-method
  1924. :ref:`int<class_int>` **is_confusable**\ (\ string\: :ref:`String<class_String>`, dict\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_confusable>`
  1925. Returns index of the first string in ``dict`` which is visually confusable with the ``string``, or ``-1`` if none is found.
  1926. \ **Note:** This method doesn't detect invisible characters, for spoof detection use it in combination with :ref:`spoof_check()<class_TextServer_method_spoof_check>`.
  1927. \ **Note:** Always returns ``-1`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  1928. .. rst-class:: classref-item-separator
  1929. ----
  1930. .. _class_TextServer_method_is_locale_right_to_left:
  1931. .. rst-class:: classref-method
  1932. :ref:`bool<class_bool>` **is_locale_right_to_left**\ (\ locale\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_locale_right_to_left>`
  1933. Returns ``true`` if locale is right-to-left.
  1934. .. rst-class:: classref-item-separator
  1935. ----
  1936. .. _class_TextServer_method_is_valid_identifier:
  1937. .. rst-class:: classref-method
  1938. :ref:`bool<class_bool>` **is_valid_identifier**\ (\ string\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_valid_identifier>`
  1939. Returns ``true`` if ``string`` is a valid identifier.
  1940. If the text server supports the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature, a valid identifier must:
  1941. - Conform to normalization form C.
  1942. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1943. - May contain Unicode characters of class XID_Continue in the other positions.
  1944. - Use UAX #31 recommended scripts only (mixed scripts are allowed).
  1945. If the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature is not supported, a valid identifier must:
  1946. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1947. - May contain Unicode characters of class XID_Continue in the other positions.
  1948. .. rst-class:: classref-item-separator
  1949. ----
  1950. .. _class_TextServer_method_is_valid_letter:
  1951. .. rst-class:: classref-method
  1952. :ref:`bool<class_bool>` **is_valid_letter**\ (\ unicode\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_valid_letter>`
  1953. Returns ``true`` if the given code point is a valid letter, i.e. it belongs to the Unicode category "L".
  1954. .. rst-class:: classref-item-separator
  1955. ----
  1956. .. _class_TextServer_method_load_support_data:
  1957. .. rst-class:: classref-method
  1958. :ref:`bool<class_bool>` **load_support_data**\ (\ filename\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_load_support_data>`
  1959. Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
  1960. \ **Note:** This function should be called before any other TextServer functions used, otherwise it won't have any effect.
  1961. .. rst-class:: classref-item-separator
  1962. ----
  1963. .. _class_TextServer_method_name_to_tag:
  1964. .. rst-class:: classref-method
  1965. :ref:`int<class_int>` **name_to_tag**\ (\ name\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_name_to_tag>`
  1966. Converts readable feature, variation, script, or language name to OpenType tag.
  1967. .. rst-class:: classref-item-separator
  1968. ----
  1969. .. _class_TextServer_method_parse_number:
  1970. .. rst-class:: classref-method
  1971. :ref:`String<class_String>` **parse_number**\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_parse_number>`
  1972. **Deprecated:** Use :ref:`TranslationServer.parse_number()<class_TranslationServer_method_parse_number>` instead.
  1973. Converts ``number`` from the numeral system used in the given ``language`` to Western Arabic (0..9).
  1974. If ``language`` is an empty string, the active locale will be used.
  1975. .. rst-class:: classref-item-separator
  1976. ----
  1977. .. _class_TextServer_method_parse_structured_text:
  1978. .. rst-class:: classref-method
  1979. :ref:`Array<class_Array>`\[:ref:`Vector3i<class_Vector3i>`\] **parse_structured_text**\ (\ parser_type\: :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>`, args\: :ref:`Array<class_Array>`, text\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_parse_structured_text>`
  1980. Default implementation of the BiDi algorithm override function.
  1981. .. rst-class:: classref-item-separator
  1982. ----
  1983. .. _class_TextServer_method_percent_sign:
  1984. .. rst-class:: classref-method
  1985. :ref:`String<class_String>` **percent_sign**\ (\ language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_percent_sign>`
  1986. **Deprecated:** Use :ref:`TranslationServer.get_percent_sign()<class_TranslationServer_method_get_percent_sign>` instead.
  1987. Returns the percent sign used in the given ``language``.
  1988. If ``language`` is an empty string, the active locale will be used.
  1989. .. rst-class:: classref-item-separator
  1990. ----
  1991. .. _class_TextServer_method_save_support_data:
  1992. .. rst-class:: classref-method
  1993. :ref:`bool<class_bool>` **save_support_data**\ (\ filename\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_save_support_data>`
  1994. Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.
  1995. \ **Note:** This function is used by during project export, to include TextServer database.
  1996. .. rst-class:: classref-item-separator
  1997. ----
  1998. .. _class_TextServer_method_shaped_get_run_count:
  1999. .. rst-class:: classref-method
  2000. :ref:`int<class_int>` **shaped_get_run_count**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_run_count>`
  2001. Returns the number of uniform text runs in the buffer.
  2002. .. rst-class:: classref-item-separator
  2003. ----
  2004. .. _class_TextServer_method_shaped_get_run_direction:
  2005. .. rst-class:: classref-method
  2006. :ref:`Direction<enum_TextServer_Direction>` **shaped_get_run_direction**\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_run_direction>`
  2007. Returns the direction of the ``index`` text run (in visual order).
  2008. .. rst-class:: classref-item-separator
  2009. ----
  2010. .. _class_TextServer_method_shaped_get_run_font_rid:
  2011. .. rst-class:: classref-method
  2012. :ref:`RID<class_RID>` **shaped_get_run_font_rid**\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_run_font_rid>`
  2013. Returns the font RID of the ``index`` text run (in visual order).
  2014. .. rst-class:: classref-item-separator
  2015. ----
  2016. .. _class_TextServer_method_shaped_get_run_font_size:
  2017. .. rst-class:: classref-method
  2018. :ref:`int<class_int>` **shaped_get_run_font_size**\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_run_font_size>`
  2019. Returns the font size of the ``index`` text run (in visual order).
  2020. .. rst-class:: classref-item-separator
  2021. ----
  2022. .. _class_TextServer_method_shaped_get_run_language:
  2023. .. rst-class:: classref-method
  2024. :ref:`String<class_String>` **shaped_get_run_language**\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_run_language>`
  2025. Returns the language of the ``index`` text run (in visual order).
  2026. .. rst-class:: classref-item-separator
  2027. ----
  2028. .. _class_TextServer_method_shaped_get_run_object:
  2029. .. rst-class:: classref-method
  2030. :ref:`Variant<class_Variant>` **shaped_get_run_object**\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_run_object>`
  2031. Returns the embedded object of the ``index`` text run (in visual order).
  2032. .. rst-class:: classref-item-separator
  2033. ----
  2034. .. _class_TextServer_method_shaped_get_run_range:
  2035. .. rst-class:: classref-method
  2036. :ref:`Vector2i<class_Vector2i>` **shaped_get_run_range**\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_run_range>`
  2037. Returns the source text range of the ``index`` text run (in visual order).
  2038. .. rst-class:: classref-item-separator
  2039. ----
  2040. .. _class_TextServer_method_shaped_get_run_text:
  2041. .. rst-class:: classref-method
  2042. :ref:`String<class_String>` **shaped_get_run_text**\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_run_text>`
  2043. Returns the source text of the ``index`` text run (in visual order).
  2044. .. rst-class:: classref-item-separator
  2045. ----
  2046. .. _class_TextServer_method_shaped_get_span_count:
  2047. .. rst-class:: classref-method
  2048. :ref:`int<class_int>` **shaped_get_span_count**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_span_count>`
  2049. 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>`.
  2050. .. rst-class:: classref-item-separator
  2051. ----
  2052. .. _class_TextServer_method_shaped_get_span_embedded_object:
  2053. .. rst-class:: classref-method
  2054. :ref:`Variant<class_Variant>` **shaped_get_span_embedded_object**\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_span_embedded_object>`
  2055. Returns text embedded object key.
  2056. .. rst-class:: classref-item-separator
  2057. ----
  2058. .. _class_TextServer_method_shaped_get_span_meta:
  2059. .. rst-class:: classref-method
  2060. :ref:`Variant<class_Variant>` **shaped_get_span_meta**\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_span_meta>`
  2061. Returns text span metadata.
  2062. .. rst-class:: classref-item-separator
  2063. ----
  2064. .. _class_TextServer_method_shaped_get_span_object:
  2065. .. rst-class:: classref-method
  2066. :ref:`Variant<class_Variant>` **shaped_get_span_object**\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_span_object>`
  2067. Returns the text span embedded object key.
  2068. .. rst-class:: classref-item-separator
  2069. ----
  2070. .. _class_TextServer_method_shaped_get_span_text:
  2071. .. rst-class:: classref-method
  2072. :ref:`String<class_String>` **shaped_get_span_text**\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_span_text>`
  2073. Returns the text span source text.
  2074. .. rst-class:: classref-item-separator
  2075. ----
  2076. .. _class_TextServer_method_shaped_get_text:
  2077. .. rst-class:: classref-method
  2078. :ref:`String<class_String>` **shaped_get_text**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_text>`
  2079. Returns the text buffer source text, including object replacement characters.
  2080. .. rst-class:: classref-item-separator
  2081. ----
  2082. .. _class_TextServer_method_shaped_set_span_update_font:
  2083. .. rst-class:: classref-method
  2084. |void| **shaped_set_span_update_font**\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, fonts\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], size\: :ref:`int<class_int>`, opentype_features\: :ref:`Dictionary<class_Dictionary>` = {}\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_set_span_update_font>`
  2085. Changes text span font, font size, and OpenType features, without changing the text.
  2086. .. rst-class:: classref-item-separator
  2087. ----
  2088. .. _class_TextServer_method_shaped_text_add_object:
  2089. .. rst-class:: classref-method
  2090. :ref:`bool<class_bool>` **shaped_text_add_object**\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`, size\: :ref:`Vector2<class_Vector2>`, inline_align\: :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` = 5, length\: :ref:`int<class_int>` = 1, baseline\: :ref:`float<class_float>` = 0.0\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_add_object>`
  2091. Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters.
  2092. .. rst-class:: classref-item-separator
  2093. ----
  2094. .. _class_TextServer_method_shaped_text_add_string:
  2095. .. rst-class:: classref-method
  2096. :ref:`bool<class_bool>` **shaped_text_add_string**\ (\ shaped\: :ref:`RID<class_RID>`, text\: :ref:`String<class_String>`, fonts\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], size\: :ref:`int<class_int>`, opentype_features\: :ref:`Dictionary<class_Dictionary>` = {}, language\: :ref:`String<class_String>` = "", meta\: :ref:`Variant<class_Variant>` = null\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_add_string>`
  2097. Adds text span and font to draw it to the text buffer.
  2098. .. rst-class:: classref-item-separator
  2099. ----
  2100. .. _class_TextServer_method_shaped_text_clear:
  2101. .. rst-class:: classref-method
  2102. |void| **shaped_text_clear**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_clear>`
  2103. Clears text buffer (removes text and inline objects).
  2104. .. rst-class:: classref-item-separator
  2105. ----
  2106. .. _class_TextServer_method_shaped_text_closest_character_pos:
  2107. .. rst-class:: classref-method
  2108. :ref:`int<class_int>` **shaped_text_closest_character_pos**\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_closest_character_pos>`
  2109. Returns composite character position closest to the ``pos``.
  2110. .. rst-class:: classref-item-separator
  2111. ----
  2112. .. _class_TextServer_method_shaped_text_draw:
  2113. .. rst-class:: classref-method
  2114. |void| **shaped_text_draw**\ (\ shaped\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, pos\: :ref:`Vector2<class_Vector2>`, clip_l\: :ref:`float<class_float>` = -1, clip_r\: :ref:`float<class_float>` = -1, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), oversampling\: :ref:`float<class_float>` = 0.0\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_draw>`
  2115. 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). If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
  2116. \ ``clip_l`` and ``clip_r`` are offsets relative to ``pos``, going to the right in horizontal layout and downward in vertical layout. If ``clip_l`` is not negative, glyphs starting before the offset are clipped. If ``clip_r`` is not negative, glyphs ending after the offset are clipped.
  2117. .. rst-class:: classref-item-separator
  2118. ----
  2119. .. _class_TextServer_method_shaped_text_draw_outline:
  2120. .. rst-class:: classref-method
  2121. |void| **shaped_text_draw_outline**\ (\ shaped\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, pos\: :ref:`Vector2<class_Vector2>`, clip_l\: :ref:`float<class_float>` = -1, clip_r\: :ref:`float<class_float>` = -1, outline_size\: :ref:`int<class_int>` = 1, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), oversampling\: :ref:`float<class_float>` = 0.0\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_draw_outline>`
  2122. 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). If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
  2123. \ ``clip_l`` and ``clip_r`` are offsets relative to ``pos``, going to the right in horizontal layout and downward in vertical layout. If ``clip_l`` is not negative, glyphs starting before the offset are clipped. If ``clip_r`` is not negative, glyphs ending after the offset are clipped.
  2124. .. rst-class:: classref-item-separator
  2125. ----
  2126. .. _class_TextServer_method_shaped_text_duplicate:
  2127. .. rst-class:: classref-method
  2128. :ref:`RID<class_RID>` **shaped_text_duplicate**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_duplicate>`
  2129. Duplicates shaped text buffer.
  2130. .. rst-class:: classref-item-separator
  2131. ----
  2132. .. _class_TextServer_method_shaped_text_fit_to_width:
  2133. .. rst-class:: classref-method
  2134. :ref:`float<class_float>` **shaped_text_fit_to_width**\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`float<class_float>`, justification_flags\: |bitfield|\[:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\] = 3\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_fit_to_width>`
  2135. Adjusts text width to fit to specified width, returns new text width.
  2136. .. rst-class:: classref-item-separator
  2137. ----
  2138. .. _class_TextServer_method_shaped_text_get_ascent:
  2139. .. rst-class:: classref-method
  2140. :ref:`float<class_float>` **shaped_text_get_ascent**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_ascent>`
  2141. Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
  2142. \ **Note:** Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline.
  2143. .. rst-class:: classref-item-separator
  2144. ----
  2145. .. _class_TextServer_method_shaped_text_get_carets:
  2146. .. rst-class:: classref-method
  2147. :ref:`Dictionary<class_Dictionary>` **shaped_text_get_carets**\ (\ shaped\: :ref:`RID<class_RID>`, position\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_carets>`
  2148. Returns shapes of the carets corresponding to the character offset ``position`` in the text. Returned caret shape is 1 pixel wide rectangle.
  2149. .. rst-class:: classref-item-separator
  2150. ----
  2151. .. _class_TextServer_method_shaped_text_get_character_breaks:
  2152. .. rst-class:: classref-method
  2153. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_character_breaks**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_character_breaks>`
  2154. Returns array of the composite character boundaries.
  2155. .. rst-class:: classref-item-separator
  2156. ----
  2157. .. _class_TextServer_method_shaped_text_get_custom_ellipsis:
  2158. .. rst-class:: classref-method
  2159. :ref:`int<class_int>` **shaped_text_get_custom_ellipsis**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_custom_ellipsis>`
  2160. Returns ellipsis character used for text clipping.
  2161. .. rst-class:: classref-item-separator
  2162. ----
  2163. .. _class_TextServer_method_shaped_text_get_custom_punctuation:
  2164. .. rst-class:: classref-method
  2165. :ref:`String<class_String>` **shaped_text_get_custom_punctuation**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_custom_punctuation>`
  2166. Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  2167. .. rst-class:: classref-item-separator
  2168. ----
  2169. .. _class_TextServer_method_shaped_text_get_descent:
  2170. .. rst-class:: classref-method
  2171. :ref:`float<class_float>` **shaped_text_get_descent**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_descent>`
  2172. Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
  2173. \ **Note:** Overall descent can be higher than font descent, if some glyphs are displaced from the baseline.
  2174. .. rst-class:: classref-item-separator
  2175. ----
  2176. .. _class_TextServer_method_shaped_text_get_direction:
  2177. .. rst-class:: classref-method
  2178. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_direction**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_direction>`
  2179. Returns direction of the text.
  2180. .. rst-class:: classref-item-separator
  2181. ----
  2182. .. _class_TextServer_method_shaped_text_get_dominant_direction_in_range:
  2183. .. rst-class:: classref-method
  2184. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_dominant_direction_in_range**\ (\ shaped\: :ref:`RID<class_RID>`, start\: :ref:`int<class_int>`, end\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_dominant_direction_in_range>`
  2185. Returns dominant direction of in the range of text.
  2186. .. rst-class:: classref-item-separator
  2187. ----
  2188. .. _class_TextServer_method_shaped_text_get_ellipsis_glyph_count:
  2189. .. rst-class:: classref-method
  2190. :ref:`int<class_int>` **shaped_text_get_ellipsis_glyph_count**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_ellipsis_glyph_count>`
  2191. Returns number of glyphs in the ellipsis.
  2192. .. rst-class:: classref-item-separator
  2193. ----
  2194. .. _class_TextServer_method_shaped_text_get_ellipsis_glyphs:
  2195. .. rst-class:: classref-method
  2196. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **shaped_text_get_ellipsis_glyphs**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_ellipsis_glyphs>`
  2197. Returns array of the glyphs in the ellipsis.
  2198. .. rst-class:: classref-item-separator
  2199. ----
  2200. .. _class_TextServer_method_shaped_text_get_ellipsis_pos:
  2201. .. rst-class:: classref-method
  2202. :ref:`int<class_int>` **shaped_text_get_ellipsis_pos**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_ellipsis_pos>`
  2203. Returns position of the ellipsis.
  2204. .. rst-class:: classref-item-separator
  2205. ----
  2206. .. _class_TextServer_method_shaped_text_get_glyph_count:
  2207. .. rst-class:: classref-method
  2208. :ref:`int<class_int>` **shaped_text_get_glyph_count**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_glyph_count>`
  2209. Returns number of glyphs in the buffer.
  2210. .. rst-class:: classref-item-separator
  2211. ----
  2212. .. _class_TextServer_method_shaped_text_get_glyphs:
  2213. .. rst-class:: classref-method
  2214. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **shaped_text_get_glyphs**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_glyphs>`
  2215. Returns an array of glyphs in the visual order.
  2216. .. rst-class:: classref-item-separator
  2217. ----
  2218. .. _class_TextServer_method_shaped_text_get_grapheme_bounds:
  2219. .. rst-class:: classref-method
  2220. :ref:`Vector2<class_Vector2>` **shaped_text_get_grapheme_bounds**\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_grapheme_bounds>`
  2221. Returns composite character's bounds as offsets from the start of the line.
  2222. .. rst-class:: classref-item-separator
  2223. ----
  2224. .. _class_TextServer_method_shaped_text_get_inferred_direction:
  2225. .. rst-class:: classref-method
  2226. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_inferred_direction**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_inferred_direction>`
  2227. Returns direction of the text, inferred by the BiDi algorithm.
  2228. .. rst-class:: classref-item-separator
  2229. ----
  2230. .. _class_TextServer_method_shaped_text_get_line_breaks:
  2231. .. rst-class:: classref-method
  2232. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_line_breaks**\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`float<class_float>`, start\: :ref:`int<class_int>` = 0, break_flags\: |bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\] = 3\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_line_breaks>`
  2233. Breaks text to the lines and returns character ranges for each line.
  2234. .. rst-class:: classref-item-separator
  2235. ----
  2236. .. _class_TextServer_method_shaped_text_get_line_breaks_adv:
  2237. .. rst-class:: classref-method
  2238. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_line_breaks_adv**\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`, start\: :ref:`int<class_int>` = 0, once\: :ref:`bool<class_bool>` = true, break_flags\: |bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\] = 3\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_line_breaks_adv>`
  2239. Breaks text to the lines and columns. Returns character ranges for each segment.
  2240. .. rst-class:: classref-item-separator
  2241. ----
  2242. .. _class_TextServer_method_shaped_text_get_object_glyph:
  2243. .. rst-class:: classref-method
  2244. :ref:`int<class_int>` **shaped_text_get_object_glyph**\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_object_glyph>`
  2245. Returns the glyph index of the inline object.
  2246. .. rst-class:: classref-item-separator
  2247. ----
  2248. .. _class_TextServer_method_shaped_text_get_object_range:
  2249. .. rst-class:: classref-method
  2250. :ref:`Vector2i<class_Vector2i>` **shaped_text_get_object_range**\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_object_range>`
  2251. Returns the character range of the inline object.
  2252. .. rst-class:: classref-item-separator
  2253. ----
  2254. .. _class_TextServer_method_shaped_text_get_object_rect:
  2255. .. rst-class:: classref-method
  2256. :ref:`Rect2<class_Rect2>` **shaped_text_get_object_rect**\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_object_rect>`
  2257. Returns bounding rectangle of the inline object.
  2258. .. rst-class:: classref-item-separator
  2259. ----
  2260. .. _class_TextServer_method_shaped_text_get_objects:
  2261. .. rst-class:: classref-method
  2262. :ref:`Array<class_Array>` **shaped_text_get_objects**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_objects>`
  2263. Returns array of inline objects.
  2264. .. rst-class:: classref-item-separator
  2265. ----
  2266. .. _class_TextServer_method_shaped_text_get_orientation:
  2267. .. rst-class:: classref-method
  2268. :ref:`Orientation<enum_TextServer_Orientation>` **shaped_text_get_orientation**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_orientation>`
  2269. Returns text orientation.
  2270. .. rst-class:: classref-item-separator
  2271. ----
  2272. .. _class_TextServer_method_shaped_text_get_parent:
  2273. .. rst-class:: classref-method
  2274. :ref:`RID<class_RID>` **shaped_text_get_parent**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_parent>`
  2275. Returns the parent buffer from which the substring originates.
  2276. .. rst-class:: classref-item-separator
  2277. ----
  2278. .. _class_TextServer_method_shaped_text_get_preserve_control:
  2279. .. rst-class:: classref-method
  2280. :ref:`bool<class_bool>` **shaped_text_get_preserve_control**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_preserve_control>`
  2281. Returns ``true`` if text buffer is configured to display control characters.
  2282. .. rst-class:: classref-item-separator
  2283. ----
  2284. .. _class_TextServer_method_shaped_text_get_preserve_invalid:
  2285. .. rst-class:: classref-method
  2286. :ref:`bool<class_bool>` **shaped_text_get_preserve_invalid**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_preserve_invalid>`
  2287. Returns ``true`` if text buffer is configured to display hexadecimal codes in place of invalid characters.
  2288. \ **Note:** If set to ``false``, nothing is displayed in place of invalid characters.
  2289. .. rst-class:: classref-item-separator
  2290. ----
  2291. .. _class_TextServer_method_shaped_text_get_range:
  2292. .. rst-class:: classref-method
  2293. :ref:`Vector2i<class_Vector2i>` **shaped_text_get_range**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_range>`
  2294. Returns substring buffer character range in the parent buffer.
  2295. .. rst-class:: classref-item-separator
  2296. ----
  2297. .. _class_TextServer_method_shaped_text_get_selection:
  2298. .. rst-class:: classref-method
  2299. :ref:`PackedVector2Array<class_PackedVector2Array>` **shaped_text_get_selection**\ (\ shaped\: :ref:`RID<class_RID>`, start\: :ref:`int<class_int>`, end\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_selection>`
  2300. Returns selection rectangles for the specified character range.
  2301. .. rst-class:: classref-item-separator
  2302. ----
  2303. .. _class_TextServer_method_shaped_text_get_size:
  2304. .. rst-class:: classref-method
  2305. :ref:`Vector2<class_Vector2>` **shaped_text_get_size**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_size>`
  2306. Returns size of the text.
  2307. .. rst-class:: classref-item-separator
  2308. ----
  2309. .. _class_TextServer_method_shaped_text_get_spacing:
  2310. .. rst-class:: classref-method
  2311. :ref:`int<class_int>` **shaped_text_get_spacing**\ (\ shaped\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_spacing>`
  2312. Returns extra spacing added between glyphs or lines in pixels.
  2313. .. rst-class:: classref-item-separator
  2314. ----
  2315. .. _class_TextServer_method_shaped_text_get_trim_pos:
  2316. .. rst-class:: classref-method
  2317. :ref:`int<class_int>` **shaped_text_get_trim_pos**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_trim_pos>`
  2318. Returns the position of the overrun trim.
  2319. .. rst-class:: classref-item-separator
  2320. ----
  2321. .. _class_TextServer_method_shaped_text_get_underline_position:
  2322. .. rst-class:: classref-method
  2323. :ref:`float<class_float>` **shaped_text_get_underline_position**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_underline_position>`
  2324. Returns pixel offset of the underline below the baseline.
  2325. .. rst-class:: classref-item-separator
  2326. ----
  2327. .. _class_TextServer_method_shaped_text_get_underline_thickness:
  2328. .. rst-class:: classref-method
  2329. :ref:`float<class_float>` **shaped_text_get_underline_thickness**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_underline_thickness>`
  2330. Returns thickness of the underline.
  2331. .. rst-class:: classref-item-separator
  2332. ----
  2333. .. _class_TextServer_method_shaped_text_get_width:
  2334. .. rst-class:: classref-method
  2335. :ref:`float<class_float>` **shaped_text_get_width**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_width>`
  2336. Returns width (for horizontal layout) or height (for vertical) of the text.
  2337. .. rst-class:: classref-item-separator
  2338. ----
  2339. .. _class_TextServer_method_shaped_text_get_word_breaks:
  2340. .. rst-class:: classref-method
  2341. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_word_breaks**\ (\ shaped\: :ref:`RID<class_RID>`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`\] = 264, skip_grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`\] = 4\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_word_breaks>`
  2342. Breaks text into words and returns array of character ranges. Use ``grapheme_flags`` to set what characters are used for breaking.
  2343. .. rst-class:: classref-item-separator
  2344. ----
  2345. .. _class_TextServer_method_shaped_text_has_object:
  2346. .. rst-class:: classref-method
  2347. :ref:`bool<class_bool>` **shaped_text_has_object**\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_has_object>`
  2348. Returns ``true`` if an object with ``key`` is embedded in this shaped text buffer.
  2349. .. rst-class:: classref-item-separator
  2350. ----
  2351. .. _class_TextServer_method_shaped_text_has_visible_chars:
  2352. .. rst-class:: classref-method
  2353. :ref:`bool<class_bool>` **shaped_text_has_visible_chars**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_has_visible_chars>`
  2354. Returns ``true`` if text buffer contains any visible characters.
  2355. .. rst-class:: classref-item-separator
  2356. ----
  2357. .. _class_TextServer_method_shaped_text_hit_test_grapheme:
  2358. .. rst-class:: classref-method
  2359. :ref:`int<class_int>` **shaped_text_hit_test_grapheme**\ (\ shaped\: :ref:`RID<class_RID>`, coords\: :ref:`float<class_float>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_hit_test_grapheme>`
  2360. Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` if none is found.
  2361. .. rst-class:: classref-item-separator
  2362. ----
  2363. .. _class_TextServer_method_shaped_text_hit_test_position:
  2364. .. rst-class:: classref-method
  2365. :ref:`int<class_int>` **shaped_text_hit_test_position**\ (\ shaped\: :ref:`RID<class_RID>`, coords\: :ref:`float<class_float>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_hit_test_position>`
  2366. Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
  2367. .. rst-class:: classref-item-separator
  2368. ----
  2369. .. _class_TextServer_method_shaped_text_is_ready:
  2370. .. rst-class:: classref-method
  2371. :ref:`bool<class_bool>` **shaped_text_is_ready**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_is_ready>`
  2372. Returns ``true`` if buffer is successfully shaped.
  2373. .. rst-class:: classref-item-separator
  2374. ----
  2375. .. _class_TextServer_method_shaped_text_next_character_pos:
  2376. .. rst-class:: classref-method
  2377. :ref:`int<class_int>` **shaped_text_next_character_pos**\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_next_character_pos>`
  2378. Returns composite character end position closest to the ``pos``.
  2379. .. rst-class:: classref-item-separator
  2380. ----
  2381. .. _class_TextServer_method_shaped_text_next_grapheme_pos:
  2382. .. rst-class:: classref-method
  2383. :ref:`int<class_int>` **shaped_text_next_grapheme_pos**\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_next_grapheme_pos>`
  2384. Returns grapheme end position closest to the ``pos``.
  2385. .. rst-class:: classref-item-separator
  2386. ----
  2387. .. _class_TextServer_method_shaped_text_overrun_trim_to_width:
  2388. .. rst-class:: classref-method
  2389. |void| **shaped_text_overrun_trim_to_width**\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`float<class_float>` = 0, overrun_trim_flags\: |bitfield|\[:ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>`\] = 0\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_overrun_trim_to_width>`
  2390. Trims text if it exceeds the given width.
  2391. .. rst-class:: classref-item-separator
  2392. ----
  2393. .. _class_TextServer_method_shaped_text_prev_character_pos:
  2394. .. rst-class:: classref-method
  2395. :ref:`int<class_int>` **shaped_text_prev_character_pos**\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_prev_character_pos>`
  2396. Returns composite character start position closest to the ``pos``.
  2397. .. rst-class:: classref-item-separator
  2398. ----
  2399. .. _class_TextServer_method_shaped_text_prev_grapheme_pos:
  2400. .. rst-class:: classref-method
  2401. :ref:`int<class_int>` **shaped_text_prev_grapheme_pos**\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_prev_grapheme_pos>`
  2402. Returns grapheme start position closest to the ``pos``.
  2403. .. rst-class:: classref-item-separator
  2404. ----
  2405. .. _class_TextServer_method_shaped_text_resize_object:
  2406. .. rst-class:: classref-method
  2407. :ref:`bool<class_bool>` **shaped_text_resize_object**\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`, size\: :ref:`Vector2<class_Vector2>`, inline_align\: :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` = 5, baseline\: :ref:`float<class_float>` = 0.0\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_resize_object>`
  2408. Sets new size and alignment of embedded object.
  2409. .. rst-class:: classref-item-separator
  2410. ----
  2411. .. _class_TextServer_method_shaped_text_set_bidi_override:
  2412. .. rst-class:: classref-method
  2413. |void| **shaped_text_set_bidi_override**\ (\ shaped\: :ref:`RID<class_RID>`, override\: :ref:`Array<class_Array>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_bidi_override>`
  2414. Overrides BiDi for the structured text.
  2415. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
  2416. .. rst-class:: classref-item-separator
  2417. ----
  2418. .. _class_TextServer_method_shaped_text_set_custom_ellipsis:
  2419. .. rst-class:: classref-method
  2420. |void| **shaped_text_set_custom_ellipsis**\ (\ shaped\: :ref:`RID<class_RID>`, char\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_custom_ellipsis>`
  2421. Sets ellipsis character used for text clipping.
  2422. .. rst-class:: classref-item-separator
  2423. ----
  2424. .. _class_TextServer_method_shaped_text_set_custom_punctuation:
  2425. .. rst-class:: classref-method
  2426. |void| **shaped_text_set_custom_punctuation**\ (\ shaped\: :ref:`RID<class_RID>`, punct\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_custom_punctuation>`
  2427. Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  2428. .. rst-class:: classref-item-separator
  2429. ----
  2430. .. _class_TextServer_method_shaped_text_set_direction:
  2431. .. rst-class:: classref-method
  2432. |void| **shaped_text_set_direction**\ (\ shaped\: :ref:`RID<class_RID>`, direction\: :ref:`Direction<enum_TextServer_Direction>` = 0\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_direction>`
  2433. 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.
  2434. \ **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>`).
  2435. .. rst-class:: classref-item-separator
  2436. ----
  2437. .. _class_TextServer_method_shaped_text_set_orientation:
  2438. .. rst-class:: classref-method
  2439. |void| **shaped_text_set_orientation**\ (\ shaped\: :ref:`RID<class_RID>`, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_orientation>`
  2440. Sets desired text orientation.
  2441. \ **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>`).
  2442. .. rst-class:: classref-item-separator
  2443. ----
  2444. .. _class_TextServer_method_shaped_text_set_preserve_control:
  2445. .. rst-class:: classref-method
  2446. |void| **shaped_text_set_preserve_control**\ (\ shaped\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_preserve_control>`
  2447. If set to ``true`` text buffer will display control characters.
  2448. .. rst-class:: classref-item-separator
  2449. ----
  2450. .. _class_TextServer_method_shaped_text_set_preserve_invalid:
  2451. .. rst-class:: classref-method
  2452. |void| **shaped_text_set_preserve_invalid**\ (\ shaped\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_preserve_invalid>`
  2453. If set to ``true`` text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.
  2454. .. rst-class:: classref-item-separator
  2455. ----
  2456. .. _class_TextServer_method_shaped_text_set_spacing:
  2457. .. rst-class:: classref-method
  2458. |void| **shaped_text_set_spacing**\ (\ shaped\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`, value\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_spacing>`
  2459. Sets extra spacing added between glyphs or lines in pixels.
  2460. .. rst-class:: classref-item-separator
  2461. ----
  2462. .. _class_TextServer_method_shaped_text_shape:
  2463. .. rst-class:: classref-method
  2464. :ref:`bool<class_bool>` **shaped_text_shape**\ (\ shaped\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_shape>`
  2465. Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped successfully.
  2466. \ **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.
  2467. .. rst-class:: classref-item-separator
  2468. ----
  2469. .. _class_TextServer_method_shaped_text_sort_logical:
  2470. .. rst-class:: classref-method
  2471. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **shaped_text_sort_logical**\ (\ shaped\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_sort_logical>`
  2472. Returns text glyphs in the logical order.
  2473. .. rst-class:: classref-item-separator
  2474. ----
  2475. .. _class_TextServer_method_shaped_text_substr:
  2476. .. rst-class:: classref-method
  2477. :ref:`RID<class_RID>` **shaped_text_substr**\ (\ shaped\: :ref:`RID<class_RID>`, start\: :ref:`int<class_int>`, length\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_substr>`
  2478. Returns text buffer for the substring of the text in the ``shaped`` text buffer (including inline objects).
  2479. .. rst-class:: classref-item-separator
  2480. ----
  2481. .. _class_TextServer_method_shaped_text_tab_align:
  2482. .. rst-class:: classref-method
  2483. :ref:`float<class_float>` **shaped_text_tab_align**\ (\ shaped\: :ref:`RID<class_RID>`, tab_stops\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_tab_align>`
  2484. Aligns shaped text to the given tab-stops.
  2485. .. rst-class:: classref-item-separator
  2486. ----
  2487. .. _class_TextServer_method_spoof_check:
  2488. .. rst-class:: classref-method
  2489. :ref:`bool<class_bool>` **spoof_check**\ (\ string\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_spoof_check>`
  2490. Returns ``true`` if ``string`` is likely to be an attempt at confusing the reader.
  2491. \ **Note:** Always returns ``false`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  2492. .. rst-class:: classref-item-separator
  2493. ----
  2494. .. _class_TextServer_method_string_get_character_breaks:
  2495. .. rst-class:: classref-method
  2496. :ref:`PackedInt32Array<class_PackedInt32Array>` **string_get_character_breaks**\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_string_get_character_breaks>`
  2497. Returns array of the composite character boundaries.
  2498. ::
  2499. var ts = TextServerManager.get_primary_interface()
  2500. print(ts.string_get_character_breaks("Test โค๏ธโ€๐Ÿ”ฅ Test")) # Prints [1, 2, 3, 4, 5, 9, 10, 11, 12, 13, 14]
  2501. .. rst-class:: classref-item-separator
  2502. ----
  2503. .. _class_TextServer_method_string_get_word_breaks:
  2504. .. rst-class:: classref-method
  2505. :ref:`PackedInt32Array<class_PackedInt32Array>` **string_get_word_breaks**\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = "", chars_per_line\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_string_get_word_breaks>`
  2506. 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.
  2507. When ``chars_per_line`` is greater than zero, line break boundaries are returned instead.
  2508. ::
  2509. var ts = TextServerManager.get_primary_interface()
  2510. # Corresponds to the substrings "The", "Godot", "Engine", and "4".
  2511. print(ts.string_get_word_breaks("The Godot Engine, 4")) # Prints [0, 3, 4, 9, 10, 16, 18, 19]
  2512. # Corresponds to the substrings "The", "Godot", "Engin", and "e, 4".
  2513. print(ts.string_get_word_breaks("The Godot Engine, 4", "en", 5)) # Prints [0, 3, 4, 9, 10, 15, 15, 19]
  2514. # Corresponds to the substrings "The Godot" and "Engine, 4".
  2515. print(ts.string_get_word_breaks("The Godot Engine, 4", "en", 10)) # Prints [0, 9, 10, 19]
  2516. .. rst-class:: classref-item-separator
  2517. ----
  2518. .. _class_TextServer_method_string_to_lower:
  2519. .. rst-class:: classref-method
  2520. :ref:`String<class_String>` **string_to_lower**\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_string_to_lower>`
  2521. Returns the string converted to lowercase.
  2522. \ **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>`).
  2523. \ **Note:** The result may be longer or shorter than the original.
  2524. .. rst-class:: classref-item-separator
  2525. ----
  2526. .. _class_TextServer_method_string_to_title:
  2527. .. rst-class:: classref-method
  2528. :ref:`String<class_String>` **string_to_title**\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_string_to_title>`
  2529. Returns the string converted to title case.
  2530. \ **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>`).
  2531. \ **Note:** The result may be longer or shorter than the original.
  2532. .. rst-class:: classref-item-separator
  2533. ----
  2534. .. _class_TextServer_method_string_to_upper:
  2535. .. rst-class:: classref-method
  2536. :ref:`String<class_String>` **string_to_upper**\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_string_to_upper>`
  2537. Returns the string converted to uppercase.
  2538. \ **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>`).
  2539. \ **Note:** The result may be longer or shorter than the original.
  2540. .. rst-class:: classref-item-separator
  2541. ----
  2542. .. _class_TextServer_method_strip_diacritics:
  2543. .. rst-class:: classref-method
  2544. :ref:`String<class_String>` **strip_diacritics**\ (\ string\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_strip_diacritics>`
  2545. Strips diacritics from the string.
  2546. \ **Note:** The result may be longer or shorter than the original.
  2547. .. rst-class:: classref-item-separator
  2548. ----
  2549. .. _class_TextServer_method_tag_to_name:
  2550. .. rst-class:: classref-method
  2551. :ref:`String<class_String>` **tag_to_name**\ (\ tag\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_tag_to_name>`
  2552. Converts OpenType tag to readable feature, variation, script, or language name.
  2553. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2554. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  2555. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2556. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2557. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2558. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2559. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  2560. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  2561. .. |void| replace:: :abbr:`void (No return value.)`