class_displayserver.rst 591 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712
  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/DisplayServer.xml.
  6. .. _class_DisplayServer:
  7. DisplayServer
  8. =============
  9. **Inherits:** :ref:`Object<class_Object>`
  10. A server interface for low-level window management.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. **DisplayServer** handles everything related to window management. It is separated from :ref:`OS<class_OS>` as a single operating system may support multiple display servers.
  15. \ **Headless mode:** Starting the engine with the ``--headless`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>` disables all rendering and window management functions. Most functions from **DisplayServer** will return dummy values in this case.
  16. .. rst-class:: classref-reftable-group
  17. Methods
  18. -------
  19. .. table::
  20. :widths: auto
  21. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`RID<class_RID>` | :ref:`accessibility_create_element<class_DisplayServer_method_accessibility_create_element>`\ (\ window_id\: :ref:`int<class_int>`, role\: :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>`\ ) |
  23. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`RID<class_RID>` | :ref:`accessibility_create_sub_element<class_DisplayServer_method_accessibility_create_sub_element>`\ (\ parent_rid\: :ref:`RID<class_RID>`, role\: :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>`, insert_pos\: :ref:`int<class_int>` = -1\ ) |
  25. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`RID<class_RID>` | :ref:`accessibility_create_sub_text_edit_elements<class_DisplayServer_method_accessibility_create_sub_text_edit_elements>`\ (\ parent_rid\: :ref:`RID<class_RID>`, shaped_text\: :ref:`RID<class_RID>`, min_height\: :ref:`float<class_float>`, insert_pos\: :ref:`int<class_int>` = -1\ ) |
  27. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`Variant<class_Variant>` | :ref:`accessibility_element_get_meta<class_DisplayServer_method_accessibility_element_get_meta>`\ (\ id\: :ref:`RID<class_RID>`\ ) |const| |
  29. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | |void| | :ref:`accessibility_element_set_meta<class_DisplayServer_method_accessibility_element_set_meta>`\ (\ id\: :ref:`RID<class_RID>`, meta\: :ref:`Variant<class_Variant>`\ ) |
  31. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | |void| | :ref:`accessibility_free_element<class_DisplayServer_method_accessibility_free_element>`\ (\ id\: :ref:`RID<class_RID>`\ ) |
  33. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | :ref:`RID<class_RID>` | :ref:`accessibility_get_window_root<class_DisplayServer_method_accessibility_get_window_root>`\ (\ window_id\: :ref:`int<class_int>`\ ) |const| |
  35. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`bool<class_bool>` | :ref:`accessibility_has_element<class_DisplayServer_method_accessibility_has_element>`\ (\ id\: :ref:`RID<class_RID>`\ ) |const| |
  37. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | :ref:`int<class_int>` | :ref:`accessibility_screen_reader_active<class_DisplayServer_method_accessibility_screen_reader_active>`\ (\ ) |const| |
  39. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | |void| | :ref:`accessibility_set_window_focused<class_DisplayServer_method_accessibility_set_window_focused>`\ (\ window_id\: :ref:`int<class_int>`, focused\: :ref:`bool<class_bool>`\ ) |
  41. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | |void| | :ref:`accessibility_set_window_rect<class_DisplayServer_method_accessibility_set_window_rect>`\ (\ window_id\: :ref:`int<class_int>`, rect_out\: :ref:`Rect2<class_Rect2>`, rect_in\: :ref:`Rect2<class_Rect2>`\ ) |
  43. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`int<class_int>` | :ref:`accessibility_should_increase_contrast<class_DisplayServer_method_accessibility_should_increase_contrast>`\ (\ ) |const| |
  45. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`int<class_int>` | :ref:`accessibility_should_reduce_animation<class_DisplayServer_method_accessibility_should_reduce_animation>`\ (\ ) |const| |
  47. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`int<class_int>` | :ref:`accessibility_should_reduce_transparency<class_DisplayServer_method_accessibility_should_reduce_transparency>`\ (\ ) |const| |
  49. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | |void| | :ref:`accessibility_update_add_action<class_DisplayServer_method_accessibility_update_add_action>`\ (\ id\: :ref:`RID<class_RID>`, action\: :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>`, callable\: :ref:`Callable<class_Callable>`\ ) |
  51. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | |void| | :ref:`accessibility_update_add_child<class_DisplayServer_method_accessibility_update_add_child>`\ (\ id\: :ref:`RID<class_RID>`, child_id\: :ref:`RID<class_RID>`\ ) |
  53. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | |void| | :ref:`accessibility_update_add_custom_action<class_DisplayServer_method_accessibility_update_add_custom_action>`\ (\ id\: :ref:`RID<class_RID>`, action_id\: :ref:`int<class_int>`, action_description\: :ref:`String<class_String>`\ ) |
  55. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | |void| | :ref:`accessibility_update_add_related_controls<class_DisplayServer_method_accessibility_update_add_related_controls>`\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) |
  57. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | |void| | :ref:`accessibility_update_add_related_described_by<class_DisplayServer_method_accessibility_update_add_related_described_by>`\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) |
  59. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | |void| | :ref:`accessibility_update_add_related_details<class_DisplayServer_method_accessibility_update_add_related_details>`\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) |
  61. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | |void| | :ref:`accessibility_update_add_related_flow_to<class_DisplayServer_method_accessibility_update_add_related_flow_to>`\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) |
  63. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | |void| | :ref:`accessibility_update_add_related_labeled_by<class_DisplayServer_method_accessibility_update_add_related_labeled_by>`\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) |
  65. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | |void| | :ref:`accessibility_update_add_related_radio_group<class_DisplayServer_method_accessibility_update_add_related_radio_group>`\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) |
  67. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | |void| | :ref:`accessibility_update_set_active_descendant<class_DisplayServer_method_accessibility_update_set_active_descendant>`\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) |
  69. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | |void| | :ref:`accessibility_update_set_background_color<class_DisplayServer_method_accessibility_update_set_background_color>`\ (\ id\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  71. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | |void| | :ref:`accessibility_update_set_bounds<class_DisplayServer_method_accessibility_update_set_bounds>`\ (\ id\: :ref:`RID<class_RID>`, p_rect\: :ref:`Rect2<class_Rect2>`\ ) |
  73. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | |void| | :ref:`accessibility_update_set_checked<class_DisplayServer_method_accessibility_update_set_checked>`\ (\ id\: :ref:`RID<class_RID>`, checekd\: :ref:`bool<class_bool>`\ ) |
  75. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | |void| | :ref:`accessibility_update_set_classname<class_DisplayServer_method_accessibility_update_set_classname>`\ (\ id\: :ref:`RID<class_RID>`, classname\: :ref:`String<class_String>`\ ) |
  77. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | |void| | :ref:`accessibility_update_set_color_value<class_DisplayServer_method_accessibility_update_set_color_value>`\ (\ id\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  79. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | |void| | :ref:`accessibility_update_set_description<class_DisplayServer_method_accessibility_update_set_description>`\ (\ id\: :ref:`RID<class_RID>`, description\: :ref:`String<class_String>`\ ) |
  81. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | |void| | :ref:`accessibility_update_set_error_message<class_DisplayServer_method_accessibility_update_set_error_message>`\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) |
  83. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | |void| | :ref:`accessibility_update_set_extra_info<class_DisplayServer_method_accessibility_update_set_extra_info>`\ (\ id\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) |
  85. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | |void| | :ref:`accessibility_update_set_flag<class_DisplayServer_method_accessibility_update_set_flag>`\ (\ id\: :ref:`RID<class_RID>`, flag\: :ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>`, value\: :ref:`bool<class_bool>`\ ) |
  87. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | |void| | :ref:`accessibility_update_set_focus<class_DisplayServer_method_accessibility_update_set_focus>`\ (\ id\: :ref:`RID<class_RID>`\ ) |
  89. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | |void| | :ref:`accessibility_update_set_foreground_color<class_DisplayServer_method_accessibility_update_set_foreground_color>`\ (\ id\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) |
  91. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | |void| | :ref:`accessibility_update_set_in_page_link_target<class_DisplayServer_method_accessibility_update_set_in_page_link_target>`\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) |
  93. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | |void| | :ref:`accessibility_update_set_language<class_DisplayServer_method_accessibility_update_set_language>`\ (\ id\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) |
  95. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | |void| | :ref:`accessibility_update_set_list_item_count<class_DisplayServer_method_accessibility_update_set_list_item_count>`\ (\ id\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |
  97. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | |void| | :ref:`accessibility_update_set_list_item_expanded<class_DisplayServer_method_accessibility_update_set_list_item_expanded>`\ (\ id\: :ref:`RID<class_RID>`, expanded\: :ref:`bool<class_bool>`\ ) |
  99. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | |void| | :ref:`accessibility_update_set_list_item_index<class_DisplayServer_method_accessibility_update_set_list_item_index>`\ (\ id\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |
  101. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | |void| | :ref:`accessibility_update_set_list_item_level<class_DisplayServer_method_accessibility_update_set_list_item_level>`\ (\ id\: :ref:`RID<class_RID>`, level\: :ref:`int<class_int>`\ ) |
  103. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | |void| | :ref:`accessibility_update_set_list_item_selected<class_DisplayServer_method_accessibility_update_set_list_item_selected>`\ (\ id\: :ref:`RID<class_RID>`, selected\: :ref:`bool<class_bool>`\ ) |
  105. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | |void| | :ref:`accessibility_update_set_list_orientation<class_DisplayServer_method_accessibility_update_set_list_orientation>`\ (\ id\: :ref:`RID<class_RID>`, vertical\: :ref:`bool<class_bool>`\ ) |
  107. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | |void| | :ref:`accessibility_update_set_live<class_DisplayServer_method_accessibility_update_set_live>`\ (\ id\: :ref:`RID<class_RID>`, live\: :ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>`\ ) |
  109. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | |void| | :ref:`accessibility_update_set_member_of<class_DisplayServer_method_accessibility_update_set_member_of>`\ (\ id\: :ref:`RID<class_RID>`, group_id\: :ref:`RID<class_RID>`\ ) |
  111. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | |void| | :ref:`accessibility_update_set_name<class_DisplayServer_method_accessibility_update_set_name>`\ (\ id\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) |
  113. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | |void| | :ref:`accessibility_update_set_next_on_line<class_DisplayServer_method_accessibility_update_set_next_on_line>`\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) |
  115. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | |void| | :ref:`accessibility_update_set_num_jump<class_DisplayServer_method_accessibility_update_set_num_jump>`\ (\ id\: :ref:`RID<class_RID>`, jump\: :ref:`float<class_float>`\ ) |
  117. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | |void| | :ref:`accessibility_update_set_num_range<class_DisplayServer_method_accessibility_update_set_num_range>`\ (\ id\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`\ ) |
  119. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | |void| | :ref:`accessibility_update_set_num_step<class_DisplayServer_method_accessibility_update_set_num_step>`\ (\ id\: :ref:`RID<class_RID>`, step\: :ref:`float<class_float>`\ ) |
  121. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | |void| | :ref:`accessibility_update_set_num_value<class_DisplayServer_method_accessibility_update_set_num_value>`\ (\ id\: :ref:`RID<class_RID>`, position\: :ref:`float<class_float>`\ ) |
  123. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | |void| | :ref:`accessibility_update_set_placeholder<class_DisplayServer_method_accessibility_update_set_placeholder>`\ (\ id\: :ref:`RID<class_RID>`, placeholder\: :ref:`String<class_String>`\ ) |
  125. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | |void| | :ref:`accessibility_update_set_popup_type<class_DisplayServer_method_accessibility_update_set_popup_type>`\ (\ id\: :ref:`RID<class_RID>`, popup\: :ref:`AccessibilityPopupType<enum_DisplayServer_AccessibilityPopupType>`\ ) |
  127. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | |void| | :ref:`accessibility_update_set_previous_on_line<class_DisplayServer_method_accessibility_update_set_previous_on_line>`\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) |
  129. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | |void| | :ref:`accessibility_update_set_role<class_DisplayServer_method_accessibility_update_set_role>`\ (\ id\: :ref:`RID<class_RID>`, role\: :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>`\ ) |
  131. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | |void| | :ref:`accessibility_update_set_role_description<class_DisplayServer_method_accessibility_update_set_role_description>`\ (\ id\: :ref:`RID<class_RID>`, description\: :ref:`String<class_String>`\ ) |
  133. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | |void| | :ref:`accessibility_update_set_scroll_x<class_DisplayServer_method_accessibility_update_set_scroll_x>`\ (\ id\: :ref:`RID<class_RID>`, position\: :ref:`float<class_float>`\ ) |
  135. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. | |void| | :ref:`accessibility_update_set_scroll_x_range<class_DisplayServer_method_accessibility_update_set_scroll_x_range>`\ (\ id\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`\ ) |
  137. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  138. | |void| | :ref:`accessibility_update_set_scroll_y<class_DisplayServer_method_accessibility_update_set_scroll_y>`\ (\ id\: :ref:`RID<class_RID>`, position\: :ref:`float<class_float>`\ ) |
  139. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  140. | |void| | :ref:`accessibility_update_set_scroll_y_range<class_DisplayServer_method_accessibility_update_set_scroll_y_range>`\ (\ id\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`\ ) |
  141. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  142. | |void| | :ref:`accessibility_update_set_shortcut<class_DisplayServer_method_accessibility_update_set_shortcut>`\ (\ id\: :ref:`RID<class_RID>`, shortcut\: :ref:`String<class_String>`\ ) |
  143. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  144. | |void| | :ref:`accessibility_update_set_state_description<class_DisplayServer_method_accessibility_update_set_state_description>`\ (\ id\: :ref:`RID<class_RID>`, description\: :ref:`String<class_String>`\ ) |
  145. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  146. | |void| | :ref:`accessibility_update_set_table_cell_position<class_DisplayServer_method_accessibility_update_set_table_cell_position>`\ (\ id\: :ref:`RID<class_RID>`, row_index\: :ref:`int<class_int>`, column_index\: :ref:`int<class_int>`\ ) |
  147. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  148. | |void| | :ref:`accessibility_update_set_table_cell_span<class_DisplayServer_method_accessibility_update_set_table_cell_span>`\ (\ id\: :ref:`RID<class_RID>`, row_span\: :ref:`int<class_int>`, column_span\: :ref:`int<class_int>`\ ) |
  149. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  150. | |void| | :ref:`accessibility_update_set_table_column_count<class_DisplayServer_method_accessibility_update_set_table_column_count>`\ (\ id\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) |
  151. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  152. | |void| | :ref:`accessibility_update_set_table_column_index<class_DisplayServer_method_accessibility_update_set_table_column_index>`\ (\ id\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |
  153. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  154. | |void| | :ref:`accessibility_update_set_table_row_count<class_DisplayServer_method_accessibility_update_set_table_row_count>`\ (\ id\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) |
  155. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  156. | |void| | :ref:`accessibility_update_set_table_row_index<class_DisplayServer_method_accessibility_update_set_table_row_index>`\ (\ id\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |
  157. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  158. | |void| | :ref:`accessibility_update_set_text_align<class_DisplayServer_method_accessibility_update_set_text_align>`\ (\ id\: :ref:`RID<class_RID>`, align\: :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>`\ ) |
  159. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  160. | |void| | :ref:`accessibility_update_set_text_decorations<class_DisplayServer_method_accessibility_update_set_text_decorations>`\ (\ id\: :ref:`RID<class_RID>`, underline\: :ref:`bool<class_bool>`, strikethrough\: :ref:`bool<class_bool>`, overline\: :ref:`bool<class_bool>`\ ) |
  161. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  162. | |void| | :ref:`accessibility_update_set_text_orientation<class_DisplayServer_method_accessibility_update_set_text_orientation>`\ (\ id\: :ref:`RID<class_RID>`, vertical\: :ref:`bool<class_bool>`\ ) |
  163. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  164. | |void| | :ref:`accessibility_update_set_text_selection<class_DisplayServer_method_accessibility_update_set_text_selection>`\ (\ id\: :ref:`RID<class_RID>`, text_start_id\: :ref:`RID<class_RID>`, start_char\: :ref:`int<class_int>`, text_end_id\: :ref:`RID<class_RID>`, end_char\: :ref:`int<class_int>`\ ) |
  165. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  166. | |void| | :ref:`accessibility_update_set_tooltip<class_DisplayServer_method_accessibility_update_set_tooltip>`\ (\ id\: :ref:`RID<class_RID>`, tooltip\: :ref:`String<class_String>`\ ) |
  167. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  168. | |void| | :ref:`accessibility_update_set_transform<class_DisplayServer_method_accessibility_update_set_transform>`\ (\ id\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  169. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  170. | |void| | :ref:`accessibility_update_set_url<class_DisplayServer_method_accessibility_update_set_url>`\ (\ id\: :ref:`RID<class_RID>`, url\: :ref:`String<class_String>`\ ) |
  171. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  172. | |void| | :ref:`accessibility_update_set_value<class_DisplayServer_method_accessibility_update_set_value>`\ (\ id\: :ref:`RID<class_RID>`, value\: :ref:`String<class_String>`\ ) |
  173. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  174. | |void| | :ref:`beep<class_DisplayServer_method_beep>`\ (\ ) |const| |
  175. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  176. | :ref:`String<class_String>` | :ref:`clipboard_get<class_DisplayServer_method_clipboard_get>`\ (\ ) |const| |
  177. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  178. | :ref:`Image<class_Image>` | :ref:`clipboard_get_image<class_DisplayServer_method_clipboard_get_image>`\ (\ ) |const| |
  179. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  180. | :ref:`String<class_String>` | :ref:`clipboard_get_primary<class_DisplayServer_method_clipboard_get_primary>`\ (\ ) |const| |
  181. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  182. | :ref:`bool<class_bool>` | :ref:`clipboard_has<class_DisplayServer_method_clipboard_has>`\ (\ ) |const| |
  183. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  184. | :ref:`bool<class_bool>` | :ref:`clipboard_has_image<class_DisplayServer_method_clipboard_has_image>`\ (\ ) |const| |
  185. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  186. | |void| | :ref:`clipboard_set<class_DisplayServer_method_clipboard_set>`\ (\ clipboard\: :ref:`String<class_String>`\ ) |
  187. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  188. | |void| | :ref:`clipboard_set_primary<class_DisplayServer_method_clipboard_set_primary>`\ (\ clipboard_primary\: :ref:`String<class_String>`\ ) |
  189. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  190. | :ref:`bool<class_bool>` | :ref:`color_picker<class_DisplayServer_method_color_picker>`\ (\ callback\: :ref:`Callable<class_Callable>`\ ) |
  191. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  192. | :ref:`int<class_int>` | :ref:`create_status_indicator<class_DisplayServer_method_create_status_indicator>`\ (\ icon\: :ref:`Texture2D<class_Texture2D>`, tooltip\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  193. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  194. | :ref:`CursorShape<enum_DisplayServer_CursorShape>` | :ref:`cursor_get_shape<class_DisplayServer_method_cursor_get_shape>`\ (\ ) |const| |
  195. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  196. | |void| | :ref:`cursor_set_custom_image<class_DisplayServer_method_cursor_set_custom_image>`\ (\ cursor\: :ref:`Resource<class_Resource>`, shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>` = 0, hotspot\: :ref:`Vector2<class_Vector2>` = Vector2(0, 0)\ ) |
  197. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  198. | |void| | :ref:`cursor_set_shape<class_DisplayServer_method_cursor_set_shape>`\ (\ shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>`\ ) |
  199. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  200. | |void| | :ref:`delete_status_indicator<class_DisplayServer_method_delete_status_indicator>`\ (\ id\: :ref:`int<class_int>`\ ) |
  201. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  202. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`dialog_input_text<class_DisplayServer_method_dialog_input_text>`\ (\ title\: :ref:`String<class_String>`, description\: :ref:`String<class_String>`, existing_text\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  203. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  204. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`dialog_show<class_DisplayServer_method_dialog_show>`\ (\ title\: :ref:`String<class_String>`, description\: :ref:`String<class_String>`, buttons\: :ref:`PackedStringArray<class_PackedStringArray>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  205. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  206. | |void| | :ref:`enable_for_stealing_focus<class_DisplayServer_method_enable_for_stealing_focus>`\ (\ process_id\: :ref:`int<class_int>`\ ) |
  207. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  208. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`file_dialog_show<class_DisplayServer_method_file_dialog_show>`\ (\ title\: :ref:`String<class_String>`, current_directory\: :ref:`String<class_String>`, filename\: :ref:`String<class_String>`, show_hidden\: :ref:`bool<class_bool>`, mode\: :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>`, filters\: :ref:`PackedStringArray<class_PackedStringArray>`, callback\: :ref:`Callable<class_Callable>`, parent_window_id\: :ref:`int<class_int>` = 0\ ) |
  209. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  210. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`file_dialog_with_options_show<class_DisplayServer_method_file_dialog_with_options_show>`\ (\ title\: :ref:`String<class_String>`, current_directory\: :ref:`String<class_String>`, root\: :ref:`String<class_String>`, filename\: :ref:`String<class_String>`, show_hidden\: :ref:`bool<class_bool>`, mode\: :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>`, filters\: :ref:`PackedStringArray<class_PackedStringArray>`, options\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\], callback\: :ref:`Callable<class_Callable>`, parent_window_id\: :ref:`int<class_int>` = 0\ ) |
  211. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  212. | |void| | :ref:`force_process_and_drop_events<class_DisplayServer_method_force_process_and_drop_events>`\ (\ ) |
  213. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  214. | :ref:`Color<class_Color>` | :ref:`get_accent_color<class_DisplayServer_method_get_accent_color>`\ (\ ) |const| |
  215. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  216. | :ref:`Color<class_Color>` | :ref:`get_base_color<class_DisplayServer_method_get_base_color>`\ (\ ) |const| |
  217. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  218. | :ref:`Array<class_Array>`\[:ref:`Rect2<class_Rect2>`\] | :ref:`get_display_cutouts<class_DisplayServer_method_get_display_cutouts>`\ (\ ) |const| |
  219. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  220. | :ref:`Rect2i<class_Rect2i>` | :ref:`get_display_safe_area<class_DisplayServer_method_get_display_safe_area>`\ (\ ) |const| |
  221. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  222. | :ref:`int<class_int>` | :ref:`get_keyboard_focus_screen<class_DisplayServer_method_get_keyboard_focus_screen>`\ (\ ) |const| |
  223. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  224. | :ref:`String<class_String>` | :ref:`get_name<class_DisplayServer_method_get_name>`\ (\ ) |const| |
  225. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  226. | :ref:`int<class_int>` | :ref:`get_primary_screen<class_DisplayServer_method_get_primary_screen>`\ (\ ) |const| |
  227. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  228. | :ref:`int<class_int>` | :ref:`get_screen_count<class_DisplayServer_method_get_screen_count>`\ (\ ) |const| |
  229. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  230. | :ref:`int<class_int>` | :ref:`get_screen_from_rect<class_DisplayServer_method_get_screen_from_rect>`\ (\ rect\: :ref:`Rect2<class_Rect2>`\ ) |const| |
  231. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  232. | :ref:`bool<class_bool>` | :ref:`get_swap_cancel_ok<class_DisplayServer_method_get_swap_cancel_ok>`\ (\ ) |
  233. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  234. | :ref:`int<class_int>` | :ref:`get_window_at_screen_position<class_DisplayServer_method_get_window_at_screen_position>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
  235. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  236. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_window_list<class_DisplayServer_method_get_window_list>`\ (\ ) |const| |
  237. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  238. | :ref:`int<class_int>` | :ref:`global_menu_add_check_item<class_DisplayServer_method_global_menu_add_check_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
  239. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  240. | :ref:`int<class_int>` | :ref:`global_menu_add_icon_check_item<class_DisplayServer_method_global_menu_add_icon_check_item>`\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
  241. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  242. | :ref:`int<class_int>` | :ref:`global_menu_add_icon_item<class_DisplayServer_method_global_menu_add_icon_item>`\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
  243. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  244. | :ref:`int<class_int>` | :ref:`global_menu_add_icon_radio_check_item<class_DisplayServer_method_global_menu_add_icon_radio_check_item>`\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
  245. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  246. | :ref:`int<class_int>` | :ref:`global_menu_add_item<class_DisplayServer_method_global_menu_add_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
  247. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  248. | :ref:`int<class_int>` | :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, max_states\: :ref:`int<class_int>`, default_state\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
  249. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  250. | :ref:`int<class_int>` | :ref:`global_menu_add_radio_check_item<class_DisplayServer_method_global_menu_add_radio_check_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
  251. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  252. | :ref:`int<class_int>` | :ref:`global_menu_add_separator<class_DisplayServer_method_global_menu_add_separator>`\ (\ menu_root\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ ) |
  253. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  254. | :ref:`int<class_int>` | :ref:`global_menu_add_submenu_item<class_DisplayServer_method_global_menu_add_submenu_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, submenu\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ ) |
  255. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  256. | |void| | :ref:`global_menu_clear<class_DisplayServer_method_global_menu_clear>`\ (\ menu_root\: :ref:`String<class_String>`\ ) |
  257. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  258. | :ref:`Key<enum_@GlobalScope_Key>` | :ref:`global_menu_get_item_accelerator<class_DisplayServer_method_global_menu_get_item_accelerator>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  259. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  260. | :ref:`Callable<class_Callable>` | :ref:`global_menu_get_item_callback<class_DisplayServer_method_global_menu_get_item_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  261. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  262. | :ref:`int<class_int>` | :ref:`global_menu_get_item_count<class_DisplayServer_method_global_menu_get_item_count>`\ (\ menu_root\: :ref:`String<class_String>`\ ) |const| |
  263. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  264. | :ref:`Texture2D<class_Texture2D>` | :ref:`global_menu_get_item_icon<class_DisplayServer_method_global_menu_get_item_icon>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  265. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  266. | :ref:`int<class_int>` | :ref:`global_menu_get_item_indentation_level<class_DisplayServer_method_global_menu_get_item_indentation_level>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  267. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  268. | :ref:`int<class_int>` | :ref:`global_menu_get_item_index_from_tag<class_DisplayServer_method_global_menu_get_item_index_from_tag>`\ (\ menu_root\: :ref:`String<class_String>`, tag\: :ref:`Variant<class_Variant>`\ ) |const| |
  269. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  270. | :ref:`int<class_int>` | :ref:`global_menu_get_item_index_from_text<class_DisplayServer_method_global_menu_get_item_index_from_text>`\ (\ menu_root\: :ref:`String<class_String>`, text\: :ref:`String<class_String>`\ ) |const| |
  271. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  272. | :ref:`Callable<class_Callable>` | :ref:`global_menu_get_item_key_callback<class_DisplayServer_method_global_menu_get_item_key_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  273. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  274. | :ref:`int<class_int>` | :ref:`global_menu_get_item_max_states<class_DisplayServer_method_global_menu_get_item_max_states>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  275. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  276. | :ref:`int<class_int>` | :ref:`global_menu_get_item_state<class_DisplayServer_method_global_menu_get_item_state>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  277. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  278. | :ref:`String<class_String>` | :ref:`global_menu_get_item_submenu<class_DisplayServer_method_global_menu_get_item_submenu>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  279. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  280. | :ref:`Variant<class_Variant>` | :ref:`global_menu_get_item_tag<class_DisplayServer_method_global_menu_get_item_tag>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  281. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  282. | :ref:`String<class_String>` | :ref:`global_menu_get_item_text<class_DisplayServer_method_global_menu_get_item_text>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  283. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  284. | :ref:`String<class_String>` | :ref:`global_menu_get_item_tooltip<class_DisplayServer_method_global_menu_get_item_tooltip>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  285. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  286. | :ref:`Dictionary<class_Dictionary>` | :ref:`global_menu_get_system_menu_roots<class_DisplayServer_method_global_menu_get_system_menu_roots>`\ (\ ) |const| |
  287. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  288. | :ref:`bool<class_bool>` | :ref:`global_menu_is_item_checkable<class_DisplayServer_method_global_menu_is_item_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  289. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  290. | :ref:`bool<class_bool>` | :ref:`global_menu_is_item_checked<class_DisplayServer_method_global_menu_is_item_checked>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  291. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  292. | :ref:`bool<class_bool>` | :ref:`global_menu_is_item_disabled<class_DisplayServer_method_global_menu_is_item_disabled>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  293. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  294. | :ref:`bool<class_bool>` | :ref:`global_menu_is_item_hidden<class_DisplayServer_method_global_menu_is_item_hidden>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  295. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  296. | :ref:`bool<class_bool>` | :ref:`global_menu_is_item_radio_checkable<class_DisplayServer_method_global_menu_is_item_radio_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  297. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  298. | |void| | :ref:`global_menu_remove_item<class_DisplayServer_method_global_menu_remove_item>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |
  299. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  300. | |void| | :ref:`global_menu_set_item_accelerator<class_DisplayServer_method_global_menu_set_item_accelerator>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |
  301. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  302. | |void| | :ref:`global_menu_set_item_callback<class_DisplayServer_method_global_menu_set_item_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  303. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  304. | |void| | :ref:`global_menu_set_item_checkable<class_DisplayServer_method_global_menu_set_item_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ ) |
  305. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  306. | |void| | :ref:`global_menu_set_item_checked<class_DisplayServer_method_global_menu_set_item_checked>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checked\: :ref:`bool<class_bool>`\ ) |
  307. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  308. | |void| | :ref:`global_menu_set_item_disabled<class_DisplayServer_method_global_menu_set_item_disabled>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) |
  309. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  310. | |void| | :ref:`global_menu_set_item_hidden<class_DisplayServer_method_global_menu_set_item_hidden>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, hidden\: :ref:`bool<class_bool>`\ ) |
  311. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  312. | |void| | :ref:`global_menu_set_item_hover_callbacks<class_DisplayServer_method_global_menu_set_item_hover_callbacks>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  313. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  314. | |void| | :ref:`global_menu_set_item_icon<class_DisplayServer_method_global_menu_set_item_icon>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) |
  315. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  316. | |void| | :ref:`global_menu_set_item_indentation_level<class_DisplayServer_method_global_menu_set_item_indentation_level>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, level\: :ref:`int<class_int>`\ ) |
  317. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  318. | |void| | :ref:`global_menu_set_item_key_callback<class_DisplayServer_method_global_menu_set_item_key_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, key_callback\: :ref:`Callable<class_Callable>`\ ) |
  319. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  320. | |void| | :ref:`global_menu_set_item_max_states<class_DisplayServer_method_global_menu_set_item_max_states>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, max_states\: :ref:`int<class_int>`\ ) |
  321. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  322. | |void| | :ref:`global_menu_set_item_radio_checkable<class_DisplayServer_method_global_menu_set_item_radio_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ ) |
  323. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  324. | |void| | :ref:`global_menu_set_item_state<class_DisplayServer_method_global_menu_set_item_state>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, state\: :ref:`int<class_int>`\ ) |
  325. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  326. | |void| | :ref:`global_menu_set_item_submenu<class_DisplayServer_method_global_menu_set_item_submenu>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, submenu\: :ref:`String<class_String>`\ ) |
  327. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  328. | |void| | :ref:`global_menu_set_item_tag<class_DisplayServer_method_global_menu_set_item_tag>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tag\: :ref:`Variant<class_Variant>`\ ) |
  329. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  330. | |void| | :ref:`global_menu_set_item_text<class_DisplayServer_method_global_menu_set_item_text>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, text\: :ref:`String<class_String>`\ ) |
  331. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  332. | |void| | :ref:`global_menu_set_item_tooltip<class_DisplayServer_method_global_menu_set_item_tooltip>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) |
  333. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  334. | |void| | :ref:`global_menu_set_popup_callbacks<class_DisplayServer_method_global_menu_set_popup_callbacks>`\ (\ menu_root\: :ref:`String<class_String>`, open_callback\: :ref:`Callable<class_Callable>`, close_callback\: :ref:`Callable<class_Callable>`\ ) |
  335. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  336. | :ref:`bool<class_bool>` | :ref:`has_additional_outputs<class_DisplayServer_method_has_additional_outputs>`\ (\ ) |const| |
  337. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  338. | :ref:`bool<class_bool>` | :ref:`has_feature<class_DisplayServer_method_has_feature>`\ (\ feature\: :ref:`Feature<enum_DisplayServer_Feature>`\ ) |const| |
  339. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  340. | :ref:`bool<class_bool>` | :ref:`has_hardware_keyboard<class_DisplayServer_method_has_hardware_keyboard>`\ (\ ) |const| |
  341. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  342. | |void| | :ref:`help_set_search_callbacks<class_DisplayServer_method_help_set_search_callbacks>`\ (\ search_callback\: :ref:`Callable<class_Callable>`, action_callback\: :ref:`Callable<class_Callable>`\ ) |
  343. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  344. | :ref:`Vector2i<class_Vector2i>` | :ref:`ime_get_selection<class_DisplayServer_method_ime_get_selection>`\ (\ ) |const| |
  345. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  346. | :ref:`String<class_String>` | :ref:`ime_get_text<class_DisplayServer_method_ime_get_text>`\ (\ ) |const| |
  347. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  348. | :ref:`bool<class_bool>` | :ref:`is_dark_mode<class_DisplayServer_method_is_dark_mode>`\ (\ ) |const| |
  349. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  350. | :ref:`bool<class_bool>` | :ref:`is_dark_mode_supported<class_DisplayServer_method_is_dark_mode_supported>`\ (\ ) |const| |
  351. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  352. | :ref:`bool<class_bool>` | :ref:`is_touchscreen_available<class_DisplayServer_method_is_touchscreen_available>`\ (\ ) |const| |
  353. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  354. | :ref:`bool<class_bool>` | :ref:`is_window_transparency_available<class_DisplayServer_method_is_window_transparency_available>`\ (\ ) |const| |
  355. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  356. | :ref:`int<class_int>` | :ref:`keyboard_get_current_layout<class_DisplayServer_method_keyboard_get_current_layout>`\ (\ ) |const| |
  357. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  358. | :ref:`Key<enum_@GlobalScope_Key>` | :ref:`keyboard_get_keycode_from_physical<class_DisplayServer_method_keyboard_get_keycode_from_physical>`\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const| |
  359. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  360. | :ref:`Key<enum_@GlobalScope_Key>` | :ref:`keyboard_get_label_from_physical<class_DisplayServer_method_keyboard_get_label_from_physical>`\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const| |
  361. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  362. | :ref:`int<class_int>` | :ref:`keyboard_get_layout_count<class_DisplayServer_method_keyboard_get_layout_count>`\ (\ ) |const| |
  363. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  364. | :ref:`String<class_String>` | :ref:`keyboard_get_layout_language<class_DisplayServer_method_keyboard_get_layout_language>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
  365. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  366. | :ref:`String<class_String>` | :ref:`keyboard_get_layout_name<class_DisplayServer_method_keyboard_get_layout_name>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
  367. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  368. | |void| | :ref:`keyboard_set_current_layout<class_DisplayServer_method_keyboard_set_current_layout>`\ (\ index\: :ref:`int<class_int>`\ ) |
  369. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  370. | |bitfield|\[:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>`\] | :ref:`mouse_get_button_state<class_DisplayServer_method_mouse_get_button_state>`\ (\ ) |const| |
  371. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  372. | :ref:`MouseMode<enum_DisplayServer_MouseMode>` | :ref:`mouse_get_mode<class_DisplayServer_method_mouse_get_mode>`\ (\ ) |const| |
  373. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  374. | :ref:`Vector2i<class_Vector2i>` | :ref:`mouse_get_position<class_DisplayServer_method_mouse_get_position>`\ (\ ) |const| |
  375. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  376. | |void| | :ref:`mouse_set_mode<class_DisplayServer_method_mouse_set_mode>`\ (\ mouse_mode\: :ref:`MouseMode<enum_DisplayServer_MouseMode>`\ ) |
  377. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  378. | |void| | :ref:`process_events<class_DisplayServer_method_process_events>`\ (\ ) |
  379. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  380. | |void| | :ref:`register_additional_output<class_DisplayServer_method_register_additional_output>`\ (\ object\: :ref:`Object<class_Object>`\ ) |
  381. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  382. | :ref:`int<class_int>` | :ref:`screen_get_dpi<class_DisplayServer_method_screen_get_dpi>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  383. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  384. | :ref:`Image<class_Image>` | :ref:`screen_get_image<class_DisplayServer_method_screen_get_image>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  385. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  386. | :ref:`Image<class_Image>` | :ref:`screen_get_image_rect<class_DisplayServer_method_screen_get_image_rect>`\ (\ rect\: :ref:`Rect2i<class_Rect2i>`\ ) |const| |
  387. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  388. | :ref:`float<class_float>` | :ref:`screen_get_max_scale<class_DisplayServer_method_screen_get_max_scale>`\ (\ ) |const| |
  389. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  390. | :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` | :ref:`screen_get_orientation<class_DisplayServer_method_screen_get_orientation>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  391. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  392. | :ref:`Color<class_Color>` | :ref:`screen_get_pixel<class_DisplayServer_method_screen_get_pixel>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
  393. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  394. | :ref:`Vector2i<class_Vector2i>` | :ref:`screen_get_position<class_DisplayServer_method_screen_get_position>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  395. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  396. | :ref:`float<class_float>` | :ref:`screen_get_refresh_rate<class_DisplayServer_method_screen_get_refresh_rate>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  397. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  398. | :ref:`float<class_float>` | :ref:`screen_get_scale<class_DisplayServer_method_screen_get_scale>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  399. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  400. | :ref:`Vector2i<class_Vector2i>` | :ref:`screen_get_size<class_DisplayServer_method_screen_get_size>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  401. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  402. | :ref:`Rect2i<class_Rect2i>` | :ref:`screen_get_usable_rect<class_DisplayServer_method_screen_get_usable_rect>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  403. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  404. | :ref:`bool<class_bool>` | :ref:`screen_is_kept_on<class_DisplayServer_method_screen_is_kept_on>`\ (\ ) |const| |
  405. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  406. | |void| | :ref:`screen_set_keep_on<class_DisplayServer_method_screen_set_keep_on>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  407. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  408. | |void| | :ref:`screen_set_orientation<class_DisplayServer_method_screen_set_orientation>`\ (\ orientation\: :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>`, screen\: :ref:`int<class_int>` = -1\ ) |
  409. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  410. | |void| | :ref:`set_hardware_keyboard_connection_change_callback<class_DisplayServer_method_set_hardware_keyboard_connection_change_callback>`\ (\ callable\: :ref:`Callable<class_Callable>`\ ) |
  411. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  412. | |void| | :ref:`set_icon<class_DisplayServer_method_set_icon>`\ (\ image\: :ref:`Image<class_Image>`\ ) |
  413. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  414. | |void| | :ref:`set_native_icon<class_DisplayServer_method_set_native_icon>`\ (\ filename\: :ref:`String<class_String>`\ ) |
  415. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  416. | |void| | :ref:`set_system_theme_change_callback<class_DisplayServer_method_set_system_theme_change_callback>`\ (\ callable\: :ref:`Callable<class_Callable>`\ ) |
  417. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  418. | |void| | :ref:`show_emoji_and_symbol_picker<class_DisplayServer_method_show_emoji_and_symbol_picker>`\ (\ ) |const| |
  419. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  420. | :ref:`Rect2<class_Rect2>` | :ref:`status_indicator_get_rect<class_DisplayServer_method_status_indicator_get_rect>`\ (\ id\: :ref:`int<class_int>`\ ) |const| |
  421. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  422. | |void| | :ref:`status_indicator_set_callback<class_DisplayServer_method_status_indicator_set_callback>`\ (\ id\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  423. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  424. | |void| | :ref:`status_indicator_set_icon<class_DisplayServer_method_status_indicator_set_icon>`\ (\ id\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) |
  425. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  426. | |void| | :ref:`status_indicator_set_menu<class_DisplayServer_method_status_indicator_set_menu>`\ (\ id\: :ref:`int<class_int>`, menu_rid\: :ref:`RID<class_RID>`\ ) |
  427. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  428. | |void| | :ref:`status_indicator_set_tooltip<class_DisplayServer_method_status_indicator_set_tooltip>`\ (\ id\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) |
  429. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  430. | :ref:`String<class_String>` | :ref:`tablet_get_current_driver<class_DisplayServer_method_tablet_get_current_driver>`\ (\ ) |const| |
  431. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  432. | :ref:`int<class_int>` | :ref:`tablet_get_driver_count<class_DisplayServer_method_tablet_get_driver_count>`\ (\ ) |const| |
  433. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  434. | :ref:`String<class_String>` | :ref:`tablet_get_driver_name<class_DisplayServer_method_tablet_get_driver_name>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
  435. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  436. | |void| | :ref:`tablet_set_current_driver<class_DisplayServer_method_tablet_set_current_driver>`\ (\ name\: :ref:`String<class_String>`\ ) |
  437. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  438. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`tts_get_voices<class_DisplayServer_method_tts_get_voices>`\ (\ ) |const| |
  439. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  440. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`tts_get_voices_for_language<class_DisplayServer_method_tts_get_voices_for_language>`\ (\ language\: :ref:`String<class_String>`\ ) |const| |
  441. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  442. | :ref:`bool<class_bool>` | :ref:`tts_is_paused<class_DisplayServer_method_tts_is_paused>`\ (\ ) |const| |
  443. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  444. | :ref:`bool<class_bool>` | :ref:`tts_is_speaking<class_DisplayServer_method_tts_is_speaking>`\ (\ ) |const| |
  445. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  446. | |void| | :ref:`tts_pause<class_DisplayServer_method_tts_pause>`\ (\ ) |
  447. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  448. | |void| | :ref:`tts_resume<class_DisplayServer_method_tts_resume>`\ (\ ) |
  449. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  450. | |void| | :ref:`tts_set_utterance_callback<class_DisplayServer_method_tts_set_utterance_callback>`\ (\ event\: :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>`, callable\: :ref:`Callable<class_Callable>`\ ) |
  451. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  452. | |void| | :ref:`tts_speak<class_DisplayServer_method_tts_speak>`\ (\ text\: :ref:`String<class_String>`, voice\: :ref:`String<class_String>`, volume\: :ref:`int<class_int>` = 50, pitch\: :ref:`float<class_float>` = 1.0, rate\: :ref:`float<class_float>` = 1.0, utterance_id\: :ref:`int<class_int>` = 0, interrupt\: :ref:`bool<class_bool>` = false\ ) |
  453. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  454. | |void| | :ref:`tts_stop<class_DisplayServer_method_tts_stop>`\ (\ ) |
  455. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  456. | |void| | :ref:`unregister_additional_output<class_DisplayServer_method_unregister_additional_output>`\ (\ object\: :ref:`Object<class_Object>`\ ) |
  457. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  458. | :ref:`int<class_int>` | :ref:`virtual_keyboard_get_height<class_DisplayServer_method_virtual_keyboard_get_height>`\ (\ ) |const| |
  459. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  460. | |void| | :ref:`virtual_keyboard_hide<class_DisplayServer_method_virtual_keyboard_hide>`\ (\ ) |
  461. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  462. | |void| | :ref:`virtual_keyboard_show<class_DisplayServer_method_virtual_keyboard_show>`\ (\ existing_text\: :ref:`String<class_String>`, position\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0), type\: :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` = 0, max_length\: :ref:`int<class_int>` = -1, cursor_start\: :ref:`int<class_int>` = -1, cursor_end\: :ref:`int<class_int>` = -1\ ) |
  463. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  464. | |void| | :ref:`warp_mouse<class_DisplayServer_method_warp_mouse>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |
  465. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  466. | :ref:`bool<class_bool>` | :ref:`window_can_draw<class_DisplayServer_method_window_can_draw>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  467. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  468. | :ref:`int<class_int>` | :ref:`window_get_active_popup<class_DisplayServer_method_window_get_active_popup>`\ (\ ) |const| |
  469. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  470. | :ref:`int<class_int>` | :ref:`window_get_attached_instance_id<class_DisplayServer_method_window_get_attached_instance_id>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  471. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  472. | :ref:`int<class_int>` | :ref:`window_get_current_screen<class_DisplayServer_method_window_get_current_screen>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  473. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  474. | :ref:`bool<class_bool>` | :ref:`window_get_flag<class_DisplayServer_method_window_get_flag>`\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  475. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  476. | :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_max_size<class_DisplayServer_method_window_get_max_size>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  477. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  478. | :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_min_size<class_DisplayServer_method_window_get_min_size>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  479. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  480. | :ref:`WindowMode<enum_DisplayServer_WindowMode>` | :ref:`window_get_mode<class_DisplayServer_method_window_get_mode>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  481. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  482. | :ref:`int<class_int>` | :ref:`window_get_native_handle<class_DisplayServer_method_window_get_native_handle>`\ (\ handle_type\: :ref:`HandleType<enum_DisplayServer_HandleType>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  483. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  484. | :ref:`Rect2i<class_Rect2i>` | :ref:`window_get_popup_safe_rect<class_DisplayServer_method_window_get_popup_safe_rect>`\ (\ window\: :ref:`int<class_int>`\ ) |const| |
  485. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  486. | :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_position<class_DisplayServer_method_window_get_position>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  487. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  488. | :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_position_with_decorations<class_DisplayServer_method_window_get_position_with_decorations>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  489. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  490. | :ref:`Vector3i<class_Vector3i>` | :ref:`window_get_safe_title_margins<class_DisplayServer_method_window_get_safe_title_margins>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  491. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  492. | :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_size<class_DisplayServer_method_window_get_size>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  493. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  494. | :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_size_with_decorations<class_DisplayServer_method_window_get_size_with_decorations>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  495. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  496. | :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_title_size<class_DisplayServer_method_window_get_title_size>`\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  497. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  498. | :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` | :ref:`window_get_vsync_mode<class_DisplayServer_method_window_get_vsync_mode>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  499. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  500. | :ref:`bool<class_bool>` | :ref:`window_is_focused<class_DisplayServer_method_window_is_focused>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  501. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  502. | :ref:`bool<class_bool>` | :ref:`window_is_maximize_allowed<class_DisplayServer_method_window_is_maximize_allowed>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  503. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  504. | :ref:`bool<class_bool>` | :ref:`window_maximize_on_title_dbl_click<class_DisplayServer_method_window_maximize_on_title_dbl_click>`\ (\ ) |const| |
  505. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  506. | :ref:`bool<class_bool>` | :ref:`window_minimize_on_title_dbl_click<class_DisplayServer_method_window_minimize_on_title_dbl_click>`\ (\ ) |const| |
  507. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  508. | |void| | :ref:`window_move_to_foreground<class_DisplayServer_method_window_move_to_foreground>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |
  509. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  510. | |void| | :ref:`window_request_attention<class_DisplayServer_method_window_request_attention>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |
  511. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  512. | |void| | :ref:`window_set_current_screen<class_DisplayServer_method_window_set_current_screen>`\ (\ screen\: :ref:`int<class_int>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  513. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  514. | |void| | :ref:`window_set_drop_files_callback<class_DisplayServer_method_window_set_drop_files_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  515. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  516. | |void| | :ref:`window_set_exclusive<class_DisplayServer_method_window_set_exclusive>`\ (\ window_id\: :ref:`int<class_int>`, exclusive\: :ref:`bool<class_bool>`\ ) |
  517. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  518. | |void| | :ref:`window_set_flag<class_DisplayServer_method_window_set_flag>`\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, enabled\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  519. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  520. | |void| | :ref:`window_set_ime_active<class_DisplayServer_method_window_set_ime_active>`\ (\ active\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  521. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  522. | |void| | :ref:`window_set_ime_position<class_DisplayServer_method_window_set_ime_position>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  523. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  524. | |void| | :ref:`window_set_input_event_callback<class_DisplayServer_method_window_set_input_event_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  525. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  526. | |void| | :ref:`window_set_input_text_callback<class_DisplayServer_method_window_set_input_text_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  527. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  528. | |void| | :ref:`window_set_max_size<class_DisplayServer_method_window_set_max_size>`\ (\ max_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  529. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  530. | |void| | :ref:`window_set_min_size<class_DisplayServer_method_window_set_min_size>`\ (\ min_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  531. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  532. | |void| | :ref:`window_set_mode<class_DisplayServer_method_window_set_mode>`\ (\ mode\: :ref:`WindowMode<enum_DisplayServer_WindowMode>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  533. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  534. | |void| | :ref:`window_set_mouse_passthrough<class_DisplayServer_method_window_set_mouse_passthrough>`\ (\ region\: :ref:`PackedVector2Array<class_PackedVector2Array>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  535. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  536. | |void| | :ref:`window_set_popup_safe_rect<class_DisplayServer_method_window_set_popup_safe_rect>`\ (\ window\: :ref:`int<class_int>`, rect\: :ref:`Rect2i<class_Rect2i>`\ ) |
  537. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  538. | |void| | :ref:`window_set_position<class_DisplayServer_method_window_set_position>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  539. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  540. | |void| | :ref:`window_set_rect_changed_callback<class_DisplayServer_method_window_set_rect_changed_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  541. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  542. | |void| | :ref:`window_set_size<class_DisplayServer_method_window_set_size>`\ (\ size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  543. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  544. | |void| | :ref:`window_set_title<class_DisplayServer_method_window_set_title>`\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  545. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  546. | |void| | :ref:`window_set_transient<class_DisplayServer_method_window_set_transient>`\ (\ window_id\: :ref:`int<class_int>`, parent_window_id\: :ref:`int<class_int>`\ ) |
  547. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  548. | |void| | :ref:`window_set_vsync_mode<class_DisplayServer_method_window_set_vsync_mode>`\ (\ vsync_mode\: :ref:`VSyncMode<enum_DisplayServer_VSyncMode>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  549. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  550. | |void| | :ref:`window_set_window_buttons_offset<class_DisplayServer_method_window_set_window_buttons_offset>`\ (\ offset\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  551. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  552. | |void| | :ref:`window_set_window_event_callback<class_DisplayServer_method_window_set_window_event_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  553. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  554. | |void| | :ref:`window_start_drag<class_DisplayServer_method_window_start_drag>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |
  555. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  556. | |void| | :ref:`window_start_resize<class_DisplayServer_method_window_start_resize>`\ (\ edge\: :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  557. +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  558. .. rst-class:: classref-section-separator
  559. ----
  560. .. rst-class:: classref-descriptions-group
  561. Enumerations
  562. ------------
  563. .. _enum_DisplayServer_Feature:
  564. .. rst-class:: classref-enumeration
  565. enum **Feature**: :ref:`๐Ÿ”—<enum_DisplayServer_Feature>`
  566. .. _class_DisplayServer_constant_FEATURE_GLOBAL_MENU:
  567. .. rst-class:: classref-enumeration-constant
  568. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_GLOBAL_MENU** = ``0``
  569. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  570. Display server supports global menu. This allows the application to display its menu items in the operating system's top bar. **macOS**
  571. .. _class_DisplayServer_constant_FEATURE_SUBWINDOWS:
  572. .. rst-class:: classref-enumeration-constant
  573. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SUBWINDOWS** = ``1``
  574. Display server supports multiple windows that can be moved outside of the main window. **Windows, macOS, Linux (X11)**
  575. .. _class_DisplayServer_constant_FEATURE_TOUCHSCREEN:
  576. .. rst-class:: classref-enumeration-constant
  577. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TOUCHSCREEN** = ``2``
  578. Display server supports touchscreen input. **Windows, Linux (X11), Android, iOS, Web**
  579. .. _class_DisplayServer_constant_FEATURE_MOUSE:
  580. .. rst-class:: classref-enumeration-constant
  581. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE** = ``3``
  582. Display server supports mouse input. **Windows, macOS, Linux (X11/Wayland), Android, Web**
  583. .. _class_DisplayServer_constant_FEATURE_MOUSE_WARP:
  584. .. rst-class:: classref-enumeration-constant
  585. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE_WARP** = ``4``
  586. Display server supports warping mouse coordinates to keep the mouse cursor constrained within an area, but looping when one of the edges is reached. **Windows, macOS, Linux (X11/Wayland)**
  587. .. _class_DisplayServer_constant_FEATURE_CLIPBOARD:
  588. .. rst-class:: classref-enumeration-constant
  589. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD** = ``5``
  590. Display server supports setting and getting clipboard data. See also :ref:`FEATURE_CLIPBOARD_PRIMARY<class_DisplayServer_constant_FEATURE_CLIPBOARD_PRIMARY>`. **Windows, macOS, Linux (X11/Wayland), Android, iOS, Web**
  591. .. _class_DisplayServer_constant_FEATURE_VIRTUAL_KEYBOARD:
  592. .. rst-class:: classref-enumeration-constant
  593. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_VIRTUAL_KEYBOARD** = ``6``
  594. Display server supports popping up a virtual keyboard when requested to input text without a physical keyboard. **Android, iOS, Web**
  595. .. _class_DisplayServer_constant_FEATURE_CURSOR_SHAPE:
  596. .. rst-class:: classref-enumeration-constant
  597. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CURSOR_SHAPE** = ``7``
  598. Display server supports setting the mouse cursor shape to be different from the default. **Windows, macOS, Linux (X11/Wayland), Android, Web**
  599. .. _class_DisplayServer_constant_FEATURE_CUSTOM_CURSOR_SHAPE:
  600. .. rst-class:: classref-enumeration-constant
  601. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CUSTOM_CURSOR_SHAPE** = ``8``
  602. Display server supports setting the mouse cursor shape to a custom image. **Windows, macOS, Linux (X11/Wayland), Web**
  603. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG:
  604. .. rst-class:: classref-enumeration-constant
  605. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG** = ``9``
  606. Display server supports spawning text dialogs using the operating system's native look-and-feel. See :ref:`dialog_show()<class_DisplayServer_method_dialog_show>`. **Windows, macOS**
  607. .. _class_DisplayServer_constant_FEATURE_IME:
  608. .. rst-class:: classref-enumeration-constant
  609. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_IME** = ``10``
  610. Display server supports `Input Method Editor <https://en.wikipedia.org/wiki/Input_method>`__, which is commonly used for inputting Chinese/Japanese/Korean text. This is handled by the operating system, rather than by Godot. **Windows, macOS, Linux (X11)**
  611. .. _class_DisplayServer_constant_FEATURE_WINDOW_TRANSPARENCY:
  612. .. rst-class:: classref-enumeration-constant
  613. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_TRANSPARENCY** = ``11``
  614. Display server supports windows can use per-pixel transparency to make windows behind them partially or fully visible. **Windows, macOS, Linux (X11/Wayland)**
  615. .. _class_DisplayServer_constant_FEATURE_HIDPI:
  616. .. rst-class:: classref-enumeration-constant
  617. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_HIDPI** = ``12``
  618. Display server supports querying the operating system's display scale factor. This allows automatically detecting the hiDPI display *reliably*, instead of guessing based on the screen resolution and the display's reported DPI (which might be unreliable due to broken monitor EDID). **Windows, Linux (Wayland), macOS**
  619. .. _class_DisplayServer_constant_FEATURE_ICON:
  620. .. rst-class:: classref-enumeration-constant
  621. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ICON** = ``13``
  622. Display server supports changing the window icon (usually displayed in the top-left corner). **Windows, macOS, Linux (X11)**
  623. .. _class_DisplayServer_constant_FEATURE_NATIVE_ICON:
  624. .. rst-class:: classref-enumeration-constant
  625. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_ICON** = ``14``
  626. Display server supports changing the window icon (usually displayed in the top-left corner). **Windows, macOS**
  627. .. _class_DisplayServer_constant_FEATURE_ORIENTATION:
  628. .. rst-class:: classref-enumeration-constant
  629. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ORIENTATION** = ``15``
  630. Display server supports changing the screen orientation. **Android, iOS**
  631. .. _class_DisplayServer_constant_FEATURE_SWAP_BUFFERS:
  632. .. rst-class:: classref-enumeration-constant
  633. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SWAP_BUFFERS** = ``16``
  634. Display server supports V-Sync status can be changed from the default (which is forced to be enabled platforms not supporting this feature). **Windows, macOS, Linux (X11/Wayland)**
  635. .. _class_DisplayServer_constant_FEATURE_CLIPBOARD_PRIMARY:
  636. .. rst-class:: classref-enumeration-constant
  637. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD_PRIMARY** = ``18``
  638. Display server supports Primary clipboard can be used. This is a different clipboard from :ref:`FEATURE_CLIPBOARD<class_DisplayServer_constant_FEATURE_CLIPBOARD>`. **Linux (X11/Wayland)**
  639. .. _class_DisplayServer_constant_FEATURE_TEXT_TO_SPEECH:
  640. .. rst-class:: classref-enumeration-constant
  641. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TEXT_TO_SPEECH** = ``19``
  642. Display server supports text-to-speech. See ``tts_*`` methods. **Windows, macOS, Linux (X11/Wayland), Android, iOS, Web**
  643. .. _class_DisplayServer_constant_FEATURE_EXTEND_TO_TITLE:
  644. .. rst-class:: classref-enumeration-constant
  645. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_EXTEND_TO_TITLE** = ``20``
  646. Display server supports expanding window content to the title. See :ref:`WINDOW_FLAG_EXTEND_TO_TITLE<class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE>`. **macOS**
  647. .. _class_DisplayServer_constant_FEATURE_SCREEN_CAPTURE:
  648. .. rst-class:: classref-enumeration-constant
  649. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SCREEN_CAPTURE** = ``21``
  650. Display server supports reading screen pixels. See :ref:`screen_get_pixel()<class_DisplayServer_method_screen_get_pixel>`.
  651. .. _class_DisplayServer_constant_FEATURE_STATUS_INDICATOR:
  652. .. rst-class:: classref-enumeration-constant
  653. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_STATUS_INDICATOR** = ``22``
  654. Display server supports application status indicators.
  655. .. _class_DisplayServer_constant_FEATURE_NATIVE_HELP:
  656. .. rst-class:: classref-enumeration-constant
  657. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_HELP** = ``23``
  658. Display server supports native help system search callbacks. See :ref:`help_set_search_callbacks()<class_DisplayServer_method_help_set_search_callbacks>`.
  659. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_INPUT:
  660. .. rst-class:: classref-enumeration-constant
  661. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_INPUT** = ``24``
  662. Display server supports spawning text input dialogs using the operating system's native look-and-feel. See :ref:`dialog_input_text()<class_DisplayServer_method_dialog_input_text>`. **Windows, macOS**
  663. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE:
  664. .. rst-class:: classref-enumeration-constant
  665. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE** = ``25``
  666. Display server supports spawning dialogs for selecting files or directories using the operating system's native look-and-feel. See :ref:`file_dialog_show()<class_DisplayServer_method_file_dialog_show>`. **Windows, macOS, Linux (X11/Wayland), Android**
  667. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE_EXTRA:
  668. .. rst-class:: classref-enumeration-constant
  669. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE_EXTRA** = ``26``
  670. The display server supports all features of :ref:`FEATURE_NATIVE_DIALOG_FILE<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE>`, with the added functionality of Options and native dialog file access to ``res://`` and ``user://`` paths. See :ref:`file_dialog_show()<class_DisplayServer_method_file_dialog_show>` and :ref:`file_dialog_with_options_show()<class_DisplayServer_method_file_dialog_with_options_show>`. **Windows, macOS, Linux (X11/Wayland)**
  671. .. _class_DisplayServer_constant_FEATURE_WINDOW_DRAG:
  672. .. rst-class:: classref-enumeration-constant
  673. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_DRAG** = ``27``
  674. The display server supports initiating window drag and resize operations on demand. See :ref:`window_start_drag()<class_DisplayServer_method_window_start_drag>` and :ref:`window_start_resize()<class_DisplayServer_method_window_start_resize>`.
  675. .. _class_DisplayServer_constant_FEATURE_SCREEN_EXCLUDE_FROM_CAPTURE:
  676. .. rst-class:: classref-enumeration-constant
  677. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SCREEN_EXCLUDE_FROM_CAPTURE** = ``28``
  678. Display server supports :ref:`WINDOW_FLAG_EXCLUDE_FROM_CAPTURE<class_DisplayServer_constant_WINDOW_FLAG_EXCLUDE_FROM_CAPTURE>` window flag.
  679. .. _class_DisplayServer_constant_FEATURE_WINDOW_EMBEDDING:
  680. .. rst-class:: classref-enumeration-constant
  681. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_EMBEDDING** = ``29``
  682. Display server supports embedding a window from another process. **Windows, Linux (X11)**
  683. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE_MIME:
  684. .. rst-class:: classref-enumeration-constant
  685. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE_MIME** = ``30``
  686. Native file selection dialog supports MIME types as filters.
  687. .. _class_DisplayServer_constant_FEATURE_EMOJI_AND_SYMBOL_PICKER:
  688. .. rst-class:: classref-enumeration-constant
  689. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_EMOJI_AND_SYMBOL_PICKER** = ``31``
  690. Display server supports system emoji and symbol picker. **Windows, macOS**
  691. .. _class_DisplayServer_constant_FEATURE_NATIVE_COLOR_PICKER:
  692. .. rst-class:: classref-enumeration-constant
  693. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_COLOR_PICKER** = ``32``
  694. Display server supports native color picker. **Linux (X11/Wayland)**
  695. .. _class_DisplayServer_constant_FEATURE_SELF_FITTING_WINDOWS:
  696. .. rst-class:: classref-enumeration-constant
  697. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SELF_FITTING_WINDOWS** = ``33``
  698. Display server automatically fits popups according to the screen boundaries. Window nodes should not attempt to do that themselves.
  699. .. _class_DisplayServer_constant_FEATURE_ACCESSIBILITY_SCREEN_READER:
  700. .. rst-class:: classref-enumeration-constant
  701. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ACCESSIBILITY_SCREEN_READER** = ``34``
  702. Display server supports interaction with screen reader or Braille display. **Linux (X11/Wayland), macOS, Windows**
  703. .. rst-class:: classref-item-separator
  704. ----
  705. .. _enum_DisplayServer_AccessibilityRole:
  706. .. rst-class:: classref-enumeration
  707. enum **AccessibilityRole**: :ref:`๐Ÿ”—<enum_DisplayServer_AccessibilityRole>`
  708. .. _class_DisplayServer_constant_ROLE_UNKNOWN:
  709. .. rst-class:: classref-enumeration-constant
  710. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_UNKNOWN** = ``0``
  711. Unknown or custom role.
  712. .. _class_DisplayServer_constant_ROLE_DEFAULT_BUTTON:
  713. .. rst-class:: classref-enumeration-constant
  714. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_DEFAULT_BUTTON** = ``1``
  715. Default dialog button element.
  716. .. _class_DisplayServer_constant_ROLE_AUDIO:
  717. .. rst-class:: classref-enumeration-constant
  718. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_AUDIO** = ``2``
  719. Audio player element.
  720. .. _class_DisplayServer_constant_ROLE_VIDEO:
  721. .. rst-class:: classref-enumeration-constant
  722. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_VIDEO** = ``3``
  723. Video player element.
  724. .. _class_DisplayServer_constant_ROLE_STATIC_TEXT:
  725. .. rst-class:: classref-enumeration-constant
  726. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_STATIC_TEXT** = ``4``
  727. Non-editable text label.
  728. .. _class_DisplayServer_constant_ROLE_CONTAINER:
  729. .. rst-class:: classref-enumeration-constant
  730. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_CONTAINER** = ``5``
  731. Container element. Elements with this role are used for internal structure and ignored by screen readers.
  732. .. _class_DisplayServer_constant_ROLE_PANEL:
  733. .. rst-class:: classref-enumeration-constant
  734. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_PANEL** = ``6``
  735. Panel container element.
  736. .. _class_DisplayServer_constant_ROLE_BUTTON:
  737. .. rst-class:: classref-enumeration-constant
  738. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_BUTTON** = ``7``
  739. Button element.
  740. .. _class_DisplayServer_constant_ROLE_LINK:
  741. .. rst-class:: classref-enumeration-constant
  742. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_LINK** = ``8``
  743. Link element.
  744. .. _class_DisplayServer_constant_ROLE_CHECK_BOX:
  745. .. rst-class:: classref-enumeration-constant
  746. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_CHECK_BOX** = ``9``
  747. Check box element.
  748. .. _class_DisplayServer_constant_ROLE_RADIO_BUTTON:
  749. .. rst-class:: classref-enumeration-constant
  750. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_RADIO_BUTTON** = ``10``
  751. Radio button element.
  752. .. _class_DisplayServer_constant_ROLE_CHECK_BUTTON:
  753. .. rst-class:: classref-enumeration-constant
  754. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_CHECK_BUTTON** = ``11``
  755. Check button element.
  756. .. _class_DisplayServer_constant_ROLE_SCROLL_BAR:
  757. .. rst-class:: classref-enumeration-constant
  758. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_SCROLL_BAR** = ``12``
  759. Scroll bar element.
  760. .. _class_DisplayServer_constant_ROLE_SCROLL_VIEW:
  761. .. rst-class:: classref-enumeration-constant
  762. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_SCROLL_VIEW** = ``13``
  763. Scroll container element.
  764. .. _class_DisplayServer_constant_ROLE_SPLITTER:
  765. .. rst-class:: classref-enumeration-constant
  766. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_SPLITTER** = ``14``
  767. Container splitter handle element.
  768. .. _class_DisplayServer_constant_ROLE_SLIDER:
  769. .. rst-class:: classref-enumeration-constant
  770. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_SLIDER** = ``15``
  771. Slider element.
  772. .. _class_DisplayServer_constant_ROLE_SPIN_BUTTON:
  773. .. rst-class:: classref-enumeration-constant
  774. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_SPIN_BUTTON** = ``16``
  775. Spin box element.
  776. .. _class_DisplayServer_constant_ROLE_PROGRESS_INDICATOR:
  777. .. rst-class:: classref-enumeration-constant
  778. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_PROGRESS_INDICATOR** = ``17``
  779. Progress indicator element.
  780. .. _class_DisplayServer_constant_ROLE_TEXT_FIELD:
  781. .. rst-class:: classref-enumeration-constant
  782. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TEXT_FIELD** = ``18``
  783. Editable text field element.
  784. .. _class_DisplayServer_constant_ROLE_MULTILINE_TEXT_FIELD:
  785. .. rst-class:: classref-enumeration-constant
  786. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MULTILINE_TEXT_FIELD** = ``19``
  787. Multiline editable text field element.
  788. .. _class_DisplayServer_constant_ROLE_COLOR_PICKER:
  789. .. rst-class:: classref-enumeration-constant
  790. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_COLOR_PICKER** = ``20``
  791. Color picker element.
  792. .. _class_DisplayServer_constant_ROLE_TABLE:
  793. .. rst-class:: classref-enumeration-constant
  794. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TABLE** = ``21``
  795. Table element.
  796. .. _class_DisplayServer_constant_ROLE_CELL:
  797. .. rst-class:: classref-enumeration-constant
  798. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_CELL** = ``22``
  799. Table/tree cell element.
  800. .. _class_DisplayServer_constant_ROLE_ROW:
  801. .. rst-class:: classref-enumeration-constant
  802. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_ROW** = ``23``
  803. Table/tree row element.
  804. .. _class_DisplayServer_constant_ROLE_ROW_GROUP:
  805. .. rst-class:: classref-enumeration-constant
  806. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_ROW_GROUP** = ``24``
  807. Table/tree row group element.
  808. .. _class_DisplayServer_constant_ROLE_ROW_HEADER:
  809. .. rst-class:: classref-enumeration-constant
  810. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_ROW_HEADER** = ``25``
  811. Table/tree row header element.
  812. .. _class_DisplayServer_constant_ROLE_COLUMN_HEADER:
  813. .. rst-class:: classref-enumeration-constant
  814. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_COLUMN_HEADER** = ``26``
  815. Table/tree column header element.
  816. .. _class_DisplayServer_constant_ROLE_TREE:
  817. .. rst-class:: classref-enumeration-constant
  818. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TREE** = ``27``
  819. Tree view element.
  820. .. _class_DisplayServer_constant_ROLE_TREE_ITEM:
  821. .. rst-class:: classref-enumeration-constant
  822. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TREE_ITEM** = ``28``
  823. Tree view item element.
  824. .. _class_DisplayServer_constant_ROLE_LIST:
  825. .. rst-class:: classref-enumeration-constant
  826. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_LIST** = ``29``
  827. List element.
  828. .. _class_DisplayServer_constant_ROLE_LIST_ITEM:
  829. .. rst-class:: classref-enumeration-constant
  830. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_LIST_ITEM** = ``30``
  831. List item element.
  832. .. _class_DisplayServer_constant_ROLE_LIST_BOX:
  833. .. rst-class:: classref-enumeration-constant
  834. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_LIST_BOX** = ``31``
  835. List view element.
  836. .. _class_DisplayServer_constant_ROLE_LIST_BOX_OPTION:
  837. .. rst-class:: classref-enumeration-constant
  838. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_LIST_BOX_OPTION** = ``32``
  839. List view item element.
  840. .. _class_DisplayServer_constant_ROLE_TAB_BAR:
  841. .. rst-class:: classref-enumeration-constant
  842. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TAB_BAR** = ``33``
  843. Tab bar element.
  844. .. _class_DisplayServer_constant_ROLE_TAB:
  845. .. rst-class:: classref-enumeration-constant
  846. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TAB** = ``34``
  847. Tab bar item element.
  848. .. _class_DisplayServer_constant_ROLE_TAB_PANEL:
  849. .. rst-class:: classref-enumeration-constant
  850. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TAB_PANEL** = ``35``
  851. Tab panel element.
  852. .. _class_DisplayServer_constant_ROLE_MENU_BAR:
  853. .. rst-class:: classref-enumeration-constant
  854. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MENU_BAR** = ``36``
  855. Menu bar element.
  856. .. _class_DisplayServer_constant_ROLE_MENU:
  857. .. rst-class:: classref-enumeration-constant
  858. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MENU** = ``37``
  859. Popup menu element.
  860. .. _class_DisplayServer_constant_ROLE_MENU_ITEM:
  861. .. rst-class:: classref-enumeration-constant
  862. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MENU_ITEM** = ``38``
  863. Popup menu item element.
  864. .. _class_DisplayServer_constant_ROLE_MENU_ITEM_CHECK_BOX:
  865. .. rst-class:: classref-enumeration-constant
  866. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MENU_ITEM_CHECK_BOX** = ``39``
  867. Popup menu check button item element.
  868. .. _class_DisplayServer_constant_ROLE_MENU_ITEM_RADIO:
  869. .. rst-class:: classref-enumeration-constant
  870. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_MENU_ITEM_RADIO** = ``40``
  871. Popup menu radio button item element.
  872. .. _class_DisplayServer_constant_ROLE_IMAGE:
  873. .. rst-class:: classref-enumeration-constant
  874. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_IMAGE** = ``41``
  875. Image element.
  876. .. _class_DisplayServer_constant_ROLE_WINDOW:
  877. .. rst-class:: classref-enumeration-constant
  878. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_WINDOW** = ``42``
  879. Window element.
  880. .. _class_DisplayServer_constant_ROLE_TITLE_BAR:
  881. .. rst-class:: classref-enumeration-constant
  882. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TITLE_BAR** = ``43``
  883. Embedded window title bar element.
  884. .. _class_DisplayServer_constant_ROLE_DIALOG:
  885. .. rst-class:: classref-enumeration-constant
  886. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_DIALOG** = ``44``
  887. Dialog window element.
  888. .. _class_DisplayServer_constant_ROLE_TOOLTIP:
  889. .. rst-class:: classref-enumeration-constant
  890. :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>` **ROLE_TOOLTIP** = ``45``
  891. Tooltip element.
  892. .. rst-class:: classref-item-separator
  893. ----
  894. .. _enum_DisplayServer_AccessibilityPopupType:
  895. .. rst-class:: classref-enumeration
  896. enum **AccessibilityPopupType**: :ref:`๐Ÿ”—<enum_DisplayServer_AccessibilityPopupType>`
  897. .. _class_DisplayServer_constant_POPUP_MENU:
  898. .. rst-class:: classref-enumeration-constant
  899. :ref:`AccessibilityPopupType<enum_DisplayServer_AccessibilityPopupType>` **POPUP_MENU** = ``0``
  900. Popup menu.
  901. .. _class_DisplayServer_constant_POPUP_LIST:
  902. .. rst-class:: classref-enumeration-constant
  903. :ref:`AccessibilityPopupType<enum_DisplayServer_AccessibilityPopupType>` **POPUP_LIST** = ``1``
  904. Popup list.
  905. .. _class_DisplayServer_constant_POPUP_TREE:
  906. .. rst-class:: classref-enumeration-constant
  907. :ref:`AccessibilityPopupType<enum_DisplayServer_AccessibilityPopupType>` **POPUP_TREE** = ``2``
  908. Popup tree view.
  909. .. _class_DisplayServer_constant_POPUP_DIALOG:
  910. .. rst-class:: classref-enumeration-constant
  911. :ref:`AccessibilityPopupType<enum_DisplayServer_AccessibilityPopupType>` **POPUP_DIALOG** = ``3``
  912. Popup dialog.
  913. .. rst-class:: classref-item-separator
  914. ----
  915. .. _enum_DisplayServer_AccessibilityFlags:
  916. .. rst-class:: classref-enumeration
  917. enum **AccessibilityFlags**: :ref:`๐Ÿ”—<enum_DisplayServer_AccessibilityFlags>`
  918. .. _class_DisplayServer_constant_FLAG_HIDDEN:
  919. .. rst-class:: classref-enumeration-constant
  920. :ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_HIDDEN** = ``0``
  921. Element is hidden for accessibility tools.
  922. .. _class_DisplayServer_constant_FLAG_MULTISELECTABLE:
  923. .. rst-class:: classref-enumeration-constant
  924. :ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_MULTISELECTABLE** = ``1``
  925. Element is support multiple item selection.
  926. .. _class_DisplayServer_constant_FLAG_REQUIRED:
  927. .. rst-class:: classref-enumeration-constant
  928. :ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_REQUIRED** = ``2``
  929. Element require user input.
  930. .. _class_DisplayServer_constant_FLAG_VISITED:
  931. .. rst-class:: classref-enumeration-constant
  932. :ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_VISITED** = ``3``
  933. Element is a visited link.
  934. .. _class_DisplayServer_constant_FLAG_BUSY:
  935. .. rst-class:: classref-enumeration-constant
  936. :ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_BUSY** = ``4``
  937. Element content is not ready (e.g. loading).
  938. .. _class_DisplayServer_constant_FLAG_MODAL:
  939. .. rst-class:: classref-enumeration-constant
  940. :ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_MODAL** = ``5``
  941. Element is modal window.
  942. .. _class_DisplayServer_constant_FLAG_TOUCH_PASSTHROUGH:
  943. .. rst-class:: classref-enumeration-constant
  944. :ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_TOUCH_PASSTHROUGH** = ``6``
  945. Element allows touches to be passed through when a screen reader is in touch exploration mode.
  946. .. _class_DisplayServer_constant_FLAG_READONLY:
  947. .. rst-class:: classref-enumeration-constant
  948. :ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_READONLY** = ``7``
  949. Element is text field with selectable but read-only text.
  950. .. _class_DisplayServer_constant_FLAG_DISABLED:
  951. .. rst-class:: classref-enumeration-constant
  952. :ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_DISABLED** = ``8``
  953. Element is disabled.
  954. .. _class_DisplayServer_constant_FLAG_CLIPS_CHILDREN:
  955. .. rst-class:: classref-enumeration-constant
  956. :ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>` **FLAG_CLIPS_CHILDREN** = ``9``
  957. Element clips children.
  958. .. rst-class:: classref-item-separator
  959. ----
  960. .. _enum_DisplayServer_AccessibilityAction:
  961. .. rst-class:: classref-enumeration
  962. enum **AccessibilityAction**: :ref:`๐Ÿ”—<enum_DisplayServer_AccessibilityAction>`
  963. .. _class_DisplayServer_constant_ACTION_CLICK:
  964. .. rst-class:: classref-enumeration-constant
  965. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_CLICK** = ``0``
  966. Single click action, callback argument is not set.
  967. .. _class_DisplayServer_constant_ACTION_FOCUS:
  968. .. rst-class:: classref-enumeration-constant
  969. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_FOCUS** = ``1``
  970. Focus action, callback argument is not set.
  971. .. _class_DisplayServer_constant_ACTION_BLUR:
  972. .. rst-class:: classref-enumeration-constant
  973. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_BLUR** = ``2``
  974. Blur action, callback argument is not set.
  975. .. _class_DisplayServer_constant_ACTION_COLLAPSE:
  976. .. rst-class:: classref-enumeration-constant
  977. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_COLLAPSE** = ``3``
  978. Collapse action, callback argument is not set.
  979. .. _class_DisplayServer_constant_ACTION_EXPAND:
  980. .. rst-class:: classref-enumeration-constant
  981. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_EXPAND** = ``4``
  982. Expand action, callback argument is not set.
  983. .. _class_DisplayServer_constant_ACTION_DECREMENT:
  984. .. rst-class:: classref-enumeration-constant
  985. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_DECREMENT** = ``5``
  986. Decrement action, callback argument is not set.
  987. .. _class_DisplayServer_constant_ACTION_INCREMENT:
  988. .. rst-class:: classref-enumeration-constant
  989. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_INCREMENT** = ``6``
  990. Increment action, callback argument is not set.
  991. .. _class_DisplayServer_constant_ACTION_HIDE_TOOLTIP:
  992. .. rst-class:: classref-enumeration-constant
  993. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_HIDE_TOOLTIP** = ``7``
  994. Hide tooltip action, callback argument is not set.
  995. .. _class_DisplayServer_constant_ACTION_SHOW_TOOLTIP:
  996. .. rst-class:: classref-enumeration-constant
  997. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SHOW_TOOLTIP** = ``8``
  998. Show tooltip action, callback argument is not set.
  999. .. _class_DisplayServer_constant_ACTION_SET_TEXT_SELECTION:
  1000. .. rst-class:: classref-enumeration-constant
  1001. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SET_TEXT_SELECTION** = ``9``
  1002. Set text selection action, callback argument is set to :ref:`Dictionary<class_Dictionary>` with the following keys:
  1003. - ``"start_element"`` accessibility element of the selection start.
  1004. - ``"start_char"`` character offset relative to the accessibility element of the selection start.
  1005. - ``"end_element"`` accessibility element of the selection end.
  1006. - ``"end_char"`` character offset relative to the accessibility element of the selection end.
  1007. .. _class_DisplayServer_constant_ACTION_REPLACE_SELECTED_TEXT:
  1008. .. rst-class:: classref-enumeration-constant
  1009. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_REPLACE_SELECTED_TEXT** = ``10``
  1010. Replace text action, callback argument is set to :ref:`String<class_String>` with the replacement text.
  1011. .. _class_DisplayServer_constant_ACTION_SCROLL_BACKWARD:
  1012. .. rst-class:: classref-enumeration-constant
  1013. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_BACKWARD** = ``11``
  1014. Scroll backward action, callback argument is not set.
  1015. .. _class_DisplayServer_constant_ACTION_SCROLL_DOWN:
  1016. .. rst-class:: classref-enumeration-constant
  1017. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_DOWN** = ``12``
  1018. Scroll down action, callback argument is not set.
  1019. .. _class_DisplayServer_constant_ACTION_SCROLL_FORWARD:
  1020. .. rst-class:: classref-enumeration-constant
  1021. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_FORWARD** = ``13``
  1022. Scroll forward action, callback argument is not set.
  1023. .. _class_DisplayServer_constant_ACTION_SCROLL_LEFT:
  1024. .. rst-class:: classref-enumeration-constant
  1025. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_LEFT** = ``14``
  1026. Scroll left action, callback argument is not set.
  1027. .. _class_DisplayServer_constant_ACTION_SCROLL_RIGHT:
  1028. .. rst-class:: classref-enumeration-constant
  1029. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_RIGHT** = ``15``
  1030. Scroll right action, callback argument is not set.
  1031. .. _class_DisplayServer_constant_ACTION_SCROLL_UP:
  1032. .. rst-class:: classref-enumeration-constant
  1033. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_UP** = ``16``
  1034. Scroll up action, callback argument is not set.
  1035. .. _class_DisplayServer_constant_ACTION_SCROLL_INTO_VIEW:
  1036. .. rst-class:: classref-enumeration-constant
  1037. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_INTO_VIEW** = ``17``
  1038. Scroll into view action, callback argument is not set.
  1039. .. _class_DisplayServer_constant_ACTION_SCROLL_TO_POINT:
  1040. .. rst-class:: classref-enumeration-constant
  1041. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SCROLL_TO_POINT** = ``18``
  1042. Scroll to point action, callback argument is set to :ref:`Vector2<class_Vector2>` with the relative point coordinates.
  1043. .. _class_DisplayServer_constant_ACTION_SET_SCROLL_OFFSET:
  1044. .. rst-class:: classref-enumeration-constant
  1045. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SET_SCROLL_OFFSET** = ``19``
  1046. Set scroll offset action, callback argument is set to :ref:`Vector2<class_Vector2>` with the scroll offset.
  1047. .. _class_DisplayServer_constant_ACTION_SET_VALUE:
  1048. .. rst-class:: classref-enumeration-constant
  1049. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SET_VALUE** = ``20``
  1050. Set value action action, callback argument is set to :ref:`String<class_String>` or number with the new value.
  1051. .. _class_DisplayServer_constant_ACTION_SHOW_CONTEXT_MENU:
  1052. .. rst-class:: classref-enumeration-constant
  1053. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_SHOW_CONTEXT_MENU** = ``21``
  1054. Show context menu action, callback argument is not set.
  1055. .. _class_DisplayServer_constant_ACTION_CUSTOM:
  1056. .. rst-class:: classref-enumeration-constant
  1057. :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>` **ACTION_CUSTOM** = ``22``
  1058. Custom action, callback argument is set to the integer action id.
  1059. .. rst-class:: classref-item-separator
  1060. ----
  1061. .. _enum_DisplayServer_AccessibilityLiveMode:
  1062. .. rst-class:: classref-enumeration
  1063. enum **AccessibilityLiveMode**: :ref:`๐Ÿ”—<enum_DisplayServer_AccessibilityLiveMode>`
  1064. .. _class_DisplayServer_constant_LIVE_OFF:
  1065. .. rst-class:: classref-enumeration-constant
  1066. :ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>` **LIVE_OFF** = ``0``
  1067. Indicates that updates to the live region should not be presented.
  1068. .. _class_DisplayServer_constant_LIVE_POLITE:
  1069. .. rst-class:: classref-enumeration-constant
  1070. :ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>` **LIVE_POLITE** = ``1``
  1071. Indicates that updates to the live region should be presented at the next opportunity (for example at the end of speaking the current sentence).
  1072. .. _class_DisplayServer_constant_LIVE_ASSERTIVE:
  1073. .. rst-class:: classref-enumeration-constant
  1074. :ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>` **LIVE_ASSERTIVE** = ``2``
  1075. Indicates that updates to the live region have the highest priority and should be presented immediately.
  1076. .. rst-class:: classref-item-separator
  1077. ----
  1078. .. _enum_DisplayServer_MouseMode:
  1079. .. rst-class:: classref-enumeration
  1080. enum **MouseMode**: :ref:`๐Ÿ”—<enum_DisplayServer_MouseMode>`
  1081. .. _class_DisplayServer_constant_MOUSE_MODE_VISIBLE:
  1082. .. rst-class:: classref-enumeration-constant
  1083. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_VISIBLE** = ``0``
  1084. Makes the mouse cursor visible if it is hidden.
  1085. .. _class_DisplayServer_constant_MOUSE_MODE_HIDDEN:
  1086. .. rst-class:: classref-enumeration-constant
  1087. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_HIDDEN** = ``1``
  1088. Makes the mouse cursor hidden if it is visible.
  1089. .. _class_DisplayServer_constant_MOUSE_MODE_CAPTURED:
  1090. .. rst-class:: classref-enumeration-constant
  1091. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CAPTURED** = ``2``
  1092. Captures the mouse. The mouse will be hidden and its position locked at the center of the window manager's window.
  1093. \ **Note:** If you want to process the mouse's movement in this mode, you need to use :ref:`InputEventMouseMotion.relative<class_InputEventMouseMotion_property_relative>`.
  1094. .. _class_DisplayServer_constant_MOUSE_MODE_CONFINED:
  1095. .. rst-class:: classref-enumeration-constant
  1096. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED** = ``3``
  1097. Confines the mouse cursor to the game window, and make it visible.
  1098. .. _class_DisplayServer_constant_MOUSE_MODE_CONFINED_HIDDEN:
  1099. .. rst-class:: classref-enumeration-constant
  1100. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED_HIDDEN** = ``4``
  1101. Confines the mouse cursor to the game window, and make it hidden.
  1102. .. _class_DisplayServer_constant_MOUSE_MODE_MAX:
  1103. .. rst-class:: classref-enumeration-constant
  1104. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_MAX** = ``5``
  1105. Max value of the :ref:`MouseMode<enum_DisplayServer_MouseMode>`.
  1106. .. rst-class:: classref-item-separator
  1107. ----
  1108. .. _enum_DisplayServer_ScreenOrientation:
  1109. .. rst-class:: classref-enumeration
  1110. enum **ScreenOrientation**: :ref:`๐Ÿ”—<enum_DisplayServer_ScreenOrientation>`
  1111. .. _class_DisplayServer_constant_SCREEN_LANDSCAPE:
  1112. .. rst-class:: classref-enumeration-constant
  1113. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_LANDSCAPE** = ``0``
  1114. Default landscape orientation.
  1115. .. _class_DisplayServer_constant_SCREEN_PORTRAIT:
  1116. .. rst-class:: classref-enumeration-constant
  1117. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_PORTRAIT** = ``1``
  1118. Default portrait orientation.
  1119. .. _class_DisplayServer_constant_SCREEN_REVERSE_LANDSCAPE:
  1120. .. rst-class:: classref-enumeration-constant
  1121. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_LANDSCAPE** = ``2``
  1122. Reverse landscape orientation (upside down).
  1123. .. _class_DisplayServer_constant_SCREEN_REVERSE_PORTRAIT:
  1124. .. rst-class:: classref-enumeration-constant
  1125. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_PORTRAIT** = ``3``
  1126. Reverse portrait orientation (upside down).
  1127. .. _class_DisplayServer_constant_SCREEN_SENSOR_LANDSCAPE:
  1128. .. rst-class:: classref-enumeration-constant
  1129. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_LANDSCAPE** = ``4``
  1130. Automatic landscape orientation (default or reverse depending on sensor).
  1131. .. _class_DisplayServer_constant_SCREEN_SENSOR_PORTRAIT:
  1132. .. rst-class:: classref-enumeration-constant
  1133. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_PORTRAIT** = ``5``
  1134. Automatic portrait orientation (default or reverse depending on sensor).
  1135. .. _class_DisplayServer_constant_SCREEN_SENSOR:
  1136. .. rst-class:: classref-enumeration-constant
  1137. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR** = ``6``
  1138. Automatic landscape or portrait orientation (default or reverse depending on sensor).
  1139. .. rst-class:: classref-item-separator
  1140. ----
  1141. .. _enum_DisplayServer_VirtualKeyboardType:
  1142. .. rst-class:: classref-enumeration
  1143. enum **VirtualKeyboardType**: :ref:`๐Ÿ”—<enum_DisplayServer_VirtualKeyboardType>`
  1144. .. _class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT:
  1145. .. rst-class:: classref-enumeration-constant
  1146. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_DEFAULT** = ``0``
  1147. Default text virtual keyboard.
  1148. .. _class_DisplayServer_constant_KEYBOARD_TYPE_MULTILINE:
  1149. .. rst-class:: classref-enumeration-constant
  1150. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_MULTILINE** = ``1``
  1151. Multiline virtual keyboard.
  1152. .. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER:
  1153. .. rst-class:: classref-enumeration-constant
  1154. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER** = ``2``
  1155. Virtual number keypad, useful for PIN entry.
  1156. .. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER_DECIMAL:
  1157. .. rst-class:: classref-enumeration-constant
  1158. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER_DECIMAL** = ``3``
  1159. Virtual number keypad, useful for entering fractional numbers.
  1160. .. _class_DisplayServer_constant_KEYBOARD_TYPE_PHONE:
  1161. .. rst-class:: classref-enumeration-constant
  1162. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PHONE** = ``4``
  1163. Virtual phone number keypad.
  1164. .. _class_DisplayServer_constant_KEYBOARD_TYPE_EMAIL_ADDRESS:
  1165. .. rst-class:: classref-enumeration-constant
  1166. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_EMAIL_ADDRESS** = ``5``
  1167. Virtual keyboard with additional keys to assist with typing email addresses.
  1168. .. _class_DisplayServer_constant_KEYBOARD_TYPE_PASSWORD:
  1169. .. rst-class:: classref-enumeration-constant
  1170. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PASSWORD** = ``6``
  1171. Virtual keyboard for entering a password. On most platforms, this should disable autocomplete and autocapitalization.
  1172. \ **Note:** This is not supported on Web. Instead, this behaves identically to :ref:`KEYBOARD_TYPE_DEFAULT<class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT>`.
  1173. .. _class_DisplayServer_constant_KEYBOARD_TYPE_URL:
  1174. .. rst-class:: classref-enumeration-constant
  1175. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_URL** = ``7``
  1176. Virtual keyboard with additional keys to assist with typing URLs.
  1177. .. rst-class:: classref-item-separator
  1178. ----
  1179. .. _enum_DisplayServer_CursorShape:
  1180. .. rst-class:: classref-enumeration
  1181. enum **CursorShape**: :ref:`๐Ÿ”—<enum_DisplayServer_CursorShape>`
  1182. .. _class_DisplayServer_constant_CURSOR_ARROW:
  1183. .. rst-class:: classref-enumeration-constant
  1184. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_ARROW** = ``0``
  1185. Arrow cursor shape. This is the default when not pointing anything that overrides the mouse cursor, such as a :ref:`LineEdit<class_LineEdit>` or :ref:`TextEdit<class_TextEdit>`.
  1186. .. _class_DisplayServer_constant_CURSOR_IBEAM:
  1187. .. rst-class:: classref-enumeration-constant
  1188. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_IBEAM** = ``1``
  1189. I-beam cursor shape. This is used by default when hovering a control that accepts text input, such as :ref:`LineEdit<class_LineEdit>` or :ref:`TextEdit<class_TextEdit>`.
  1190. .. _class_DisplayServer_constant_CURSOR_POINTING_HAND:
  1191. .. rst-class:: classref-enumeration-constant
  1192. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_POINTING_HAND** = ``2``
  1193. Pointing hand cursor shape. This is used by default when hovering a :ref:`LinkButton<class_LinkButton>` or a URL tag in a :ref:`RichTextLabel<class_RichTextLabel>`.
  1194. .. _class_DisplayServer_constant_CURSOR_CROSS:
  1195. .. rst-class:: classref-enumeration-constant
  1196. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CROSS** = ``3``
  1197. Crosshair cursor. This is intended to be displayed when the user needs precise aim over an element, such as a rectangle selection tool or a color picker.
  1198. .. _class_DisplayServer_constant_CURSOR_WAIT:
  1199. .. rst-class:: classref-enumeration-constant
  1200. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_WAIT** = ``4``
  1201. Wait cursor. On most cursor themes, this displays a spinning icon *besides* the arrow. Intended to be used for non-blocking operations (when the user can do something else at the moment). See also :ref:`CURSOR_BUSY<class_DisplayServer_constant_CURSOR_BUSY>`.
  1202. .. _class_DisplayServer_constant_CURSOR_BUSY:
  1203. .. rst-class:: classref-enumeration-constant
  1204. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BUSY** = ``5``
  1205. Wait cursor. On most cursor themes, this *replaces* the arrow with a spinning icon. Intended to be used for blocking operations (when the user can't do anything else at the moment). See also :ref:`CURSOR_WAIT<class_DisplayServer_constant_CURSOR_WAIT>`.
  1206. .. _class_DisplayServer_constant_CURSOR_DRAG:
  1207. .. rst-class:: classref-enumeration-constant
  1208. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_DRAG** = ``6``
  1209. Dragging hand cursor. This is displayed during drag-and-drop operations. See also :ref:`CURSOR_CAN_DROP<class_DisplayServer_constant_CURSOR_CAN_DROP>`.
  1210. .. _class_DisplayServer_constant_CURSOR_CAN_DROP:
  1211. .. rst-class:: classref-enumeration-constant
  1212. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CAN_DROP** = ``7``
  1213. "Can drop" cursor. This is displayed during drag-and-drop operations if hovering over a :ref:`Control<class_Control>` that can accept the drag-and-drop event. On most cursor themes, this displays a dragging hand with an arrow symbol besides it. See also :ref:`CURSOR_DRAG<class_DisplayServer_constant_CURSOR_DRAG>`.
  1214. .. _class_DisplayServer_constant_CURSOR_FORBIDDEN:
  1215. .. rst-class:: classref-enumeration-constant
  1216. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FORBIDDEN** = ``8``
  1217. Forbidden cursor. This is displayed during drag-and-drop operations if the hovered :ref:`Control<class_Control>` can't accept the drag-and-drop event.
  1218. .. _class_DisplayServer_constant_CURSOR_VSIZE:
  1219. .. rst-class:: classref-enumeration-constant
  1220. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSIZE** = ``9``
  1221. Vertical resize cursor. Intended to be displayed when the hovered :ref:`Control<class_Control>` can be vertically resized using the mouse. See also :ref:`CURSOR_VSPLIT<class_DisplayServer_constant_CURSOR_VSPLIT>`.
  1222. .. _class_DisplayServer_constant_CURSOR_HSIZE:
  1223. .. rst-class:: classref-enumeration-constant
  1224. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSIZE** = ``10``
  1225. Horizontal resize cursor. Intended to be displayed when the hovered :ref:`Control<class_Control>` can be horizontally resized using the mouse. See also :ref:`CURSOR_HSPLIT<class_DisplayServer_constant_CURSOR_HSPLIT>`.
  1226. .. _class_DisplayServer_constant_CURSOR_BDIAGSIZE:
  1227. .. rst-class:: classref-enumeration-constant
  1228. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BDIAGSIZE** = ``11``
  1229. Secondary diagonal resize cursor (top-right/bottom-left). Intended to be displayed when the hovered :ref:`Control<class_Control>` can be resized on both axes at once using the mouse.
  1230. .. _class_DisplayServer_constant_CURSOR_FDIAGSIZE:
  1231. .. rst-class:: classref-enumeration-constant
  1232. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FDIAGSIZE** = ``12``
  1233. Main diagonal resize cursor (top-left/bottom-right). Intended to be displayed when the hovered :ref:`Control<class_Control>` can be resized on both axes at once using the mouse.
  1234. .. _class_DisplayServer_constant_CURSOR_MOVE:
  1235. .. rst-class:: classref-enumeration-constant
  1236. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MOVE** = ``13``
  1237. Move cursor. Intended to be displayed when the hovered :ref:`Control<class_Control>` can be moved using the mouse.
  1238. .. _class_DisplayServer_constant_CURSOR_VSPLIT:
  1239. .. rst-class:: classref-enumeration-constant
  1240. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSPLIT** = ``14``
  1241. Vertical split cursor. This is displayed when hovering a :ref:`Control<class_Control>` with splits that can be vertically resized using the mouse, such as :ref:`VSplitContainer<class_VSplitContainer>`. On some cursor themes, this cursor may have the same appearance as :ref:`CURSOR_VSIZE<class_DisplayServer_constant_CURSOR_VSIZE>`.
  1242. .. _class_DisplayServer_constant_CURSOR_HSPLIT:
  1243. .. rst-class:: classref-enumeration-constant
  1244. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSPLIT** = ``15``
  1245. Horizontal split cursor. This is displayed when hovering a :ref:`Control<class_Control>` with splits that can be horizontally resized using the mouse, such as :ref:`HSplitContainer<class_HSplitContainer>`. On some cursor themes, this cursor may have the same appearance as :ref:`CURSOR_HSIZE<class_DisplayServer_constant_CURSOR_HSIZE>`.
  1246. .. _class_DisplayServer_constant_CURSOR_HELP:
  1247. .. rst-class:: classref-enumeration-constant
  1248. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HELP** = ``16``
  1249. Help cursor. On most cursor themes, this displays a question mark icon instead of the mouse cursor. Intended to be used when the user has requested help on the next element that will be clicked.
  1250. .. _class_DisplayServer_constant_CURSOR_MAX:
  1251. .. rst-class:: classref-enumeration-constant
  1252. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MAX** = ``17``
  1253. Represents the size of the :ref:`CursorShape<enum_DisplayServer_CursorShape>` enum.
  1254. .. rst-class:: classref-item-separator
  1255. ----
  1256. .. _enum_DisplayServer_FileDialogMode:
  1257. .. rst-class:: classref-enumeration
  1258. enum **FileDialogMode**: :ref:`๐Ÿ”—<enum_DisplayServer_FileDialogMode>`
  1259. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILE:
  1260. .. rst-class:: classref-enumeration-constant
  1261. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILE** = ``0``
  1262. The native file dialog allows selecting one, and only one file.
  1263. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILES:
  1264. .. rst-class:: classref-enumeration-constant
  1265. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILES** = ``1``
  1266. The native file dialog allows selecting multiple files.
  1267. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_DIR:
  1268. .. rst-class:: classref-enumeration-constant
  1269. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_DIR** = ``2``
  1270. The native file dialog only allows selecting a directory, disallowing the selection of any file.
  1271. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_ANY:
  1272. .. rst-class:: classref-enumeration-constant
  1273. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_ANY** = ``3``
  1274. The native file dialog allows selecting one file or directory.
  1275. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_SAVE_FILE:
  1276. .. rst-class:: classref-enumeration-constant
  1277. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_SAVE_FILE** = ``4``
  1278. The native file dialog will warn when a file exists.
  1279. .. rst-class:: classref-item-separator
  1280. ----
  1281. .. _enum_DisplayServer_WindowMode:
  1282. .. rst-class:: classref-enumeration
  1283. enum **WindowMode**: :ref:`๐Ÿ”—<enum_DisplayServer_WindowMode>`
  1284. .. _class_DisplayServer_constant_WINDOW_MODE_WINDOWED:
  1285. .. rst-class:: classref-enumeration-constant
  1286. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_WINDOWED** = ``0``
  1287. Windowed mode, i.e. :ref:`Window<class_Window>` doesn't occupy the whole screen (unless set to the size of the screen).
  1288. .. _class_DisplayServer_constant_WINDOW_MODE_MINIMIZED:
  1289. .. rst-class:: classref-enumeration-constant
  1290. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MINIMIZED** = ``1``
  1291. Minimized window mode, i.e. :ref:`Window<class_Window>` is not visible and available on window manager's window list. Normally happens when the minimize button is pressed.
  1292. .. _class_DisplayServer_constant_WINDOW_MODE_MAXIMIZED:
  1293. .. rst-class:: classref-enumeration-constant
  1294. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MAXIMIZED** = ``2``
  1295. Maximized window mode, i.e. :ref:`Window<class_Window>` will occupy whole screen area except task bar and still display its borders. Normally happens when the maximize button is pressed.
  1296. .. _class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN:
  1297. .. rst-class:: classref-enumeration-constant
  1298. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_FULLSCREEN** = ``3``
  1299. Full screen mode with full multi-window support.
  1300. Full screen window covers the entire display area of a screen and has no decorations. The display's video mode is not changed.
  1301. \ **On Android:** This enables immersive mode.
  1302. \ **On macOS:** A new desktop is used to display the running project.
  1303. \ **Note:** Regardless of the platform, enabling full screen will change the window size to match the monitor's size. Therefore, make sure your project supports :doc:`multiple resolutions <../tutorials/rendering/multiple_resolutions>` when enabling full screen mode.
  1304. .. _class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN:
  1305. .. rst-class:: classref-enumeration-constant
  1306. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_EXCLUSIVE_FULLSCREEN** = ``4``
  1307. A single window full screen mode. This mode has less overhead, but only one window can be open on a given screen at a time (opening a child window or application switching will trigger a full screen transition).
  1308. Full screen window covers the entire display area of a screen and has no border or decorations. The display's video mode is not changed.
  1309. \ **On Android:** This enables immersive mode.
  1310. \ **On Windows:** Depending on video driver, full screen transition might cause screens to go black for a moment.
  1311. \ **On macOS:** A new desktop is used to display the running project. Exclusive full screen mode prevents Dock and Menu from showing up when the mouse pointer is hovering the edge of the screen.
  1312. \ **On Linux (X11):** Exclusive full screen mode bypasses compositor.
  1313. \ **On Linux (Wayland):** Equivalent to :ref:`WINDOW_MODE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN>`.
  1314. \ **Note:** Regardless of the platform, enabling full screen will change the window size to match the monitor's size. Therefore, make sure your project supports :doc:`multiple resolutions <../tutorials/rendering/multiple_resolutions>` when enabling full screen mode.
  1315. .. rst-class:: classref-item-separator
  1316. ----
  1317. .. _enum_DisplayServer_WindowFlags:
  1318. .. rst-class:: classref-enumeration
  1319. enum **WindowFlags**: :ref:`๐Ÿ”—<enum_DisplayServer_WindowFlags>`
  1320. .. _class_DisplayServer_constant_WINDOW_FLAG_RESIZE_DISABLED:
  1321. .. rst-class:: classref-enumeration-constant
  1322. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_RESIZE_DISABLED** = ``0``
  1323. The window can't be resized by dragging its resize grip. It's still possible to resize the window using :ref:`window_set_size()<class_DisplayServer_method_window_set_size>`. This flag is ignored for full screen windows.
  1324. .. _class_DisplayServer_constant_WINDOW_FLAG_BORDERLESS:
  1325. .. rst-class:: classref-enumeration-constant
  1326. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_BORDERLESS** = ``1``
  1327. The window do not have native title bar and other decorations. This flag is ignored for full-screen windows.
  1328. .. _class_DisplayServer_constant_WINDOW_FLAG_ALWAYS_ON_TOP:
  1329. .. rst-class:: classref-enumeration-constant
  1330. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_ALWAYS_ON_TOP** = ``2``
  1331. The window is floating on top of all other windows. This flag is ignored for full-screen windows.
  1332. .. _class_DisplayServer_constant_WINDOW_FLAG_TRANSPARENT:
  1333. .. rst-class:: classref-enumeration-constant
  1334. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_TRANSPARENT** = ``3``
  1335. The window background can be transparent.
  1336. \ **Note:** This flag has no effect if :ref:`is_window_transparency_available()<class_DisplayServer_method_is_window_transparency_available>` returns ``false``.
  1337. \ **Note:** Transparency support is implemented on Linux (X11/Wayland), macOS, and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities.
  1338. .. _class_DisplayServer_constant_WINDOW_FLAG_NO_FOCUS:
  1339. .. rst-class:: classref-enumeration-constant
  1340. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_NO_FOCUS** = ``4``
  1341. The window can't be focused. No-focus window will ignore all input, except mouse clicks.
  1342. .. _class_DisplayServer_constant_WINDOW_FLAG_POPUP:
  1343. .. rst-class:: classref-enumeration-constant
  1344. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_POPUP** = ``5``
  1345. Window is part of menu or :ref:`OptionButton<class_OptionButton>` dropdown. This flag can't be changed when the window is visible. An active popup window will exclusively receive all input, without stealing focus from its parent. Popup windows are automatically closed when uses click outside it, or when an application is switched. Popup window must have transient parent set (see :ref:`window_set_transient()<class_DisplayServer_method_window_set_transient>`).
  1346. .. _class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE:
  1347. .. rst-class:: classref-enumeration-constant
  1348. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_EXTEND_TO_TITLE** = ``6``
  1349. Window content is expanded to the full size of the window. Unlike borderless window, the frame is left intact and can be used to resize the window, title bar is transparent, but have minimize/maximize/close buttons.
  1350. Use :ref:`window_set_window_buttons_offset()<class_DisplayServer_method_window_set_window_buttons_offset>` to adjust minimize/maximize/close buttons offset.
  1351. Use :ref:`window_get_safe_title_margins()<class_DisplayServer_method_window_get_safe_title_margins>` to determine area under the title bar that is not covered by decorations.
  1352. \ **Note:** This flag is implemented only on macOS.
  1353. .. _class_DisplayServer_constant_WINDOW_FLAG_MOUSE_PASSTHROUGH:
  1354. .. rst-class:: classref-enumeration-constant
  1355. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MOUSE_PASSTHROUGH** = ``7``
  1356. All mouse events are passed to the underlying window of the same application.
  1357. .. _class_DisplayServer_constant_WINDOW_FLAG_SHARP_CORNERS:
  1358. .. rst-class:: classref-enumeration-constant
  1359. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_SHARP_CORNERS** = ``8``
  1360. Window style is overridden, forcing sharp corners.
  1361. \ **Note:** This flag is implemented only on Windows (11).
  1362. .. _class_DisplayServer_constant_WINDOW_FLAG_EXCLUDE_FROM_CAPTURE:
  1363. .. rst-class:: classref-enumeration-constant
  1364. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_EXCLUDE_FROM_CAPTURE** = ``9``
  1365. Window is excluded from screenshots taken by :ref:`screen_get_image()<class_DisplayServer_method_screen_get_image>`, :ref:`screen_get_image_rect()<class_DisplayServer_method_screen_get_image_rect>`, and :ref:`screen_get_pixel()<class_DisplayServer_method_screen_get_pixel>`.
  1366. \ **Note:** This flag is implemented on macOS and Windows.
  1367. \ **Note:** Setting this flag will **NOT** prevent other apps from capturing an image. It should not be used as a security measure.
  1368. .. _class_DisplayServer_constant_WINDOW_FLAG_POPUP_WM_HINT:
  1369. .. rst-class:: classref-enumeration-constant
  1370. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_POPUP_WM_HINT** = ``10``
  1371. Signals the window manager that this window is supposed to be an implementation-defined "popup" (usually a floating, borderless, untileable and immovable child window).
  1372. .. _class_DisplayServer_constant_WINDOW_FLAG_MINIMIZE_DISABLED:
  1373. .. rst-class:: classref-enumeration-constant
  1374. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MINIMIZE_DISABLED** = ``11``
  1375. Window minimize button is disabled.
  1376. \ **Note:** This flag is implemented on macOS and Windows.
  1377. .. _class_DisplayServer_constant_WINDOW_FLAG_MAXIMIZE_DISABLED:
  1378. .. rst-class:: classref-enumeration-constant
  1379. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MAXIMIZE_DISABLED** = ``12``
  1380. Window maximize button is disabled.
  1381. \ **Note:** This flag is implemented on macOS and Windows.
  1382. .. _class_DisplayServer_constant_WINDOW_FLAG_MAX:
  1383. .. rst-class:: classref-enumeration-constant
  1384. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MAX** = ``13``
  1385. Max value of the :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`.
  1386. .. rst-class:: classref-item-separator
  1387. ----
  1388. .. _enum_DisplayServer_WindowEvent:
  1389. .. rst-class:: classref-enumeration
  1390. enum **WindowEvent**: :ref:`๐Ÿ”—<enum_DisplayServer_WindowEvent>`
  1391. .. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_ENTER:
  1392. .. rst-class:: classref-enumeration-constant
  1393. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_ENTER** = ``0``
  1394. Sent when the mouse pointer enters the window.
  1395. .. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_EXIT:
  1396. .. rst-class:: classref-enumeration-constant
  1397. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_EXIT** = ``1``
  1398. Sent when the mouse pointer exits the window.
  1399. .. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_IN:
  1400. .. rst-class:: classref-enumeration-constant
  1401. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_IN** = ``2``
  1402. Sent when the window grabs focus.
  1403. .. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_OUT:
  1404. .. rst-class:: classref-enumeration-constant
  1405. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_OUT** = ``3``
  1406. Sent when the window loses focus.
  1407. .. _class_DisplayServer_constant_WINDOW_EVENT_CLOSE_REQUEST:
  1408. .. rst-class:: classref-enumeration-constant
  1409. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_CLOSE_REQUEST** = ``4``
  1410. Sent when the user has attempted to close the window (e.g. close button is pressed).
  1411. .. _class_DisplayServer_constant_WINDOW_EVENT_GO_BACK_REQUEST:
  1412. .. rst-class:: classref-enumeration-constant
  1413. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_GO_BACK_REQUEST** = ``5``
  1414. Sent when the device "Back" button is pressed.
  1415. \ **Note:** This event is implemented only on Android.
  1416. .. _class_DisplayServer_constant_WINDOW_EVENT_DPI_CHANGE:
  1417. .. rst-class:: classref-enumeration-constant
  1418. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_DPI_CHANGE** = ``6``
  1419. Sent when the window is moved to the display with different DPI, or display DPI is changed.
  1420. \ **Note:** This flag is implemented only on macOS and Linux (Wayland).
  1421. .. _class_DisplayServer_constant_WINDOW_EVENT_TITLEBAR_CHANGE:
  1422. .. rst-class:: classref-enumeration-constant
  1423. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_TITLEBAR_CHANGE** = ``7``
  1424. Sent when the window title bar decoration is changed (e.g. :ref:`WINDOW_FLAG_EXTEND_TO_TITLE<class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE>` is set or window entered/exited full screen mode).
  1425. \ **Note:** This flag is implemented only on macOS.
  1426. .. _class_DisplayServer_constant_WINDOW_EVENT_FORCE_CLOSE:
  1427. .. rst-class:: classref-enumeration-constant
  1428. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FORCE_CLOSE** = ``8``
  1429. Sent when the window has been forcibly closed by the Display Server. The window shall immediately hide and clean any internal rendering references.
  1430. \ **Note:** This flag is implemented only on Linux (Wayland).
  1431. .. rst-class:: classref-item-separator
  1432. ----
  1433. .. _enum_DisplayServer_WindowResizeEdge:
  1434. .. rst-class:: classref-enumeration
  1435. enum **WindowResizeEdge**: :ref:`๐Ÿ”—<enum_DisplayServer_WindowResizeEdge>`
  1436. .. _class_DisplayServer_constant_WINDOW_EDGE_TOP_LEFT:
  1437. .. rst-class:: classref-enumeration-constant
  1438. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_TOP_LEFT** = ``0``
  1439. Top-left edge of a window.
  1440. .. _class_DisplayServer_constant_WINDOW_EDGE_TOP:
  1441. .. rst-class:: classref-enumeration-constant
  1442. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_TOP** = ``1``
  1443. Top edge of a window.
  1444. .. _class_DisplayServer_constant_WINDOW_EDGE_TOP_RIGHT:
  1445. .. rst-class:: classref-enumeration-constant
  1446. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_TOP_RIGHT** = ``2``
  1447. Top-right edge of a window.
  1448. .. _class_DisplayServer_constant_WINDOW_EDGE_LEFT:
  1449. .. rst-class:: classref-enumeration-constant
  1450. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_LEFT** = ``3``
  1451. Left edge of a window.
  1452. .. _class_DisplayServer_constant_WINDOW_EDGE_RIGHT:
  1453. .. rst-class:: classref-enumeration-constant
  1454. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_RIGHT** = ``4``
  1455. Right edge of a window.
  1456. .. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM_LEFT:
  1457. .. rst-class:: classref-enumeration-constant
  1458. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_BOTTOM_LEFT** = ``5``
  1459. Bottom-left edge of a window.
  1460. .. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM:
  1461. .. rst-class:: classref-enumeration-constant
  1462. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_BOTTOM** = ``6``
  1463. Bottom edge of a window.
  1464. .. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM_RIGHT:
  1465. .. rst-class:: classref-enumeration-constant
  1466. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_BOTTOM_RIGHT** = ``7``
  1467. Bottom-right edge of a window.
  1468. .. _class_DisplayServer_constant_WINDOW_EDGE_MAX:
  1469. .. rst-class:: classref-enumeration-constant
  1470. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_MAX** = ``8``
  1471. Represents the size of the :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` enum.
  1472. .. rst-class:: classref-item-separator
  1473. ----
  1474. .. _enum_DisplayServer_VSyncMode:
  1475. .. rst-class:: classref-enumeration
  1476. enum **VSyncMode**: :ref:`๐Ÿ”—<enum_DisplayServer_VSyncMode>`
  1477. .. _class_DisplayServer_constant_VSYNC_DISABLED:
  1478. .. rst-class:: classref-enumeration-constant
  1479. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_DISABLED** = ``0``
  1480. No vertical synchronization, which means the engine will display frames as fast as possible (tearing may be visible). Framerate is unlimited (regardless of :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
  1481. .. _class_DisplayServer_constant_VSYNC_ENABLED:
  1482. .. rst-class:: classref-enumeration-constant
  1483. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ENABLED** = ``1``
  1484. Default vertical synchronization mode, the image is displayed only on vertical blanking intervals (no tearing is visible). Framerate is limited by the monitor refresh rate (regardless of :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
  1485. .. _class_DisplayServer_constant_VSYNC_ADAPTIVE:
  1486. .. rst-class:: classref-enumeration-constant
  1487. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ADAPTIVE** = ``2``
  1488. Behaves like :ref:`VSYNC_DISABLED<class_DisplayServer_constant_VSYNC_DISABLED>` when the framerate drops below the screen's refresh rate to reduce stuttering (tearing may be visible). Otherwise, vertical synchronization is enabled to avoid tearing. Framerate is limited by the monitor refresh rate (regardless of :ref:`Engine.max_fps<class_Engine_property_max_fps>`). Behaves like :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>` when using the Compatibility rendering method.
  1489. .. _class_DisplayServer_constant_VSYNC_MAILBOX:
  1490. .. rst-class:: classref-enumeration-constant
  1491. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_MAILBOX** = ``3``
  1492. Displays the most recent image in the queue on vertical blanking intervals, while rendering to the other images (no tearing is visible). Framerate is unlimited (regardless of :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
  1493. Although not guaranteed, the images can be rendered as fast as possible, which may reduce input lag (also called "Fast" V-Sync mode). :ref:`VSYNC_MAILBOX<class_DisplayServer_constant_VSYNC_MAILBOX>` works best when at least twice as many frames as the display refresh rate are rendered. Behaves like :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>` when using the Compatibility rendering method.
  1494. .. rst-class:: classref-item-separator
  1495. ----
  1496. .. _enum_DisplayServer_HandleType:
  1497. .. rst-class:: classref-enumeration
  1498. enum **HandleType**: :ref:`๐Ÿ”—<enum_DisplayServer_HandleType>`
  1499. .. _class_DisplayServer_constant_DISPLAY_HANDLE:
  1500. .. rst-class:: classref-enumeration-constant
  1501. :ref:`HandleType<enum_DisplayServer_HandleType>` **DISPLAY_HANDLE** = ``0``
  1502. Display handle:
  1503. - Linux (X11): ``X11::Display*`` for the display.
  1504. - Linux (Wayland): ``wl_display`` for the display.
  1505. - Android: ``EGLDisplay`` for the display.
  1506. .. _class_DisplayServer_constant_WINDOW_HANDLE:
  1507. .. rst-class:: classref-enumeration-constant
  1508. :ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_HANDLE** = ``1``
  1509. Window handle:
  1510. - Windows: ``HWND`` for the window.
  1511. - Linux (X11): ``X11::Window*`` for the window.
  1512. - Linux (Wayland): ``wl_surface`` for the window.
  1513. - macOS: ``NSWindow*`` for the window.
  1514. - iOS: ``UIViewController*`` for the view controller.
  1515. - Android: ``jObject`` for the activity.
  1516. .. _class_DisplayServer_constant_WINDOW_VIEW:
  1517. .. rst-class:: classref-enumeration-constant
  1518. :ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_VIEW** = ``2``
  1519. Window view:
  1520. - Windows: ``HDC`` for the window (only with the Compatibility renderer).
  1521. - macOS: ``NSView*`` for the window main view.
  1522. - iOS: ``UIView*`` for the window main view.
  1523. .. _class_DisplayServer_constant_OPENGL_CONTEXT:
  1524. .. rst-class:: classref-enumeration-constant
  1525. :ref:`HandleType<enum_DisplayServer_HandleType>` **OPENGL_CONTEXT** = ``3``
  1526. OpenGL context (only with the Compatibility renderer):
  1527. - Windows: ``HGLRC`` for the window (native GL), or ``EGLContext`` for the window (ANGLE).
  1528. - Linux (X11): ``GLXContext*`` for the window.
  1529. - Linux (Wayland): ``EGLContext`` for the window.
  1530. - macOS: ``NSOpenGLContext*`` for the window (native GL), or ``EGLContext`` for the window (ANGLE).
  1531. - Android: ``EGLContext`` for the window.
  1532. .. _class_DisplayServer_constant_EGL_DISPLAY:
  1533. .. rst-class:: classref-enumeration-constant
  1534. :ref:`HandleType<enum_DisplayServer_HandleType>` **EGL_DISPLAY** = ``4``
  1535. - Windows: ``EGLDisplay`` for the window (ANGLE).
  1536. - macOS: ``EGLDisplay`` for the window (ANGLE).
  1537. - Linux (Wayland): ``EGLDisplay`` for the window.
  1538. .. _class_DisplayServer_constant_EGL_CONFIG:
  1539. .. rst-class:: classref-enumeration-constant
  1540. :ref:`HandleType<enum_DisplayServer_HandleType>` **EGL_CONFIG** = ``5``
  1541. - Windows: ``EGLConfig`` for the window (ANGLE).
  1542. - macOS: ``EGLConfig`` for the window (ANGLE).
  1543. - Linux (Wayland): ``EGLConfig`` for the window.
  1544. .. rst-class:: classref-item-separator
  1545. ----
  1546. .. _enum_DisplayServer_TTSUtteranceEvent:
  1547. .. rst-class:: classref-enumeration
  1548. enum **TTSUtteranceEvent**: :ref:`๐Ÿ”—<enum_DisplayServer_TTSUtteranceEvent>`
  1549. .. _class_DisplayServer_constant_TTS_UTTERANCE_STARTED:
  1550. .. rst-class:: classref-enumeration-constant
  1551. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_STARTED** = ``0``
  1552. Utterance has begun to be spoken.
  1553. .. _class_DisplayServer_constant_TTS_UTTERANCE_ENDED:
  1554. .. rst-class:: classref-enumeration-constant
  1555. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_ENDED** = ``1``
  1556. Utterance was successfully finished.
  1557. .. _class_DisplayServer_constant_TTS_UTTERANCE_CANCELED:
  1558. .. rst-class:: classref-enumeration-constant
  1559. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_CANCELED** = ``2``
  1560. Utterance was canceled, or TTS service was unable to process it.
  1561. .. _class_DisplayServer_constant_TTS_UTTERANCE_BOUNDARY:
  1562. .. rst-class:: classref-enumeration-constant
  1563. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_BOUNDARY** = ``3``
  1564. Utterance reached a word or sentence boundary.
  1565. .. rst-class:: classref-section-separator
  1566. ----
  1567. .. rst-class:: classref-descriptions-group
  1568. Constants
  1569. ---------
  1570. .. _class_DisplayServer_constant_INVALID_SCREEN:
  1571. .. rst-class:: classref-constant
  1572. **INVALID_SCREEN** = ``-1`` :ref:`๐Ÿ”—<class_DisplayServer_constant_INVALID_SCREEN>`
  1573. The ID that refers to a screen that does not exist. This is returned by some **DisplayServer** methods if no screen matches the requested result.
  1574. .. _class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS:
  1575. .. rst-class:: classref-constant
  1576. **SCREEN_WITH_MOUSE_FOCUS** = ``-4`` :ref:`๐Ÿ”—<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`
  1577. Represents the screen containing the mouse pointer.
  1578. \ **Note:** On Android, iOS, Web, and Linux (Wayland), this constant always represents the screen at index ``0``.
  1579. .. _class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS:
  1580. .. rst-class:: classref-constant
  1581. **SCREEN_WITH_KEYBOARD_FOCUS** = ``-3`` :ref:`๐Ÿ”—<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`
  1582. Represents the screen containing the window with the keyboard focus.
  1583. \ **Note:** On Android, iOS, Web, and Linux (Wayland), this constant always represents the screen at index ``0``.
  1584. .. _class_DisplayServer_constant_SCREEN_PRIMARY:
  1585. .. rst-class:: classref-constant
  1586. **SCREEN_PRIMARY** = ``-2`` :ref:`๐Ÿ”—<class_DisplayServer_constant_SCREEN_PRIMARY>`
  1587. Represents the primary screen.
  1588. \ **Note:** On Android, iOS, Web, and Linux (Wayland), this constant always represents the screen at index ``0``.
  1589. .. _class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW:
  1590. .. rst-class:: classref-constant
  1591. **SCREEN_OF_MAIN_WINDOW** = ``-1`` :ref:`๐Ÿ”—<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`
  1592. Represents the screen where the main window is located. This is usually the default value in functions that allow specifying one of several screens.
  1593. \ **Note:** On Android, iOS, Web, and Linux (Wayland), this constant always represents the screen at index ``0``.
  1594. .. _class_DisplayServer_constant_MAIN_WINDOW_ID:
  1595. .. rst-class:: classref-constant
  1596. **MAIN_WINDOW_ID** = ``0`` :ref:`๐Ÿ”—<class_DisplayServer_constant_MAIN_WINDOW_ID>`
  1597. The ID of the main window spawned by the engine, which can be passed to methods expecting a ``window_id``.
  1598. .. _class_DisplayServer_constant_INVALID_WINDOW_ID:
  1599. .. rst-class:: classref-constant
  1600. **INVALID_WINDOW_ID** = ``-1`` :ref:`๐Ÿ”—<class_DisplayServer_constant_INVALID_WINDOW_ID>`
  1601. The ID that refers to a nonexistent window. This is returned by some **DisplayServer** methods if no window matches the requested result.
  1602. .. _class_DisplayServer_constant_INVALID_INDICATOR_ID:
  1603. .. rst-class:: classref-constant
  1604. **INVALID_INDICATOR_ID** = ``-1`` :ref:`๐Ÿ”—<class_DisplayServer_constant_INVALID_INDICATOR_ID>`
  1605. The ID that refers to a nonexistent application status indicator.
  1606. .. rst-class:: classref-section-separator
  1607. ----
  1608. .. rst-class:: classref-descriptions-group
  1609. Method Descriptions
  1610. -------------------
  1611. .. _class_DisplayServer_method_accessibility_create_element:
  1612. .. rst-class:: classref-method
  1613. :ref:`RID<class_RID>` **accessibility_create_element**\ (\ window_id\: :ref:`int<class_int>`, role\: :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_create_element>`
  1614. Creates a new, empty accessibility element resource.
  1615. \ **Note:** An accessibility element is created and freed automatically for each :ref:`Node<class_Node>`. In general, this function should not be called manually.
  1616. .. rst-class:: classref-item-separator
  1617. ----
  1618. .. _class_DisplayServer_method_accessibility_create_sub_element:
  1619. .. rst-class:: classref-method
  1620. :ref:`RID<class_RID>` **accessibility_create_sub_element**\ (\ parent_rid\: :ref:`RID<class_RID>`, role\: :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>`, insert_pos\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_create_sub_element>`
  1621. Creates a new, empty accessibility sub-element resource. Sub-elements can be used to provide accessibility information for objects which are not :ref:`Node<class_Node>`\ s, such as list items, table cells, or menu items. Sub-elements are freed automatically when the parent element is freed, or can be freed early using the :ref:`accessibility_free_element()<class_DisplayServer_method_accessibility_free_element>` method.
  1622. .. rst-class:: classref-item-separator
  1623. ----
  1624. .. _class_DisplayServer_method_accessibility_create_sub_text_edit_elements:
  1625. .. rst-class:: classref-method
  1626. :ref:`RID<class_RID>` **accessibility_create_sub_text_edit_elements**\ (\ parent_rid\: :ref:`RID<class_RID>`, shaped_text\: :ref:`RID<class_RID>`, min_height\: :ref:`float<class_float>`, insert_pos\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_create_sub_text_edit_elements>`
  1627. Creates a new, empty accessibility sub-element from the shaped text buffer. Sub-elements are freed automatically when the parent element is freed, or can be freed early using the :ref:`accessibility_free_element()<class_DisplayServer_method_accessibility_free_element>` method.
  1628. .. rst-class:: classref-item-separator
  1629. ----
  1630. .. _class_DisplayServer_method_accessibility_element_get_meta:
  1631. .. rst-class:: classref-method
  1632. :ref:`Variant<class_Variant>` **accessibility_element_get_meta**\ (\ id\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_element_get_meta>`
  1633. Returns the metadata of the accessibility element.
  1634. .. rst-class:: classref-item-separator
  1635. ----
  1636. .. _class_DisplayServer_method_accessibility_element_set_meta:
  1637. .. rst-class:: classref-method
  1638. |void| **accessibility_element_set_meta**\ (\ id\: :ref:`RID<class_RID>`, meta\: :ref:`Variant<class_Variant>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_element_set_meta>`
  1639. Sets the metadata of the accessibility element.
  1640. .. rst-class:: classref-item-separator
  1641. ----
  1642. .. _class_DisplayServer_method_accessibility_free_element:
  1643. .. rst-class:: classref-method
  1644. |void| **accessibility_free_element**\ (\ id\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_free_element>`
  1645. Frees an object created by :ref:`accessibility_create_element()<class_DisplayServer_method_accessibility_create_element>`, :ref:`accessibility_create_sub_element()<class_DisplayServer_method_accessibility_create_sub_element>`, or :ref:`accessibility_create_sub_text_edit_elements()<class_DisplayServer_method_accessibility_create_sub_text_edit_elements>`.
  1646. .. rst-class:: classref-item-separator
  1647. ----
  1648. .. _class_DisplayServer_method_accessibility_get_window_root:
  1649. .. rst-class:: classref-method
  1650. :ref:`RID<class_RID>` **accessibility_get_window_root**\ (\ window_id\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_get_window_root>`
  1651. Returns the main accessibility element of the OS native window.
  1652. .. rst-class:: classref-item-separator
  1653. ----
  1654. .. _class_DisplayServer_method_accessibility_has_element:
  1655. .. rst-class:: classref-method
  1656. :ref:`bool<class_bool>` **accessibility_has_element**\ (\ id\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_has_element>`
  1657. Returns ``true`` if ``id`` is a valid accessibility element.
  1658. .. rst-class:: classref-item-separator
  1659. ----
  1660. .. _class_DisplayServer_method_accessibility_screen_reader_active:
  1661. .. rst-class:: classref-method
  1662. :ref:`int<class_int>` **accessibility_screen_reader_active**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_screen_reader_active>`
  1663. Returns ``1`` if a screen reader, Braille display or other assistive app is active, ``0`` otherwise. Returns ``-1`` if status is unknown.
  1664. \ **Note:** This method is implemented on Linux, macOS, and Windows.
  1665. \ **Note:** Accessibility debugging tools, such as Accessibility Insights for Windows, macOS Accessibility Inspector, or AT-SPI Browser do not count as assistive apps and will not affect this value. To test your app with these tools, set :ref:`ProjectSettings.accessibility/general/accessibility_support<class_ProjectSettings_property_accessibility/general/accessibility_support>` to ``1``.
  1666. .. rst-class:: classref-item-separator
  1667. ----
  1668. .. _class_DisplayServer_method_accessibility_set_window_focused:
  1669. .. rst-class:: classref-method
  1670. |void| **accessibility_set_window_focused**\ (\ window_id\: :ref:`int<class_int>`, focused\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_set_window_focused>`
  1671. Sets the window focused state for assistive apps.
  1672. \ **Note:** This method is implemented on Linux, macOS, and Windows.
  1673. \ **Note:** Advanced users only! :ref:`Window<class_Window>` objects call this method automatically.
  1674. .. rst-class:: classref-item-separator
  1675. ----
  1676. .. _class_DisplayServer_method_accessibility_set_window_rect:
  1677. .. rst-class:: classref-method
  1678. |void| **accessibility_set_window_rect**\ (\ window_id\: :ref:`int<class_int>`, rect_out\: :ref:`Rect2<class_Rect2>`, rect_in\: :ref:`Rect2<class_Rect2>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_set_window_rect>`
  1679. Sets window outer (with decorations) and inner (without decorations) bounds for assistive apps.
  1680. \ **Note:** This method is implemented on Linux, macOS, and Windows.
  1681. \ **Note:** Advanced users only! :ref:`Window<class_Window>` objects call this method automatically.
  1682. .. rst-class:: classref-item-separator
  1683. ----
  1684. .. _class_DisplayServer_method_accessibility_should_increase_contrast:
  1685. .. rst-class:: classref-method
  1686. :ref:`int<class_int>` **accessibility_should_increase_contrast**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_should_increase_contrast>`
  1687. Returns ``1`` if a high-contrast user interface theme should be used, ``0`` otherwise. Returns ``-1`` if status is unknown.
  1688. \ **Note:** This method is implemented on Linux (X11/Wayland, GNOME), macOS, and Windows.
  1689. .. rst-class:: classref-item-separator
  1690. ----
  1691. .. _class_DisplayServer_method_accessibility_should_reduce_animation:
  1692. .. rst-class:: classref-method
  1693. :ref:`int<class_int>` **accessibility_should_reduce_animation**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_should_reduce_animation>`
  1694. Returns ``1`` if flashing, blinking, and other moving content that can cause seizures in users with photosensitive epilepsy should be disabled, ``0`` otherwise. Returns ``-1`` if status is unknown.
  1695. \ **Note:** This method is implemented on macOS and Windows.
  1696. .. rst-class:: classref-item-separator
  1697. ----
  1698. .. _class_DisplayServer_method_accessibility_should_reduce_transparency:
  1699. .. rst-class:: classref-method
  1700. :ref:`int<class_int>` **accessibility_should_reduce_transparency**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_should_reduce_transparency>`
  1701. Returns ``1`` if background images, transparency, and other features that can reduce the contrast between the foreground and background should be disabled, ``0`` otherwise. Returns ``-1`` if status is unknown.
  1702. \ **Note:** This method is implemented on macOS and Windows.
  1703. .. rst-class:: classref-item-separator
  1704. ----
  1705. .. _class_DisplayServer_method_accessibility_update_add_action:
  1706. .. rst-class:: classref-method
  1707. |void| **accessibility_update_add_action**\ (\ id\: :ref:`RID<class_RID>`, action\: :ref:`AccessibilityAction<enum_DisplayServer_AccessibilityAction>`, callable\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_add_action>`
  1708. Adds a callback for the accessibility action (action which can be performed by using a special screen reader command or buttons on the Braille display), and marks this action as supported. The action callback receives one :ref:`Variant<class_Variant>` argument, which value depends on action type.
  1709. .. rst-class:: classref-item-separator
  1710. ----
  1711. .. _class_DisplayServer_method_accessibility_update_add_child:
  1712. .. rst-class:: classref-method
  1713. |void| **accessibility_update_add_child**\ (\ id\: :ref:`RID<class_RID>`, child_id\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_add_child>`
  1714. Adds a child accessibility element.
  1715. \ **Note:** :ref:`Node<class_Node>` children and sub-elements are added to the child list automatically.
  1716. .. rst-class:: classref-item-separator
  1717. ----
  1718. .. _class_DisplayServer_method_accessibility_update_add_custom_action:
  1719. .. rst-class:: classref-method
  1720. |void| **accessibility_update_add_custom_action**\ (\ id\: :ref:`RID<class_RID>`, action_id\: :ref:`int<class_int>`, action_description\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_add_custom_action>`
  1721. Adds support for a custom accessibility action. ``action_id`` is passed as an argument to the callback of :ref:`ACTION_CUSTOM<class_DisplayServer_constant_ACTION_CUSTOM>` action.
  1722. .. rst-class:: classref-item-separator
  1723. ----
  1724. .. _class_DisplayServer_method_accessibility_update_add_related_controls:
  1725. .. rst-class:: classref-method
  1726. |void| **accessibility_update_add_related_controls**\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_add_related_controls>`
  1727. Adds an element that is controlled by this element.
  1728. .. rst-class:: classref-item-separator
  1729. ----
  1730. .. _class_DisplayServer_method_accessibility_update_add_related_described_by:
  1731. .. rst-class:: classref-method
  1732. |void| **accessibility_update_add_related_described_by**\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_add_related_described_by>`
  1733. Adds an element that describes this element.
  1734. .. rst-class:: classref-item-separator
  1735. ----
  1736. .. _class_DisplayServer_method_accessibility_update_add_related_details:
  1737. .. rst-class:: classref-method
  1738. |void| **accessibility_update_add_related_details**\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_add_related_details>`
  1739. Adds an element that details this element.
  1740. .. rst-class:: classref-item-separator
  1741. ----
  1742. .. _class_DisplayServer_method_accessibility_update_add_related_flow_to:
  1743. .. rst-class:: classref-method
  1744. |void| **accessibility_update_add_related_flow_to**\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_add_related_flow_to>`
  1745. Adds an element that this element flow into.
  1746. .. rst-class:: classref-item-separator
  1747. ----
  1748. .. _class_DisplayServer_method_accessibility_update_add_related_labeled_by:
  1749. .. rst-class:: classref-method
  1750. |void| **accessibility_update_add_related_labeled_by**\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_add_related_labeled_by>`
  1751. Adds an element that labels this element.
  1752. .. rst-class:: classref-item-separator
  1753. ----
  1754. .. _class_DisplayServer_method_accessibility_update_add_related_radio_group:
  1755. .. rst-class:: classref-method
  1756. |void| **accessibility_update_add_related_radio_group**\ (\ id\: :ref:`RID<class_RID>`, related_id\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_add_related_radio_group>`
  1757. Adds an element that is part of the same radio group.
  1758. \ **Note:** This method should be called on each element of the group, using all other elements as ``related_id``.
  1759. .. rst-class:: classref-item-separator
  1760. ----
  1761. .. _class_DisplayServer_method_accessibility_update_set_active_descendant:
  1762. .. rst-class:: classref-method
  1763. |void| **accessibility_update_set_active_descendant**\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_active_descendant>`
  1764. Adds an element that is an active descendant of this element.
  1765. .. rst-class:: classref-item-separator
  1766. ----
  1767. .. _class_DisplayServer_method_accessibility_update_set_background_color:
  1768. .. rst-class:: classref-method
  1769. |void| **accessibility_update_set_background_color**\ (\ id\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_background_color>`
  1770. Sets element background color.
  1771. .. rst-class:: classref-item-separator
  1772. ----
  1773. .. _class_DisplayServer_method_accessibility_update_set_bounds:
  1774. .. rst-class:: classref-method
  1775. |void| **accessibility_update_set_bounds**\ (\ id\: :ref:`RID<class_RID>`, p_rect\: :ref:`Rect2<class_Rect2>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_bounds>`
  1776. Sets element bounding box, relative to the node position.
  1777. .. rst-class:: classref-item-separator
  1778. ----
  1779. .. _class_DisplayServer_method_accessibility_update_set_checked:
  1780. .. rst-class:: classref-method
  1781. |void| **accessibility_update_set_checked**\ (\ id\: :ref:`RID<class_RID>`, checekd\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_checked>`
  1782. Sets element checked state.
  1783. .. rst-class:: classref-item-separator
  1784. ----
  1785. .. _class_DisplayServer_method_accessibility_update_set_classname:
  1786. .. rst-class:: classref-method
  1787. |void| **accessibility_update_set_classname**\ (\ id\: :ref:`RID<class_RID>`, classname\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_classname>`
  1788. Sets element class name.
  1789. .. rst-class:: classref-item-separator
  1790. ----
  1791. .. _class_DisplayServer_method_accessibility_update_set_color_value:
  1792. .. rst-class:: classref-method
  1793. |void| **accessibility_update_set_color_value**\ (\ id\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_color_value>`
  1794. Sets element color value.
  1795. .. rst-class:: classref-item-separator
  1796. ----
  1797. .. _class_DisplayServer_method_accessibility_update_set_description:
  1798. .. rst-class:: classref-method
  1799. |void| **accessibility_update_set_description**\ (\ id\: :ref:`RID<class_RID>`, description\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_description>`
  1800. Sets element accessibility description.
  1801. .. rst-class:: classref-item-separator
  1802. ----
  1803. .. _class_DisplayServer_method_accessibility_update_set_error_message:
  1804. .. rst-class:: classref-method
  1805. |void| **accessibility_update_set_error_message**\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_error_message>`
  1806. Sets an element which contains an error message for this element.
  1807. .. rst-class:: classref-item-separator
  1808. ----
  1809. .. _class_DisplayServer_method_accessibility_update_set_extra_info:
  1810. .. rst-class:: classref-method
  1811. |void| **accessibility_update_set_extra_info**\ (\ id\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_extra_info>`
  1812. Sets element accessibility extra information added to the element name.
  1813. .. rst-class:: classref-item-separator
  1814. ----
  1815. .. _class_DisplayServer_method_accessibility_update_set_flag:
  1816. .. rst-class:: classref-method
  1817. |void| **accessibility_update_set_flag**\ (\ id\: :ref:`RID<class_RID>`, flag\: :ref:`AccessibilityFlags<enum_DisplayServer_AccessibilityFlags>`, value\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_flag>`
  1818. Sets element flag.
  1819. .. rst-class:: classref-item-separator
  1820. ----
  1821. .. _class_DisplayServer_method_accessibility_update_set_focus:
  1822. .. rst-class:: classref-method
  1823. |void| **accessibility_update_set_focus**\ (\ id\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_focus>`
  1824. Sets currently focused element.
  1825. .. rst-class:: classref-item-separator
  1826. ----
  1827. .. _class_DisplayServer_method_accessibility_update_set_foreground_color:
  1828. .. rst-class:: classref-method
  1829. |void| **accessibility_update_set_foreground_color**\ (\ id\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_foreground_color>`
  1830. Sets element foreground color.
  1831. .. rst-class:: classref-item-separator
  1832. ----
  1833. .. _class_DisplayServer_method_accessibility_update_set_in_page_link_target:
  1834. .. rst-class:: classref-method
  1835. |void| **accessibility_update_set_in_page_link_target**\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_in_page_link_target>`
  1836. Sets target element for the link.
  1837. .. rst-class:: classref-item-separator
  1838. ----
  1839. .. _class_DisplayServer_method_accessibility_update_set_language:
  1840. .. rst-class:: classref-method
  1841. |void| **accessibility_update_set_language**\ (\ id\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_language>`
  1842. Sets element text language.
  1843. .. rst-class:: classref-item-separator
  1844. ----
  1845. .. _class_DisplayServer_method_accessibility_update_set_list_item_count:
  1846. .. rst-class:: classref-method
  1847. |void| **accessibility_update_set_list_item_count**\ (\ id\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_list_item_count>`
  1848. Sets number of items in the list.
  1849. .. rst-class:: classref-item-separator
  1850. ----
  1851. .. _class_DisplayServer_method_accessibility_update_set_list_item_expanded:
  1852. .. rst-class:: classref-method
  1853. |void| **accessibility_update_set_list_item_expanded**\ (\ id\: :ref:`RID<class_RID>`, expanded\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_list_item_expanded>`
  1854. Sets list/tree item expanded status.
  1855. .. rst-class:: classref-item-separator
  1856. ----
  1857. .. _class_DisplayServer_method_accessibility_update_set_list_item_index:
  1858. .. rst-class:: classref-method
  1859. |void| **accessibility_update_set_list_item_index**\ (\ id\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_list_item_index>`
  1860. Sets the position of the element in the list.
  1861. .. rst-class:: classref-item-separator
  1862. ----
  1863. .. _class_DisplayServer_method_accessibility_update_set_list_item_level:
  1864. .. rst-class:: classref-method
  1865. |void| **accessibility_update_set_list_item_level**\ (\ id\: :ref:`RID<class_RID>`, level\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_list_item_level>`
  1866. Sets the hierarchical level of the element in the list.
  1867. .. rst-class:: classref-item-separator
  1868. ----
  1869. .. _class_DisplayServer_method_accessibility_update_set_list_item_selected:
  1870. .. rst-class:: classref-method
  1871. |void| **accessibility_update_set_list_item_selected**\ (\ id\: :ref:`RID<class_RID>`, selected\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_list_item_selected>`
  1872. Sets list/tree item selected status.
  1873. .. rst-class:: classref-item-separator
  1874. ----
  1875. .. _class_DisplayServer_method_accessibility_update_set_list_orientation:
  1876. .. rst-class:: classref-method
  1877. |void| **accessibility_update_set_list_orientation**\ (\ id\: :ref:`RID<class_RID>`, vertical\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_list_orientation>`
  1878. Sets the orientation of the list elements.
  1879. .. rst-class:: classref-item-separator
  1880. ----
  1881. .. _class_DisplayServer_method_accessibility_update_set_live:
  1882. .. rst-class:: classref-method
  1883. |void| **accessibility_update_set_live**\ (\ id\: :ref:`RID<class_RID>`, live\: :ref:`AccessibilityLiveMode<enum_DisplayServer_AccessibilityLiveMode>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_live>`
  1884. Sets the priority of the live region updates.
  1885. .. rst-class:: classref-item-separator
  1886. ----
  1887. .. _class_DisplayServer_method_accessibility_update_set_member_of:
  1888. .. rst-class:: classref-method
  1889. |void| **accessibility_update_set_member_of**\ (\ id\: :ref:`RID<class_RID>`, group_id\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_member_of>`
  1890. Sets the element to be a member of the group.
  1891. .. rst-class:: classref-item-separator
  1892. ----
  1893. .. _class_DisplayServer_method_accessibility_update_set_name:
  1894. .. rst-class:: classref-method
  1895. |void| **accessibility_update_set_name**\ (\ id\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_name>`
  1896. Sets element accessibility name.
  1897. .. rst-class:: classref-item-separator
  1898. ----
  1899. .. _class_DisplayServer_method_accessibility_update_set_next_on_line:
  1900. .. rst-class:: classref-method
  1901. |void| **accessibility_update_set_next_on_line**\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_next_on_line>`
  1902. Sets next element on the line.
  1903. .. rst-class:: classref-item-separator
  1904. ----
  1905. .. _class_DisplayServer_method_accessibility_update_set_num_jump:
  1906. .. rst-class:: classref-method
  1907. |void| **accessibility_update_set_num_jump**\ (\ id\: :ref:`RID<class_RID>`, jump\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_num_jump>`
  1908. Sets numeric value jump.
  1909. .. rst-class:: classref-item-separator
  1910. ----
  1911. .. _class_DisplayServer_method_accessibility_update_set_num_range:
  1912. .. rst-class:: classref-method
  1913. |void| **accessibility_update_set_num_range**\ (\ id\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_num_range>`
  1914. Sets numeric value range.
  1915. .. rst-class:: classref-item-separator
  1916. ----
  1917. .. _class_DisplayServer_method_accessibility_update_set_num_step:
  1918. .. rst-class:: classref-method
  1919. |void| **accessibility_update_set_num_step**\ (\ id\: :ref:`RID<class_RID>`, step\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_num_step>`
  1920. Sets numeric value step.
  1921. .. rst-class:: classref-item-separator
  1922. ----
  1923. .. _class_DisplayServer_method_accessibility_update_set_num_value:
  1924. .. rst-class:: classref-method
  1925. |void| **accessibility_update_set_num_value**\ (\ id\: :ref:`RID<class_RID>`, position\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_num_value>`
  1926. Sets numeric value.
  1927. .. rst-class:: classref-item-separator
  1928. ----
  1929. .. _class_DisplayServer_method_accessibility_update_set_placeholder:
  1930. .. rst-class:: classref-method
  1931. |void| **accessibility_update_set_placeholder**\ (\ id\: :ref:`RID<class_RID>`, placeholder\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_placeholder>`
  1932. Sets placeholder text.
  1933. .. rst-class:: classref-item-separator
  1934. ----
  1935. .. _class_DisplayServer_method_accessibility_update_set_popup_type:
  1936. .. rst-class:: classref-method
  1937. |void| **accessibility_update_set_popup_type**\ (\ id\: :ref:`RID<class_RID>`, popup\: :ref:`AccessibilityPopupType<enum_DisplayServer_AccessibilityPopupType>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_popup_type>`
  1938. Sets popup type for popup buttons.
  1939. .. rst-class:: classref-item-separator
  1940. ----
  1941. .. _class_DisplayServer_method_accessibility_update_set_previous_on_line:
  1942. .. rst-class:: classref-method
  1943. |void| **accessibility_update_set_previous_on_line**\ (\ id\: :ref:`RID<class_RID>`, other_id\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_previous_on_line>`
  1944. Sets previous element on the line.
  1945. .. rst-class:: classref-item-separator
  1946. ----
  1947. .. _class_DisplayServer_method_accessibility_update_set_role:
  1948. .. rst-class:: classref-method
  1949. |void| **accessibility_update_set_role**\ (\ id\: :ref:`RID<class_RID>`, role\: :ref:`AccessibilityRole<enum_DisplayServer_AccessibilityRole>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_role>`
  1950. Sets element accessibility role.
  1951. .. rst-class:: classref-item-separator
  1952. ----
  1953. .. _class_DisplayServer_method_accessibility_update_set_role_description:
  1954. .. rst-class:: classref-method
  1955. |void| **accessibility_update_set_role_description**\ (\ id\: :ref:`RID<class_RID>`, description\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_role_description>`
  1956. Sets element accessibility role description text.
  1957. .. rst-class:: classref-item-separator
  1958. ----
  1959. .. _class_DisplayServer_method_accessibility_update_set_scroll_x:
  1960. .. rst-class:: classref-method
  1961. |void| **accessibility_update_set_scroll_x**\ (\ id\: :ref:`RID<class_RID>`, position\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_scroll_x>`
  1962. Sets scroll bar x position.
  1963. .. rst-class:: classref-item-separator
  1964. ----
  1965. .. _class_DisplayServer_method_accessibility_update_set_scroll_x_range:
  1966. .. rst-class:: classref-method
  1967. |void| **accessibility_update_set_scroll_x_range**\ (\ id\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_scroll_x_range>`
  1968. Sets scroll bar x range.
  1969. .. rst-class:: classref-item-separator
  1970. ----
  1971. .. _class_DisplayServer_method_accessibility_update_set_scroll_y:
  1972. .. rst-class:: classref-method
  1973. |void| **accessibility_update_set_scroll_y**\ (\ id\: :ref:`RID<class_RID>`, position\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_scroll_y>`
  1974. Sets scroll bar y position.
  1975. .. rst-class:: classref-item-separator
  1976. ----
  1977. .. _class_DisplayServer_method_accessibility_update_set_scroll_y_range:
  1978. .. rst-class:: classref-method
  1979. |void| **accessibility_update_set_scroll_y_range**\ (\ id\: :ref:`RID<class_RID>`, min\: :ref:`float<class_float>`, max\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_scroll_y_range>`
  1980. Sets scroll bar y range.
  1981. .. rst-class:: classref-item-separator
  1982. ----
  1983. .. _class_DisplayServer_method_accessibility_update_set_shortcut:
  1984. .. rst-class:: classref-method
  1985. |void| **accessibility_update_set_shortcut**\ (\ id\: :ref:`RID<class_RID>`, shortcut\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_shortcut>`
  1986. Sets the list of keyboard shortcuts used by element.
  1987. .. rst-class:: classref-item-separator
  1988. ----
  1989. .. _class_DisplayServer_method_accessibility_update_set_state_description:
  1990. .. rst-class:: classref-method
  1991. |void| **accessibility_update_set_state_description**\ (\ id\: :ref:`RID<class_RID>`, description\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_state_description>`
  1992. Sets human-readable description of the current checked state.
  1993. .. rst-class:: classref-item-separator
  1994. ----
  1995. .. _class_DisplayServer_method_accessibility_update_set_table_cell_position:
  1996. .. rst-class:: classref-method
  1997. |void| **accessibility_update_set_table_cell_position**\ (\ id\: :ref:`RID<class_RID>`, row_index\: :ref:`int<class_int>`, column_index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_table_cell_position>`
  1998. Sets cell position in the table.
  1999. .. rst-class:: classref-item-separator
  2000. ----
  2001. .. _class_DisplayServer_method_accessibility_update_set_table_cell_span:
  2002. .. rst-class:: classref-method
  2003. |void| **accessibility_update_set_table_cell_span**\ (\ id\: :ref:`RID<class_RID>`, row_span\: :ref:`int<class_int>`, column_span\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_table_cell_span>`
  2004. Sets cell row/column span.
  2005. .. rst-class:: classref-item-separator
  2006. ----
  2007. .. _class_DisplayServer_method_accessibility_update_set_table_column_count:
  2008. .. rst-class:: classref-method
  2009. |void| **accessibility_update_set_table_column_count**\ (\ id\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_table_column_count>`
  2010. Sets number of columns in the table.
  2011. .. rst-class:: classref-item-separator
  2012. ----
  2013. .. _class_DisplayServer_method_accessibility_update_set_table_column_index:
  2014. .. rst-class:: classref-method
  2015. |void| **accessibility_update_set_table_column_index**\ (\ id\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_table_column_index>`
  2016. Sets position of the column.
  2017. .. rst-class:: classref-item-separator
  2018. ----
  2019. .. _class_DisplayServer_method_accessibility_update_set_table_row_count:
  2020. .. rst-class:: classref-method
  2021. |void| **accessibility_update_set_table_row_count**\ (\ id\: :ref:`RID<class_RID>`, count\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_table_row_count>`
  2022. Sets number of rows in the table.
  2023. .. rst-class:: classref-item-separator
  2024. ----
  2025. .. _class_DisplayServer_method_accessibility_update_set_table_row_index:
  2026. .. rst-class:: classref-method
  2027. |void| **accessibility_update_set_table_row_index**\ (\ id\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_table_row_index>`
  2028. Sets position of the row in the table.
  2029. .. rst-class:: classref-item-separator
  2030. ----
  2031. .. _class_DisplayServer_method_accessibility_update_set_text_align:
  2032. .. rst-class:: classref-method
  2033. |void| **accessibility_update_set_text_align**\ (\ id\: :ref:`RID<class_RID>`, align\: :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_text_align>`
  2034. Sets element text alignment.
  2035. .. rst-class:: classref-item-separator
  2036. ----
  2037. .. _class_DisplayServer_method_accessibility_update_set_text_decorations:
  2038. .. rst-class:: classref-method
  2039. |void| **accessibility_update_set_text_decorations**\ (\ id\: :ref:`RID<class_RID>`, underline\: :ref:`bool<class_bool>`, strikethrough\: :ref:`bool<class_bool>`, overline\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_text_decorations>`
  2040. Sets text underline/overline/strikethrough.
  2041. .. rst-class:: classref-item-separator
  2042. ----
  2043. .. _class_DisplayServer_method_accessibility_update_set_text_orientation:
  2044. .. rst-class:: classref-method
  2045. |void| **accessibility_update_set_text_orientation**\ (\ id\: :ref:`RID<class_RID>`, vertical\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_text_orientation>`
  2046. Sets text orientation.
  2047. .. rst-class:: classref-item-separator
  2048. ----
  2049. .. _class_DisplayServer_method_accessibility_update_set_text_selection:
  2050. .. rst-class:: classref-method
  2051. |void| **accessibility_update_set_text_selection**\ (\ id\: :ref:`RID<class_RID>`, text_start_id\: :ref:`RID<class_RID>`, start_char\: :ref:`int<class_int>`, text_end_id\: :ref:`RID<class_RID>`, end_char\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_text_selection>`
  2052. Sets text selection to the text field. ``text_start_id`` and ``text_end_id`` should be elements created by :ref:`accessibility_create_sub_text_edit_elements()<class_DisplayServer_method_accessibility_create_sub_text_edit_elements>`. Character offsets are relative to the corresponding element.
  2053. .. rst-class:: classref-item-separator
  2054. ----
  2055. .. _class_DisplayServer_method_accessibility_update_set_tooltip:
  2056. .. rst-class:: classref-method
  2057. |void| **accessibility_update_set_tooltip**\ (\ id\: :ref:`RID<class_RID>`, tooltip\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_tooltip>`
  2058. Sets tooltip text.
  2059. .. rst-class:: classref-item-separator
  2060. ----
  2061. .. _class_DisplayServer_method_accessibility_update_set_transform:
  2062. .. rst-class:: classref-method
  2063. |void| **accessibility_update_set_transform**\ (\ id\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_transform>`
  2064. Sets element 2D transform.
  2065. .. rst-class:: classref-item-separator
  2066. ----
  2067. .. _class_DisplayServer_method_accessibility_update_set_url:
  2068. .. rst-class:: classref-method
  2069. |void| **accessibility_update_set_url**\ (\ id\: :ref:`RID<class_RID>`, url\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_url>`
  2070. Sets link URL.
  2071. .. rst-class:: classref-item-separator
  2072. ----
  2073. .. _class_DisplayServer_method_accessibility_update_set_value:
  2074. .. rst-class:: classref-method
  2075. |void| **accessibility_update_set_value**\ (\ id\: :ref:`RID<class_RID>`, value\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_accessibility_update_set_value>`
  2076. Sets element text value.
  2077. .. rst-class:: classref-item-separator
  2078. ----
  2079. .. _class_DisplayServer_method_beep:
  2080. .. rst-class:: classref-method
  2081. |void| **beep**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_beep>`
  2082. Plays the beep sound from the operative system, if possible. Because it comes from the OS, the beep sound will be audible even if the application is muted. It may also be disabled for the entire OS by the user.
  2083. \ **Note:** This method is implemented on macOS, Linux (X11/Wayland), and Windows.
  2084. .. rst-class:: classref-item-separator
  2085. ----
  2086. .. _class_DisplayServer_method_clipboard_get:
  2087. .. rst-class:: classref-method
  2088. :ref:`String<class_String>` **clipboard_get**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_get>`
  2089. Returns the user's clipboard as a string if possible.
  2090. .. rst-class:: classref-item-separator
  2091. ----
  2092. .. _class_DisplayServer_method_clipboard_get_image:
  2093. .. rst-class:: classref-method
  2094. :ref:`Image<class_Image>` **clipboard_get_image**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_get_image>`
  2095. Returns the user's clipboard as an image if possible.
  2096. \ **Note:** This method uses the copied pixel data, e.g. from a image editing software or a web browser, not an image file copied from file explorer.
  2097. .. rst-class:: classref-item-separator
  2098. ----
  2099. .. _class_DisplayServer_method_clipboard_get_primary:
  2100. .. rst-class:: classref-method
  2101. :ref:`String<class_String>` **clipboard_get_primary**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_get_primary>`
  2102. Returns the user's `primary <https://unix.stackexchange.com/questions/139191/whats-the-difference-between-primary-selection-and-clipboard-buffer>`__ clipboard as a string if possible. This is the clipboard that is set when the user selects text in any application, rather than when pressing :kbd:`Ctrl + C`. The clipboard data can then be pasted by clicking the middle mouse button in any application that supports the primary clipboard mechanism.
  2103. \ **Note:** This method is only implemented on Linux (X11/Wayland).
  2104. .. rst-class:: classref-item-separator
  2105. ----
  2106. .. _class_DisplayServer_method_clipboard_has:
  2107. .. rst-class:: classref-method
  2108. :ref:`bool<class_bool>` **clipboard_has**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_has>`
  2109. Returns ``true`` if there is a text content on the user's clipboard.
  2110. .. rst-class:: classref-item-separator
  2111. ----
  2112. .. _class_DisplayServer_method_clipboard_has_image:
  2113. .. rst-class:: classref-method
  2114. :ref:`bool<class_bool>` **clipboard_has_image**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_has_image>`
  2115. Returns ``true`` if there is an image content on the user's clipboard.
  2116. .. rst-class:: classref-item-separator
  2117. ----
  2118. .. _class_DisplayServer_method_clipboard_set:
  2119. .. rst-class:: classref-method
  2120. |void| **clipboard_set**\ (\ clipboard\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_set>`
  2121. Sets the user's clipboard content to the given string.
  2122. .. rst-class:: classref-item-separator
  2123. ----
  2124. .. _class_DisplayServer_method_clipboard_set_primary:
  2125. .. rst-class:: classref-method
  2126. |void| **clipboard_set_primary**\ (\ clipboard_primary\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_set_primary>`
  2127. Sets the user's `primary <https://unix.stackexchange.com/questions/139191/whats-the-difference-between-primary-selection-and-clipboard-buffer>`__ clipboard content to the given string. This is the clipboard that is set when the user selects text in any application, rather than when pressing :kbd:`Ctrl + C`. The clipboard data can then be pasted by clicking the middle mouse button in any application that supports the primary clipboard mechanism.
  2128. \ **Note:** This method is only implemented on Linux (X11/Wayland).
  2129. .. rst-class:: classref-item-separator
  2130. ----
  2131. .. _class_DisplayServer_method_color_picker:
  2132. .. rst-class:: classref-method
  2133. :ref:`bool<class_bool>` **color_picker**\ (\ callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_color_picker>`
  2134. Displays OS native color picker.
  2135. Callbacks have the following arguments: ``status: bool, color: Color``.
  2136. \ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_COLOR_PICKER<class_DisplayServer_constant_FEATURE_NATIVE_COLOR_PICKER>` feature.
  2137. \ **Note:** This method is only implemented on Linux (X11/Wayland).
  2138. .. rst-class:: classref-item-separator
  2139. ----
  2140. .. _class_DisplayServer_method_create_status_indicator:
  2141. .. rst-class:: classref-method
  2142. :ref:`int<class_int>` **create_status_indicator**\ (\ icon\: :ref:`Texture2D<class_Texture2D>`, tooltip\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_create_status_indicator>`
  2143. Creates a new application status indicator with the specified icon, tooltip, and activation callback.
  2144. \ ``callback`` should take two arguments: the pressed mouse button (one of the :ref:`MouseButton<enum_@GlobalScope_MouseButton>` constants) and the click position in screen coordinates (a :ref:`Vector2i<class_Vector2i>`).
  2145. .. rst-class:: classref-item-separator
  2146. ----
  2147. .. _class_DisplayServer_method_cursor_get_shape:
  2148. .. rst-class:: classref-method
  2149. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **cursor_get_shape**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_cursor_get_shape>`
  2150. Returns the default mouse cursor shape set by :ref:`cursor_set_shape()<class_DisplayServer_method_cursor_set_shape>`.
  2151. .. rst-class:: classref-item-separator
  2152. ----
  2153. .. _class_DisplayServer_method_cursor_set_custom_image:
  2154. .. rst-class:: classref-method
  2155. |void| **cursor_set_custom_image**\ (\ cursor\: :ref:`Resource<class_Resource>`, shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>` = 0, hotspot\: :ref:`Vector2<class_Vector2>` = Vector2(0, 0)\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_cursor_set_custom_image>`
  2156. Sets a custom mouse cursor image for the given ``shape``. This means the user's operating system and mouse cursor theme will no longer influence the mouse cursor's appearance.
  2157. \ ``cursor`` can be either a :ref:`Texture2D<class_Texture2D>` or an :ref:`Image<class_Image>`, and it should not be larger than 256ร—256 to display correctly. Optionally, ``hotspot`` can be set to offset the image's position relative to the click point. By default, ``hotspot`` is set to the top-left corner of the image. See also :ref:`cursor_set_shape()<class_DisplayServer_method_cursor_set_shape>`.
  2158. .. rst-class:: classref-item-separator
  2159. ----
  2160. .. _class_DisplayServer_method_cursor_set_shape:
  2161. .. rst-class:: classref-method
  2162. |void| **cursor_set_shape**\ (\ shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_cursor_set_shape>`
  2163. Sets the default mouse cursor shape. The cursor's appearance will vary depending on the user's operating system and mouse cursor theme. See also :ref:`cursor_get_shape()<class_DisplayServer_method_cursor_get_shape>` and :ref:`cursor_set_custom_image()<class_DisplayServer_method_cursor_set_custom_image>`.
  2164. .. rst-class:: classref-item-separator
  2165. ----
  2166. .. _class_DisplayServer_method_delete_status_indicator:
  2167. .. rst-class:: classref-method
  2168. |void| **delete_status_indicator**\ (\ id\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_delete_status_indicator>`
  2169. Removes the application status indicator.
  2170. .. rst-class:: classref-item-separator
  2171. ----
  2172. .. _class_DisplayServer_method_dialog_input_text:
  2173. .. rst-class:: classref-method
  2174. :ref:`Error<enum_@GlobalScope_Error>` **dialog_input_text**\ (\ title\: :ref:`String<class_String>`, description\: :ref:`String<class_String>`, existing_text\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_dialog_input_text>`
  2175. Shows a text input dialog which uses the operating system's native look-and-feel. ``callback`` should accept a single :ref:`String<class_String>` parameter which contains the text field's contents.
  2176. \ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_INPUT<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_INPUT>` feature. Supported platforms include macOS, Windows, and Android.
  2177. .. rst-class:: classref-item-separator
  2178. ----
  2179. .. _class_DisplayServer_method_dialog_show:
  2180. .. rst-class:: classref-method
  2181. :ref:`Error<enum_@GlobalScope_Error>` **dialog_show**\ (\ title\: :ref:`String<class_String>`, description\: :ref:`String<class_String>`, buttons\: :ref:`PackedStringArray<class_PackedStringArray>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_dialog_show>`
  2182. Shows a text dialog which uses the operating system's native look-and-feel. ``callback`` should accept a single :ref:`int<class_int>` parameter which corresponds to the index of the pressed button.
  2183. \ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG>` feature. Supported platforms include macOS, Windows, and Android.
  2184. .. rst-class:: classref-item-separator
  2185. ----
  2186. .. _class_DisplayServer_method_enable_for_stealing_focus:
  2187. .. rst-class:: classref-method
  2188. |void| **enable_for_stealing_focus**\ (\ process_id\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_enable_for_stealing_focus>`
  2189. Allows the ``process_id`` PID to steal focus from this window. In other words, this disables the operating system's focus stealing protection for the specified PID.
  2190. \ **Note:** This method is implemented only on Windows.
  2191. .. rst-class:: classref-item-separator
  2192. ----
  2193. .. _class_DisplayServer_method_file_dialog_show:
  2194. .. rst-class:: classref-method
  2195. :ref:`Error<enum_@GlobalScope_Error>` **file_dialog_show**\ (\ title\: :ref:`String<class_String>`, current_directory\: :ref:`String<class_String>`, filename\: :ref:`String<class_String>`, show_hidden\: :ref:`bool<class_bool>`, mode\: :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>`, filters\: :ref:`PackedStringArray<class_PackedStringArray>`, callback\: :ref:`Callable<class_Callable>`, parent_window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_file_dialog_show>`
  2196. Displays OS native dialog for selecting files or directories in the file system.
  2197. Each filter string in the ``filters`` array should be formatted like this: ``*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg``. The description text of the filter is optional and can be omitted. It is recommended to set both file extension and MIME type. See also :ref:`FileDialog.filters<class_FileDialog_property_filters>`.
  2198. Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int``. **On Android,** the third callback argument (``selected_filter_index``) is always ``0``.
  2199. \ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_FILE<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE>` feature. Supported platforms include Linux (X11/Wayland), Windows, macOS, and Android.
  2200. \ **Note:** ``current_directory`` might be ignored.
  2201. \ **Note:** Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.
  2202. \ **Note:** On Android and Linux, ``show_hidden`` is ignored.
  2203. \ **Note:** On Android and macOS, native file dialogs have no title.
  2204. \ **Note:** On macOS, sandboxed apps will save security-scoped bookmarks to retain access to the opened folders across multiple sessions. Use :ref:`OS.get_granted_permissions()<class_OS_method_get_granted_permissions>` to get a list of saved bookmarks.
  2205. .. rst-class:: classref-item-separator
  2206. ----
  2207. .. _class_DisplayServer_method_file_dialog_with_options_show:
  2208. .. rst-class:: classref-method
  2209. :ref:`Error<enum_@GlobalScope_Error>` **file_dialog_with_options_show**\ (\ title\: :ref:`String<class_String>`, current_directory\: :ref:`String<class_String>`, root\: :ref:`String<class_String>`, filename\: :ref:`String<class_String>`, show_hidden\: :ref:`bool<class_bool>`, mode\: :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>`, filters\: :ref:`PackedStringArray<class_PackedStringArray>`, options\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\], callback\: :ref:`Callable<class_Callable>`, parent_window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_file_dialog_with_options_show>`
  2210. Displays OS native dialog for selecting files or directories in the file system with additional user selectable options.
  2211. Each filter string in the ``filters`` array should be formatted like this: ``*.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg``. The description text of the filter is optional and can be omitted. It is recommended to set both file extension and MIME type. See also :ref:`FileDialog.filters<class_FileDialog_property_filters>`.
  2212. \ ``options`` is array of :ref:`Dictionary<class_Dictionary>`\ s with the following keys:
  2213. - ``"name"`` - option's name :ref:`String<class_String>`.
  2214. - ``"values"`` - :ref:`PackedStringArray<class_PackedStringArray>` of values. If empty, boolean option (check box) is used.
  2215. - ``"default"`` - default selected option index (:ref:`int<class_int>`) or default boolean value (:ref:`bool<class_bool>`).
  2216. Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int, selected_option: Dictionary``.
  2217. \ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_FILE_EXTRA<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE_EXTRA>` feature. Supported platforms include Linux (X11/Wayland), Windows, and macOS.
  2218. \ **Note:** ``current_directory`` might be ignored.
  2219. \ **Note:** Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.
  2220. \ **Note:** On Linux (X11), ``show_hidden`` is ignored.
  2221. \ **Note:** On macOS, native file dialogs have no title.
  2222. \ **Note:** On macOS, sandboxed apps will save security-scoped bookmarks to retain access to the opened folders across multiple sessions. Use :ref:`OS.get_granted_permissions()<class_OS_method_get_granted_permissions>` to get a list of saved bookmarks.
  2223. .. rst-class:: classref-item-separator
  2224. ----
  2225. .. _class_DisplayServer_method_force_process_and_drop_events:
  2226. .. rst-class:: classref-method
  2227. |void| **force_process_and_drop_events**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_force_process_and_drop_events>`
  2228. Forces window manager processing while ignoring all :ref:`InputEvent<class_InputEvent>`\ s. See also :ref:`process_events()<class_DisplayServer_method_process_events>`.
  2229. \ **Note:** This method is implemented on Windows and macOS.
  2230. .. rst-class:: classref-item-separator
  2231. ----
  2232. .. _class_DisplayServer_method_get_accent_color:
  2233. .. rst-class:: classref-method
  2234. :ref:`Color<class_Color>` **get_accent_color**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_accent_color>`
  2235. Returns OS theme accent color. Returns ``Color(0, 0, 0, 0)``, if accent color is unknown.
  2236. \ **Note:** This method is implemented on macOS, Windows, Android, and Linux (X11/Wayland).
  2237. .. rst-class:: classref-item-separator
  2238. ----
  2239. .. _class_DisplayServer_method_get_base_color:
  2240. .. rst-class:: classref-method
  2241. :ref:`Color<class_Color>` **get_base_color**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_base_color>`
  2242. Returns the OS theme base color (default control background). Returns ``Color(0, 0, 0, 0)`` if the base color is unknown.
  2243. \ **Note:** This method is implemented on macOS, Windows, and Android.
  2244. .. rst-class:: classref-item-separator
  2245. ----
  2246. .. _class_DisplayServer_method_get_display_cutouts:
  2247. .. rst-class:: classref-method
  2248. :ref:`Array<class_Array>`\[:ref:`Rect2<class_Rect2>`\] **get_display_cutouts**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_display_cutouts>`
  2249. Returns an :ref:`Array<class_Array>` of :ref:`Rect2<class_Rect2>`, each of which is the bounding rectangle for a display cutout or notch. These are non-functional areas on edge-to-edge screens used by cameras and sensors. Returns an empty array if the device does not have cutouts. See also :ref:`get_display_safe_area()<class_DisplayServer_method_get_display_safe_area>`.
  2250. \ **Note:** Currently only implemented on Android. Other platforms will return an empty array even if they do have display cutouts or notches.
  2251. .. rst-class:: classref-item-separator
  2252. ----
  2253. .. _class_DisplayServer_method_get_display_safe_area:
  2254. .. rst-class:: classref-method
  2255. :ref:`Rect2i<class_Rect2i>` **get_display_safe_area**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_display_safe_area>`
  2256. Returns the unobscured area of the display where interactive controls should be rendered. See also :ref:`get_display_cutouts()<class_DisplayServer_method_get_display_cutouts>`.
  2257. \ **Note:** Currently only implemented on Android and iOS. On other platforms, ``screen_get_usable_rect(SCREEN_OF_MAIN_WINDOW)`` will be returned as a fallback. See also :ref:`screen_get_usable_rect()<class_DisplayServer_method_screen_get_usable_rect>`.
  2258. .. rst-class:: classref-item-separator
  2259. ----
  2260. .. _class_DisplayServer_method_get_keyboard_focus_screen:
  2261. .. rst-class:: classref-method
  2262. :ref:`int<class_int>` **get_keyboard_focus_screen**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_keyboard_focus_screen>`
  2263. Returns the index of the screen containing the window with the keyboard focus, or the primary screen if there's no focused window.
  2264. \ **Note:** This method is implemented on Linux/X11, macOS, and Windows. On other platforms, this method always returns the primary screen.
  2265. .. rst-class:: classref-item-separator
  2266. ----
  2267. .. _class_DisplayServer_method_get_name:
  2268. .. rst-class:: classref-method
  2269. :ref:`String<class_String>` **get_name**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_name>`
  2270. Returns the name of the **DisplayServer** currently in use. Most operating systems only have a single **DisplayServer**, but Linux has access to more than one **DisplayServer** (currently X11 and Wayland).
  2271. The names of built-in display servers are ``Windows``, ``macOS``, ``X11`` (Linux), ``Wayland`` (Linux), ``Android``, ``iOS``, ``web`` (HTML5), and ``headless`` (when started with the ``--headless`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>`).
  2272. .. rst-class:: classref-item-separator
  2273. ----
  2274. .. _class_DisplayServer_method_get_primary_screen:
  2275. .. rst-class:: classref-method
  2276. :ref:`int<class_int>` **get_primary_screen**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_primary_screen>`
  2277. Returns index of the primary screen.
  2278. \ **Note:** This method is implemented on Linux/X11, macOS, and Windows. On other platforms, this method always returns ``0``.
  2279. .. rst-class:: classref-item-separator
  2280. ----
  2281. .. _class_DisplayServer_method_get_screen_count:
  2282. .. rst-class:: classref-method
  2283. :ref:`int<class_int>` **get_screen_count**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_screen_count>`
  2284. Returns the number of displays available.
  2285. \ **Note:** This method is implemented on Linux (X11 and Wayland), macOS, and Windows. On other platforms, this method always returns ``1``.
  2286. .. rst-class:: classref-item-separator
  2287. ----
  2288. .. _class_DisplayServer_method_get_screen_from_rect:
  2289. .. rst-class:: classref-method
  2290. :ref:`int<class_int>` **get_screen_from_rect**\ (\ rect\: :ref:`Rect2<class_Rect2>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_screen_from_rect>`
  2291. Returns the index of the screen that overlaps the most with the given rectangle. Returns :ref:`INVALID_SCREEN<class_DisplayServer_constant_INVALID_SCREEN>` if the rectangle doesn't overlap with any screen or has no area.
  2292. .. rst-class:: classref-item-separator
  2293. ----
  2294. .. _class_DisplayServer_method_get_swap_cancel_ok:
  2295. .. rst-class:: classref-method
  2296. :ref:`bool<class_bool>` **get_swap_cancel_ok**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_get_swap_cancel_ok>`
  2297. Returns ``true`` if positions of **OK** and **Cancel** buttons are swapped in dialogs. This is enabled by default on Windows to follow interface conventions, and be toggled by changing :ref:`ProjectSettings.gui/common/swap_cancel_ok<class_ProjectSettings_property_gui/common/swap_cancel_ok>`.
  2298. \ **Note:** This doesn't affect native dialogs such as the ones spawned by :ref:`dialog_show()<class_DisplayServer_method_dialog_show>`.
  2299. .. rst-class:: classref-item-separator
  2300. ----
  2301. .. _class_DisplayServer_method_get_window_at_screen_position:
  2302. .. rst-class:: classref-method
  2303. :ref:`int<class_int>` **get_window_at_screen_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_window_at_screen_position>`
  2304. Returns the ID of the window at the specified screen ``position`` (in pixels). On multi-monitor setups, the screen position is relative to the virtual desktop area. On multi-monitor setups with different screen resolutions or orientations, the origin may be located outside any display like this:
  2305. .. code:: text
  2306. * (0, 0) +-------+
  2307. | |
  2308. +-------------+ | |
  2309. | | | |
  2310. | | | |
  2311. +-------------+ +-------+
  2312. .. rst-class:: classref-item-separator
  2313. ----
  2314. .. _class_DisplayServer_method_get_window_list:
  2315. .. rst-class:: classref-method
  2316. :ref:`PackedInt32Array<class_PackedInt32Array>` **get_window_list**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_window_list>`
  2317. Returns the list of Godot window IDs belonging to this process.
  2318. \ **Note:** Native dialogs are not included in this list.
  2319. .. rst-class:: classref-item-separator
  2320. ----
  2321. .. _class_DisplayServer_method_global_menu_add_check_item:
  2322. .. rst-class:: classref-method
  2323. :ref:`int<class_int>` **global_menu_add_check_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_check_item>`
  2324. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2325. Adds a new checkable item with text ``label`` to the global menu with ID ``menu_root``.
  2326. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  2327. An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
  2328. \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
  2329. \ **Note:** This method is implemented only on macOS.
  2330. \ **Supported system menu IDs:**\
  2331. .. code:: text
  2332. "_main" - Main menu (macOS).
  2333. "_dock" - Dock popup menu (macOS).
  2334. "_apple" - Apple menu (macOS, custom items added before "Services").
  2335. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  2336. "_help" - Help menu (macOS).
  2337. .. rst-class:: classref-item-separator
  2338. ----
  2339. .. _class_DisplayServer_method_global_menu_add_icon_check_item:
  2340. .. rst-class:: classref-method
  2341. :ref:`int<class_int>` **global_menu_add_icon_check_item**\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_icon_check_item>`
  2342. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2343. Adds a new checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
  2344. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  2345. An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
  2346. \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
  2347. \ **Note:** This method is implemented only on macOS.
  2348. \ **Supported system menu IDs:**\
  2349. .. code:: text
  2350. "_main" - Main menu (macOS).
  2351. "_dock" - Dock popup menu (macOS).
  2352. "_apple" - Apple menu (macOS, custom items added before "Services").
  2353. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  2354. "_help" - Help menu (macOS).
  2355. .. rst-class:: classref-item-separator
  2356. ----
  2357. .. _class_DisplayServer_method_global_menu_add_icon_item:
  2358. .. rst-class:: classref-method
  2359. :ref:`int<class_int>` **global_menu_add_icon_item**\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_icon_item>`
  2360. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2361. Adds a new item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
  2362. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  2363. An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
  2364. \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
  2365. \ **Note:** This method is implemented only on macOS.
  2366. \ **Supported system menu IDs:**\
  2367. .. code:: text
  2368. "_main" - Main menu (macOS).
  2369. "_dock" - Dock popup menu (macOS).
  2370. "_apple" - Apple menu (macOS, custom items added before "Services").
  2371. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  2372. "_help" - Help menu (macOS).
  2373. .. rst-class:: classref-item-separator
  2374. ----
  2375. .. _class_DisplayServer_method_global_menu_add_icon_radio_check_item:
  2376. .. rst-class:: classref-method
  2377. :ref:`int<class_int>` **global_menu_add_icon_radio_check_item**\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_icon_radio_check_item>`
  2378. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2379. Adds a new radio-checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
  2380. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  2381. An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
  2382. \ **Note:** Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`global_menu_set_item_checked()<class_DisplayServer_method_global_menu_set_item_checked>` for more info on how to control it.
  2383. \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
  2384. \ **Note:** This method is implemented only on macOS.
  2385. \ **Supported system menu IDs:**\
  2386. .. code:: text
  2387. "_main" - Main menu (macOS).
  2388. "_dock" - Dock popup menu (macOS).
  2389. "_apple" - Apple menu (macOS, custom items added before "Services").
  2390. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  2391. "_help" - Help menu (macOS).
  2392. .. rst-class:: classref-item-separator
  2393. ----
  2394. .. _class_DisplayServer_method_global_menu_add_item:
  2395. .. rst-class:: classref-method
  2396. :ref:`int<class_int>` **global_menu_add_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_item>`
  2397. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2398. Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
  2399. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  2400. An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
  2401. \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
  2402. \ **Note:** This method is implemented only on macOS.
  2403. \ **Supported system menu IDs:**\
  2404. .. code:: text
  2405. "_main" - Main menu (macOS).
  2406. "_dock" - Dock popup menu (macOS).
  2407. "_apple" - Apple menu (macOS, custom items added before "Services").
  2408. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  2409. "_help" - Help menu (macOS).
  2410. .. rst-class:: classref-item-separator
  2411. ----
  2412. .. _class_DisplayServer_method_global_menu_add_multistate_item:
  2413. .. rst-class:: classref-method
  2414. :ref:`int<class_int>` **global_menu_add_multistate_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, max_states\: :ref:`int<class_int>`, default_state\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_multistate_item>`
  2415. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2416. Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
  2417. Contrarily to normal binary items, multistate items can have more than two states, as defined by ``max_states``. Each press or activate of the item will increase the state by one. The default value is defined by ``default_state``.
  2418. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  2419. An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
  2420. \ **Note:** By default, there's no indication of the current item state, it should be changed manually.
  2421. \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
  2422. \ **Note:** This method is implemented only on macOS.
  2423. \ **Supported system menu IDs:**\
  2424. .. code:: text
  2425. "_main" - Main menu (macOS).
  2426. "_dock" - Dock popup menu (macOS).
  2427. "_apple" - Apple menu (macOS, custom items added before "Services").
  2428. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  2429. "_help" - Help menu (macOS).
  2430. .. rst-class:: classref-item-separator
  2431. ----
  2432. .. _class_DisplayServer_method_global_menu_add_radio_check_item:
  2433. .. rst-class:: classref-method
  2434. :ref:`int<class_int>` **global_menu_add_radio_check_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_radio_check_item>`
  2435. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2436. Adds a new radio-checkable item with text ``label`` to the global menu with ID ``menu_root``.
  2437. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  2438. An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
  2439. \ **Note:** Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See :ref:`global_menu_set_item_checked()<class_DisplayServer_method_global_menu_set_item_checked>` for more info on how to control it.
  2440. \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
  2441. \ **Note:** This method is implemented only on macOS.
  2442. \ **Supported system menu IDs:**\
  2443. .. code:: text
  2444. "_main" - Main menu (macOS).
  2445. "_dock" - Dock popup menu (macOS).
  2446. "_apple" - Apple menu (macOS, custom items added before "Services").
  2447. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  2448. "_help" - Help menu (macOS).
  2449. .. rst-class:: classref-item-separator
  2450. ----
  2451. .. _class_DisplayServer_method_global_menu_add_separator:
  2452. .. rst-class:: classref-method
  2453. :ref:`int<class_int>` **global_menu_add_separator**\ (\ menu_root\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_separator>`
  2454. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2455. Adds a separator between items to the global menu with ID ``menu_root``. Separators also occupy an index.
  2456. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  2457. \ **Note:** This method is implemented only on macOS.
  2458. \ **Supported system menu IDs:**\
  2459. .. code:: text
  2460. "_main" - Main menu (macOS).
  2461. "_dock" - Dock popup menu (macOS).
  2462. "_apple" - Apple menu (macOS, custom items added before "Services").
  2463. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  2464. "_help" - Help menu (macOS).
  2465. .. rst-class:: classref-item-separator
  2466. ----
  2467. .. _class_DisplayServer_method_global_menu_add_submenu_item:
  2468. .. rst-class:: classref-method
  2469. :ref:`int<class_int>` **global_menu_add_submenu_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, submenu\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_submenu_item>`
  2470. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2471. Adds an item that will act as a submenu of the global menu ``menu_root``. The ``submenu`` argument is the ID of the global menu root that will be shown when the item is clicked.
  2472. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  2473. \ **Note:** This method is implemented only on macOS.
  2474. \ **Supported system menu IDs:**\
  2475. .. code:: text
  2476. "_main" - Main menu (macOS).
  2477. "_dock" - Dock popup menu (macOS).
  2478. "_apple" - Apple menu (macOS, custom items added before "Services").
  2479. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  2480. "_help" - Help menu (macOS).
  2481. .. rst-class:: classref-item-separator
  2482. ----
  2483. .. _class_DisplayServer_method_global_menu_clear:
  2484. .. rst-class:: classref-method
  2485. |void| **global_menu_clear**\ (\ menu_root\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_clear>`
  2486. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2487. Removes all items from the global menu with ID ``menu_root``.
  2488. \ **Note:** This method is implemented only on macOS.
  2489. \ **Supported system menu IDs:**\
  2490. .. code:: text
  2491. "_main" - Main menu (macOS).
  2492. "_dock" - Dock popup menu (macOS).
  2493. "_apple" - Apple menu (macOS, custom items added before "Services").
  2494. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  2495. "_help" - Help menu (macOS).
  2496. .. rst-class:: classref-item-separator
  2497. ----
  2498. .. _class_DisplayServer_method_global_menu_get_item_accelerator:
  2499. .. rst-class:: classref-method
  2500. :ref:`Key<enum_@GlobalScope_Key>` **global_menu_get_item_accelerator**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_accelerator>`
  2501. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2502. Returns the accelerator of the item at index ``idx``. Accelerators are special combinations of keys that activate the item, no matter which control is focused.
  2503. \ **Note:** This method is implemented only on macOS.
  2504. .. rst-class:: classref-item-separator
  2505. ----
  2506. .. _class_DisplayServer_method_global_menu_get_item_callback:
  2507. .. rst-class:: classref-method
  2508. :ref:`Callable<class_Callable>` **global_menu_get_item_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_callback>`
  2509. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2510. Returns the callback of the item at index ``idx``.
  2511. \ **Note:** This method is implemented only on macOS.
  2512. .. rst-class:: classref-item-separator
  2513. ----
  2514. .. _class_DisplayServer_method_global_menu_get_item_count:
  2515. .. rst-class:: classref-method
  2516. :ref:`int<class_int>` **global_menu_get_item_count**\ (\ menu_root\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_count>`
  2517. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2518. Returns number of items in the global menu with ID ``menu_root``.
  2519. \ **Note:** This method is implemented only on macOS.
  2520. .. rst-class:: classref-item-separator
  2521. ----
  2522. .. _class_DisplayServer_method_global_menu_get_item_icon:
  2523. .. rst-class:: classref-method
  2524. :ref:`Texture2D<class_Texture2D>` **global_menu_get_item_icon**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_icon>`
  2525. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2526. Returns the icon of the item at index ``idx``.
  2527. \ **Note:** This method is implemented only on macOS.
  2528. .. rst-class:: classref-item-separator
  2529. ----
  2530. .. _class_DisplayServer_method_global_menu_get_item_indentation_level:
  2531. .. rst-class:: classref-method
  2532. :ref:`int<class_int>` **global_menu_get_item_indentation_level**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_indentation_level>`
  2533. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2534. Returns the horizontal offset of the item at the given ``idx``.
  2535. \ **Note:** This method is implemented only on macOS.
  2536. .. rst-class:: classref-item-separator
  2537. ----
  2538. .. _class_DisplayServer_method_global_menu_get_item_index_from_tag:
  2539. .. rst-class:: classref-method
  2540. :ref:`int<class_int>` **global_menu_get_item_index_from_tag**\ (\ menu_root\: :ref:`String<class_String>`, tag\: :ref:`Variant<class_Variant>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_index_from_tag>`
  2541. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2542. Returns the index of the item with the specified ``tag``. Indices are automatically assigned to each item by the engine, and cannot be set manually.
  2543. \ **Note:** This method is implemented only on macOS.
  2544. .. rst-class:: classref-item-separator
  2545. ----
  2546. .. _class_DisplayServer_method_global_menu_get_item_index_from_text:
  2547. .. rst-class:: classref-method
  2548. :ref:`int<class_int>` **global_menu_get_item_index_from_text**\ (\ menu_root\: :ref:`String<class_String>`, text\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_index_from_text>`
  2549. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2550. Returns the index of the item with the specified ``text``. Indices are automatically assigned to each item by the engine, and cannot be set manually.
  2551. \ **Note:** This method is implemented only on macOS.
  2552. .. rst-class:: classref-item-separator
  2553. ----
  2554. .. _class_DisplayServer_method_global_menu_get_item_key_callback:
  2555. .. rst-class:: classref-method
  2556. :ref:`Callable<class_Callable>` **global_menu_get_item_key_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_key_callback>`
  2557. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2558. Returns the callback of the item accelerator at index ``idx``.
  2559. \ **Note:** This method is implemented only on macOS.
  2560. .. rst-class:: classref-item-separator
  2561. ----
  2562. .. _class_DisplayServer_method_global_menu_get_item_max_states:
  2563. .. rst-class:: classref-method
  2564. :ref:`int<class_int>` **global_menu_get_item_max_states**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_max_states>`
  2565. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2566. Returns number of states of a multistate item. See :ref:`global_menu_add_multistate_item()<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
  2567. \ **Note:** This method is implemented only on macOS.
  2568. .. rst-class:: classref-item-separator
  2569. ----
  2570. .. _class_DisplayServer_method_global_menu_get_item_state:
  2571. .. rst-class:: classref-method
  2572. :ref:`int<class_int>` **global_menu_get_item_state**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_state>`
  2573. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2574. Returns the state of a multistate item. See :ref:`global_menu_add_multistate_item()<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
  2575. \ **Note:** This method is implemented only on macOS.
  2576. .. rst-class:: classref-item-separator
  2577. ----
  2578. .. _class_DisplayServer_method_global_menu_get_item_submenu:
  2579. .. rst-class:: classref-method
  2580. :ref:`String<class_String>` **global_menu_get_item_submenu**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_submenu>`
  2581. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2582. Returns the submenu ID of the item at index ``idx``. See :ref:`global_menu_add_submenu_item()<class_DisplayServer_method_global_menu_add_submenu_item>` for more info on how to add a submenu.
  2583. \ **Note:** This method is implemented only on macOS.
  2584. .. rst-class:: classref-item-separator
  2585. ----
  2586. .. _class_DisplayServer_method_global_menu_get_item_tag:
  2587. .. rst-class:: classref-method
  2588. :ref:`Variant<class_Variant>` **global_menu_get_item_tag**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_tag>`
  2589. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2590. Returns the metadata of the specified item, which might be of any type. You can set it with :ref:`global_menu_set_item_tag()<class_DisplayServer_method_global_menu_set_item_tag>`, which provides a simple way of assigning context data to items.
  2591. \ **Note:** This method is implemented only on macOS.
  2592. .. rst-class:: classref-item-separator
  2593. ----
  2594. .. _class_DisplayServer_method_global_menu_get_item_text:
  2595. .. rst-class:: classref-method
  2596. :ref:`String<class_String>` **global_menu_get_item_text**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_text>`
  2597. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2598. Returns the text of the item at index ``idx``.
  2599. \ **Note:** This method is implemented only on macOS.
  2600. .. rst-class:: classref-item-separator
  2601. ----
  2602. .. _class_DisplayServer_method_global_menu_get_item_tooltip:
  2603. .. rst-class:: classref-method
  2604. :ref:`String<class_String>` **global_menu_get_item_tooltip**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_tooltip>`
  2605. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2606. Returns the tooltip associated with the specified index ``idx``.
  2607. \ **Note:** This method is implemented only on macOS.
  2608. .. rst-class:: classref-item-separator
  2609. ----
  2610. .. _class_DisplayServer_method_global_menu_get_system_menu_roots:
  2611. .. rst-class:: classref-method
  2612. :ref:`Dictionary<class_Dictionary>` **global_menu_get_system_menu_roots**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_system_menu_roots>`
  2613. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2614. Returns Dictionary of supported system menu IDs and names.
  2615. \ **Note:** This method is implemented only on macOS.
  2616. .. rst-class:: classref-item-separator
  2617. ----
  2618. .. _class_DisplayServer_method_global_menu_is_item_checkable:
  2619. .. rst-class:: classref-method
  2620. :ref:`bool<class_bool>` **global_menu_is_item_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_is_item_checkable>`
  2621. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2622. Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if it has a checkbox or radio button.
  2623. \ **Note:** This method is implemented only on macOS.
  2624. .. rst-class:: classref-item-separator
  2625. ----
  2626. .. _class_DisplayServer_method_global_menu_is_item_checked:
  2627. .. rst-class:: classref-method
  2628. :ref:`bool<class_bool>` **global_menu_is_item_checked**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_is_item_checked>`
  2629. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2630. Returns ``true`` if the item at index ``idx`` is checked.
  2631. \ **Note:** This method is implemented only on macOS.
  2632. .. rst-class:: classref-item-separator
  2633. ----
  2634. .. _class_DisplayServer_method_global_menu_is_item_disabled:
  2635. .. rst-class:: classref-method
  2636. :ref:`bool<class_bool>` **global_menu_is_item_disabled**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_is_item_disabled>`
  2637. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2638. Returns ``true`` if the item at index ``idx`` is disabled. When it is disabled it can't be selected, or its action invoked.
  2639. See :ref:`global_menu_set_item_disabled()<class_DisplayServer_method_global_menu_set_item_disabled>` for more info on how to disable an item.
  2640. \ **Note:** This method is implemented only on macOS.
  2641. .. rst-class:: classref-item-separator
  2642. ----
  2643. .. _class_DisplayServer_method_global_menu_is_item_hidden:
  2644. .. rst-class:: classref-method
  2645. :ref:`bool<class_bool>` **global_menu_is_item_hidden**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_is_item_hidden>`
  2646. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2647. Returns ``true`` if the item at index ``idx`` is hidden.
  2648. See :ref:`global_menu_set_item_hidden()<class_DisplayServer_method_global_menu_set_item_hidden>` for more info on how to hide an item.
  2649. \ **Note:** This method is implemented only on macOS.
  2650. .. rst-class:: classref-item-separator
  2651. ----
  2652. .. _class_DisplayServer_method_global_menu_is_item_radio_checkable:
  2653. .. rst-class:: classref-method
  2654. :ref:`bool<class_bool>` **global_menu_is_item_radio_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_is_item_radio_checkable>`
  2655. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2656. Returns ``true`` if the item at index ``idx`` has radio button-style checkability.
  2657. \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
  2658. \ **Note:** This method is implemented only on macOS.
  2659. .. rst-class:: classref-item-separator
  2660. ----
  2661. .. _class_DisplayServer_method_global_menu_remove_item:
  2662. .. rst-class:: classref-method
  2663. |void| **global_menu_remove_item**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_remove_item>`
  2664. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2665. Removes the item at index ``idx`` from the global menu ``menu_root``.
  2666. \ **Note:** The indices of items after the removed item will be shifted by one.
  2667. \ **Note:** This method is implemented only on macOS.
  2668. .. rst-class:: classref-item-separator
  2669. ----
  2670. .. _class_DisplayServer_method_global_menu_set_item_accelerator:
  2671. .. rst-class:: classref-method
  2672. |void| **global_menu_set_item_accelerator**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_accelerator>`
  2673. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2674. Sets the accelerator of the item at index ``idx``. ``keycode`` can be a single :ref:`Key<enum_@GlobalScope_Key>`, or a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
  2675. \ **Note:** This method is implemented only on macOS.
  2676. .. rst-class:: classref-item-separator
  2677. ----
  2678. .. _class_DisplayServer_method_global_menu_set_item_callback:
  2679. .. rst-class:: classref-method
  2680. |void| **global_menu_set_item_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_callback>`
  2681. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2682. Sets the callback of the item at index ``idx``. Callback is emitted when an item is pressed.
  2683. \ **Note:** The ``callback`` Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the ``tag`` parameter when the menu item was created.
  2684. \ **Note:** This method is implemented only on macOS.
  2685. .. rst-class:: classref-item-separator
  2686. ----
  2687. .. _class_DisplayServer_method_global_menu_set_item_checkable:
  2688. .. rst-class:: classref-method
  2689. |void| **global_menu_set_item_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_checkable>`
  2690. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2691. Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the type of the item to plain text.
  2692. \ **Note:** This method is implemented only on macOS.
  2693. .. rst-class:: classref-item-separator
  2694. ----
  2695. .. _class_DisplayServer_method_global_menu_set_item_checked:
  2696. .. rst-class:: classref-method
  2697. |void| **global_menu_set_item_checked**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checked\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_checked>`
  2698. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2699. Sets the checkstate status of the item at index ``idx``.
  2700. \ **Note:** This method is implemented only on macOS.
  2701. .. rst-class:: classref-item-separator
  2702. ----
  2703. .. _class_DisplayServer_method_global_menu_set_item_disabled:
  2704. .. rst-class:: classref-method
  2705. |void| **global_menu_set_item_disabled**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_disabled>`
  2706. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2707. Enables/disables the item at index ``idx``. When it is disabled, it can't be selected and its action can't be invoked.
  2708. \ **Note:** This method is implemented only on macOS.
  2709. .. rst-class:: classref-item-separator
  2710. ----
  2711. .. _class_DisplayServer_method_global_menu_set_item_hidden:
  2712. .. rst-class:: classref-method
  2713. |void| **global_menu_set_item_hidden**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, hidden\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_hidden>`
  2714. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2715. Hides/shows the item at index ``idx``. When it is hidden, an item does not appear in a menu and its action cannot be invoked.
  2716. \ **Note:** This method is implemented only on macOS.
  2717. .. rst-class:: classref-item-separator
  2718. ----
  2719. .. _class_DisplayServer_method_global_menu_set_item_hover_callbacks:
  2720. .. rst-class:: classref-method
  2721. |void| **global_menu_set_item_hover_callbacks**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_hover_callbacks>`
  2722. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2723. Sets the callback of the item at index ``idx``. The callback is emitted when an item is hovered.
  2724. \ **Note:** The ``callback`` Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the ``tag`` parameter when the menu item was created.
  2725. \ **Note:** This method is implemented only on macOS.
  2726. .. rst-class:: classref-item-separator
  2727. ----
  2728. .. _class_DisplayServer_method_global_menu_set_item_icon:
  2729. .. rst-class:: classref-method
  2730. |void| **global_menu_set_item_icon**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_icon>`
  2731. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2732. Replaces the :ref:`Texture2D<class_Texture2D>` icon of the specified ``idx``.
  2733. \ **Note:** This method is implemented only on macOS.
  2734. \ **Note:** This method is not supported by macOS "_dock" menu items.
  2735. .. rst-class:: classref-item-separator
  2736. ----
  2737. .. _class_DisplayServer_method_global_menu_set_item_indentation_level:
  2738. .. rst-class:: classref-method
  2739. |void| **global_menu_set_item_indentation_level**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, level\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_indentation_level>`
  2740. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2741. Sets the horizontal offset of the item at the given ``idx``.
  2742. \ **Note:** This method is implemented only on macOS.
  2743. .. rst-class:: classref-item-separator
  2744. ----
  2745. .. _class_DisplayServer_method_global_menu_set_item_key_callback:
  2746. .. rst-class:: classref-method
  2747. |void| **global_menu_set_item_key_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, key_callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_key_callback>`
  2748. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2749. Sets the callback of the item at index ``idx``. Callback is emitted when its accelerator is activated.
  2750. \ **Note:** The ``key_callback`` Callable needs to accept exactly one Variant parameter, the parameter passed to the Callable will be the value passed to the ``tag`` parameter when the menu item was created.
  2751. \ **Note:** This method is implemented only on macOS.
  2752. .. rst-class:: classref-item-separator
  2753. ----
  2754. .. _class_DisplayServer_method_global_menu_set_item_max_states:
  2755. .. rst-class:: classref-method
  2756. |void| **global_menu_set_item_max_states**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, max_states\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_max_states>`
  2757. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2758. Sets number of state of a multistate item. See :ref:`global_menu_add_multistate_item()<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
  2759. \ **Note:** This method is implemented only on macOS.
  2760. .. rst-class:: classref-item-separator
  2761. ----
  2762. .. _class_DisplayServer_method_global_menu_set_item_radio_checkable:
  2763. .. rst-class:: classref-method
  2764. |void| **global_menu_set_item_radio_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_radio_checkable>`
  2765. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2766. Sets the type of the item at the specified index ``idx`` to radio button. If ``false``, sets the type of the item to plain text.
  2767. \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
  2768. \ **Note:** This method is implemented only on macOS.
  2769. .. rst-class:: classref-item-separator
  2770. ----
  2771. .. _class_DisplayServer_method_global_menu_set_item_state:
  2772. .. rst-class:: classref-method
  2773. |void| **global_menu_set_item_state**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, state\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_state>`
  2774. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2775. Sets the state of a multistate item. See :ref:`global_menu_add_multistate_item()<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
  2776. \ **Note:** This method is implemented only on macOS.
  2777. .. rst-class:: classref-item-separator
  2778. ----
  2779. .. _class_DisplayServer_method_global_menu_set_item_submenu:
  2780. .. rst-class:: classref-method
  2781. |void| **global_menu_set_item_submenu**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, submenu\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_submenu>`
  2782. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2783. Sets the submenu of the item at index ``idx``. The submenu is the ID of a global menu root that would be shown when the item is clicked.
  2784. \ **Note:** This method is implemented only on macOS.
  2785. .. rst-class:: classref-item-separator
  2786. ----
  2787. .. _class_DisplayServer_method_global_menu_set_item_tag:
  2788. .. rst-class:: classref-method
  2789. |void| **global_menu_set_item_tag**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tag\: :ref:`Variant<class_Variant>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_tag>`
  2790. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2791. Sets the metadata of an item, which may be of any type. You can later get it with :ref:`global_menu_get_item_tag()<class_DisplayServer_method_global_menu_get_item_tag>`, which provides a simple way of assigning context data to items.
  2792. \ **Note:** This method is implemented only on macOS.
  2793. .. rst-class:: classref-item-separator
  2794. ----
  2795. .. _class_DisplayServer_method_global_menu_set_item_text:
  2796. .. rst-class:: classref-method
  2797. |void| **global_menu_set_item_text**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, text\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_text>`
  2798. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2799. Sets the text of the item at index ``idx``.
  2800. \ **Note:** This method is implemented only on macOS.
  2801. .. rst-class:: classref-item-separator
  2802. ----
  2803. .. _class_DisplayServer_method_global_menu_set_item_tooltip:
  2804. .. rst-class:: classref-method
  2805. |void| **global_menu_set_item_tooltip**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_tooltip>`
  2806. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2807. Sets the :ref:`String<class_String>` tooltip of the item at the specified index ``idx``.
  2808. \ **Note:** This method is implemented only on macOS.
  2809. .. rst-class:: classref-item-separator
  2810. ----
  2811. .. _class_DisplayServer_method_global_menu_set_popup_callbacks:
  2812. .. rst-class:: classref-method
  2813. |void| **global_menu_set_popup_callbacks**\ (\ menu_root\: :ref:`String<class_String>`, open_callback\: :ref:`Callable<class_Callable>`, close_callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_popup_callbacks>`
  2814. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  2815. Registers callables to emit when the menu is respectively about to show or closed. Callback methods should have zero arguments.
  2816. .. rst-class:: classref-item-separator
  2817. ----
  2818. .. _class_DisplayServer_method_has_additional_outputs:
  2819. .. rst-class:: classref-method
  2820. :ref:`bool<class_bool>` **has_additional_outputs**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_has_additional_outputs>`
  2821. Returns ``true`` if any additional outputs have been registered via :ref:`register_additional_output()<class_DisplayServer_method_register_additional_output>`.
  2822. .. rst-class:: classref-item-separator
  2823. ----
  2824. .. _class_DisplayServer_method_has_feature:
  2825. .. rst-class:: classref-method
  2826. :ref:`bool<class_bool>` **has_feature**\ (\ feature\: :ref:`Feature<enum_DisplayServer_Feature>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_has_feature>`
  2827. Returns ``true`` if the specified ``feature`` is supported by the current **DisplayServer**, ``false`` otherwise.
  2828. .. rst-class:: classref-item-separator
  2829. ----
  2830. .. _class_DisplayServer_method_has_hardware_keyboard:
  2831. .. rst-class:: classref-method
  2832. :ref:`bool<class_bool>` **has_hardware_keyboard**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_has_hardware_keyboard>`
  2833. Returns ``true`` if a hardware keyboard is connected.
  2834. \ **Note:** This method is implemented on Android and iOS. On other platforms, this method always returns ``true``.
  2835. .. rst-class:: classref-item-separator
  2836. ----
  2837. .. _class_DisplayServer_method_help_set_search_callbacks:
  2838. .. rst-class:: classref-method
  2839. |void| **help_set_search_callbacks**\ (\ search_callback\: :ref:`Callable<class_Callable>`, action_callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_help_set_search_callbacks>`
  2840. Sets native help system search callbacks.
  2841. \ ``search_callback`` has the following arguments: ``String search_string, int result_limit`` and return a :ref:`Dictionary<class_Dictionary>` with "key, display name" pairs for the search results. Called when the user enters search terms in the ``Help`` menu.
  2842. \ ``action_callback`` has the following arguments: ``String key``. Called when the user selects a search result in the ``Help`` menu.
  2843. \ **Note:** This method is implemented only on macOS.
  2844. .. rst-class:: classref-item-separator
  2845. ----
  2846. .. _class_DisplayServer_method_ime_get_selection:
  2847. .. rst-class:: classref-method
  2848. :ref:`Vector2i<class_Vector2i>` **ime_get_selection**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_ime_get_selection>`
  2849. Returns the text selection in the `Input Method Editor <https://en.wikipedia.org/wiki/Input_method>`__ composition string, with the :ref:`Vector2i<class_Vector2i>`'s ``x`` component being the caret position and ``y`` being the length of the selection.
  2850. \ **Note:** This method is implemented only on macOS.
  2851. .. rst-class:: classref-item-separator
  2852. ----
  2853. .. _class_DisplayServer_method_ime_get_text:
  2854. .. rst-class:: classref-method
  2855. :ref:`String<class_String>` **ime_get_text**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_ime_get_text>`
  2856. Returns the composition string contained within the `Input Method Editor <https://en.wikipedia.org/wiki/Input_method>`__ window.
  2857. \ **Note:** This method is implemented only on macOS.
  2858. .. rst-class:: classref-item-separator
  2859. ----
  2860. .. _class_DisplayServer_method_is_dark_mode:
  2861. .. rst-class:: classref-method
  2862. :ref:`bool<class_bool>` **is_dark_mode**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_is_dark_mode>`
  2863. Returns ``true`` if OS is using dark mode.
  2864. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
  2865. .. rst-class:: classref-item-separator
  2866. ----
  2867. .. _class_DisplayServer_method_is_dark_mode_supported:
  2868. .. rst-class:: classref-method
  2869. :ref:`bool<class_bool>` **is_dark_mode_supported**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_is_dark_mode_supported>`
  2870. Returns ``true`` if OS supports dark mode.
  2871. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
  2872. .. rst-class:: classref-item-separator
  2873. ----
  2874. .. _class_DisplayServer_method_is_touchscreen_available:
  2875. .. rst-class:: classref-method
  2876. :ref:`bool<class_bool>` **is_touchscreen_available**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_is_touchscreen_available>`
  2877. Returns ``true`` if touch events are available (Android or iOS), the capability is detected on the Web platform or if :ref:`ProjectSettings.input_devices/pointing/emulate_touch_from_mouse<class_ProjectSettings_property_input_devices/pointing/emulate_touch_from_mouse>` is ``true``.
  2878. .. rst-class:: classref-item-separator
  2879. ----
  2880. .. _class_DisplayServer_method_is_window_transparency_available:
  2881. .. rst-class:: classref-method
  2882. :ref:`bool<class_bool>` **is_window_transparency_available**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_is_window_transparency_available>`
  2883. Returns ``true`` if the window background can be made transparent. This method returns ``false`` if :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>` is set to ``false``, or if transparency is not supported by the renderer or OS compositor.
  2884. .. rst-class:: classref-item-separator
  2885. ----
  2886. .. _class_DisplayServer_method_keyboard_get_current_layout:
  2887. .. rst-class:: classref-method
  2888. :ref:`int<class_int>` **keyboard_get_current_layout**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_current_layout>`
  2889. Returns active keyboard layout index.
  2890. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS, and Windows.
  2891. .. rst-class:: classref-item-separator
  2892. ----
  2893. .. _class_DisplayServer_method_keyboard_get_keycode_from_physical:
  2894. .. rst-class:: classref-method
  2895. :ref:`Key<enum_@GlobalScope_Key>` **keyboard_get_keycode_from_physical**\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_keycode_from_physical>`
  2896. Converts a physical (US QWERTY) ``keycode`` to one in the active keyboard layout.
  2897. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
  2898. .. rst-class:: classref-item-separator
  2899. ----
  2900. .. _class_DisplayServer_method_keyboard_get_label_from_physical:
  2901. .. rst-class:: classref-method
  2902. :ref:`Key<enum_@GlobalScope_Key>` **keyboard_get_label_from_physical**\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_label_from_physical>`
  2903. Converts a physical (US QWERTY) ``keycode`` to localized label printed on the key in the active keyboard layout.
  2904. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
  2905. .. rst-class:: classref-item-separator
  2906. ----
  2907. .. _class_DisplayServer_method_keyboard_get_layout_count:
  2908. .. rst-class:: classref-method
  2909. :ref:`int<class_int>` **keyboard_get_layout_count**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_layout_count>`
  2910. Returns the number of keyboard layouts.
  2911. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
  2912. .. rst-class:: classref-item-separator
  2913. ----
  2914. .. _class_DisplayServer_method_keyboard_get_layout_language:
  2915. .. rst-class:: classref-method
  2916. :ref:`String<class_String>` **keyboard_get_layout_language**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_layout_language>`
  2917. Returns the ISO-639/BCP-47 language code of the keyboard layout at position ``index``.
  2918. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
  2919. .. rst-class:: classref-item-separator
  2920. ----
  2921. .. _class_DisplayServer_method_keyboard_get_layout_name:
  2922. .. rst-class:: classref-method
  2923. :ref:`String<class_String>` **keyboard_get_layout_name**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_layout_name>`
  2924. Returns the localized name of the keyboard layout at position ``index``.
  2925. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
  2926. .. rst-class:: classref-item-separator
  2927. ----
  2928. .. _class_DisplayServer_method_keyboard_set_current_layout:
  2929. .. rst-class:: classref-method
  2930. |void| **keyboard_set_current_layout**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_set_current_layout>`
  2931. Sets the active keyboard layout.
  2932. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
  2933. .. rst-class:: classref-item-separator
  2934. ----
  2935. .. _class_DisplayServer_method_mouse_get_button_state:
  2936. .. rst-class:: classref-method
  2937. |bitfield|\[:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>`\] **mouse_get_button_state**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_mouse_get_button_state>`
  2938. Returns the current state of mouse buttons (whether each button is pressed) as a bitmask. If multiple mouse buttons are pressed at the same time, the bits are added together. Equivalent to :ref:`Input.get_mouse_button_mask()<class_Input_method_get_mouse_button_mask>`.
  2939. .. rst-class:: classref-item-separator
  2940. ----
  2941. .. _class_DisplayServer_method_mouse_get_mode:
  2942. .. rst-class:: classref-method
  2943. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **mouse_get_mode**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_mouse_get_mode>`
  2944. Returns the current mouse mode. See also :ref:`mouse_set_mode()<class_DisplayServer_method_mouse_set_mode>`.
  2945. .. rst-class:: classref-item-separator
  2946. ----
  2947. .. _class_DisplayServer_method_mouse_get_position:
  2948. .. rst-class:: classref-method
  2949. :ref:`Vector2i<class_Vector2i>` **mouse_get_position**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_mouse_get_position>`
  2950. Returns the mouse cursor's current position in screen coordinates.
  2951. .. rst-class:: classref-item-separator
  2952. ----
  2953. .. _class_DisplayServer_method_mouse_set_mode:
  2954. .. rst-class:: classref-method
  2955. |void| **mouse_set_mode**\ (\ mouse_mode\: :ref:`MouseMode<enum_DisplayServer_MouseMode>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_mouse_set_mode>`
  2956. Sets the current mouse mode. See also :ref:`mouse_get_mode()<class_DisplayServer_method_mouse_get_mode>`.
  2957. .. rst-class:: classref-item-separator
  2958. ----
  2959. .. _class_DisplayServer_method_process_events:
  2960. .. rst-class:: classref-method
  2961. |void| **process_events**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_process_events>`
  2962. Perform window manager processing, including input flushing. See also :ref:`force_process_and_drop_events()<class_DisplayServer_method_force_process_and_drop_events>`, :ref:`Input.flush_buffered_events()<class_Input_method_flush_buffered_events>` and :ref:`Input.use_accumulated_input<class_Input_property_use_accumulated_input>`.
  2963. .. rst-class:: classref-item-separator
  2964. ----
  2965. .. _class_DisplayServer_method_register_additional_output:
  2966. .. rst-class:: classref-method
  2967. |void| **register_additional_output**\ (\ object\: :ref:`Object<class_Object>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_register_additional_output>`
  2968. Registers an :ref:`Object<class_Object>` which represents an additional output that will be rendered too, beyond normal windows. The :ref:`Object<class_Object>` is only used as an identifier, which can be later passed to :ref:`unregister_additional_output()<class_DisplayServer_method_unregister_additional_output>`.
  2969. This can be used to prevent Godot from skipping rendering when no normal windows are visible.
  2970. .. rst-class:: classref-item-separator
  2971. ----
  2972. .. _class_DisplayServer_method_screen_get_dpi:
  2973. .. rst-class:: classref-method
  2974. :ref:`int<class_int>` **screen_get_dpi**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_dpi>`
  2975. Returns the dots per inch density of the specified screen. Returns platform specific default value if ``screen`` is invalid.
  2976. \ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
  2977. \ **Note:** On macOS, returned value is inaccurate if fractional display scaling mode is used.
  2978. \ **Note:** On Android devices, the actual screen densities are grouped into six generalized densities:
  2979. .. code:: text
  2980. ldpi - 120 dpi
  2981. mdpi - 160 dpi
  2982. hdpi - 240 dpi
  2983. xhdpi - 320 dpi
  2984. xxhdpi - 480 dpi
  2985. xxxhdpi - 640 dpi
  2986. \ **Note:** This method is implemented on Android, iOS, Linux (X11/Wayland), macOS, Web, and Windows. On other platforms, this method always returns ``72``.
  2987. .. rst-class:: classref-item-separator
  2988. ----
  2989. .. _class_DisplayServer_method_screen_get_image:
  2990. .. rst-class:: classref-method
  2991. :ref:`Image<class_Image>` **screen_get_image**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_image>`
  2992. Returns a screenshot of the ``screen``. Returns ``null`` if ``screen`` is invalid or the **DisplayServer** fails to capture screenshot.
  2993. \ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
  2994. \ **Note:** This method is implemented on Linux (X11, excluding XWayland), macOS, and Windows. On other platforms, this method always returns ``null``.
  2995. \ **Note:** On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a screenshot that will not include other application windows or OS elements not related to the application.
  2996. .. rst-class:: classref-item-separator
  2997. ----
  2998. .. _class_DisplayServer_method_screen_get_image_rect:
  2999. .. rst-class:: classref-method
  3000. :ref:`Image<class_Image>` **screen_get_image_rect**\ (\ rect\: :ref:`Rect2i<class_Rect2i>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_image_rect>`
  3001. Returns a screenshot of the screen region defined by ``rect``. Returns ``null`` if ``rect`` is outside screen bounds or the **DisplayServer** fails to capture screenshot.
  3002. \ **Note:** This method is implemented on macOS and Windows. On other platforms, this method always returns ``null``.
  3003. \ **Note:** On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a screenshot that will not include other application windows or OS elements not related to the application.
  3004. .. rst-class:: classref-item-separator
  3005. ----
  3006. .. _class_DisplayServer_method_screen_get_max_scale:
  3007. .. rst-class:: classref-method
  3008. :ref:`float<class_float>` **screen_get_max_scale**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_max_scale>`
  3009. Returns the greatest scale factor of all screens.
  3010. \ **Note:** On macOS returned value is ``2.0`` if there is at least one hiDPI (Retina) screen in the system, and ``1.0`` in all other cases.
  3011. \ **Note:** This method is implemented only on macOS.
  3012. .. rst-class:: classref-item-separator
  3013. ----
  3014. .. _class_DisplayServer_method_screen_get_orientation:
  3015. .. rst-class:: classref-method
  3016. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **screen_get_orientation**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_orientation>`
  3017. Returns the ``screen``'s current orientation. See also :ref:`screen_set_orientation()<class_DisplayServer_method_screen_set_orientation>`. Returns :ref:`SCREEN_LANDSCAPE<class_DisplayServer_constant_SCREEN_LANDSCAPE>` if ``screen`` is invalid.
  3018. \ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
  3019. \ **Note:** This method is implemented on Android and iOS. On other platforms, this method always returns :ref:`SCREEN_LANDSCAPE<class_DisplayServer_constant_SCREEN_LANDSCAPE>`.
  3020. .. rst-class:: classref-item-separator
  3021. ----
  3022. .. _class_DisplayServer_method_screen_get_pixel:
  3023. .. rst-class:: classref-method
  3024. :ref:`Color<class_Color>` **screen_get_pixel**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_pixel>`
  3025. Returns color of the display pixel at the ``position``.
  3026. \ **Note:** This method is implemented on Linux (X11, excluding XWayland), macOS, and Windows. On other platforms, this method always returns :ref:`Color<class_Color>`.
  3027. \ **Note:** On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a screenshot that will only contain the desktop wallpaper, the current application's window, and other related UI elements.
  3028. .. rst-class:: classref-item-separator
  3029. ----
  3030. .. _class_DisplayServer_method_screen_get_position:
  3031. .. rst-class:: classref-method
  3032. :ref:`Vector2i<class_Vector2i>` **screen_get_position**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_position>`
  3033. Returns the screen's top-left corner position in pixels. Returns :ref:`Vector2i.ZERO<class_Vector2i_constant_ZERO>` if ``screen`` is invalid. On multi-monitor setups, the screen position is relative to the virtual desktop area. On multi-monitor setups with different screen resolutions or orientations, the origin might be located outside any display like this:
  3034. .. code:: text
  3035. * (0, 0) +-------+
  3036. | |
  3037. +-------------+ | |
  3038. | | | |
  3039. | | | |
  3040. +-------------+ +-------+
  3041. See also :ref:`screen_get_size()<class_DisplayServer_method_screen_get_size>`.
  3042. \ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
  3043. .. rst-class:: classref-item-separator
  3044. ----
  3045. .. _class_DisplayServer_method_screen_get_refresh_rate:
  3046. .. rst-class:: classref-method
  3047. :ref:`float<class_float>` **screen_get_refresh_rate**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_refresh_rate>`
  3048. Returns the current refresh rate of the specified screen. Returns ``-1.0`` if ``screen`` is invalid or the **DisplayServer** fails to find the refresh rate for the specified screen.
  3049. To fallback to a default refresh rate if the method fails, try:
  3050. ::
  3051. var refresh_rate = DisplayServer.screen_get_refresh_rate()
  3052. if refresh_rate < 0:
  3053. refresh_rate = 60.0
  3054. \ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
  3055. \ **Note:** This method is implemented on Android, iOS, macOS, Linux (X11 and Wayland), and Windows. On other platforms, this method always returns ``-1.0``.
  3056. .. rst-class:: classref-item-separator
  3057. ----
  3058. .. _class_DisplayServer_method_screen_get_scale:
  3059. .. rst-class:: classref-method
  3060. :ref:`float<class_float>` **screen_get_scale**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_scale>`
  3061. Returns the scale factor of the specified screen by index. Returns ``1.0`` if ``screen`` is invalid.
  3062. \ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
  3063. \ **Note:** On macOS, the returned value is ``2.0`` for hiDPI (Retina) screens, and ``1.0`` for all other cases.
  3064. \ **Note:** On Linux (Wayland), the returned value is accurate only when ``screen`` is :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`. Due to API limitations, passing a direct index will return a rounded-up integer, if the screen has a fractional scale (e.g. ``1.25`` would get rounded up to ``2.0``).
  3065. \ **Note:** This method is implemented on Android, iOS, Web, macOS, and Linux (Wayland). On other platforms, this method always returns ``1.0``.
  3066. .. rst-class:: classref-item-separator
  3067. ----
  3068. .. _class_DisplayServer_method_screen_get_size:
  3069. .. rst-class:: classref-method
  3070. :ref:`Vector2i<class_Vector2i>` **screen_get_size**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_size>`
  3071. Returns the screen's size in pixels. See also :ref:`screen_get_position()<class_DisplayServer_method_screen_get_position>` and :ref:`screen_get_usable_rect()<class_DisplayServer_method_screen_get_usable_rect>`. Returns :ref:`Vector2i.ZERO<class_Vector2i_constant_ZERO>` if ``screen`` is invalid.
  3072. \ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
  3073. .. rst-class:: classref-item-separator
  3074. ----
  3075. .. _class_DisplayServer_method_screen_get_usable_rect:
  3076. .. rst-class:: classref-method
  3077. :ref:`Rect2i<class_Rect2i>` **screen_get_usable_rect**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_usable_rect>`
  3078. Returns the portion of the screen that is not obstructed by a status bar in pixels. See also :ref:`screen_get_size()<class_DisplayServer_method_screen_get_size>`.
  3079. \ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
  3080. \ **Note:** This method is implemented on Linux/X11, macOS, and Windows. On other platforms, this method always returns ``Rect2i(screen_get_position(screen), screen_get_size(screen))``.
  3081. .. rst-class:: classref-item-separator
  3082. ----
  3083. .. _class_DisplayServer_method_screen_is_kept_on:
  3084. .. rst-class:: classref-method
  3085. :ref:`bool<class_bool>` **screen_is_kept_on**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_is_kept_on>`
  3086. Returns ``true`` if the screen should never be turned off by the operating system's power-saving measures. See also :ref:`screen_set_keep_on()<class_DisplayServer_method_screen_set_keep_on>`.
  3087. .. rst-class:: classref-item-separator
  3088. ----
  3089. .. _class_DisplayServer_method_screen_set_keep_on:
  3090. .. rst-class:: classref-method
  3091. |void| **screen_set_keep_on**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_screen_set_keep_on>`
  3092. Sets whether the screen should never be turned off by the operating system's power-saving measures. See also :ref:`screen_is_kept_on()<class_DisplayServer_method_screen_is_kept_on>`.
  3093. .. rst-class:: classref-item-separator
  3094. ----
  3095. .. _class_DisplayServer_method_screen_set_orientation:
  3096. .. rst-class:: classref-method
  3097. |void| **screen_set_orientation**\ (\ orientation\: :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>`, screen\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_screen_set_orientation>`
  3098. Sets the ``screen``'s ``orientation``. See also :ref:`screen_get_orientation()<class_DisplayServer_method_screen_get_orientation>`.
  3099. \ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
  3100. \ **Note:** This method is implemented on Android and iOS.
  3101. \ **Note:** On iOS, this method has no effect if :ref:`ProjectSettings.display/window/handheld/orientation<class_ProjectSettings_property_display/window/handheld/orientation>` is not set to :ref:`SCREEN_SENSOR<class_DisplayServer_constant_SCREEN_SENSOR>`.
  3102. .. rst-class:: classref-item-separator
  3103. ----
  3104. .. _class_DisplayServer_method_set_hardware_keyboard_connection_change_callback:
  3105. .. rst-class:: classref-method
  3106. |void| **set_hardware_keyboard_connection_change_callback**\ (\ callable\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_set_hardware_keyboard_connection_change_callback>`
  3107. Sets the ``callable`` that should be called when hardware keyboard is connected/disconnected. ``callable`` should accept a single :ref:`bool<class_bool>` parameter indicating whether the keyboard is connected (true) or disconnected (false).
  3108. \ **Note:** This method is only implemented on Android.
  3109. .. rst-class:: classref-item-separator
  3110. ----
  3111. .. _class_DisplayServer_method_set_icon:
  3112. .. rst-class:: classref-method
  3113. |void| **set_icon**\ (\ image\: :ref:`Image<class_Image>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_set_icon>`
  3114. Sets the window icon (usually displayed in the top-left corner) with an :ref:`Image<class_Image>`. To use icons in the operating system's native format, use :ref:`set_native_icon()<class_DisplayServer_method_set_native_icon>` instead.
  3115. \ **Note:** Requires support for :ref:`FEATURE_ICON<class_DisplayServer_constant_FEATURE_ICON>`.
  3116. .. rst-class:: classref-item-separator
  3117. ----
  3118. .. _class_DisplayServer_method_set_native_icon:
  3119. .. rst-class:: classref-method
  3120. |void| **set_native_icon**\ (\ filename\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_set_native_icon>`
  3121. Sets the window icon (usually displayed in the top-left corner) in the operating system's *native* format. The file at ``filename`` must be in ``.ico`` format on Windows or ``.icns`` on macOS. By using specially crafted ``.ico`` or ``.icns`` icons, :ref:`set_native_icon()<class_DisplayServer_method_set_native_icon>` allows specifying different icons depending on the size the icon is displayed at. This size is determined by the operating system and user preferences (including the display scale factor). To use icons in other formats, use :ref:`set_icon()<class_DisplayServer_method_set_icon>` instead.
  3122. \ **Note:** Requires support for :ref:`FEATURE_NATIVE_ICON<class_DisplayServer_constant_FEATURE_NATIVE_ICON>`.
  3123. .. rst-class:: classref-item-separator
  3124. ----
  3125. .. _class_DisplayServer_method_set_system_theme_change_callback:
  3126. .. rst-class:: classref-method
  3127. |void| **set_system_theme_change_callback**\ (\ callable\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_set_system_theme_change_callback>`
  3128. Sets the ``callable`` that should be called when system theme settings are changed. Callback method should have zero arguments.
  3129. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
  3130. .. rst-class:: classref-item-separator
  3131. ----
  3132. .. _class_DisplayServer_method_show_emoji_and_symbol_picker:
  3133. .. rst-class:: classref-method
  3134. |void| **show_emoji_and_symbol_picker**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_show_emoji_and_symbol_picker>`
  3135. Opens system emoji and symbol picker.
  3136. \ **Note:** This method is implemented on macOS and Windows.
  3137. .. rst-class:: classref-item-separator
  3138. ----
  3139. .. _class_DisplayServer_method_status_indicator_get_rect:
  3140. .. rst-class:: classref-method
  3141. :ref:`Rect2<class_Rect2>` **status_indicator_get_rect**\ (\ id\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_status_indicator_get_rect>`
  3142. Returns the rectangle for the given status indicator ``id`` in screen coordinates. If the status indicator is not visible, returns an empty :ref:`Rect2<class_Rect2>`.
  3143. \ **Note:** This method is implemented on macOS and Windows.
  3144. .. rst-class:: classref-item-separator
  3145. ----
  3146. .. _class_DisplayServer_method_status_indicator_set_callback:
  3147. .. rst-class:: classref-method
  3148. |void| **status_indicator_set_callback**\ (\ id\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_status_indicator_set_callback>`
  3149. Sets the application status indicator activation callback. ``callback`` should take two arguments: :ref:`int<class_int>` mouse button index (one of :ref:`MouseButton<enum_@GlobalScope_MouseButton>` values) and :ref:`Vector2i<class_Vector2i>` click position in screen coordinates.
  3150. \ **Note:** This method is implemented on macOS and Windows.
  3151. .. rst-class:: classref-item-separator
  3152. ----
  3153. .. _class_DisplayServer_method_status_indicator_set_icon:
  3154. .. rst-class:: classref-method
  3155. |void| **status_indicator_set_icon**\ (\ id\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_status_indicator_set_icon>`
  3156. Sets the application status indicator icon.
  3157. \ **Note:** This method is implemented on macOS and Windows.
  3158. .. rst-class:: classref-item-separator
  3159. ----
  3160. .. _class_DisplayServer_method_status_indicator_set_menu:
  3161. .. rst-class:: classref-method
  3162. |void| **status_indicator_set_menu**\ (\ id\: :ref:`int<class_int>`, menu_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_status_indicator_set_menu>`
  3163. Sets the application status indicator native popup menu.
  3164. \ **Note:** On macOS, the menu is activated by any mouse button. Its activation callback is *not* triggered.
  3165. \ **Note:** On Windows, the menu is activated by the right mouse button, selecting the status icon and pressing :kbd:`Shift + F10`, or the applications key. The menu's activation callback for the other mouse buttons is still triggered.
  3166. \ **Note:** Native popup is only supported if :ref:`NativeMenu<class_NativeMenu>` supports the :ref:`NativeMenu.FEATURE_POPUP_MENU<class_NativeMenu_constant_FEATURE_POPUP_MENU>` feature.
  3167. .. rst-class:: classref-item-separator
  3168. ----
  3169. .. _class_DisplayServer_method_status_indicator_set_tooltip:
  3170. .. rst-class:: classref-method
  3171. |void| **status_indicator_set_tooltip**\ (\ id\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_status_indicator_set_tooltip>`
  3172. Sets the application status indicator tooltip.
  3173. \ **Note:** This method is implemented on macOS and Windows.
  3174. .. rst-class:: classref-item-separator
  3175. ----
  3176. .. _class_DisplayServer_method_tablet_get_current_driver:
  3177. .. rst-class:: classref-method
  3178. :ref:`String<class_String>` **tablet_get_current_driver**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tablet_get_current_driver>`
  3179. Returns current active tablet driver name.
  3180. \ **Note:** This method is implemented only on Windows.
  3181. .. rst-class:: classref-item-separator
  3182. ----
  3183. .. _class_DisplayServer_method_tablet_get_driver_count:
  3184. .. rst-class:: classref-method
  3185. :ref:`int<class_int>` **tablet_get_driver_count**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tablet_get_driver_count>`
  3186. Returns the total number of available tablet drivers.
  3187. \ **Note:** This method is implemented only on Windows.
  3188. .. rst-class:: classref-item-separator
  3189. ----
  3190. .. _class_DisplayServer_method_tablet_get_driver_name:
  3191. .. rst-class:: classref-method
  3192. :ref:`String<class_String>` **tablet_get_driver_name**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tablet_get_driver_name>`
  3193. Returns the tablet driver name for the given index.
  3194. \ **Note:** This method is implemented only on Windows.
  3195. .. rst-class:: classref-item-separator
  3196. ----
  3197. .. _class_DisplayServer_method_tablet_set_current_driver:
  3198. .. rst-class:: classref-method
  3199. |void| **tablet_set_current_driver**\ (\ name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tablet_set_current_driver>`
  3200. Set active tablet driver name.
  3201. Supported drivers:
  3202. - ``winink``: Windows Ink API, default.
  3203. - ``wintab``: Wacom Wintab API (compatible device driver required).
  3204. - ``dummy``: Dummy driver, tablet input is disabled.
  3205. \ **Note:** This method is implemented only on Windows.
  3206. .. rst-class:: classref-item-separator
  3207. ----
  3208. .. _class_DisplayServer_method_tts_get_voices:
  3209. .. rst-class:: classref-method
  3210. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **tts_get_voices**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tts_get_voices>`
  3211. Returns an :ref:`Array<class_Array>` of voice information dictionaries.
  3212. Each :ref:`Dictionary<class_Dictionary>` contains two :ref:`String<class_String>` entries:
  3213. - ``name`` is voice name.
  3214. - ``id`` is voice identifier.
  3215. - ``language`` is language code in ``lang_Variant`` format. The ``lang`` part is a 2 or 3-letter code based on the ISO-639 standard, in lowercase. The ``Variant`` part is an engine-dependent string describing country, region or/and dialect.
  3216. Note that Godot depends on system libraries for text-to-speech functionality. These libraries are installed by default on Windows and macOS, but not on all Linux distributions. If they are not present, this method will return an empty list. This applies to both Godot users on Linux, as well as end-users on Linux running Godot games that use text-to-speech.
  3217. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  3218. .. rst-class:: classref-item-separator
  3219. ----
  3220. .. _class_DisplayServer_method_tts_get_voices_for_language:
  3221. .. rst-class:: classref-method
  3222. :ref:`PackedStringArray<class_PackedStringArray>` **tts_get_voices_for_language**\ (\ language\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tts_get_voices_for_language>`
  3223. Returns an :ref:`PackedStringArray<class_PackedStringArray>` of voice identifiers for the ``language``.
  3224. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  3225. .. rst-class:: classref-item-separator
  3226. ----
  3227. .. _class_DisplayServer_method_tts_is_paused:
  3228. .. rst-class:: classref-method
  3229. :ref:`bool<class_bool>` **tts_is_paused**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tts_is_paused>`
  3230. Returns ``true`` if the synthesizer is in a paused state.
  3231. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  3232. .. rst-class:: classref-item-separator
  3233. ----
  3234. .. _class_DisplayServer_method_tts_is_speaking:
  3235. .. rst-class:: classref-method
  3236. :ref:`bool<class_bool>` **tts_is_speaking**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tts_is_speaking>`
  3237. Returns ``true`` if the synthesizer is generating speech, or have utterance waiting in the queue.
  3238. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  3239. .. rst-class:: classref-item-separator
  3240. ----
  3241. .. _class_DisplayServer_method_tts_pause:
  3242. .. rst-class:: classref-method
  3243. |void| **tts_pause**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tts_pause>`
  3244. Puts the synthesizer into a paused state.
  3245. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  3246. .. rst-class:: classref-item-separator
  3247. ----
  3248. .. _class_DisplayServer_method_tts_resume:
  3249. .. rst-class:: classref-method
  3250. |void| **tts_resume**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tts_resume>`
  3251. Resumes the synthesizer if it was paused.
  3252. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  3253. .. rst-class:: classref-item-separator
  3254. ----
  3255. .. _class_DisplayServer_method_tts_set_utterance_callback:
  3256. .. rst-class:: classref-method
  3257. |void| **tts_set_utterance_callback**\ (\ event\: :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>`, callable\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tts_set_utterance_callback>`
  3258. Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary.
  3259. - :ref:`TTS_UTTERANCE_STARTED<class_DisplayServer_constant_TTS_UTTERANCE_STARTED>`, :ref:`TTS_UTTERANCE_ENDED<class_DisplayServer_constant_TTS_UTTERANCE_ENDED>`, and :ref:`TTS_UTTERANCE_CANCELED<class_DisplayServer_constant_TTS_UTTERANCE_CANCELED>` callable's method should take one :ref:`int<class_int>` parameter, the utterance ID.
  3260. - :ref:`TTS_UTTERANCE_BOUNDARY<class_DisplayServer_constant_TTS_UTTERANCE_BOUNDARY>` callable's method should take two :ref:`int<class_int>` parameters, the index of the character and the utterance ID.
  3261. \ **Note:** The granularity of the boundary callbacks is engine dependent.
  3262. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  3263. .. rst-class:: classref-item-separator
  3264. ----
  3265. .. _class_DisplayServer_method_tts_speak:
  3266. .. rst-class:: classref-method
  3267. |void| **tts_speak**\ (\ text\: :ref:`String<class_String>`, voice\: :ref:`String<class_String>`, volume\: :ref:`int<class_int>` = 50, pitch\: :ref:`float<class_float>` = 1.0, rate\: :ref:`float<class_float>` = 1.0, utterance_id\: :ref:`int<class_int>` = 0, interrupt\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tts_speak>`
  3268. Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is cleared first.
  3269. - ``voice`` identifier is one of the ``"id"`` values returned by :ref:`tts_get_voices()<class_DisplayServer_method_tts_get_voices>` or one of the values returned by :ref:`tts_get_voices_for_language()<class_DisplayServer_method_tts_get_voices_for_language>`.
  3270. - ``volume`` ranges from ``0`` (lowest) to ``100`` (highest).
  3271. - ``pitch`` ranges from ``0.0`` (lowest) to ``2.0`` (highest), ``1.0`` is default pitch for the current voice.
  3272. - ``rate`` ranges from ``0.1`` (lowest) to ``10.0`` (highest), ``1.0`` is a normal speaking rate. Other values act as a percentage relative.
  3273. - ``utterance_id`` is passed as a parameter to the callback functions.
  3274. \ **Note:** On Windows and Linux (X11/Wayland), utterance ``text`` can use SSML markup. SSML support is engine and voice dependent. If the engine does not support SSML, you should strip out all XML markup before calling :ref:`tts_speak()<class_DisplayServer_method_tts_speak>`.
  3275. \ **Note:** The granularity of pitch, rate, and volume is engine and voice dependent. Values may be truncated.
  3276. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  3277. .. rst-class:: classref-item-separator
  3278. ----
  3279. .. _class_DisplayServer_method_tts_stop:
  3280. .. rst-class:: classref-method
  3281. |void| **tts_stop**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tts_stop>`
  3282. Stops synthesis in progress and removes all utterances from the queue.
  3283. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Linux), macOS, and Windows.
  3284. .. rst-class:: classref-item-separator
  3285. ----
  3286. .. _class_DisplayServer_method_unregister_additional_output:
  3287. .. rst-class:: classref-method
  3288. |void| **unregister_additional_output**\ (\ object\: :ref:`Object<class_Object>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_unregister_additional_output>`
  3289. Unregisters an :ref:`Object<class_Object>` representing an additional output, that was registered via :ref:`register_additional_output()<class_DisplayServer_method_register_additional_output>`.
  3290. .. rst-class:: classref-item-separator
  3291. ----
  3292. .. _class_DisplayServer_method_virtual_keyboard_get_height:
  3293. .. rst-class:: classref-method
  3294. :ref:`int<class_int>` **virtual_keyboard_get_height**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_virtual_keyboard_get_height>`
  3295. Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.
  3296. .. rst-class:: classref-item-separator
  3297. ----
  3298. .. _class_DisplayServer_method_virtual_keyboard_hide:
  3299. .. rst-class:: classref-method
  3300. |void| **virtual_keyboard_hide**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_virtual_keyboard_hide>`
  3301. Hides the virtual keyboard if it is shown, does nothing otherwise.
  3302. .. rst-class:: classref-item-separator
  3303. ----
  3304. .. _class_DisplayServer_method_virtual_keyboard_show:
  3305. .. rst-class:: classref-method
  3306. |void| **virtual_keyboard_show**\ (\ existing_text\: :ref:`String<class_String>`, position\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0), type\: :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` = 0, max_length\: :ref:`int<class_int>` = -1, cursor_start\: :ref:`int<class_int>` = -1, cursor_end\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_virtual_keyboard_show>`
  3307. Shows the virtual keyboard if the platform has one.
  3308. \ ``existing_text`` parameter is useful for implementing your own :ref:`LineEdit<class_LineEdit>` or :ref:`TextEdit<class_TextEdit>`, as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions).
  3309. \ ``position`` parameter is the screen space :ref:`Rect2<class_Rect2>` of the edited text.
  3310. \ ``type`` parameter allows configuring which type of virtual keyboard to show.
  3311. \ ``max_length`` limits the number of characters that can be entered if different from ``-1``.
  3312. \ ``cursor_start`` can optionally define the current text cursor position if ``cursor_end`` is not set.
  3313. \ ``cursor_start`` and ``cursor_end`` can optionally define the current text selection.
  3314. \ **Note:** This method is implemented on Android, iOS and Web.
  3315. .. rst-class:: classref-item-separator
  3316. ----
  3317. .. _class_DisplayServer_method_warp_mouse:
  3318. .. rst-class:: classref-method
  3319. |void| **warp_mouse**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_warp_mouse>`
  3320. Sets the mouse cursor position to the given ``position`` relative to an origin at the upper left corner of the currently focused game Window Manager window.
  3321. \ **Note:** :ref:`warp_mouse()<class_DisplayServer_method_warp_mouse>` is only supported on Windows, macOS, and Linux (X11/Wayland). It has no effect on Android, iOS, and Web.
  3322. .. rst-class:: classref-item-separator
  3323. ----
  3324. .. _class_DisplayServer_method_window_can_draw:
  3325. .. rst-class:: classref-method
  3326. :ref:`bool<class_bool>` **window_can_draw**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_can_draw>`
  3327. Returns ``true`` if anything can be drawn in the window specified by ``window_id``, ``false`` otherwise. Using the ``--disable-render-loop`` command line argument or a headless build will return ``false``.
  3328. .. rst-class:: classref-item-separator
  3329. ----
  3330. .. _class_DisplayServer_method_window_get_active_popup:
  3331. .. rst-class:: classref-method
  3332. :ref:`int<class_int>` **window_get_active_popup**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_active_popup>`
  3333. Returns ID of the active popup window, or :ref:`INVALID_WINDOW_ID<class_DisplayServer_constant_INVALID_WINDOW_ID>` if there is none.
  3334. .. rst-class:: classref-item-separator
  3335. ----
  3336. .. _class_DisplayServer_method_window_get_attached_instance_id:
  3337. .. rst-class:: classref-method
  3338. :ref:`int<class_int>` **window_get_attached_instance_id**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_attached_instance_id>`
  3339. Returns the :ref:`Object.get_instance_id()<class_Object_method_get_instance_id>` of the :ref:`Window<class_Window>` the ``window_id`` is attached to.
  3340. .. rst-class:: classref-item-separator
  3341. ----
  3342. .. _class_DisplayServer_method_window_get_current_screen:
  3343. .. rst-class:: classref-method
  3344. :ref:`int<class_int>` **window_get_current_screen**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_current_screen>`
  3345. Returns the screen the window specified by ``window_id`` is currently positioned on. If the screen overlaps multiple displays, the screen where the window's center is located is returned. See also :ref:`window_set_current_screen()<class_DisplayServer_method_window_set_current_screen>`. Returns :ref:`INVALID_SCREEN<class_DisplayServer_constant_INVALID_SCREEN>` if ``window_id`` is invalid.
  3346. \ **Note:** This method is implemented on Linux/X11, macOS, and Windows. On other platforms, this method always returns ``0``.
  3347. .. rst-class:: classref-item-separator
  3348. ----
  3349. .. _class_DisplayServer_method_window_get_flag:
  3350. .. rst-class:: classref-method
  3351. :ref:`bool<class_bool>` **window_get_flag**\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_flag>`
  3352. Returns the current value of the given window's ``flag``.
  3353. .. rst-class:: classref-item-separator
  3354. ----
  3355. .. _class_DisplayServer_method_window_get_max_size:
  3356. .. rst-class:: classref-method
  3357. :ref:`Vector2i<class_Vector2i>` **window_get_max_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_max_size>`
  3358. Returns the window's maximum size (in pixels). See also :ref:`window_set_max_size()<class_DisplayServer_method_window_set_max_size>`.
  3359. .. rst-class:: classref-item-separator
  3360. ----
  3361. .. _class_DisplayServer_method_window_get_min_size:
  3362. .. rst-class:: classref-method
  3363. :ref:`Vector2i<class_Vector2i>` **window_get_min_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_min_size>`
  3364. Returns the window's minimum size (in pixels). See also :ref:`window_set_min_size()<class_DisplayServer_method_window_set_min_size>`.
  3365. .. rst-class:: classref-item-separator
  3366. ----
  3367. .. _class_DisplayServer_method_window_get_mode:
  3368. .. rst-class:: classref-method
  3369. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **window_get_mode**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_mode>`
  3370. Returns the mode of the given window.
  3371. .. rst-class:: classref-item-separator
  3372. ----
  3373. .. _class_DisplayServer_method_window_get_native_handle:
  3374. .. rst-class:: classref-method
  3375. :ref:`int<class_int>` **window_get_native_handle**\ (\ handle_type\: :ref:`HandleType<enum_DisplayServer_HandleType>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_native_handle>`
  3376. Returns internal structure pointers for use in plugins.
  3377. \ **Note:** This method is implemented on Android, Linux (X11/Wayland), macOS, and Windows.
  3378. .. rst-class:: classref-item-separator
  3379. ----
  3380. .. _class_DisplayServer_method_window_get_popup_safe_rect:
  3381. .. rst-class:: classref-method
  3382. :ref:`Rect2i<class_Rect2i>` **window_get_popup_safe_rect**\ (\ window\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_popup_safe_rect>`
  3383. Returns the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system.
  3384. .. rst-class:: classref-item-separator
  3385. ----
  3386. .. _class_DisplayServer_method_window_get_position:
  3387. .. rst-class:: classref-method
  3388. :ref:`Vector2i<class_Vector2i>` **window_get_position**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_position>`
  3389. Returns the position of the client area of the given window on the screen.
  3390. .. rst-class:: classref-item-separator
  3391. ----
  3392. .. _class_DisplayServer_method_window_get_position_with_decorations:
  3393. .. rst-class:: classref-method
  3394. :ref:`Vector2i<class_Vector2i>` **window_get_position_with_decorations**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_position_with_decorations>`
  3395. Returns the position of the given window on the screen including the borders drawn by the operating system. See also :ref:`window_get_position()<class_DisplayServer_method_window_get_position>`.
  3396. .. rst-class:: classref-item-separator
  3397. ----
  3398. .. _class_DisplayServer_method_window_get_safe_title_margins:
  3399. .. rst-class:: classref-method
  3400. :ref:`Vector3i<class_Vector3i>` **window_get_safe_title_margins**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_safe_title_margins>`
  3401. Returns left margins (``x``), right margins (``y``) and height (``z``) of the title that are safe to use (contains no buttons or other elements) when :ref:`WINDOW_FLAG_EXTEND_TO_TITLE<class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE>` flag is set.
  3402. .. rst-class:: classref-item-separator
  3403. ----
  3404. .. _class_DisplayServer_method_window_get_size:
  3405. .. rst-class:: classref-method
  3406. :ref:`Vector2i<class_Vector2i>` **window_get_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_size>`
  3407. Returns the size of the window specified by ``window_id`` (in pixels), excluding the borders drawn by the operating system. This is also called the "client area". See also :ref:`window_get_size_with_decorations()<class_DisplayServer_method_window_get_size_with_decorations>`, :ref:`window_set_size()<class_DisplayServer_method_window_set_size>` and :ref:`window_get_position()<class_DisplayServer_method_window_get_position>`.
  3408. .. rst-class:: classref-item-separator
  3409. ----
  3410. .. _class_DisplayServer_method_window_get_size_with_decorations:
  3411. .. rst-class:: classref-method
  3412. :ref:`Vector2i<class_Vector2i>` **window_get_size_with_decorations**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_size_with_decorations>`
  3413. Returns the size of the window specified by ``window_id`` (in pixels), including the borders drawn by the operating system. See also :ref:`window_get_size()<class_DisplayServer_method_window_get_size>`.
  3414. .. rst-class:: classref-item-separator
  3415. ----
  3416. .. _class_DisplayServer_method_window_get_title_size:
  3417. .. rst-class:: classref-method
  3418. :ref:`Vector2i<class_Vector2i>` **window_get_title_size**\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_title_size>`
  3419. Returns the estimated window title bar size (including text and window buttons) for the window specified by ``window_id`` (in pixels). This method does not change the window title.
  3420. \ **Note:** This method is implemented on macOS and Windows.
  3421. .. rst-class:: classref-item-separator
  3422. ----
  3423. .. _class_DisplayServer_method_window_get_vsync_mode:
  3424. .. rst-class:: classref-method
  3425. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **window_get_vsync_mode**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_vsync_mode>`
  3426. Returns the V-Sync mode of the given window.
  3427. .. rst-class:: classref-item-separator
  3428. ----
  3429. .. _class_DisplayServer_method_window_is_focused:
  3430. .. rst-class:: classref-method
  3431. :ref:`bool<class_bool>` **window_is_focused**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_is_focused>`
  3432. Returns ``true`` if the window specified by ``window_id`` is focused.
  3433. .. rst-class:: classref-item-separator
  3434. ----
  3435. .. _class_DisplayServer_method_window_is_maximize_allowed:
  3436. .. rst-class:: classref-method
  3437. :ref:`bool<class_bool>` **window_is_maximize_allowed**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_is_maximize_allowed>`
  3438. Returns ``true`` if the given window can be maximized (the maximize button is enabled).
  3439. .. rst-class:: classref-item-separator
  3440. ----
  3441. .. _class_DisplayServer_method_window_maximize_on_title_dbl_click:
  3442. .. rst-class:: classref-method
  3443. :ref:`bool<class_bool>` **window_maximize_on_title_dbl_click**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_maximize_on_title_dbl_click>`
  3444. Returns ``true``, if double-click on a window title should maximize it.
  3445. \ **Note:** This method is implemented only on macOS.
  3446. .. rst-class:: classref-item-separator
  3447. ----
  3448. .. _class_DisplayServer_method_window_minimize_on_title_dbl_click:
  3449. .. rst-class:: classref-method
  3450. :ref:`bool<class_bool>` **window_minimize_on_title_dbl_click**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_minimize_on_title_dbl_click>`
  3451. Returns ``true``, if double-click on a window title should minimize it.
  3452. \ **Note:** This method is implemented only on macOS.
  3453. .. rst-class:: classref-item-separator
  3454. ----
  3455. .. _class_DisplayServer_method_window_move_to_foreground:
  3456. .. rst-class:: classref-method
  3457. |void| **window_move_to_foreground**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_move_to_foreground>`
  3458. Moves the window specified by ``window_id`` to the foreground, so that it is visible over other windows.
  3459. .. rst-class:: classref-item-separator
  3460. ----
  3461. .. _class_DisplayServer_method_window_request_attention:
  3462. .. rst-class:: classref-method
  3463. |void| **window_request_attention**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_request_attention>`
  3464. Makes the window specified by ``window_id`` request attention, which is materialized by the window title and taskbar entry blinking until the window is focused. This usually has no visible effect if the window is currently focused. The exact behavior varies depending on the operating system.
  3465. .. rst-class:: classref-item-separator
  3466. ----
  3467. .. _class_DisplayServer_method_window_set_current_screen:
  3468. .. rst-class:: classref-method
  3469. |void| **window_set_current_screen**\ (\ screen\: :ref:`int<class_int>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_current_screen>`
  3470. Moves the window specified by ``window_id`` to the specified ``screen``. See also :ref:`window_get_current_screen()<class_DisplayServer_method_window_get_current_screen>`.
  3471. \ **Note:** One of the following constants can be used as ``screen``: :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`, :ref:`SCREEN_PRIMARY<class_DisplayServer_constant_SCREEN_PRIMARY>`, :ref:`SCREEN_WITH_MOUSE_FOCUS<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`, or :ref:`SCREEN_WITH_KEYBOARD_FOCUS<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`.
  3472. \ **Note:** This method is implemented on Linux/X11, macOS, and Windows.
  3473. .. rst-class:: classref-item-separator
  3474. ----
  3475. .. _class_DisplayServer_method_window_set_drop_files_callback:
  3476. .. rst-class:: classref-method
  3477. |void| **window_set_drop_files_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_drop_files_callback>`
  3478. Sets the ``callback`` that should be called when files are dropped from the operating system's file manager to the window specified by ``window_id``. ``callback`` should take one :ref:`PackedStringArray<class_PackedStringArray>` argument, which is the list of dropped files.
  3479. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
  3480. \ **Note:** This method is implemented on Windows, macOS, Linux (X11/Wayland), and Web.
  3481. .. rst-class:: classref-item-separator
  3482. ----
  3483. .. _class_DisplayServer_method_window_set_exclusive:
  3484. .. rst-class:: classref-method
  3485. |void| **window_set_exclusive**\ (\ window_id\: :ref:`int<class_int>`, exclusive\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_exclusive>`
  3486. If set to ``true``, this window will always stay on top of its parent window, parent window will ignore input while this window is opened.
  3487. \ **Note:** On macOS, exclusive windows are confined to the same space (virtual desktop or screen) as the parent window.
  3488. \ **Note:** This method is implemented on macOS and Windows.
  3489. .. rst-class:: classref-item-separator
  3490. ----
  3491. .. _class_DisplayServer_method_window_set_flag:
  3492. .. rst-class:: classref-method
  3493. |void| **window_set_flag**\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, enabled\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_flag>`
  3494. Enables or disables the given window's given ``flag``.
  3495. .. rst-class:: classref-item-separator
  3496. ----
  3497. .. _class_DisplayServer_method_window_set_ime_active:
  3498. .. rst-class:: classref-method
  3499. |void| **window_set_ime_active**\ (\ active\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_ime_active>`
  3500. Sets whether `Input Method Editor <https://en.wikipedia.org/wiki/Input_method>`__ should be enabled for the window specified by ``window_id``. See also :ref:`window_set_ime_position()<class_DisplayServer_method_window_set_ime_position>`.
  3501. .. rst-class:: classref-item-separator
  3502. ----
  3503. .. _class_DisplayServer_method_window_set_ime_position:
  3504. .. rst-class:: classref-method
  3505. |void| **window_set_ime_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_ime_position>`
  3506. Sets the position of the `Input Method Editor <https://en.wikipedia.org/wiki/Input_method>`__ popup for the specified ``window_id``. Only effective if :ref:`window_set_ime_active()<class_DisplayServer_method_window_set_ime_active>` was set to ``true`` for the specified ``window_id``.
  3507. .. rst-class:: classref-item-separator
  3508. ----
  3509. .. _class_DisplayServer_method_window_set_input_event_callback:
  3510. .. rst-class:: classref-method
  3511. |void| **window_set_input_event_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_input_event_callback>`
  3512. Sets the ``callback`` that should be called when any :ref:`InputEvent<class_InputEvent>` is sent to the window specified by ``window_id``.
  3513. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
  3514. .. rst-class:: classref-item-separator
  3515. ----
  3516. .. _class_DisplayServer_method_window_set_input_text_callback:
  3517. .. rst-class:: classref-method
  3518. |void| **window_set_input_text_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_input_text_callback>`
  3519. Sets the ``callback`` that should be called when text is entered using the virtual keyboard to the window specified by ``window_id``.
  3520. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
  3521. .. rst-class:: classref-item-separator
  3522. ----
  3523. .. _class_DisplayServer_method_window_set_max_size:
  3524. .. rst-class:: classref-method
  3525. |void| **window_set_max_size**\ (\ max_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_max_size>`
  3526. Sets the maximum size of the window specified by ``window_id`` in pixels. Normally, the user will not be able to drag the window to make it larger than the specified size. See also :ref:`window_get_max_size()<class_DisplayServer_method_window_get_max_size>`.
  3527. \ **Note:** It's recommended to change this value using :ref:`Window.max_size<class_Window_property_max_size>` instead.
  3528. \ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.
  3529. .. rst-class:: classref-item-separator
  3530. ----
  3531. .. _class_DisplayServer_method_window_set_min_size:
  3532. .. rst-class:: classref-method
  3533. |void| **window_set_min_size**\ (\ min_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_min_size>`
  3534. Sets the minimum size for the given window to ``min_size`` in pixels. Normally, the user will not be able to drag the window to make it smaller than the specified size. See also :ref:`window_get_min_size()<class_DisplayServer_method_window_get_min_size>`.
  3535. \ **Note:** It's recommended to change this value using :ref:`Window.min_size<class_Window_property_min_size>` instead.
  3536. \ **Note:** By default, the main window has a minimum size of ``Vector2i(64, 64)``. This prevents issues that can arise when the window is resized to a near-zero size.
  3537. \ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.
  3538. .. rst-class:: classref-item-separator
  3539. ----
  3540. .. _class_DisplayServer_method_window_set_mode:
  3541. .. rst-class:: classref-method
  3542. |void| **window_set_mode**\ (\ mode\: :ref:`WindowMode<enum_DisplayServer_WindowMode>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_mode>`
  3543. Sets window mode for the given window to ``mode``.
  3544. \ **Note:** On Android, setting it to :ref:`WINDOW_MODE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN>` or :ref:`WINDOW_MODE_EXCLUSIVE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN>` will enable immersive mode.
  3545. \ **Note:** Setting the window to full screen forcibly sets the borderless flag to ``true``, so make sure to set it back to ``false`` when not wanted.
  3546. .. rst-class:: classref-item-separator
  3547. ----
  3548. .. _class_DisplayServer_method_window_set_mouse_passthrough:
  3549. .. rst-class:: classref-method
  3550. |void| **window_set_mouse_passthrough**\ (\ region\: :ref:`PackedVector2Array<class_PackedVector2Array>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_mouse_passthrough>`
  3551. Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through.
  3552. Passing an empty array will disable passthrough support (all mouse events will be intercepted by the window, which is the default behavior).
  3553. .. tabs::
  3554. .. code-tab:: gdscript
  3555. # Set region, using Path2D node.
  3556. DisplayServer.window_set_mouse_passthrough($Path2D.curve.get_baked_points())
  3557. # Set region, using Polygon2D node.
  3558. DisplayServer.window_set_mouse_passthrough($Polygon2D.polygon)
  3559. # Reset region to default.
  3560. DisplayServer.window_set_mouse_passthrough([])
  3561. .. code-tab:: csharp
  3562. // Set region, using Path2D node.
  3563. DisplayServer.WindowSetMousePassthrough(GetNode<Path2D>("Path2D").Curve.GetBakedPoints());
  3564. // Set region, using Polygon2D node.
  3565. DisplayServer.WindowSetMousePassthrough(GetNode<Polygon2D>("Polygon2D").Polygon);
  3566. // Reset region to default.
  3567. DisplayServer.WindowSetMousePassthrough([]);
  3568. \ **Note:** On Windows, the portion of a window that lies outside the region is not drawn, while on Linux (X11) and macOS it is.
  3569. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
  3570. .. rst-class:: classref-item-separator
  3571. ----
  3572. .. _class_DisplayServer_method_window_set_popup_safe_rect:
  3573. .. rst-class:: classref-method
  3574. |void| **window_set_popup_safe_rect**\ (\ window\: :ref:`int<class_int>`, rect\: :ref:`Rect2i<class_Rect2i>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_popup_safe_rect>`
  3575. Sets the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system. Clicking this area will not auto-close this popup.
  3576. .. rst-class:: classref-item-separator
  3577. ----
  3578. .. _class_DisplayServer_method_window_set_position:
  3579. .. rst-class:: classref-method
  3580. |void| **window_set_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_position>`
  3581. Sets the position of the given window to ``position``. On multi-monitor setups, the screen position is relative to the virtual desktop area. On multi-monitor setups with different screen resolutions or orientations, the origin may be located outside any display like this:
  3582. .. code:: text
  3583. * (0, 0) +-------+
  3584. | |
  3585. +-------------+ | |
  3586. | | | |
  3587. | | | |
  3588. +-------------+ +-------+
  3589. See also :ref:`window_get_position()<class_DisplayServer_method_window_get_position>` and :ref:`window_set_size()<class_DisplayServer_method_window_set_size>`.
  3590. \ **Note:** It's recommended to change this value using :ref:`Window.position<class_Window_property_position>` instead.
  3591. \ **Note:** On Linux (Wayland): this method is a no-op.
  3592. .. rst-class:: classref-item-separator
  3593. ----
  3594. .. _class_DisplayServer_method_window_set_rect_changed_callback:
  3595. .. rst-class:: classref-method
  3596. |void| **window_set_rect_changed_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_rect_changed_callback>`
  3597. Sets the ``callback`` that will be called when the window specified by ``window_id`` is moved or resized.
  3598. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
  3599. .. rst-class:: classref-item-separator
  3600. ----
  3601. .. _class_DisplayServer_method_window_set_size:
  3602. .. rst-class:: classref-method
  3603. |void| **window_set_size**\ (\ size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_size>`
  3604. Sets the size of the given window to ``size`` (in pixels). See also :ref:`window_get_size()<class_DisplayServer_method_window_get_size>` and :ref:`window_get_position()<class_DisplayServer_method_window_get_position>`.
  3605. \ **Note:** It's recommended to change this value using :ref:`Window.size<class_Window_property_size>` instead.
  3606. .. rst-class:: classref-item-separator
  3607. ----
  3608. .. _class_DisplayServer_method_window_set_title:
  3609. .. rst-class:: classref-method
  3610. |void| **window_set_title**\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_title>`
  3611. Sets the title of the given window to ``title``.
  3612. \ **Note:** It's recommended to change this value using :ref:`Window.title<class_Window_property_title>` instead.
  3613. \ **Note:** Avoid changing the window title every frame, as this can cause performance issues on certain window managers. Try to change the window title only a few times per second at most.
  3614. .. rst-class:: classref-item-separator
  3615. ----
  3616. .. _class_DisplayServer_method_window_set_transient:
  3617. .. rst-class:: classref-method
  3618. |void| **window_set_transient**\ (\ window_id\: :ref:`int<class_int>`, parent_window_id\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_transient>`
  3619. Sets window transient parent. Transient window will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can't enter full-screen mode.
  3620. \ **Note:** It's recommended to change this value using :ref:`Window.transient<class_Window_property_transient>` instead.
  3621. \ **Note:** The behavior might be different depending on the platform.
  3622. .. rst-class:: classref-item-separator
  3623. ----
  3624. .. _class_DisplayServer_method_window_set_vsync_mode:
  3625. .. rst-class:: classref-method
  3626. |void| **window_set_vsync_mode**\ (\ vsync_mode\: :ref:`VSyncMode<enum_DisplayServer_VSyncMode>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_vsync_mode>`
  3627. Sets the V-Sync mode of the given window. See also :ref:`ProjectSettings.display/window/vsync/vsync_mode<class_ProjectSettings_property_display/window/vsync/vsync_mode>`.
  3628. Depending on the platform and used renderer, the engine will fall back to :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>` if the desired mode is not supported.
  3629. \ **Note:** V-Sync modes other than :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>` are only supported in the Forward+ and Mobile rendering methods, not Compatibility.
  3630. .. rst-class:: classref-item-separator
  3631. ----
  3632. .. _class_DisplayServer_method_window_set_window_buttons_offset:
  3633. .. rst-class:: classref-method
  3634. |void| **window_set_window_buttons_offset**\ (\ offset\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_window_buttons_offset>`
  3635. When :ref:`WINDOW_FLAG_EXTEND_TO_TITLE<class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE>` flag is set, set offset to the center of the first titlebar button.
  3636. \ **Note:** This flag is implemented only on macOS.
  3637. .. rst-class:: classref-item-separator
  3638. ----
  3639. .. _class_DisplayServer_method_window_set_window_event_callback:
  3640. .. rst-class:: classref-method
  3641. |void| **window_set_window_event_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_window_event_callback>`
  3642. Sets the ``callback`` that will be called when an event occurs in the window specified by ``window_id``.
  3643. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
  3644. .. rst-class:: classref-item-separator
  3645. ----
  3646. .. _class_DisplayServer_method_window_start_drag:
  3647. .. rst-class:: classref-method
  3648. |void| **window_start_drag**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_start_drag>`
  3649. Starts an interactive drag operation on the window with the given ``window_id``, using the current mouse position. Call this method when handling a mouse button being pressed to simulate a pressed event on the window's title bar. Using this method allows the window to participate in space switching, tiling, and other system features.
  3650. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS, and Windows.
  3651. .. rst-class:: classref-item-separator
  3652. ----
  3653. .. _class_DisplayServer_method_window_start_resize:
  3654. .. rst-class:: classref-method
  3655. |void| **window_start_resize**\ (\ edge\: :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_start_resize>`
  3656. Starts an interactive resize operation on the window with the given ``window_id``, using the current mouse position. Call this method when handling a mouse button being pressed to simulate a pressed event on the window's edge.
  3657. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS, and Windows.
  3658. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  3659. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  3660. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  3661. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  3662. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  3663. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  3664. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  3665. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  3666. .. |void| replace:: :abbr:`void (No return value.)`