Strona główna Odkrywaj Pomoc
Zaloguj się
godotengine
/
godot-docs
kopia lustrzana https://github.com/godotengine/godot-docs
Obserwuj 1
Polub 1
Forkuj 0
Pliki
Drzewo: 689bb9743c
Gałęzie Tagi
godot-docs
/
classes
/
class_displayserver.rst

class_displayserver.rst 409 KB
Historia Czysty

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DisplayServer.xml.
    7. 

  7. 

  8. .. _class_DisplayServer:
    9. 

  9. 

  10. DisplayServer
    11. 

  11. =============
    12. 

  12. 

  13. **Inherits:** :ref:`Object<class_Object>`
    14. 

  14. 

  15. A server interface for low-level window management.
    16. 

  16. 

  17. .. rst-class:: classref-introduction-group
    18. 

  18. 

  19. Description
    20. 

  20. -----------
    21. 

  21. 

  22. **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.
    23. 

  23. 

  24. \ **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.
    25. 

  25. 

  26. .. rst-class:: classref-reftable-group
    27. 

  27. 

  28. Methods
    29. 

  29. -------
    30. 

  30. 

  31. .. table::
    32. 

  32.    :widths: auto
    33. 

  33. 

  34.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35.    | |void|                                                                  | :ref:`beep<class_DisplayServer_method_beep>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    36. 

  36.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37.    | :ref:`String<class_String>`                                             | :ref:`clipboard_get<class_DisplayServer_method_clipboard_get>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    38. 

  38.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39.    | :ref:`Image<class_Image>`                                               | :ref:`clipboard_get_image<class_DisplayServer_method_clipboard_get_image>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
    40. 

  40.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41.    | :ref:`String<class_String>`                                             | :ref:`clipboard_get_primary<class_DisplayServer_method_clipboard_get_primary>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    42. 

  42.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43.    | :ref:`bool<class_bool>`                                                 | :ref:`clipboard_has<class_DisplayServer_method_clipboard_has>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    44. 

  44.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45.    | :ref:`bool<class_bool>`                                                 | :ref:`clipboard_has_image<class_DisplayServer_method_clipboard_has_image>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
    46. 

  46.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47.    | |void|                                                                  | :ref:`clipboard_set<class_DisplayServer_method_clipboard_set>`\ (\ clipboard\: :ref:`String<class_String>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
    48. 

  48.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49.    | |void|                                                                  | :ref:`clipboard_set_primary<class_DisplayServer_method_clipboard_set_primary>`\ (\ clipboard_primary\: :ref:`String<class_String>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                               |
    50. 

  50.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51.    | :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>`\ )                                                                                                                                                                                                                                                                                                                                               |
    52. 

  52.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53.    | :ref:`CursorShape<enum_DisplayServer_CursorShape>`                      | :ref:`cursor_get_shape<class_DisplayServer_method_cursor_get_shape>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    54. 

  54.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

  55.    | |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)\ )                                                                                                                                                                                                                                                                                                         |
    56. 

  56.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    57. 

  57.    | |void|                                                                  | :ref:`cursor_set_shape<class_DisplayServer_method_cursor_set_shape>`\ (\ shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                              |
    58. 

  58.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    59. 

  59.    | |void|                                                                  | :ref:`delete_status_indicator<class_DisplayServer_method_delete_status_indicator>`\ (\ id\: :ref:`int<class_int>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    60. 

  60.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    61. 

  61.    | :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>`\ )                                                                                                                                                                                                                                                                                                               |
    62. 

  62.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    63. 

  63.    | :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>`\ )                                                                                                                                                                                                                                                                                                           |
    64. 

  64.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    65. 

  65.    | |void|                                                                  | :ref:`enable_for_stealing_focus<class_DisplayServer_method_enable_for_stealing_focus>`\ (\ process_id\: :ref:`int<class_int>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    66. 

  66.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    67. 

  67.    | :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>`\ )                                                                                                                                           |
    68. 

  68.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    69. 

  69.    | :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>`\ ) |
    70. 

  70.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    71. 

  71.    | |void|                                                                  | :ref:`force_process_and_drop_events<class_DisplayServer_method_force_process_and_drop_events>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    72. 

  72.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    73. 

  73.    | :ref:`Color<class_Color>`                                               | :ref:`get_accent_color<class_DisplayServer_method_get_accent_color>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    74. 

  74.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    75. 

  75.    | :ref:`Color<class_Color>`                                               | :ref:`get_base_color<class_DisplayServer_method_get_base_color>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    76. 

  76.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    77. 

  77.    | :ref:`Array<class_Array>`\[:ref:`Rect2<class_Rect2>`\]                  | :ref:`get_display_cutouts<class_DisplayServer_method_get_display_cutouts>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
    78. 

  78.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    79. 

  79.    | :ref:`Rect2i<class_Rect2i>`                                             | :ref:`get_display_safe_area<class_DisplayServer_method_get_display_safe_area>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    80. 

  80.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    81. 

  81.    | :ref:`int<class_int>`                                                   | :ref:`get_keyboard_focus_screen<class_DisplayServer_method_get_keyboard_focus_screen>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    82. 

  82.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    83. 

  83.    | :ref:`String<class_String>`                                             | :ref:`get_name<class_DisplayServer_method_get_name>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    84. 

  84.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    85. 

  85.    | :ref:`int<class_int>`                                                   | :ref:`get_primary_screen<class_DisplayServer_method_get_primary_screen>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    86. 

  86.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    87. 

  87.    | :ref:`int<class_int>`                                                   | :ref:`get_screen_count<class_DisplayServer_method_get_screen_count>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    88. 

  88.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    89. 

  89.    | :ref:`int<class_int>`                                                   | :ref:`get_screen_from_rect<class_DisplayServer_method_get_screen_from_rect>`\ (\ rect\: :ref:`Rect2<class_Rect2>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    90. 

  90.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    91. 

  91.    | :ref:`bool<class_bool>`                                                 | :ref:`get_swap_cancel_ok<class_DisplayServer_method_get_swap_cancel_ok>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    92. 

  92.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    93. 

  93.    | :ref:`int<class_int>`                                                   | :ref:`get_window_at_screen_position<class_DisplayServer_method_get_window_at_screen_position>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                            |
    94. 

  94.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    95. 

  95.    | :ref:`PackedInt32Array<class_PackedInt32Array>`                         | :ref:`get_window_list<class_DisplayServer_method_get_window_list>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    96. 

  96.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    97. 

  97.    | :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\ )                                                                                                                             |
    98. 

  98.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    99. 

  99.    | :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\ )                                                                         |
    100. 

  100.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    101. 

  101.    | :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\ )                                                                                     |
    102. 

  102.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    103. 

  103.    | :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\ )                                                             |
    104. 

  104.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    105. 

  105.    | :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\ )                                                                                                                                         |
    106. 

  106.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    107. 

  107.    | :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\ )                                        |
    108. 

  108.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    109. 

  109.    | :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\ )                                                                                                                 |
    110. 

  110.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    111. 

  111.    | :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\ )                                                                                                                                                                                                                                                                                                                                                                                           |
    112. 

  112.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    113. 

  113.    | :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\ )                                                                                                                                                                                                                                                                                                         |
    114. 

  114.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    115. 

  115.    | |void|                                                                  | :ref:`global_menu_clear<class_DisplayServer_method_global_menu_clear>`\ (\ menu_root\: :ref:`String<class_String>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                               |
    116. 

  116.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    117. 

  117.    | :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|                                                                                                                                                                                                                                                                                                                                                                            |
    118. 

  118.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    119. 

  119.    | :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|                                                                                                                                                                                                                                                                                                                                                                                  |
    120. 

  120.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    121. 

  121.    | :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|                                                                                                                                                                                                                                                                                                                                                                                                                     |
    122. 

  122.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    123. 

  123.    | :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|                                                                                                                                                                                                                                                                                                                                                                                          |
    124. 

  124.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    125. 

  125.    | :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|                                                                                                                                                                                                                                                                                                                                                                |
    126. 

  126.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    127. 

  127.    | :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|                                                                                                                                                                                                                                                                                                                                                              |
    128. 

  128.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    129. 

  129.    | :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|                                                                                                                                                                                                                                                                                                                                                             |
    130. 

  130.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    131. 

  131.    | :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|                                                                                                                                                                                                                                                                                                                                                                          |
    132. 

  132.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    133. 

  133.    | :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|                                                                                                                                                                                                                                                                                                                                                                              |
    134. 

  134.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    135. 

  135.    | :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|                                                                                                                                                                                                                                                                                                                                                                                        |
    136. 

  136.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    137. 

  137.    | :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|                                                                                                                                                                                                                                                                                                                                                                                    |
    138. 

  138.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    139. 

  139.    | :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|                                                                                                                                                                                                                                                                                                                                                                                            |
    140. 

  140.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    141. 

  141.    | :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|                                                                                                                                                                                                                                                                                                                                                                                          |
    142. 

  142.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    143. 

  143.    | :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|                                                                                                                                                                                                                                                                                                                                                                                    |
    144. 

  144.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    145. 

  145.    | :ref:`Dictionary<class_Dictionary>`                                     | :ref:`global_menu_get_system_menu_roots<class_DisplayServer_method_global_menu_get_system_menu_roots>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    146. 

  146.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    147. 

  147.    | :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|                                                                                                                                                                                                                                                                                                                                                                                  |
    148. 

  148.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    149. 

  149.    | :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|                                                                                                                                                                                                                                                                                                                                                                                      |
    150. 

  150.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    151. 

  151.    | :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|                                                                                                                                                                                                                                                                                                                                                                                    |
    152. 

  152.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    153. 

  153.    | :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|                                                                                                                                                                                                                                                                                                                                                                                        |
    154. 

  154.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    155. 

  155.    | :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|                                                                                                                                                                                                                                                                                                                                                                      |
    156. 

  156.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    157. 

  157.    | |void|                                                                  | :ref:`global_menu_remove_item<class_DisplayServer_method_global_menu_remove_item>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ )                                                                                                                                                                                                                                                                                                                                                                                                      |
    158. 

  158.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    159. 

  159.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                       |
    160. 

  160.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    161. 

  161.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                              |
    162. 

  162.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    163. 

  163.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                                   |
    164. 

  164.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    165. 

  165.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                                         |
    166. 

  166.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    167. 

  167.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                                      |
    168. 

  168.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    169. 

  169.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                                            |
    170. 

  170.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    171. 

  171.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                |
    172. 

  172.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    173. 

  173.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                                        |
    174. 

  174.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    175. 

  175.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                         |
    176. 

  176.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    177. 

  177.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                  |
    178. 

  178.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    179. 

  179.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                                  |
    180. 

  180.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    181. 

  181.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                       |
    182. 

  182.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    183. 

  183.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                                                 |
    184. 

  184.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    185. 

  185.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                                     |
    186. 

  186.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    187. 

  187.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                                               |
    188. 

  188.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    189. 

  189.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                                              |
    190. 

  190.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    191. 

  191.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                                     |
    192. 

  192.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    193. 

  193.    | |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>`\ )                                                                                                                                                                                                                                                                                                                |
    194. 

  194.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    195. 

  195.    | :ref:`bool<class_bool>`                                                 | :ref:`has_additional_outputs<class_DisplayServer_method_has_additional_outputs>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    196. 

  196.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    197. 

  197.    | :ref:`bool<class_bool>`                                                 | :ref:`has_feature<class_DisplayServer_method_has_feature>`\ (\ feature\: :ref:`Feature<enum_DisplayServer_Feature>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    198. 

  198.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    199. 

  199.    | :ref:`bool<class_bool>`                                                 | :ref:`has_hardware_keyboard<class_DisplayServer_method_has_hardware_keyboard>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    200. 

  200.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    201. 

  201.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                                                  |
    202. 

  202.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    203. 

  203.    | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`ime_get_selection<class_DisplayServer_method_ime_get_selection>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    204. 

  204.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    205. 

  205.    | :ref:`String<class_String>`                                             | :ref:`ime_get_text<class_DisplayServer_method_ime_get_text>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    206. 

  206.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    207. 

  207.    | :ref:`bool<class_bool>`                                                 | :ref:`is_dark_mode<class_DisplayServer_method_is_dark_mode>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    208. 

  208.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    209. 

  209.    | :ref:`bool<class_bool>`                                                 | :ref:`is_dark_mode_supported<class_DisplayServer_method_is_dark_mode_supported>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    210. 

  210.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    211. 

  211.    | :ref:`bool<class_bool>`                                                 | :ref:`is_touchscreen_available<class_DisplayServer_method_is_touchscreen_available>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    212. 

  212.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    213. 

  213.    | :ref:`bool<class_bool>`                                                 | :ref:`is_window_transparency_available<class_DisplayServer_method_is_window_transparency_available>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    214. 

  214.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    215. 

  215.    | :ref:`int<class_int>`                                                   | :ref:`keyboard_get_current_layout<class_DisplayServer_method_keyboard_get_current_layout>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
    216. 

  216.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    217. 

  217.    | :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|                                                                                                                                                                                                                                                                                                                                                                                                 |
    218. 

  218.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    219. 

  219.    | :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|                                                                                                                                                                                                                                                                                                                                                                                                     |
    220. 

  220.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    221. 

  221.    | :ref:`int<class_int>`                                                   | :ref:`keyboard_get_layout_count<class_DisplayServer_method_keyboard_get_layout_count>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    222. 

  222.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    223. 

  223.    | :ref:`String<class_String>`                                             | :ref:`keyboard_get_layout_language<class_DisplayServer_method_keyboard_get_layout_language>`\ (\ index\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                           |
    224. 

  224.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    225. 

  225.    | :ref:`String<class_String>`                                             | :ref:`keyboard_get_layout_name<class_DisplayServer_method_keyboard_get_layout_name>`\ (\ index\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    226. 

  226.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    227. 

  227.    | |void|                                                                  | :ref:`keyboard_set_current_layout<class_DisplayServer_method_keyboard_set_current_layout>`\ (\ index\: :ref:`int<class_int>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    228. 

  228.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    229. 

  229.    | |bitfield|\[:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>`\] | :ref:`mouse_get_button_state<class_DisplayServer_method_mouse_get_button_state>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    230. 

  230.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    231. 

  231.    | :ref:`MouseMode<enum_DisplayServer_MouseMode>`                          | :ref:`mouse_get_mode<class_DisplayServer_method_mouse_get_mode>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    232. 

  232.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    233. 

  233.    | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`mouse_get_position<class_DisplayServer_method_mouse_get_position>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    234. 

  234.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    235. 

  235.    | |void|                                                                  | :ref:`mouse_set_mode<class_DisplayServer_method_mouse_set_mode>`\ (\ mouse_mode\: :ref:`MouseMode<enum_DisplayServer_MouseMode>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    236. 

  236.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    237. 

  237.    | |void|                                                                  | :ref:`process_events<class_DisplayServer_method_process_events>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    238. 

  238.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    239. 

  239.    | |void|                                                                  | :ref:`register_additional_output<class_DisplayServer_method_register_additional_output>`\ (\ object\: :ref:`Object<class_Object>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                |
    240. 

  240.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    241. 

  241.    | :ref:`int<class_int>`                                                   | :ref:`screen_get_dpi<class_DisplayServer_method_screen_get_dpi>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    242. 

  242.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    243. 

  243.    | :ref:`Image<class_Image>`                                               | :ref:`screen_get_image<class_DisplayServer_method_screen_get_image>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                             |
    244. 

  244.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    245. 

  245.    | :ref:`Image<class_Image>`                                               | :ref:`screen_get_image_rect<class_DisplayServer_method_screen_get_image_rect>`\ (\ rect\: :ref:`Rect2i<class_Rect2i>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    246. 

  246.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    247. 

  247.    | :ref:`float<class_float>`                                               | :ref:`screen_get_max_scale<class_DisplayServer_method_screen_get_max_scale>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    248. 

  248.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    249. 

  249.    | :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>`          | :ref:`screen_get_orientation<class_DisplayServer_method_screen_get_orientation>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    250. 

  250.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    251. 

  251.    | :ref:`Color<class_Color>`                                               | :ref:`screen_get_pixel<class_DisplayServer_method_screen_get_pixel>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    252. 

  252.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    253. 

  253.    | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`screen_get_position<class_DisplayServer_method_screen_get_position>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                       |
    254. 

  254.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    255. 

  255.    | :ref:`float<class_float>`                                               | :ref:`screen_get_refresh_rate<class_DisplayServer_method_screen_get_refresh_rate>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                               |
    256. 

  256.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    257. 

  257.    | :ref:`float<class_float>`                                               | :ref:`screen_get_scale<class_DisplayServer_method_screen_get_scale>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                             |
    258. 

  258.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    259. 

  259.    | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`screen_get_size<class_DisplayServer_method_screen_get_size>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                               |
    260. 

  260.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    261. 

  261.    | :ref:`Rect2i<class_Rect2i>`                                             | :ref:`screen_get_usable_rect<class_DisplayServer_method_screen_get_usable_rect>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    262. 

  262.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    263. 

  263.    | :ref:`bool<class_bool>`                                                 | :ref:`screen_is_kept_on<class_DisplayServer_method_screen_is_kept_on>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    264. 

  264.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    265. 

  265.    | |void|                                                                  | :ref:`screen_set_keep_on<class_DisplayServer_method_screen_set_keep_on>`\ (\ enable\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    266. 

  266.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    267. 

  267.    | |void|                                                                  | :ref:`screen_set_orientation<class_DisplayServer_method_screen_set_orientation>`\ (\ orientation\: :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>`, screen\: :ref:`int<class_int>` = -1\ )                                                                                                                                                                                                                                                                                                                                                           |
    268. 

  268.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    269. 

  269.    | |void|                                                                  | :ref:`set_icon<class_DisplayServer_method_set_icon>`\ (\ image\: :ref:`Image<class_Image>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
    270. 

  270.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    271. 

  271.    | |void|                                                                  | :ref:`set_native_icon<class_DisplayServer_method_set_native_icon>`\ (\ filename\: :ref:`String<class_String>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    272. 

  272.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    273. 

  273.    | |void|                                                                  | :ref:`set_system_theme_change_callback<class_DisplayServer_method_set_system_theme_change_callback>`\ (\ callable\: :ref:`Callable<class_Callable>`\ )                                                                                                                                                                                                                                                                                                                                                                                                              |
    274. 

  274.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    275. 

  275.    | |void|                                                                  | :ref:`show_emoji_and_symbol_picker<class_DisplayServer_method_show_emoji_and_symbol_picker>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    276. 

  276.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    277. 

  277.    | :ref:`Rect2<class_Rect2>`                                               | :ref:`status_indicator_get_rect<class_DisplayServer_method_status_indicator_get_rect>`\ (\ id\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    278. 

  278.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    279. 

  279.    | |void|                                                                  | :ref:`status_indicator_set_callback<class_DisplayServer_method_status_indicator_set_callback>`\ (\ id\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ )                                                                                                                                                                                                                                                                                                                                                                                        |
    280. 

  280.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    281. 

  281.    | |void|                                                                  | :ref:`status_indicator_set_icon<class_DisplayServer_method_status_indicator_set_icon>`\ (\ id\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ )                                                                                                                                                                                                                                                                                                                                                                                                  |
    282. 

  282.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    283. 

  283.    | |void|                                                                  | :ref:`status_indicator_set_menu<class_DisplayServer_method_status_indicator_set_menu>`\ (\ id\: :ref:`int<class_int>`, menu_rid\: :ref:`RID<class_RID>`\ )                                                                                                                                                                                                                                                                                                                                                                                                          |
    284. 

  284.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    285. 

  285.    | |void|                                                                  | :ref:`status_indicator_set_tooltip<class_DisplayServer_method_status_indicator_set_tooltip>`\ (\ id\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ )                                                                                                                                                                                                                                                                                                                                                                                               |
    286. 

  286.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    287. 

  287.    | :ref:`String<class_String>`                                             | :ref:`tablet_get_current_driver<class_DisplayServer_method_tablet_get_current_driver>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    288. 

  288.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    289. 

  289.    | :ref:`int<class_int>`                                                   | :ref:`tablet_get_driver_count<class_DisplayServer_method_tablet_get_driver_count>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    290. 

  290.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    291. 

  291.    | :ref:`String<class_String>`                                             | :ref:`tablet_get_driver_name<class_DisplayServer_method_tablet_get_driver_name>`\ (\ idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                         |
    292. 

  292.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    293. 

  293.    | |void|                                                                  | :ref:`tablet_set_current_driver<class_DisplayServer_method_tablet_set_current_driver>`\ (\ name\: :ref:`String<class_String>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    294. 

  294.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    295. 

  295.    | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\]        | :ref:`tts_get_voices<class_DisplayServer_method_tts_get_voices>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    296. 

  296.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    297. 

  297.    | :ref:`PackedStringArray<class_PackedStringArray>`                       | :ref:`tts_get_voices_for_language<class_DisplayServer_method_tts_get_voices_for_language>`\ (\ language\: :ref:`String<class_String>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                    |
    298. 

  298.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    299. 

  299.    | :ref:`bool<class_bool>`                                                 | :ref:`tts_is_paused<class_DisplayServer_method_tts_is_paused>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    300. 

  300.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    301. 

  301.    | :ref:`bool<class_bool>`                                                 | :ref:`tts_is_speaking<class_DisplayServer_method_tts_is_speaking>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    302. 

  302.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    303. 

  303.    | |void|                                                                  | :ref:`tts_pause<class_DisplayServer_method_tts_pause>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    304. 

  304.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    305. 

  305.    | |void|                                                                  | :ref:`tts_resume<class_DisplayServer_method_tts_resume>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    306. 

  306.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    307. 

  307.    | |void|                                                                  | :ref:`tts_set_utterance_callback<class_DisplayServer_method_tts_set_utterance_callback>`\ (\ event\: :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>`, callable\: :ref:`Callable<class_Callable>`\ )                                                                                                                                                                                                                                                                                                                                                  |
    308. 

  308.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    309. 

  309.    | |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\ )                                                                                                                                                                                                                  |
    310. 

  310.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    311. 

  311.    | |void|                                                                  | :ref:`tts_stop<class_DisplayServer_method_tts_stop>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    312. 

  312.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    313. 

  313.    | |void|                                                                  | :ref:`unregister_additional_output<class_DisplayServer_method_unregister_additional_output>`\ (\ object\: :ref:`Object<class_Object>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                            |
    314. 

  314.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    315. 

  315.    | :ref:`int<class_int>`                                                   | :ref:`virtual_keyboard_get_height<class_DisplayServer_method_virtual_keyboard_get_height>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
    316. 

  316.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    317. 

  317.    | |void|                                                                  | :ref:`virtual_keyboard_hide<class_DisplayServer_method_virtual_keyboard_hide>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    318. 

  318.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    319. 

  319.    | |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\ )                                                                                                                                                             |
    320. 

  320.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    321. 

  321.    | |void|                                                                  | :ref:`warp_mouse<class_DisplayServer_method_warp_mouse>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    322. 

  322.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    323. 

  323.    | :ref:`bool<class_bool>`                                                 | :ref:`window_can_draw<class_DisplayServer_method_window_can_draw>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                             |
    324. 

  324.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    325. 

  325.    | :ref:`int<class_int>`                                                   | :ref:`window_get_active_popup<class_DisplayServer_method_window_get_active_popup>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    326. 

  326.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    327. 

  327.    | :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|                                                                                                                                                                                                                                                                                                                                                                                                             |
    328. 

  328.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    329. 

  329.    | :ref:`int<class_int>`                                                   | :ref:`window_get_current_screen<class_DisplayServer_method_window_get_current_screen>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                         |
    330. 

  330.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    331. 

  331.    | :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|                                                                                                                                                                                                                                                                                                                                                                                  |
    332. 

  332.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    333. 

  333.    | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`window_get_max_size<class_DisplayServer_method_window_get_max_size>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    334. 

  334.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    335. 

  335.    | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`window_get_min_size<class_DisplayServer_method_window_get_min_size>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    336. 

  336.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    337. 

  337.    | :ref:`WindowMode<enum_DisplayServer_WindowMode>`                        | :ref:`window_get_mode<class_DisplayServer_method_window_get_mode>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                             |
    338. 

  338.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    339. 

  339.    | :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|                                                                                                                                                                                                                                                                                                                                                           |
    340. 

  340.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    341. 

  341.    | :ref:`Rect2i<class_Rect2i>`                                             | :ref:`window_get_popup_safe_rect<class_DisplayServer_method_window_get_popup_safe_rect>`\ (\ window\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                              |
    342. 

  342.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    343. 

  343.    | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`window_get_position<class_DisplayServer_method_window_get_position>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    344. 

  344.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    345. 

  345.    | :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|                                                                                                                                                                                                                                                                                                                                                                                                   |
    346. 

  346.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    347. 

  347.    | :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|                                                                                                                                                                                                                                                                                                                                                                                                                 |
    348. 

  348.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    349. 

  349.    | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`window_get_size<class_DisplayServer_method_window_get_size>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                             |
    350. 

  350.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    351. 

  351.    | :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|                                                                                                                                                                                                                                                                                                                                                                                                           |
    352. 

  352.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    353. 

  353.    | :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|                                                                                                                                                                                                                                                                                                                                                                                            |
    354. 

  354.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    355. 

  355.    | :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|                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    356. 

  356.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    357. 

  357.    | :ref:`bool<class_bool>`                                                 | :ref:`window_is_focused<class_DisplayServer_method_window_is_focused>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                         |
    358. 

  358.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    359. 

  359.    | :ref:`bool<class_bool>`                                                 | :ref:`window_is_maximize_allowed<class_DisplayServer_method_window_is_maximize_allowed>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                       |
    360. 

  360.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    361. 

  361.    | :ref:`bool<class_bool>`                                                 | :ref:`window_maximize_on_title_dbl_click<class_DisplayServer_method_window_maximize_on_title_dbl_click>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    362. 

  362.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    363. 

  363.    | :ref:`bool<class_bool>`                                                 | :ref:`window_minimize_on_title_dbl_click<class_DisplayServer_method_window_minimize_on_title_dbl_click>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    364. 

  364.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    365. 

  365.    | |void|                                                                  | :ref:`window_move_to_foreground<class_DisplayServer_method_window_move_to_foreground>`\ (\ window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    366. 

  366.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    367. 

  367.    | |void|                                                                  | :ref:`window_request_attention<class_DisplayServer_method_window_request_attention>`\ (\ window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    368. 

  368.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    369. 

  369.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                                                 |
    370. 

  370.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    371. 

  371.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                           |
    372. 

  372.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    373. 

  373.    | |void|                                                                  | :ref:`window_set_exclusive<class_DisplayServer_method_window_set_exclusive>`\ (\ window_id\: :ref:`int<class_int>`, exclusive\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                                                                                                                          |
    374. 

  374.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    375. 

  375.    | |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\ )                                                                                                                                                                                                                                                                                                                                                       |
    376. 

  376.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    377. 

  377.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                                                       |
    378. 

  378.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    379. 

  379.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                                         |
    380. 

  380.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    381. 

  381.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                         |
    382. 

  382.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    383. 

  383.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                           |
    384. 

  384.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    385. 

  385.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                                                 |
    386. 

  386.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    387. 

  387.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                                                 |
    388. 

  388.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    389. 

  389.    | |void|                                                                  | :ref:`window_set_mode<class_DisplayServer_method_window_set_mode>`\ (\ mode\: :ref:`WindowMode<enum_DisplayServer_WindowMode>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                                            |
    390. 

  390.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    391. 

  391.    | |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\ )                                                                                                                                                                                                                                                                                                                                                             |
    392. 

  392.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    393. 

  393.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                                                                                  |
    394. 

  394.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    395. 

  395.    | |void|                                                                  | :ref:`window_set_position<class_DisplayServer_method_window_set_position>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                                                 |
    396. 

  396.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    397. 

  397.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                       |
    398. 

  398.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    399. 

  399.    | |void|                                                                  | :ref:`window_set_size<class_DisplayServer_method_window_set_size>`\ (\ size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                                                             |
    400. 

  400.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    401. 

  401.    | |void|                                                                  | :ref:`window_set_title<class_DisplayServer_method_window_set_title>`\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                                                              |
    402. 

  402.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    403. 

  403.    | |void|                                                                  | :ref:`window_set_transient<class_DisplayServer_method_window_set_transient>`\ (\ window_id\: :ref:`int<class_int>`, parent_window_id\: :ref:`int<class_int>`\ )                                                                                                                                                                                                                                                                                                                                                                                                     |
    404. 

  404.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    405. 

  405.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                            |
    406. 

  406.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    407. 

  407.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                         |
    408. 

  408.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    409. 

  409.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                       |
    410. 

  410.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    411. 

  411.    | |void|                                                                  | :ref:`window_start_drag<class_DisplayServer_method_window_start_drag>`\ (\ window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    412. 

  412.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    413. 

  413.    | |void|                                                                  | :ref:`window_start_resize<class_DisplayServer_method_window_start_resize>`\ (\ edge\: :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                        |
    414. 

  414.    +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    415. 

  415. 

  416. .. rst-class:: classref-section-separator
    417. 

  417. 

  418. ----
    419. 

  419. 

  420. .. rst-class:: classref-descriptions-group
    421. 

  421. 

  422. Enumerations
    423. 

  423. ------------
    424. 

  424. 

  425. .. _enum_DisplayServer_Feature:
    426. 

  426. 

  427. .. rst-class:: classref-enumeration
    428. 

  428. 

  429. enum **Feature**: :ref:`🔗<enum_DisplayServer_Feature>`
    430. 

  430. 

  431. .. _class_DisplayServer_constant_FEATURE_GLOBAL_MENU:
    432. 

  432. 

  433. .. rst-class:: classref-enumeration-constant
    434. 

  434. 

  435. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_GLOBAL_MENU** = ``0``
    436. 

  436. 

  437. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    438. 

  438. 

  439. Display server supports global menu. This allows the application to display its menu items in the operating system's top bar. **macOS**
    440. 

  440. 

  441. .. _class_DisplayServer_constant_FEATURE_SUBWINDOWS:
    442. 

  442. 

  443. .. rst-class:: classref-enumeration-constant
    444. 

  444. 

  445. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SUBWINDOWS** = ``1``
    446. 

  446. 

  447. Display server supports multiple windows that can be moved outside of the main window. **Windows, macOS, Linux (X11)**
    448. 

  448. 

  449. .. _class_DisplayServer_constant_FEATURE_TOUCHSCREEN:
    450. 

  450. 

  451. .. rst-class:: classref-enumeration-constant
    452. 

  452. 

  453. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TOUCHSCREEN** = ``2``
    454. 

  454. 

  455. Display server supports touchscreen input. **Windows, Linux (X11), Android, iOS, Web**
    456. 

  456. 

  457. .. _class_DisplayServer_constant_FEATURE_MOUSE:
    458. 

  458. 

  459. .. rst-class:: classref-enumeration-constant
    460. 

  460. 

  461. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE** = ``3``
    462. 

  462. 

  463. Display server supports mouse input. **Windows, macOS, Linux (X11/Wayland), Android, Web**
    464. 

  464. 

  465. .. _class_DisplayServer_constant_FEATURE_MOUSE_WARP:
    466. 

  466. 

  467. .. rst-class:: classref-enumeration-constant
    468. 

  468. 

  469. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE_WARP** = ``4``
    470. 

  470. 

  471. 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)**
    472. 

  472. 

  473. .. _class_DisplayServer_constant_FEATURE_CLIPBOARD:
    474. 

  474. 

  475. .. rst-class:: classref-enumeration-constant
    476. 

  476. 

  477. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD** = ``5``
    478. 

  478. 

  479. 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**
    480. 

  480. 

  481. .. _class_DisplayServer_constant_FEATURE_VIRTUAL_KEYBOARD:
    482. 

  482. 

  483. .. rst-class:: classref-enumeration-constant
    484. 

  484. 

  485. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_VIRTUAL_KEYBOARD** = ``6``
    486. 

  486. 

  487. Display server supports popping up a virtual keyboard when requested to input text without a physical keyboard. **Android, iOS, Web**
    488. 

  488. 

  489. .. _class_DisplayServer_constant_FEATURE_CURSOR_SHAPE:
    490. 

  490. 

  491. .. rst-class:: classref-enumeration-constant
    492. 

  492. 

  493. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CURSOR_SHAPE** = ``7``
    494. 

  494. 

  495. Display server supports setting the mouse cursor shape to be different from the default. **Windows, macOS, Linux (X11/Wayland), Android, Web**
    496. 

  496. 

  497. .. _class_DisplayServer_constant_FEATURE_CUSTOM_CURSOR_SHAPE:
    498. 

  498. 

  499. .. rst-class:: classref-enumeration-constant
    500. 

  500. 

  501. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CUSTOM_CURSOR_SHAPE** = ``8``
    502. 

  502. 

  503. Display server supports setting the mouse cursor shape to a custom image. **Windows, macOS, Linux (X11/Wayland), Web**
    504. 

  504. 

  505. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG:
    506. 

  506. 

  507. .. rst-class:: classref-enumeration-constant
    508. 

  508. 

  509. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG** = ``9``
    510. 

  510. 

  511. 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**
    512. 

  512. 

  513. .. _class_DisplayServer_constant_FEATURE_IME:
    514. 

  514. 

  515. .. rst-class:: classref-enumeration-constant
    516. 

  516. 

  517. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_IME** = ``10``
    518. 

  518. 

  519. 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)**
    520. 

  520. 

  521. .. _class_DisplayServer_constant_FEATURE_WINDOW_TRANSPARENCY:
    522. 

  522. 

  523. .. rst-class:: classref-enumeration-constant
    524. 

  524. 

  525. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_TRANSPARENCY** = ``11``
    526. 

  526. 

  527. Display server supports windows can use per-pixel transparency to make windows behind them partially or fully visible. **Windows, macOS, Linux (X11/Wayland)**
    528. 

  528. 

  529. .. _class_DisplayServer_constant_FEATURE_HIDPI:
    530. 

  530. 

  531. .. rst-class:: classref-enumeration-constant
    532. 

  532. 

  533. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_HIDPI** = ``12``
    534. 

  534. 

  535. Display server supports querying the operating system's display scale factor. This allows for *reliable* automatic hiDPI display detection, as opposed to guessing based on the screen resolution and reported display DPI (which can be unreliable due to broken monitor EDID). **Windows, Linux (Wayland), macOS**
    536. 

  536. 

  537. .. _class_DisplayServer_constant_FEATURE_ICON:
    538. 

  538. 

  539. .. rst-class:: classref-enumeration-constant
    540. 

  540. 

  541. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ICON** = ``13``
    542. 

  542. 

  543. Display server supports changing the window icon (usually displayed in the top-left corner). **Windows, macOS, Linux (X11)**
    544. 

  544. 

  545. .. _class_DisplayServer_constant_FEATURE_NATIVE_ICON:
    546. 

  546. 

  547. .. rst-class:: classref-enumeration-constant
    548. 

  548. 

  549. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_ICON** = ``14``
    550. 

  550. 

  551. Display server supports changing the window icon (usually displayed in the top-left corner). **Windows, macOS**
    552. 

  552. 

  553. .. _class_DisplayServer_constant_FEATURE_ORIENTATION:
    554. 

  554. 

  555. .. rst-class:: classref-enumeration-constant
    556. 

  556. 

  557. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ORIENTATION** = ``15``
    558. 

  558. 

  559. Display server supports changing the screen orientation. **Android, iOS**
    560. 

  560. 

  561. .. _class_DisplayServer_constant_FEATURE_SWAP_BUFFERS:
    562. 

  562. 

  563. .. rst-class:: classref-enumeration-constant
    564. 

  564. 

  565. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SWAP_BUFFERS** = ``16``
    566. 

  566. 

  567. 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)**
    568. 

  568. 

  569. .. _class_DisplayServer_constant_FEATURE_CLIPBOARD_PRIMARY:
    570. 

  570. 

  571. .. rst-class:: classref-enumeration-constant
    572. 

  572. 

  573. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD_PRIMARY** = ``18``
    574. 

  574. 

  575. 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)**
    576. 

  576. 

  577. .. _class_DisplayServer_constant_FEATURE_TEXT_TO_SPEECH:
    578. 

  578. 

  579. .. rst-class:: classref-enumeration-constant
    580. 

  580. 

  581. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TEXT_TO_SPEECH** = ``19``
    582. 

  582. 

  583. Display server supports text-to-speech. See ``tts_*`` methods. **Windows, macOS, Linux (X11/Wayland), Android, iOS, Web**
    584. 

  584. 

  585. .. _class_DisplayServer_constant_FEATURE_EXTEND_TO_TITLE:
    586. 

  586. 

  587. .. rst-class:: classref-enumeration-constant
    588. 

  588. 

  589. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_EXTEND_TO_TITLE** = ``20``
    590. 

  590. 

  591. 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**
    592. 

  592. 

  593. .. _class_DisplayServer_constant_FEATURE_SCREEN_CAPTURE:
    594. 

  594. 

  595. .. rst-class:: classref-enumeration-constant
    596. 

  596. 

  597. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SCREEN_CAPTURE** = ``21``
    598. 

  598. 

  599. Display server supports reading screen pixels. See :ref:`screen_get_pixel<class_DisplayServer_method_screen_get_pixel>`.
    600. 

  600. 

  601. .. _class_DisplayServer_constant_FEATURE_STATUS_INDICATOR:
    602. 

  602. 

  603. .. rst-class:: classref-enumeration-constant
    604. 

  604. 

  605. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_STATUS_INDICATOR** = ``22``
    606. 

  606. 

  607. Display server supports application status indicators.
    608. 

  608. 

  609. .. _class_DisplayServer_constant_FEATURE_NATIVE_HELP:
    610. 

  610. 

  611. .. rst-class:: classref-enumeration-constant
    612. 

  612. 

  613. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_HELP** = ``23``
    614. 

  614. 

  615. Display server supports native help system search callbacks. See :ref:`help_set_search_callbacks<class_DisplayServer_method_help_set_search_callbacks>`.
    616. 

  616. 

  617. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_INPUT:
    618. 

  618. 

  619. .. rst-class:: classref-enumeration-constant
    620. 

  620. 

  621. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_INPUT** = ``24``
    622. 

  622. 

  623. 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**
    624. 

  624. 

  625. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE:
    626. 

  626. 

  627. .. rst-class:: classref-enumeration-constant
    628. 

  628. 

  629. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE** = ``25``
    630. 

  630. 

  631. 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**
    632. 

  632. 

  633. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE_EXTRA:
    634. 

  634. 

  635. .. rst-class:: classref-enumeration-constant
    636. 

  636. 

  637. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE_EXTRA** = ``26``
    638. 

  638. 

  639. 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)**
    640. 

  640. 

  641. .. _class_DisplayServer_constant_FEATURE_WINDOW_DRAG:
    642. 

  642. 

  643. .. rst-class:: classref-enumeration-constant
    644. 

  644. 

  645. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_DRAG** = ``27``
    646. 

  646. 

  647. 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>`.
    648. 

  648. 

  649. .. _class_DisplayServer_constant_FEATURE_SCREEN_EXCLUDE_FROM_CAPTURE:
    650. 

  650. 

  651. .. rst-class:: classref-enumeration-constant
    652. 

  652. 

  653. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SCREEN_EXCLUDE_FROM_CAPTURE** = ``28``
    654. 

  654. 

  655. Display server supports :ref:`WINDOW_FLAG_EXCLUDE_FROM_CAPTURE<class_DisplayServer_constant_WINDOW_FLAG_EXCLUDE_FROM_CAPTURE>` window flag.
    656. 

  656. 

  657. .. _class_DisplayServer_constant_FEATURE_WINDOW_EMBEDDING:
    658. 

  658. 

  659. .. rst-class:: classref-enumeration-constant
    660. 

  660. 

  661. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_EMBEDDING** = ``29``
    662. 

  662. 

  663. Display server supports embedding a window from another process. **Windows, Linux (X11)**
    664. 

  664. 

  665. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE_MIME:
    666. 

  666. 

  667. .. rst-class:: classref-enumeration-constant
    668. 

  668. 

  669. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE_MIME** = ``30``
    670. 

  670. 

  671. Native file selection dialog supports MIME types as filters.
    672. 

  672. 

  673. .. _class_DisplayServer_constant_FEATURE_EMOJI_AND_SYMBOL_PICKER:
    674. 

  674. 

  675. .. rst-class:: classref-enumeration-constant
    676. 

  676. 

  677. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_EMOJI_AND_SYMBOL_PICKER** = ``31``
    678. 

  678. 

  679. Display server supports system emoji and symbol picker. **Windows, macOS**
    680. 

  680. 

  681. .. rst-class:: classref-item-separator
    682. 

  682. 

  683. ----
    684. 

  684. 

  685. .. _enum_DisplayServer_MouseMode:
    686. 

  686. 

  687. .. rst-class:: classref-enumeration
    688. 

  688. 

  689. enum **MouseMode**: :ref:`🔗<enum_DisplayServer_MouseMode>`
    690. 

  690. 

  691. .. _class_DisplayServer_constant_MOUSE_MODE_VISIBLE:
    692. 

  692. 

  693. .. rst-class:: classref-enumeration-constant
    694. 

  694. 

  695. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_VISIBLE** = ``0``
    696. 

  696. 

  697. Makes the mouse cursor visible if it is hidden.
    698. 

  698. 

  699. .. _class_DisplayServer_constant_MOUSE_MODE_HIDDEN:
    700. 

  700. 

  701. .. rst-class:: classref-enumeration-constant
    702. 

  702. 

  703. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_HIDDEN** = ``1``
    704. 

  704. 

  705. Makes the mouse cursor hidden if it is visible.
    706. 

  706. 

  707. .. _class_DisplayServer_constant_MOUSE_MODE_CAPTURED:
    708. 

  708. 

  709. .. rst-class:: classref-enumeration-constant
    710. 

  710. 

  711. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CAPTURED** = ``2``
    712. 

  712. 

  713. Captures the mouse. The mouse will be hidden and its position locked at the center of the window manager's window.
    714. 

  714. 

  715. \ **Note:** If you want to process the mouse's movement in this mode, you need to use :ref:`InputEventMouseMotion.relative<class_InputEventMouseMotion_property_relative>`.
    716. 

  716. 

  717. .. _class_DisplayServer_constant_MOUSE_MODE_CONFINED:
    718. 

  718. 

  719. .. rst-class:: classref-enumeration-constant
    720. 

  720. 

  721. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED** = ``3``
    722. 

  722. 

  723. Confines the mouse cursor to the game window, and make it visible.
    724. 

  724. 

  725. .. _class_DisplayServer_constant_MOUSE_MODE_CONFINED_HIDDEN:
    726. 

  726. 

  727. .. rst-class:: classref-enumeration-constant
    728. 

  728. 

  729. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED_HIDDEN** = ``4``
    730. 

  730. 

  731. Confines the mouse cursor to the game window, and make it hidden.
    732. 

  732. 

  733. .. rst-class:: classref-item-separator
    734. 

  734. 

  735. ----
    736. 

  736. 

  737. .. _enum_DisplayServer_ScreenOrientation:
    738. 

  738. 

  739. .. rst-class:: classref-enumeration
    740. 

  740. 

  741. enum **ScreenOrientation**: :ref:`🔗<enum_DisplayServer_ScreenOrientation>`
    742. 

  742. 

  743. .. _class_DisplayServer_constant_SCREEN_LANDSCAPE:
    744. 

  744. 

  745. .. rst-class:: classref-enumeration-constant
    746. 

  746. 

  747. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_LANDSCAPE** = ``0``
    748. 

  748. 

  749. Default landscape orientation.
    750. 

  750. 

  751. .. _class_DisplayServer_constant_SCREEN_PORTRAIT:
    752. 

  752. 

  753. .. rst-class:: classref-enumeration-constant
    754. 

  754. 

  755. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_PORTRAIT** = ``1``
    756. 

  756. 

  757. Default portrait orientation.
    758. 

  758. 

  759. .. _class_DisplayServer_constant_SCREEN_REVERSE_LANDSCAPE:
    760. 

  760. 

  761. .. rst-class:: classref-enumeration-constant
    762. 

  762. 

  763. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_LANDSCAPE** = ``2``
    764. 

  764. 

  765. Reverse landscape orientation (upside down).
    766. 

  766. 

  767. .. _class_DisplayServer_constant_SCREEN_REVERSE_PORTRAIT:
    768. 

  768. 

  769. .. rst-class:: classref-enumeration-constant
    770. 

  770. 

  771. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_PORTRAIT** = ``3``
    772. 

  772. 

  773. Reverse portrait orientation (upside down).
    774. 

  774. 

  775. .. _class_DisplayServer_constant_SCREEN_SENSOR_LANDSCAPE:
    776. 

  776. 

  777. .. rst-class:: classref-enumeration-constant
    778. 

  778. 

  779. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_LANDSCAPE** = ``4``
    780. 

  780. 

  781. Automatic landscape orientation (default or reverse depending on sensor).
    782. 

  782. 

  783. .. _class_DisplayServer_constant_SCREEN_SENSOR_PORTRAIT:
    784. 

  784. 

  785. .. rst-class:: classref-enumeration-constant
    786. 

  786. 

  787. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_PORTRAIT** = ``5``
    788. 

  788. 

  789. Automatic portrait orientation (default or reverse depending on sensor).
    790. 

  790. 

  791. .. _class_DisplayServer_constant_SCREEN_SENSOR:
    792. 

  792. 

  793. .. rst-class:: classref-enumeration-constant
    794. 

  794. 

  795. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR** = ``6``
    796. 

  796. 

  797. Automatic landscape or portrait orientation (default or reverse depending on sensor).
    798. 

  798. 

  799. .. rst-class:: classref-item-separator
    800. 

  800. 

  801. ----
    802. 

  802. 

  803. .. _enum_DisplayServer_VirtualKeyboardType:
    804. 

  804. 

  805. .. rst-class:: classref-enumeration
    806. 

  806. 

  807. enum **VirtualKeyboardType**: :ref:`🔗<enum_DisplayServer_VirtualKeyboardType>`
    808. 

  808. 

  809. .. _class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT:
    810. 

  810. 

  811. .. rst-class:: classref-enumeration-constant
    812. 

  812. 

  813. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_DEFAULT** = ``0``
    814. 

  814. 

  815. Default text virtual keyboard.
    816. 

  816. 

  817. .. _class_DisplayServer_constant_KEYBOARD_TYPE_MULTILINE:
    818. 

  818. 

  819. .. rst-class:: classref-enumeration-constant
    820. 

  820. 

  821. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_MULTILINE** = ``1``
    822. 

  822. 

  823. Multiline virtual keyboard.
    824. 

  824. 

  825. .. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER:
    826. 

  826. 

  827. .. rst-class:: classref-enumeration-constant
    828. 

  828. 

  829. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER** = ``2``
    830. 

  830. 

  831. Virtual number keypad, useful for PIN entry.
    832. 

  832. 

  833. .. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER_DECIMAL:
    834. 

  834. 

  835. .. rst-class:: classref-enumeration-constant
    836. 

  836. 

  837. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER_DECIMAL** = ``3``
    838. 

  838. 

  839. Virtual number keypad, useful for entering fractional numbers.
    840. 

  840. 

  841. .. _class_DisplayServer_constant_KEYBOARD_TYPE_PHONE:
    842. 

  842. 

  843. .. rst-class:: classref-enumeration-constant
    844. 

  844. 

  845. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PHONE** = ``4``
    846. 

  846. 

  847. Virtual phone number keypad.
    848. 

  848. 

  849. .. _class_DisplayServer_constant_KEYBOARD_TYPE_EMAIL_ADDRESS:
    850. 

  850. 

  851. .. rst-class:: classref-enumeration-constant
    852. 

  852. 

  853. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_EMAIL_ADDRESS** = ``5``
    854. 

  854. 

  855. Virtual keyboard with additional keys to assist with typing email addresses.
    856. 

  856. 

  857. .. _class_DisplayServer_constant_KEYBOARD_TYPE_PASSWORD:
    858. 

  858. 

  859. .. rst-class:: classref-enumeration-constant
    860. 

  860. 

  861. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PASSWORD** = ``6``
    862. 

  862. 

  863. Virtual keyboard for entering a password. On most platforms, this should disable autocomplete and autocapitalization.
    864. 

  864. 

  865. \ **Note:** This is not supported on Web. Instead, this behaves identically to :ref:`KEYBOARD_TYPE_DEFAULT<class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT>`.
    866. 

  866. 

  867. .. _class_DisplayServer_constant_KEYBOARD_TYPE_URL:
    868. 

  868. 

  869. .. rst-class:: classref-enumeration-constant
    870. 

  870. 

  871. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_URL** = ``7``
    872. 

  872. 

  873. Virtual keyboard with additional keys to assist with typing URLs.
    874. 

  874. 

  875. .. rst-class:: classref-item-separator
    876. 

  876. 

  877. ----
    878. 

  878. 

  879. .. _enum_DisplayServer_CursorShape:
    880. 

  880. 

  881. .. rst-class:: classref-enumeration
    882. 

  882. 

  883. enum **CursorShape**: :ref:`🔗<enum_DisplayServer_CursorShape>`
    884. 

  884. 

  885. .. _class_DisplayServer_constant_CURSOR_ARROW:
    886. 

  886. 

  887. .. rst-class:: classref-enumeration-constant
    888. 

  888. 

  889. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_ARROW** = ``0``
    890. 

  890. 

  891. 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>`.
    892. 

  892. 

  893. .. _class_DisplayServer_constant_CURSOR_IBEAM:
    894. 

  894. 

  895. .. rst-class:: classref-enumeration-constant
    896. 

  896. 

  897. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_IBEAM** = ``1``
    898. 

  898. 

  899. 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>`.
    900. 

  900. 

  901. .. _class_DisplayServer_constant_CURSOR_POINTING_HAND:
    902. 

  902. 

  903. .. rst-class:: classref-enumeration-constant
    904. 

  904. 

  905. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_POINTING_HAND** = ``2``
    906. 

  906. 

  907. 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>`.
    908. 

  908. 

  909. .. _class_DisplayServer_constant_CURSOR_CROSS:
    910. 

  910. 

  911. .. rst-class:: classref-enumeration-constant
    912. 

  912. 

  913. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CROSS** = ``3``
    914. 

  914. 

  915. 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.
    916. 

  916. 

  917. .. _class_DisplayServer_constant_CURSOR_WAIT:
    918. 

  918. 

  919. .. rst-class:: classref-enumeration-constant
    920. 

  920. 

  921. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_WAIT** = ``4``
    922. 

  922. 

  923. 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>`.
    924. 

  924. 

  925. .. _class_DisplayServer_constant_CURSOR_BUSY:
    926. 

  926. 

  927. .. rst-class:: classref-enumeration-constant
    928. 

  928. 

  929. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BUSY** = ``5``
    930. 

  930. 

  931. 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>`.
    932. 

  932. 

  933. .. _class_DisplayServer_constant_CURSOR_DRAG:
    934. 

  934. 

  935. .. rst-class:: classref-enumeration-constant
    936. 

  936. 

  937. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_DRAG** = ``6``
    938. 

  938. 

  939. Dragging hand cursor. This is displayed during drag-and-drop operations. See also :ref:`CURSOR_CAN_DROP<class_DisplayServer_constant_CURSOR_CAN_DROP>`.
    940. 

  940. 

  941. .. _class_DisplayServer_constant_CURSOR_CAN_DROP:
    942. 

  942. 

  943. .. rst-class:: classref-enumeration-constant
    944. 

  944. 

  945. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CAN_DROP** = ``7``
    946. 

  946. 

  947. "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>`.
    948. 

  948. 

  949. .. _class_DisplayServer_constant_CURSOR_FORBIDDEN:
    950. 

  950. 

  951. .. rst-class:: classref-enumeration-constant
    952. 

  952. 

  953. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FORBIDDEN** = ``8``
    954. 

  954. 

  955. 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.
    956. 

  956. 

  957. .. _class_DisplayServer_constant_CURSOR_VSIZE:
    958. 

  958. 

  959. .. rst-class:: classref-enumeration-constant
    960. 

  960. 

  961. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSIZE** = ``9``
    962. 

  962. 

  963. 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>`.
    964. 

  964. 

  965. .. _class_DisplayServer_constant_CURSOR_HSIZE:
    966. 

  966. 

  967. .. rst-class:: classref-enumeration-constant
    968. 

  968. 

  969. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSIZE** = ``10``
    970. 

  970. 

  971. 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>`.
    972. 

  972. 

  973. .. _class_DisplayServer_constant_CURSOR_BDIAGSIZE:
    974. 

  974. 

  975. .. rst-class:: classref-enumeration-constant
    976. 

  976. 

  977. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BDIAGSIZE** = ``11``
    978. 

  978. 

  979. 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.
    980. 

  980. 

  981. .. _class_DisplayServer_constant_CURSOR_FDIAGSIZE:
    982. 

  982. 

  983. .. rst-class:: classref-enumeration-constant
    984. 

  984. 

  985. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FDIAGSIZE** = ``12``
    986. 

  986. 

  987. 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.
    988. 

  988. 

  989. .. _class_DisplayServer_constant_CURSOR_MOVE:
    990. 

  990. 

  991. .. rst-class:: classref-enumeration-constant
    992. 

  992. 

  993. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MOVE** = ``13``
    994. 

  994. 

  995. Move cursor. Intended to be displayed when the hovered :ref:`Control<class_Control>` can be moved using the mouse.
    996. 

  996. 

  997. .. _class_DisplayServer_constant_CURSOR_VSPLIT:
    998. 

  998. 

  999. .. rst-class:: classref-enumeration-constant
    1000. 

  1000. 

  1001. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSPLIT** = ``14``
    1002. 

  1002. 

  1003. 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>`.
    1004. 

  1004. 

  1005. .. _class_DisplayServer_constant_CURSOR_HSPLIT:
    1006. 

  1006. 

  1007. .. rst-class:: classref-enumeration-constant
    1008. 

  1008. 

  1009. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSPLIT** = ``15``
    1010. 

  1010. 

  1011. 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>`.
    1012. 

  1012. 

  1013. .. _class_DisplayServer_constant_CURSOR_HELP:
    1014. 

  1014. 

  1015. .. rst-class:: classref-enumeration-constant
    1016. 

  1016. 

  1017. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HELP** = ``16``
    1018. 

  1018. 

  1019. 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.
    1020. 

  1020. 

  1021. .. _class_DisplayServer_constant_CURSOR_MAX:
    1022. 

  1022. 

  1023. .. rst-class:: classref-enumeration-constant
    1024. 

  1024. 

  1025. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MAX** = ``17``
    1026. 

  1026. 

  1027. Represents the size of the :ref:`CursorShape<enum_DisplayServer_CursorShape>` enum.
    1028. 

  1028. 

  1029. .. rst-class:: classref-item-separator
    1030. 

  1030. 

  1031. ----
    1032. 

  1032. 

  1033. .. _enum_DisplayServer_FileDialogMode:
    1034. 

  1034. 

  1035. .. rst-class:: classref-enumeration
    1036. 

  1036. 

  1037. enum **FileDialogMode**: :ref:`🔗<enum_DisplayServer_FileDialogMode>`
    1038. 

  1038. 

  1039. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILE:
    1040. 

  1040. 

  1041. .. rst-class:: classref-enumeration-constant
    1042. 

  1042. 

  1043. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILE** = ``0``
    1044. 

  1044. 

  1045. The native file dialog allows selecting one, and only one file.
    1046. 

  1046. 

  1047. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILES:
    1048. 

  1048. 

  1049. .. rst-class:: classref-enumeration-constant
    1050. 

  1050. 

  1051. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILES** = ``1``
    1052. 

  1052. 

  1053. The native file dialog allows selecting multiple files.
    1054. 

  1054. 

  1055. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_DIR:
    1056. 

  1056. 

  1057. .. rst-class:: classref-enumeration-constant
    1058. 

  1058. 

  1059. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_DIR** = ``2``
    1060. 

  1060. 

  1061. The native file dialog only allows selecting a directory, disallowing the selection of any file.
    1062. 

  1062. 

  1063. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_ANY:
    1064. 

  1064. 

  1065. .. rst-class:: classref-enumeration-constant
    1066. 

  1066. 

  1067. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_ANY** = ``3``
    1068. 

  1068. 

  1069. The native file dialog allows selecting one file or directory.
    1070. 

  1070. 

  1071. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_SAVE_FILE:
    1072. 

  1072. 

  1073. .. rst-class:: classref-enumeration-constant
    1074. 

  1074. 

  1075. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_SAVE_FILE** = ``4``
    1076. 

  1076. 

  1077. The native file dialog will warn when a file exists.
    1078. 

  1078. 

  1079. .. rst-class:: classref-item-separator
    1080. 

  1080. 

  1081. ----
    1082. 

  1082. 

  1083. .. _enum_DisplayServer_WindowMode:
    1084. 

  1084. 

  1085. .. rst-class:: classref-enumeration
    1086. 

  1086. 

  1087. enum **WindowMode**: :ref:`🔗<enum_DisplayServer_WindowMode>`
    1088. 

  1088. 

  1089. .. _class_DisplayServer_constant_WINDOW_MODE_WINDOWED:
    1090. 

  1090. 

  1091. .. rst-class:: classref-enumeration-constant
    1092. 

  1092. 

  1093. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_WINDOWED** = ``0``
    1094. 

  1094. 

  1095. Windowed mode, i.e. :ref:`Window<class_Window>` doesn't occupy the whole screen (unless set to the size of the screen).
    1096. 

  1096. 

  1097. .. _class_DisplayServer_constant_WINDOW_MODE_MINIMIZED:
    1098. 

  1098. 

  1099. .. rst-class:: classref-enumeration-constant
    1100. 

  1100. 

  1101. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MINIMIZED** = ``1``
    1102. 

  1102. 

  1103. 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.
    1104. 

  1104. 

  1105. .. _class_DisplayServer_constant_WINDOW_MODE_MAXIMIZED:
    1106. 

  1106. 

  1107. .. rst-class:: classref-enumeration-constant
    1108. 

  1108. 

  1109. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MAXIMIZED** = ``2``
    1110. 

  1110. 

  1111. 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.
    1112. 

  1112. 

  1113. .. _class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN:
    1114. 

  1114. 

  1115. .. rst-class:: classref-enumeration-constant
    1116. 

  1116. 

  1117. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_FULLSCREEN** = ``3``
    1118. 

  1118. 

  1119. Full screen mode with full multi-window support.
    1120. 

  1120. 

  1121. Full screen window covers the entire display area of a screen and has no decorations. The display's video mode is not changed.
    1122. 

  1122. 

  1123. \ **On Android:** This enables immersive mode.
    1124. 

  1124. 

  1125. \ **On Windows:** Multi-window full-screen mode has a 1px border of the :ref:`ProjectSettings.rendering/environment/defaults/default_clear_color<class_ProjectSettings_property_rendering/environment/defaults/default_clear_color>` color.
    1126. 

  1126. 

  1127. \ **On macOS:** A new desktop is used to display the running project.
    1128. 

  1128. 

  1129. \ **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.
    1130. 

  1130. 

  1131. .. _class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN:
    1132. 

  1132. 

  1133. .. rst-class:: classref-enumeration-constant
    1134. 

  1134. 

  1135. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_EXCLUSIVE_FULLSCREEN** = ``4``
    1136. 

  1136. 

  1137. 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).
    1138. 

  1138. 

  1139. 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.
    1140. 

  1140. 

  1141. \ **On Android:** This enables immersive mode.
    1142. 

  1142. 

  1143. \ **On Windows:** Depending on video driver, full screen transition might cause screens to go black for a moment.
    1144. 

  1144. 

  1145. \ **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.
    1146. 

  1146. 

  1147. \ **On Linux (X11):** Exclusive full screen mode bypasses compositor.
    1148. 

  1148. 

  1149. \ **On Linux (Wayland):** Equivalent to :ref:`WINDOW_MODE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN>`.
    1150. 

  1150. 

  1151. \ **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.
    1152. 

  1152. 

  1153. .. rst-class:: classref-item-separator
    1154. 

  1154. 

  1155. ----
    1156. 

  1156. 

  1157. .. _enum_DisplayServer_WindowFlags:
    1158. 

  1158. 

  1159. .. rst-class:: classref-enumeration
    1160. 

  1160. 

  1161. enum **WindowFlags**: :ref:`🔗<enum_DisplayServer_WindowFlags>`
    1162. 

  1162. 

  1163. .. _class_DisplayServer_constant_WINDOW_FLAG_RESIZE_DISABLED:
    1164. 

  1164. 

  1165. .. rst-class:: classref-enumeration-constant
    1166. 

  1166. 

  1167. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_RESIZE_DISABLED** = ``0``
    1168. 

  1168. 

  1169. 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.
    1170. 

  1170. 

  1171. .. _class_DisplayServer_constant_WINDOW_FLAG_BORDERLESS:
    1172. 

  1172. 

  1173. .. rst-class:: classref-enumeration-constant
    1174. 

  1174. 

  1175. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_BORDERLESS** = ``1``
    1176. 

  1176. 

  1177. The window do not have native title bar and other decorations. This flag is ignored for full-screen windows.
    1178. 

  1178. 

  1179. .. _class_DisplayServer_constant_WINDOW_FLAG_ALWAYS_ON_TOP:
    1180. 

  1180. 

  1181. .. rst-class:: classref-enumeration-constant
    1182. 

  1182. 

  1183. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_ALWAYS_ON_TOP** = ``2``
    1184. 

  1184. 

  1185. The window is floating on top of all other windows. This flag is ignored for full-screen windows.
    1186. 

  1186. 

  1187. .. _class_DisplayServer_constant_WINDOW_FLAG_TRANSPARENT:
    1188. 

  1188. 

  1189. .. rst-class:: classref-enumeration-constant
    1190. 

  1190. 

  1191. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_TRANSPARENT** = ``3``
    1192. 

  1192. 

  1193. The window background can be transparent.
    1194. 

  1194. 

  1195. \ **Note:** This flag has no effect if :ref:`is_window_transparency_available<class_DisplayServer_method_is_window_transparency_available>` returns ``false``.
    1196. 

  1196. 

  1197. \ **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.
    1198. 

  1198. 

  1199. .. _class_DisplayServer_constant_WINDOW_FLAG_NO_FOCUS:
    1200. 

  1200. 

  1201. .. rst-class:: classref-enumeration-constant
    1202. 

  1202. 

  1203. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_NO_FOCUS** = ``4``
    1204. 

  1204. 

  1205. The window can't be focused. No-focus window will ignore all input, except mouse clicks.
    1206. 

  1206. 

  1207. .. _class_DisplayServer_constant_WINDOW_FLAG_POPUP:
    1208. 

  1208. 

  1209. .. rst-class:: classref-enumeration-constant
    1210. 

  1210. 

  1211. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_POPUP** = ``5``
    1212. 

  1212. 

  1213. 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>`).
    1214. 

  1214. 

  1215. .. _class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE:
    1216. 

  1216. 

  1217. .. rst-class:: classref-enumeration-constant
    1218. 

  1218. 

  1219. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_EXTEND_TO_TITLE** = ``6``
    1220. 

  1220. 

  1221. 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.
    1222. 

  1222. 

  1223. Use :ref:`window_set_window_buttons_offset<class_DisplayServer_method_window_set_window_buttons_offset>` to adjust minimize/maximize/close buttons offset.
    1224. 

  1224. 

  1225. 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.
    1226. 

  1226. 

  1227. \ **Note:** This flag is implemented only on macOS.
    1228. 

  1228. 

  1229. .. _class_DisplayServer_constant_WINDOW_FLAG_MOUSE_PASSTHROUGH:
    1230. 

  1230. 

  1231. .. rst-class:: classref-enumeration-constant
    1232. 

  1232. 

  1233. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MOUSE_PASSTHROUGH** = ``7``
    1234. 

  1234. 

  1235. All mouse events are passed to the underlying window of the same application.
    1236. 

  1236. 

  1237. .. _class_DisplayServer_constant_WINDOW_FLAG_SHARP_CORNERS:
    1238. 

  1238. 

  1239. .. rst-class:: classref-enumeration-constant
    1240. 

  1240. 

  1241. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_SHARP_CORNERS** = ``8``
    1242. 

  1242. 

  1243. Window style is overridden, forcing sharp corners.
    1244. 

  1244. 

  1245. \ **Note:** This flag is implemented only on Windows (11).
    1246. 

  1246. 

  1247. .. _class_DisplayServer_constant_WINDOW_FLAG_EXCLUDE_FROM_CAPTURE:
    1248. 

  1248. 

  1249. .. rst-class:: classref-enumeration-constant
    1250. 

  1250. 

  1251. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_EXCLUDE_FROM_CAPTURE** = ``9``
    1252. 

  1252. 

  1253. Windows 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>`.
    1254. 

  1254. 

  1255. \ **Note:** This flag is implemented on macOS and Windows.
    1256. 

  1256. 

  1257. \ **Note:** Setting this flag will **NOT** prevent other apps from capturing an image, it should not be used as a security measure.
    1258. 

  1258. 

  1259. .. _class_DisplayServer_constant_WINDOW_FLAG_MAX:
    1260. 

  1260. 

  1261. .. rst-class:: classref-enumeration-constant
    1262. 

  1262. 

  1263. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MAX** = ``10``
    1264. 

  1264. 

  1265. Max value of the :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`.
    1266. 

  1266. 

  1267. .. rst-class:: classref-item-separator
    1268. 

  1268. 

  1269. ----
    1270. 

  1270. 

  1271. .. _enum_DisplayServer_WindowEvent:
    1272. 

  1272. 

  1273. .. rst-class:: classref-enumeration
    1274. 

  1274. 

  1275. enum **WindowEvent**: :ref:`🔗<enum_DisplayServer_WindowEvent>`
    1276. 

  1276. 

  1277. .. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_ENTER:
    1278. 

  1278. 

  1279. .. rst-class:: classref-enumeration-constant
    1280. 

  1280. 

  1281. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_ENTER** = ``0``
    1282. 

  1282. 

  1283. Sent when the mouse pointer enters the window.
    1284. 

  1284. 

  1285. .. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_EXIT:
    1286. 

  1286. 

  1287. .. rst-class:: classref-enumeration-constant
    1288. 

  1288. 

  1289. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_EXIT** = ``1``
    1290. 

  1290. 

  1291. Sent when the mouse pointer exits the window.
    1292. 

  1292. 

  1293. .. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_IN:
    1294. 

  1294. 

  1295. .. rst-class:: classref-enumeration-constant
    1296. 

  1296. 

  1297. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_IN** = ``2``
    1298. 

  1298. 

  1299. Sent when the window grabs focus.
    1300. 

  1300. 

  1301. .. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_OUT:
    1302. 

  1302. 

  1303. .. rst-class:: classref-enumeration-constant
    1304. 

  1304. 

  1305. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_OUT** = ``3``
    1306. 

  1306. 

  1307. Sent when the window loses focus.
    1308. 

  1308. 

  1309. .. _class_DisplayServer_constant_WINDOW_EVENT_CLOSE_REQUEST:
    1310. 

  1310. 

  1311. .. rst-class:: classref-enumeration-constant
    1312. 

  1312. 

  1313. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_CLOSE_REQUEST** = ``4``
    1314. 

  1314. 

  1315. Sent when the user has attempted to close the window (e.g. close button is pressed).
    1316. 

  1316. 

  1317. .. _class_DisplayServer_constant_WINDOW_EVENT_GO_BACK_REQUEST:
    1318. 

  1318. 

  1319. .. rst-class:: classref-enumeration-constant
    1320. 

  1320. 

  1321. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_GO_BACK_REQUEST** = ``5``
    1322. 

  1322. 

  1323. Sent when the device "Back" button is pressed.
    1324. 

  1324. 

  1325. \ **Note:** This event is implemented only on Android.
    1326. 

  1326. 

  1327. .. _class_DisplayServer_constant_WINDOW_EVENT_DPI_CHANGE:
    1328. 

  1328. 

  1329. .. rst-class:: classref-enumeration-constant
    1330. 

  1330. 

  1331. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_DPI_CHANGE** = ``6``
    1332. 

  1332. 

  1333. Sent when the window is moved to the display with different DPI, or display DPI is changed.
    1334. 

  1334. 

  1335. \ **Note:** This flag is implemented only on macOS.
    1336. 

  1336. 

  1337. .. _class_DisplayServer_constant_WINDOW_EVENT_TITLEBAR_CHANGE:
    1338. 

  1338. 

  1339. .. rst-class:: classref-enumeration-constant
    1340. 

  1340. 

  1341. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_TITLEBAR_CHANGE** = ``7``
    1342. 

  1342. 

  1343. 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).
    1344. 

  1344. 

  1345. \ **Note:** This flag is implemented only on macOS.
    1346. 

  1346. 

  1347. .. rst-class:: classref-item-separator
    1348. 

  1348. 

  1349. ----
    1350. 

  1350. 

  1351. .. _enum_DisplayServer_WindowResizeEdge:
    1352. 

  1352. 

  1353. .. rst-class:: classref-enumeration
    1354. 

  1354. 

  1355. enum **WindowResizeEdge**: :ref:`🔗<enum_DisplayServer_WindowResizeEdge>`
    1356. 

  1356. 

  1357. .. _class_DisplayServer_constant_WINDOW_EDGE_TOP_LEFT:
    1358. 

  1358. 

  1359. .. rst-class:: classref-enumeration-constant
    1360. 

  1360. 

  1361. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_TOP_LEFT** = ``0``
    1362. 

  1362. 

  1363. Top-left edge of a window.
    1364. 

  1364. 

  1365. .. _class_DisplayServer_constant_WINDOW_EDGE_TOP:
    1366. 

  1366. 

  1367. .. rst-class:: classref-enumeration-constant
    1368. 

  1368. 

  1369. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_TOP** = ``1``
    1370. 

  1370. 

  1371. Top edge of a window.
    1372. 

  1372. 

  1373. .. _class_DisplayServer_constant_WINDOW_EDGE_TOP_RIGHT:
    1374. 

  1374. 

  1375. .. rst-class:: classref-enumeration-constant
    1376. 

  1376. 

  1377. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_TOP_RIGHT** = ``2``
    1378. 

  1378. 

  1379. Top-right edge of a window.
    1380. 

  1380. 

  1381. .. _class_DisplayServer_constant_WINDOW_EDGE_LEFT:
    1382. 

  1382. 

  1383. .. rst-class:: classref-enumeration-constant
    1384. 

  1384. 

  1385. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_LEFT** = ``3``
    1386. 

  1386. 

  1387. Left edge of a window.
    1388. 

  1388. 

  1389. .. _class_DisplayServer_constant_WINDOW_EDGE_RIGHT:
    1390. 

  1390. 

  1391. .. rst-class:: classref-enumeration-constant
    1392. 

  1392. 

  1393. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_RIGHT** = ``4``
    1394. 

  1394. 

  1395. Right edge of a window.
    1396. 

  1396. 

  1397. .. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM_LEFT:
    1398. 

  1398. 

  1399. .. rst-class:: classref-enumeration-constant
    1400. 

  1400. 

  1401. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_BOTTOM_LEFT** = ``5``
    1402. 

  1402. 

  1403. Bottom-left edge of a window.
    1404. 

  1404. 

  1405. .. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM:
    1406. 

  1406. 

  1407. .. rst-class:: classref-enumeration-constant
    1408. 

  1408. 

  1409. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_BOTTOM** = ``6``
    1410. 

  1410. 

  1411. Bottom edge of a window.
    1412. 

  1412. 

  1413. .. _class_DisplayServer_constant_WINDOW_EDGE_BOTTOM_RIGHT:
    1414. 

  1414. 

  1415. .. rst-class:: classref-enumeration-constant
    1416. 

  1416. 

  1417. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_BOTTOM_RIGHT** = ``7``
    1418. 

  1418. 

  1419. Bottom-right edge of a window.
    1420. 

  1420. 

  1421. .. _class_DisplayServer_constant_WINDOW_EDGE_MAX:
    1422. 

  1422. 

  1423. .. rst-class:: classref-enumeration-constant
    1424. 

  1424. 

  1425. :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` **WINDOW_EDGE_MAX** = ``8``
    1426. 

  1426. 

  1427. Represents the size of the :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>` enum.
    1428. 

  1428. 

  1429. .. rst-class:: classref-item-separator
    1430. 

  1430. 

  1431. ----
    1432. 

  1432. 

  1433. .. _enum_DisplayServer_VSyncMode:
    1434. 

  1434. 

  1435. .. rst-class:: classref-enumeration
    1436. 

  1436. 

  1437. enum **VSyncMode**: :ref:`🔗<enum_DisplayServer_VSyncMode>`
    1438. 

  1438. 

  1439. .. _class_DisplayServer_constant_VSYNC_DISABLED:
    1440. 

  1440. 

  1441. .. rst-class:: classref-enumeration-constant
    1442. 

  1442. 

  1443. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_DISABLED** = ``0``
    1444. 

  1444. 

  1445. 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>`).
    1446. 

  1446. 

  1447. .. _class_DisplayServer_constant_VSYNC_ENABLED:
    1448. 

  1448. 

  1449. .. rst-class:: classref-enumeration-constant
    1450. 

  1450. 

  1451. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ENABLED** = ``1``
    1452. 

  1452. 

  1453. 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>`).
    1454. 

  1454. 

  1455. .. _class_DisplayServer_constant_VSYNC_ADAPTIVE:
    1456. 

  1456. 

  1457. .. rst-class:: classref-enumeration-constant
    1458. 

  1458. 

  1459. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ADAPTIVE** = ``2``
    1460. 

  1460. 

  1461. 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.
    1462. 

  1462. 

  1463. .. _class_DisplayServer_constant_VSYNC_MAILBOX:
    1464. 

  1464. 

  1465. .. rst-class:: classref-enumeration-constant
    1466. 

  1466. 

  1467. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_MAILBOX** = ``3``
    1468. 

  1468. 

  1469. 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>`).
    1470. 

  1470. 

  1471. 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.
    1472. 

  1472. 

  1473. .. rst-class:: classref-item-separator
    1474. 

  1474. 

  1475. ----
    1476. 

  1476. 

  1477. .. _enum_DisplayServer_HandleType:
    1478. 

  1478. 

  1479. .. rst-class:: classref-enumeration
    1480. 

  1480. 

  1481. enum **HandleType**: :ref:`🔗<enum_DisplayServer_HandleType>`
    1482. 

  1482. 

  1483. .. _class_DisplayServer_constant_DISPLAY_HANDLE:
    1484. 

  1484. 

  1485. .. rst-class:: classref-enumeration-constant
    1486. 

  1486. 

  1487. :ref:`HandleType<enum_DisplayServer_HandleType>` **DISPLAY_HANDLE** = ``0``
    1488. 

  1488. 

  1489. Display handle:
    1490. 

  1490. 

  1491. - Linux (X11): ``X11::Display*`` for the display.
    1492. 

  1492. 

  1493. - Linux (Wayland): ``wl_display`` for the display.
    1494. 

  1494. 

  1495. - Android: ``EGLDisplay`` for the display.
    1496. 

  1496. 

  1497. .. _class_DisplayServer_constant_WINDOW_HANDLE:
    1498. 

  1498. 

  1499. .. rst-class:: classref-enumeration-constant
    1500. 

  1500. 

  1501. :ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_HANDLE** = ``1``
    1502. 

  1502. 

  1503. Window handle:
    1504. 

  1504. 

  1505. - Windows: ``HWND`` for the window.
    1506. 

  1506. 

  1507. - Linux (X11): ``X11::Window*`` for the window.
    1508. 

  1508. 

  1509. - Linux (Wayland): ``wl_surface`` for the window.
    1510. 

  1510. 

  1511. - macOS: ``NSWindow*`` for the window.
    1512. 

  1512. 

  1513. - iOS: ``UIViewController*`` for the view controller.
    1514. 

  1514. 

  1515. - Android: ``jObject`` for the activity.
    1516. 

  1516. 

  1517. .. _class_DisplayServer_constant_WINDOW_VIEW:
    1518. 

  1518. 

  1519. .. rst-class:: classref-enumeration-constant
    1520. 

  1520. 

  1521. :ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_VIEW** = ``2``
    1522. 

  1522. 

  1523. Window view:
    1524. 

  1524. 

  1525. - Windows: ``HDC`` for the window (only with the Compatibility renderer).
    1526. 

  1526. 

  1527. - macOS: ``NSView*`` for the window main view.
    1528. 

  1528. 

  1529. - iOS: ``UIView*`` for the window main view.
    1530. 

  1530. 

  1531. .. _class_DisplayServer_constant_OPENGL_CONTEXT:
    1532. 

  1532. 

  1533. .. rst-class:: classref-enumeration-constant
    1534. 

  1534. 

  1535. :ref:`HandleType<enum_DisplayServer_HandleType>` **OPENGL_CONTEXT** = ``3``
    1536. 

  1536. 

  1537. OpenGL context (only with the Compatibility renderer):
    1538. 

  1538. 

  1539. - Windows: ``HGLRC`` for the window (native GL), or ``EGLContext`` for the window (ANGLE).
    1540. 

  1540. 

  1541. - Linux (X11): ``GLXContext*`` for the window.
    1542. 

  1542. 

  1543. - Linux (Wayland): ``EGLContext`` for the window.
    1544. 

  1544. 

  1545. - macOS: ``NSOpenGLContext*`` for the window (native GL), or ``EGLContext`` for the window (ANGLE).
    1546. 

  1546. 

  1547. - Android: ``EGLContext`` for the window.
    1548. 

  1548. 

  1549. .. _class_DisplayServer_constant_EGL_DISPLAY:
    1550. 

  1550. 

  1551. .. rst-class:: classref-enumeration-constant
    1552. 

  1552. 

  1553. :ref:`HandleType<enum_DisplayServer_HandleType>` **EGL_DISPLAY** = ``4``
    1554. 

  1554. 

  1555. - Windows: ``EGLDisplay`` for the window (ANGLE).
    1556. 

  1556. 

  1557. - macOS: ``EGLDisplay`` for the window (ANGLE).
    1558. 

  1558. 

  1559. - Linux (Wayland): ``EGLDisplay`` for the window.
    1560. 

  1560. 

  1561. .. _class_DisplayServer_constant_EGL_CONFIG:
    1562. 

  1562. 

  1563. .. rst-class:: classref-enumeration-constant
    1564. 

  1564. 

  1565. :ref:`HandleType<enum_DisplayServer_HandleType>` **EGL_CONFIG** = ``5``
    1566. 

  1566. 

  1567. - Windows: ``EGLConfig`` for the window (ANGLE).
    1568. 

  1568. 

  1569. - macOS: ``EGLConfig`` for the window (ANGLE).
    1570. 

  1570. 

  1571. - Linux (Wayland): ``EGLConfig`` for the window.
    1572. 

  1572. 

  1573. .. rst-class:: classref-item-separator
    1574. 

  1574. 

  1575. ----
    1576. 

  1576. 

  1577. .. _enum_DisplayServer_TTSUtteranceEvent:
    1578. 

  1578. 

  1579. .. rst-class:: classref-enumeration
    1580. 

  1580. 

  1581. enum **TTSUtteranceEvent**: :ref:`🔗<enum_DisplayServer_TTSUtteranceEvent>`
    1582. 

  1582. 

  1583. .. _class_DisplayServer_constant_TTS_UTTERANCE_STARTED:
    1584. 

  1584. 

  1585. .. rst-class:: classref-enumeration-constant
    1586. 

  1586. 

  1587. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_STARTED** = ``0``
    1588. 

  1588. 

  1589. Utterance has begun to be spoken.
    1590. 

  1590. 

  1591. .. _class_DisplayServer_constant_TTS_UTTERANCE_ENDED:
    1592. 

  1592. 

  1593. .. rst-class:: classref-enumeration-constant
    1594. 

  1594. 

  1595. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_ENDED** = ``1``
    1596. 

  1596. 

  1597. Utterance was successfully finished.
    1598. 

  1598. 

  1599. .. _class_DisplayServer_constant_TTS_UTTERANCE_CANCELED:
    1600. 

  1600. 

  1601. .. rst-class:: classref-enumeration-constant
    1602. 

  1602. 

  1603. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_CANCELED** = ``2``
    1604. 

  1604. 

  1605. Utterance was canceled, or TTS service was unable to process it.
    1606. 

  1606. 

  1607. .. _class_DisplayServer_constant_TTS_UTTERANCE_BOUNDARY:
    1608. 

  1608. 

  1609. .. rst-class:: classref-enumeration-constant
    1610. 

  1610. 

  1611. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_BOUNDARY** = ``3``
    1612. 

  1612. 

  1613. Utterance reached a word or sentence boundary.
    1614. 

  1614. 

  1615. .. rst-class:: classref-section-separator
    1616. 

  1616. 

  1617. ----
    1618. 

  1618. 

  1619. .. rst-class:: classref-descriptions-group
    1620. 

  1620. 

  1621. Constants
    1622. 

  1622. ---------
    1623. 

  1623. 

  1624. .. _class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS:
    1625. 

  1625. 

  1626. .. rst-class:: classref-constant
    1627. 

  1627. 

  1628. **SCREEN_WITH_MOUSE_FOCUS** = ``-4`` :ref:`🔗<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`
    1629. 

  1629. 

  1630. Represents the screen containing the mouse pointer.
    1631. 

  1631. 

  1632. \ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``.
    1633. 

  1633. 

  1634. .. _class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS:
    1635. 

  1635. 

  1636. .. rst-class:: classref-constant
    1637. 

  1637. 

  1638. **SCREEN_WITH_KEYBOARD_FOCUS** = ``-3`` :ref:`🔗<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`
    1639. 

  1639. 

  1640. Represents the screen containing the window with the keyboard focus.
    1641. 

  1641. 

  1642. \ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``.
    1643. 

  1643. 

  1644. .. _class_DisplayServer_constant_SCREEN_PRIMARY:
    1645. 

  1645. 

  1646. .. rst-class:: classref-constant
    1647. 

  1647. 

  1648. **SCREEN_PRIMARY** = ``-2`` :ref:`🔗<class_DisplayServer_constant_SCREEN_PRIMARY>`
    1649. 

  1649. 

  1650. Represents the primary screen.
    1651. 

  1651. 

  1652. \ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``.
    1653. 

  1653. 

  1654. .. _class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW:
    1655. 

  1655. 

  1656. .. rst-class:: classref-constant
    1657. 

  1657. 

  1658. **SCREEN_OF_MAIN_WINDOW** = ``-1`` :ref:`🔗<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`
    1659. 

  1659. 

  1660. Represents the screen where the main window is located. This is usually the default value in functions that allow specifying one of several screens.
    1661. 

  1661. 

  1662. \ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``.
    1663. 

  1663. 

  1664. .. _class_DisplayServer_constant_MAIN_WINDOW_ID:
    1665. 

  1665. 

  1666. .. rst-class:: classref-constant
    1667. 

  1667. 

  1668. **MAIN_WINDOW_ID** = ``0`` :ref:`🔗<class_DisplayServer_constant_MAIN_WINDOW_ID>`
    1669. 

  1669. 

  1670. The ID of the main window spawned by the engine, which can be passed to methods expecting a ``window_id``.
    1671. 

  1671. 

  1672. .. _class_DisplayServer_constant_INVALID_WINDOW_ID:
    1673. 

  1673. 

  1674. .. rst-class:: classref-constant
    1675. 

  1675. 

  1676. **INVALID_WINDOW_ID** = ``-1`` :ref:`🔗<class_DisplayServer_constant_INVALID_WINDOW_ID>`
    1677. 

  1677. 

  1678. The ID that refers to a nonexistent window. This is returned by some **DisplayServer** methods if no window matches the requested result.
    1679. 

  1679. 

  1680. .. _class_DisplayServer_constant_INVALID_INDICATOR_ID:
    1681. 

  1681. 

  1682. .. rst-class:: classref-constant
    1683. 

  1683. 

  1684. **INVALID_INDICATOR_ID** = ``-1`` :ref:`🔗<class_DisplayServer_constant_INVALID_INDICATOR_ID>`
    1685. 

  1685. 

  1686. The ID that refers to a nonexistent application status indicator.
    1687. 

  1687. 

  1688. .. rst-class:: classref-section-separator
    1689. 

  1689. 

  1690. ----
    1691. 

  1691. 

  1692. .. rst-class:: classref-descriptions-group
    1693. 

  1693. 

  1694. Method Descriptions
    1695. 

  1695. -------------------
    1696. 

  1696. 

  1697. .. _class_DisplayServer_method_beep:
    1698. 

  1698. 

  1699. .. rst-class:: classref-method
    1700. 

  1700. 

  1701. |void| **beep**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_beep>`
    1702. 

  1702. 

  1703. 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.
    1704. 

  1704. 

  1705. \ **Note:** This method is implemented on macOS, Linux (X11/Wayland), and Windows.
    1706. 

  1706. 

  1707. .. rst-class:: classref-item-separator
    1708. 

  1708. 

  1709. ----
    1710. 

  1710. 

  1711. .. _class_DisplayServer_method_clipboard_get:
    1712. 

  1712. 

  1713. .. rst-class:: classref-method
    1714. 

  1714. 

  1715. :ref:`String<class_String>` **clipboard_get**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_clipboard_get>`
    1716. 

  1716. 

  1717. Returns the user's clipboard as a string if possible.
    1718. 

  1718. 

  1719. .. rst-class:: classref-item-separator
    1720. 

  1720. 

  1721. ----
    1722. 

  1722. 

  1723. .. _class_DisplayServer_method_clipboard_get_image:
    1724. 

  1724. 

  1725. .. rst-class:: classref-method
    1726. 

  1726. 

  1727. :ref:`Image<class_Image>` **clipboard_get_image**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_clipboard_get_image>`
    1728. 

  1728. 

  1729. Returns the user's clipboard as an image if possible.
    1730. 

  1730. 

  1731. \ **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.
    1732. 

  1732. 

  1733. .. rst-class:: classref-item-separator
    1734. 

  1734. 

  1735. ----
    1736. 

  1736. 

  1737. .. _class_DisplayServer_method_clipboard_get_primary:
    1738. 

  1738. 

  1739. .. rst-class:: classref-method
    1740. 

  1740. 

  1741. :ref:`String<class_String>` **clipboard_get_primary**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_clipboard_get_primary>`
    1742. 

  1742. 

  1743. 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.
    1744. 

  1744. 

  1745. \ **Note:** This method is only implemented on Linux (X11/Wayland).
    1746. 

  1746. 

  1747. .. rst-class:: classref-item-separator
    1748. 

  1748. 

  1749. ----
    1750. 

  1750. 

  1751. .. _class_DisplayServer_method_clipboard_has:
    1752. 

  1752. 

  1753. .. rst-class:: classref-method
    1754. 

  1754. 

  1755. :ref:`bool<class_bool>` **clipboard_has**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_clipboard_has>`
    1756. 

  1756. 

  1757. Returns ``true`` if there is a text content on the user's clipboard.
    1758. 

  1758. 

  1759. .. rst-class:: classref-item-separator
    1760. 

  1760. 

  1761. ----
    1762. 

  1762. 

  1763. .. _class_DisplayServer_method_clipboard_has_image:
    1764. 

  1764. 

  1765. .. rst-class:: classref-method
    1766. 

  1766. 

  1767. :ref:`bool<class_bool>` **clipboard_has_image**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_clipboard_has_image>`
    1768. 

  1768. 

  1769. Returns ``true`` if there is an image content on the user's clipboard.
    1770. 

  1770. 

  1771. .. rst-class:: classref-item-separator
    1772. 

  1772. 

  1773. ----
    1774. 

  1774. 

  1775. .. _class_DisplayServer_method_clipboard_set:
    1776. 

  1776. 

  1777. .. rst-class:: classref-method
    1778. 

  1778. 

  1779. |void| **clipboard_set**\ (\ clipboard\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_clipboard_set>`
    1780. 

  1780. 

  1781. Sets the user's clipboard content to the given string.
    1782. 

  1782. 

  1783. .. rst-class:: classref-item-separator
    1784. 

  1784. 

  1785. ----
    1786. 

  1786. 

  1787. .. _class_DisplayServer_method_clipboard_set_primary:
    1788. 

  1788. 

  1789. .. rst-class:: classref-method
    1790. 

  1790. 

  1791. |void| **clipboard_set_primary**\ (\ clipboard_primary\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_clipboard_set_primary>`
    1792. 

  1792. 

  1793. 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.
    1794. 

  1794. 

  1795. \ **Note:** This method is only implemented on Linux (X11/Wayland).
    1796. 

  1796. 

  1797. .. rst-class:: classref-item-separator
    1798. 

  1798. 

  1799. ----
    1800. 

  1800. 

  1801. .. _class_DisplayServer_method_create_status_indicator:
    1802. 

  1802. 

  1803. .. rst-class:: classref-method
    1804. 

  1804. 

  1805. :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>`
    1806. 

  1806. 

  1807. Creates a new application status indicator with the specified icon, tooltip, and activation callback.
    1808. 

  1808. 

  1809. \ ``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>`).
    1810. 

  1810. 

  1811. .. rst-class:: classref-item-separator
    1812. 

  1812. 

  1813. ----
    1814. 

  1814. 

  1815. .. _class_DisplayServer_method_cursor_get_shape:
    1816. 

  1816. 

  1817. .. rst-class:: classref-method
    1818. 

  1818. 

  1819. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **cursor_get_shape**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_cursor_get_shape>`
    1820. 

  1820. 

  1821. Returns the default mouse cursor shape set by :ref:`cursor_set_shape<class_DisplayServer_method_cursor_set_shape>`.
    1822. 

  1822. 

  1823. .. rst-class:: classref-item-separator
    1824. 

  1824. 

  1825. ----
    1826. 

  1826. 

  1827. .. _class_DisplayServer_method_cursor_set_custom_image:
    1828. 

  1828. 

  1829. .. rst-class:: classref-method
    1830. 

  1830. 

  1831. |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>`
    1832. 

  1832. 

  1833. 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.
    1834. 

  1834. 

  1835. \ ``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>`.
    1836. 

  1836. 

  1837. .. rst-class:: classref-item-separator
    1838. 

  1838. 

  1839. ----
    1840. 

  1840. 

  1841. .. _class_DisplayServer_method_cursor_set_shape:
    1842. 

  1842. 

  1843. .. rst-class:: classref-method
    1844. 

  1844. 

  1845. |void| **cursor_set_shape**\ (\ shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>`\ ) :ref:`🔗<class_DisplayServer_method_cursor_set_shape>`
    1846. 

  1846. 

  1847. 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>`.
    1848. 

  1848. 

  1849. .. rst-class:: classref-item-separator
    1850. 

  1850. 

  1851. ----
    1852. 

  1852. 

  1853. .. _class_DisplayServer_method_delete_status_indicator:
    1854. 

  1854. 

  1855. .. rst-class:: classref-method
    1856. 

  1856. 

  1857. |void| **delete_status_indicator**\ (\ id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_delete_status_indicator>`
    1858. 

  1858. 

  1859. Removes the application status indicator.
    1860. 

  1860. 

  1861. .. rst-class:: classref-item-separator
    1862. 

  1862. 

  1863. ----
    1864. 

  1864. 

  1865. .. _class_DisplayServer_method_dialog_input_text:
    1866. 

  1866. 

  1867. .. rst-class:: classref-method
    1868. 

  1868. 

  1869. :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>`
    1870. 

  1870. 

  1871. 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.
    1872. 

  1872. 

  1873. \ **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.
    1874. 

  1874. 

  1875. .. rst-class:: classref-item-separator
    1876. 

  1876. 

  1877. ----
    1878. 

  1878. 

  1879. .. _class_DisplayServer_method_dialog_show:
    1880. 

  1880. 

  1881. .. rst-class:: classref-method
    1882. 

  1882. 

  1883. :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>`
    1884. 

  1884. 

  1885. 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.
    1886. 

  1886. 

  1887. \ **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.
    1888. 

  1888. 

  1889. .. rst-class:: classref-item-separator
    1890. 

  1890. 

  1891. ----
    1892. 

  1892. 

  1893. .. _class_DisplayServer_method_enable_for_stealing_focus:
    1894. 

  1894. 

  1895. .. rst-class:: classref-method
    1896. 

  1896. 

  1897. |void| **enable_for_stealing_focus**\ (\ process_id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_enable_for_stealing_focus>`
    1898. 

  1898. 

  1899. 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.
    1900. 

  1900. 

  1901. \ **Note:** This method is implemented only on Windows.
    1902. 

  1902. 

  1903. .. rst-class:: classref-item-separator
    1904. 

  1904. 

  1905. ----
    1906. 

  1906. 

  1907. .. _class_DisplayServer_method_file_dialog_show:
    1908. 

  1908. 

  1909. .. rst-class:: classref-method
    1910. 

  1910. 

  1911. :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>`\ ) :ref:`🔗<class_DisplayServer_method_file_dialog_show>`
    1912. 

  1912. 

  1913. Displays OS native dialog for selecting files or directories in the file system.
    1914. 

  1914. 

  1915. 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>`.
    1916. 

  1916. 

  1917. Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int``. **On Android,** callback argument ``selected_filter_index`` is always zero.
    1918. 

  1918. 

  1919. \ **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.
    1920. 

  1920. 

  1921. \ **Note:** ``current_directory`` might be ignored.
    1922. 

  1922. 

  1923. \ **Note:** Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.
    1924. 

  1924. 

  1925. \ **Note:** On Android and Linux, ``show_hidden`` is ignored.
    1926. 

  1926. 

  1927. \ **Note:** On Android and macOS, native file dialogs have no title.
    1928. 

  1928. 

  1929. \ **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.
    1930. 

  1930. 

  1931. .. rst-class:: classref-item-separator
    1932. 

  1932. 

  1933. ----
    1934. 

  1934. 

  1935. .. _class_DisplayServer_method_file_dialog_with_options_show:
    1936. 

  1936. 

  1937. .. rst-class:: classref-method
    1938. 

  1938. 

  1939. :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>`\ ) :ref:`🔗<class_DisplayServer_method_file_dialog_with_options_show>`
    1940. 

  1940. 

  1941. Displays OS native dialog for selecting files or directories in the file system with additional user selectable options.
    1942. 

  1942. 

  1943. 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>`.
    1944. 

  1944. 

  1945. \ ``options`` is array of :ref:`Dictionary<class_Dictionary>`\ s with the following keys:
    1946. 

  1946. 

  1947. - ``"name"`` - option's name :ref:`String<class_String>`.
    1948. 

  1948. 

  1949. - ``"values"`` - :ref:`PackedStringArray<class_PackedStringArray>` of values. If empty, boolean option (check box) is used.
    1950. 

  1950. 

  1951. - ``"default"`` - default selected option index (:ref:`int<class_int>`) or default boolean value (:ref:`bool<class_bool>`).
    1952. 

  1952. 

  1953. Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int, selected_option: Dictionary``.
    1954. 

  1954. 

  1955. \ **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.
    1956. 

  1956. 

  1957. \ **Note:** ``current_directory`` might be ignored.
    1958. 

  1958. 

  1959. \ **Note:** Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types.
    1960. 

  1960. 

  1961. \ **Note:** On Linux (X11), ``show_hidden`` is ignored.
    1962. 

  1962. 

  1963. \ **Note:** On macOS, native file dialogs have no title.
    1964. 

  1964. 

  1965. \ **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.
    1966. 

  1966. 

  1967. .. rst-class:: classref-item-separator
    1968. 

  1968. 

  1969. ----
    1970. 

  1970. 

  1971. .. _class_DisplayServer_method_force_process_and_drop_events:
    1972. 

  1972. 

  1973. .. rst-class:: classref-method
    1974. 

  1974. 

  1975. |void| **force_process_and_drop_events**\ (\ ) :ref:`🔗<class_DisplayServer_method_force_process_and_drop_events>`
    1976. 

  1976. 

  1977. Forces window manager processing while ignoring all :ref:`InputEvent<class_InputEvent>`\ s. See also :ref:`process_events<class_DisplayServer_method_process_events>`.
    1978. 

  1978. 

  1979. \ **Note:** This method is implemented on Windows and macOS.
    1980. 

  1980. 

  1981. .. rst-class:: classref-item-separator
    1982. 

  1982. 

  1983. ----
    1984. 

  1984. 

  1985. .. _class_DisplayServer_method_get_accent_color:
    1986. 

  1986. 

  1987. .. rst-class:: classref-method
    1988. 

  1988. 

  1989. :ref:`Color<class_Color>` **get_accent_color**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_accent_color>`
    1990. 

  1990. 

  1991. Returns OS theme accent color. Returns ``Color(0, 0, 0, 0)``, if accent color is unknown.
    1992. 

  1992. 

  1993. \ **Note:** This method is implemented on macOS, Windows, and Android.
    1994. 

  1994. 

  1995. .. rst-class:: classref-item-separator
    1996. 

  1996. 

  1997. ----
    1998. 

  1998. 

  1999. .. _class_DisplayServer_method_get_base_color:
    2000. 

  2000. 

  2001. .. rst-class:: classref-method
    2002. 

  2002. 

  2003. :ref:`Color<class_Color>` **get_base_color**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_base_color>`
    2004. 

  2004. 

  2005. Returns the OS theme base color (default control background). Returns ``Color(0, 0, 0, 0)`` if the base color is unknown.
    2006. 

  2006. 

  2007. \ **Note:** This method is implemented on macOS, Windows, and Android.
    2008. 

  2008. 

  2009. .. rst-class:: classref-item-separator
    2010. 

  2010. 

  2011. ----
    2012. 

  2012. 

  2013. .. _class_DisplayServer_method_get_display_cutouts:
    2014. 

  2014. 

  2015. .. rst-class:: classref-method
    2016. 

  2016. 

  2017. :ref:`Array<class_Array>`\[:ref:`Rect2<class_Rect2>`\] **get_display_cutouts**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_display_cutouts>`
    2018. 

  2018. 

  2019. 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>`.
    2020. 

  2020. 

  2021. \ **Note:** Currently only implemented on Android. Other platforms will return an empty array even if they do have display cutouts or notches.
    2022. 

  2022. 

  2023. .. rst-class:: classref-item-separator
    2024. 

  2024. 

  2025. ----
    2026. 

  2026. 

  2027. .. _class_DisplayServer_method_get_display_safe_area:
    2028. 

  2028. 

  2029. .. rst-class:: classref-method
    2030. 

  2030. 

  2031. :ref:`Rect2i<class_Rect2i>` **get_display_safe_area**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_display_safe_area>`
    2032. 

  2032. 

  2033. 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>`.
    2034. 

  2034. 

  2035. \ **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>`.
    2036. 

  2036. 

  2037. .. rst-class:: classref-item-separator
    2038. 

  2038. 

  2039. ----
    2040. 

  2040. 

  2041. .. _class_DisplayServer_method_get_keyboard_focus_screen:
    2042. 

  2042. 

  2043. .. rst-class:: classref-method
    2044. 

  2044. 

  2045. :ref:`int<class_int>` **get_keyboard_focus_screen**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_keyboard_focus_screen>`
    2046. 

  2046. 

  2047. Returns the index of the screen containing the window with the keyboard focus, or the primary screen if there's no focused window.
    2048. 

  2048. 

  2049. .. rst-class:: classref-item-separator
    2050. 

  2050. 

  2051. ----
    2052. 

  2052. 

  2053. .. _class_DisplayServer_method_get_name:
    2054. 

  2054. 

  2055. .. rst-class:: classref-method
    2056. 

  2056. 

  2057. :ref:`String<class_String>` **get_name**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_name>`
    2058. 

  2058. 

  2059. 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).
    2060. 

  2060. 

  2061. 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>`).
    2062. 

  2062. 

  2063. .. rst-class:: classref-item-separator
    2064. 

  2064. 

  2065. ----
    2066. 

  2066. 

  2067. .. _class_DisplayServer_method_get_primary_screen:
    2068. 

  2068. 

  2069. .. rst-class:: classref-method
    2070. 

  2070. 

  2071. :ref:`int<class_int>` **get_primary_screen**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_primary_screen>`
    2072. 

  2072. 

  2073. Returns index of the primary screen.
    2074. 

  2074. 

  2075. .. rst-class:: classref-item-separator
    2076. 

  2076. 

  2077. ----
    2078. 

  2078. 

  2079. .. _class_DisplayServer_method_get_screen_count:
    2080. 

  2080. 

  2081. .. rst-class:: classref-method
    2082. 

  2082. 

  2083. :ref:`int<class_int>` **get_screen_count**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_screen_count>`
    2084. 

  2084. 

  2085. Returns the number of displays available.
    2086. 

  2086. 

  2087. .. rst-class:: classref-item-separator
    2088. 

  2088. 

  2089. ----
    2090. 

  2090. 

  2091. .. _class_DisplayServer_method_get_screen_from_rect:
    2092. 

  2092. 

  2093. .. rst-class:: classref-method
    2094. 

  2094. 

  2095. :ref:`int<class_int>` **get_screen_from_rect**\ (\ rect\: :ref:`Rect2<class_Rect2>`\ ) |const| :ref:`🔗<class_DisplayServer_method_get_screen_from_rect>`
    2096. 

  2096. 

  2097. Returns the index of the screen that overlaps the most with the given rectangle. Returns ``-1`` if the rectangle doesn't overlap with any screen or has no area.
    2098. 

  2098. 

  2099. .. rst-class:: classref-item-separator
    2100. 

  2100. 

  2101. ----
    2102. 

  2102. 

  2103. .. _class_DisplayServer_method_get_swap_cancel_ok:
    2104. 

  2104. 

  2105. .. rst-class:: classref-method
    2106. 

  2106. 

  2107. :ref:`bool<class_bool>` **get_swap_cancel_ok**\ (\ ) :ref:`🔗<class_DisplayServer_method_get_swap_cancel_ok>`
    2108. 

  2108. 

  2109. 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>`.
    2110. 

  2110. 

  2111. \ **Note:** This doesn't affect native dialogs such as the ones spawned by :ref:`dialog_show<class_DisplayServer_method_dialog_show>`.
    2112. 

  2112. 

  2113. .. rst-class:: classref-item-separator
    2114. 

  2114. 

  2115. ----
    2116. 

  2116. 

  2117. .. _class_DisplayServer_method_get_window_at_screen_position:
    2118. 

  2118. 

  2119. .. rst-class:: classref-method
    2120. 

  2120. 

  2121. :ref:`int<class_int>` **get_window_at_screen_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`🔗<class_DisplayServer_method_get_window_at_screen_position>`
    2122. 

  2122. 

  2123. 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:
    2124. 

  2124. 

  2125. .. code:: text
    2126. 

  2126. 

  2127.     * (0, 0)        +-------+
    2128. 

  2128.                     |       |
    2129. 

  2129.     +-------------+ |       |
    2130. 

  2130.     |             | |       |
    2131. 

  2131.     |             | |       |
    2132. 

  2132.     +-------------+ +-------+
    2133. 

  2133. 

  2134. .. rst-class:: classref-item-separator
    2135. 

  2135. 

  2136. ----
    2137. 

  2137. 

  2138. .. _class_DisplayServer_method_get_window_list:
    2139. 

  2139. 

  2140. .. rst-class:: classref-method
    2141. 

  2141. 

  2142. :ref:`PackedInt32Array<class_PackedInt32Array>` **get_window_list**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_get_window_list>`
    2143. 

  2143. 

  2144. Returns the list of Godot window IDs belonging to this process.
    2145. 

  2145. 

  2146. \ **Note:** Native dialogs are not included in this list.
    2147. 

  2147. 

  2148. .. rst-class:: classref-item-separator
    2149. 

  2149. 

  2150. ----
    2151. 

  2151. 

  2152. .. _class_DisplayServer_method_global_menu_add_check_item:
    2153. 

  2153. 

  2154. .. rst-class:: classref-method
    2155. 

  2155. 

  2156. :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>`
    2157. 

  2157. 

  2158. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2159. 

  2159. 

  2160. Adds a new checkable item with text ``label`` to the global menu with ID ``menu_root``.
    2161. 

  2161. 

  2162. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    2163. 

  2163. 

  2164. 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`).
    2165. 

  2165. 

  2166. \ **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``.
    2167. 

  2167. 

  2168. \ **Note:** This method is implemented only on macOS.
    2169. 

  2169. 

  2170. \ **Supported system menu IDs:**\ 
    2171. 

  2171. 

  2172. .. code:: text
    2173. 

  2173. 

  2174.     "_main" - Main menu (macOS).
    2175. 

  2175.     "_dock" - Dock popup menu (macOS).
    2176. 

  2176.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2177. 

  2177.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2178. 

  2178.     "_help" - Help menu (macOS).
    2179. 

  2179. 

  2180. .. rst-class:: classref-item-separator
    2181. 

  2181. 

  2182. ----
    2183. 

  2183. 

  2184. .. _class_DisplayServer_method_global_menu_add_icon_check_item:
    2185. 

  2185. 

  2186. .. rst-class:: classref-method
    2187. 

  2187. 

  2188. :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>`
    2189. 

  2189. 

  2190. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2191. 

  2191. 

  2192. Adds a new checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
    2193. 

  2193. 

  2194. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    2195. 

  2195. 

  2196. 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`).
    2197. 

  2197. 

  2198. \ **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``.
    2199. 

  2199. 

  2200. \ **Note:** This method is implemented only on macOS.
    2201. 

  2201. 

  2202. \ **Supported system menu IDs:**\ 
    2203. 

  2203. 

  2204. .. code:: text
    2205. 

  2205. 

  2206.     "_main" - Main menu (macOS).
    2207. 

  2207.     "_dock" - Dock popup menu (macOS).
    2208. 

  2208.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2209. 

  2209.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2210. 

  2210.     "_help" - Help menu (macOS).
    2211. 

  2211. 

  2212. .. rst-class:: classref-item-separator
    2213. 

  2213. 

  2214. ----
    2215. 

  2215. 

  2216. .. _class_DisplayServer_method_global_menu_add_icon_item:
    2217. 

  2217. 

  2218. .. rst-class:: classref-method
    2219. 

  2219. 

  2220. :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>`
    2221. 

  2221. 

  2222. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2223. 

  2223. 

  2224. Adds a new item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
    2225. 

  2225. 

  2226. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    2227. 

  2227. 

  2228. 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`).
    2229. 

  2229. 

  2230. \ **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``.
    2231. 

  2231. 

  2232. \ **Note:** This method is implemented only on macOS.
    2233. 

  2233. 

  2234. \ **Supported system menu IDs:**\ 
    2235. 

  2235. 

  2236. .. code:: text
    2237. 

  2237. 

  2238.     "_main" - Main menu (macOS).
    2239. 

  2239.     "_dock" - Dock popup menu (macOS).
    2240. 

  2240.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2241. 

  2241.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2242. 

  2242.     "_help" - Help menu (macOS).
    2243. 

  2243. 

  2244. .. rst-class:: classref-item-separator
    2245. 

  2245. 

  2246. ----
    2247. 

  2247. 

  2248. .. _class_DisplayServer_method_global_menu_add_icon_radio_check_item:
    2249. 

  2249. 

  2250. .. rst-class:: classref-method
    2251. 

  2251. 

  2252. :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>`
    2253. 

  2253. 

  2254. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2255. 

  2255. 

  2256. Adds a new radio-checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
    2257. 

  2257. 

  2258. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    2259. 

  2259. 

  2260. 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`).
    2261. 

  2261. 

  2262. \ **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.
    2263. 

  2263. 

  2264. \ **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``.
    2265. 

  2265. 

  2266. \ **Note:** This method is implemented only on macOS.
    2267. 

  2267. 

  2268. \ **Supported system menu IDs:**\ 
    2269. 

  2269. 

  2270. .. code:: text
    2271. 

  2271. 

  2272.     "_main" - Main menu (macOS).
    2273. 

  2273.     "_dock" - Dock popup menu (macOS).
    2274. 

  2274.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2275. 

  2275.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2276. 

  2276.     "_help" - Help menu (macOS).
    2277. 

  2277. 

  2278. .. rst-class:: classref-item-separator
    2279. 

  2279. 

  2280. ----
    2281. 

  2281. 

  2282. .. _class_DisplayServer_method_global_menu_add_item:
    2283. 

  2283. 

  2284. .. rst-class:: classref-method
    2285. 

  2285. 

  2286. :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>`
    2287. 

  2287. 

  2288. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2289. 

  2289. 

  2290. Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
    2291. 

  2291. 

  2292. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    2293. 

  2293. 

  2294. 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`).
    2295. 

  2295. 

  2296. \ **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``.
    2297. 

  2297. 

  2298. \ **Note:** This method is implemented only on macOS.
    2299. 

  2299. 

  2300. \ **Supported system menu IDs:**\ 
    2301. 

  2301. 

  2302. .. code:: text
    2303. 

  2303. 

  2304.     "_main" - Main menu (macOS).
    2305. 

  2305.     "_dock" - Dock popup menu (macOS).
    2306. 

  2306.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2307. 

  2307.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2308. 

  2308.     "_help" - Help menu (macOS).
    2309. 

  2309. 

  2310. .. rst-class:: classref-item-separator
    2311. 

  2311. 

  2312. ----
    2313. 

  2313. 

  2314. .. _class_DisplayServer_method_global_menu_add_multistate_item:
    2315. 

  2315. 

  2316. .. rst-class:: classref-method
    2317. 

  2317. 

  2318. :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>`
    2319. 

  2319. 

  2320. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2321. 

  2321. 

  2322. Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
    2323. 

  2323. 

  2324. 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``.
    2325. 

  2325. 

  2326. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    2327. 

  2327. 

  2328. 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`).
    2329. 

  2329. 

  2330. \ **Note:** By default, there's no indication of the current item state, it should be changed manually.
    2331. 

  2331. 

  2332. \ **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``.
    2333. 

  2333. 

  2334. \ **Note:** This method is implemented only on macOS.
    2335. 

  2335. 

  2336. \ **Supported system menu IDs:**\ 
    2337. 

  2337. 

  2338. .. code:: text
    2339. 

  2339. 

  2340.     "_main" - Main menu (macOS).
    2341. 

  2341.     "_dock" - Dock popup menu (macOS).
    2342. 

  2342.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2343. 

  2343.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2344. 

  2344.     "_help" - Help menu (macOS).
    2345. 

  2345. 

  2346. .. rst-class:: classref-item-separator
    2347. 

  2347. 

  2348. ----
    2349. 

  2349. 

  2350. .. _class_DisplayServer_method_global_menu_add_radio_check_item:
    2351. 

  2351. 

  2352. .. rst-class:: classref-method
    2353. 

  2353. 

  2354. :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>`
    2355. 

  2355. 

  2356. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2357. 

  2357. 

  2358. Adds a new radio-checkable item with text ``label`` to the global menu with ID ``menu_root``.
    2359. 

  2359. 

  2360. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    2361. 

  2361. 

  2362. 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`).
    2363. 

  2363. 

  2364. \ **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.
    2365. 

  2365. 

  2366. \ **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``.
    2367. 

  2367. 

  2368. \ **Note:** This method is implemented only on macOS.
    2369. 

  2369. 

  2370. \ **Supported system menu IDs:**\ 
    2371. 

  2371. 

  2372. .. code:: text
    2373. 

  2373. 

  2374.     "_main" - Main menu (macOS).
    2375. 

  2375.     "_dock" - Dock popup menu (macOS).
    2376. 

  2376.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2377. 

  2377.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2378. 

  2378.     "_help" - Help menu (macOS).
    2379. 

  2379. 

  2380. .. rst-class:: classref-item-separator
    2381. 

  2381. 

  2382. ----
    2383. 

  2383. 

  2384. .. _class_DisplayServer_method_global_menu_add_separator:
    2385. 

  2385. 

  2386. .. rst-class:: classref-method
    2387. 

  2387. 

  2388. :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>`
    2389. 

  2389. 

  2390. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2391. 

  2391. 

  2392. Adds a separator between items to the global menu with ID ``menu_root``. Separators also occupy an index.
    2393. 

  2393. 

  2394. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    2395. 

  2395. 

  2396. \ **Note:** This method is implemented only on macOS.
    2397. 

  2397. 

  2398. \ **Supported system menu IDs:**\ 
    2399. 

  2399. 

  2400. .. code:: text
    2401. 

  2401. 

  2402.     "_main" - Main menu (macOS).
    2403. 

  2403.     "_dock" - Dock popup menu (macOS).
    2404. 

  2404.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2405. 

  2405.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2406. 

  2406.     "_help" - Help menu (macOS).
    2407. 

  2407. 

  2408. .. rst-class:: classref-item-separator
    2409. 

  2409. 

  2410. ----
    2411. 

  2411. 

  2412. .. _class_DisplayServer_method_global_menu_add_submenu_item:
    2413. 

  2413. 

  2414. .. rst-class:: classref-method
    2415. 

  2415. 

  2416. :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>`
    2417. 

  2417. 

  2418. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2419. 

  2419. 

  2420. 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.
    2421. 

  2421. 

  2422. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    2423. 

  2423. 

  2424. \ **Note:** This method is implemented only on macOS.
    2425. 

  2425. 

  2426. \ **Supported system menu IDs:**\ 
    2427. 

  2427. 

  2428. .. code:: text
    2429. 

  2429. 

  2430.     "_main" - Main menu (macOS).
    2431. 

  2431.     "_dock" - Dock popup menu (macOS).
    2432. 

  2432.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2433. 

  2433.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2434. 

  2434.     "_help" - Help menu (macOS).
    2435. 

  2435. 

  2436. .. rst-class:: classref-item-separator
    2437. 

  2437. 

  2438. ----
    2439. 

  2439. 

  2440. .. _class_DisplayServer_method_global_menu_clear:
    2441. 

  2441. 

  2442. .. rst-class:: classref-method
    2443. 

  2443. 

  2444. |void| **global_menu_clear**\ (\ menu_root\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_clear>`
    2445. 

  2445. 

  2446. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2447. 

  2447. 

  2448. Removes all items from the global menu with ID ``menu_root``.
    2449. 

  2449. 

  2450. \ **Note:** This method is implemented only on macOS.
    2451. 

  2451. 

  2452. \ **Supported system menu IDs:**\ 
    2453. 

  2453. 

  2454. .. code:: text
    2455. 

  2455. 

  2456.     "_main" - Main menu (macOS).
    2457. 

  2457.     "_dock" - Dock popup menu (macOS).
    2458. 

  2458.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2459. 

  2459.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2460. 

  2460.     "_help" - Help menu (macOS).
    2461. 

  2461. 

  2462. .. rst-class:: classref-item-separator
    2463. 

  2463. 

  2464. ----
    2465. 

  2465. 

  2466. .. _class_DisplayServer_method_global_menu_get_item_accelerator:
    2467. 

  2467. 

  2468. .. rst-class:: classref-method
    2469. 

  2469. 

  2470. :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>`
    2471. 

  2471. 

  2472. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2473. 

  2473. 

  2474. 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.
    2475. 

  2475. 

  2476. \ **Note:** This method is implemented only on macOS.
    2477. 

  2477. 

  2478. .. rst-class:: classref-item-separator
    2479. 

  2479. 

  2480. ----
    2481. 

  2481. 

  2482. .. _class_DisplayServer_method_global_menu_get_item_callback:
    2483. 

  2483. 

  2484. .. rst-class:: classref-method
    2485. 

  2485. 

  2486. :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>`
    2487. 

  2487. 

  2488. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2489. 

  2489. 

  2490. Returns the callback of the item at index ``idx``.
    2491. 

  2491. 

  2492. \ **Note:** This method is implemented only on macOS.
    2493. 

  2493. 

  2494. .. rst-class:: classref-item-separator
    2495. 

  2495. 

  2496. ----
    2497. 

  2497. 

  2498. .. _class_DisplayServer_method_global_menu_get_item_count:
    2499. 

  2499. 

  2500. .. rst-class:: classref-method
    2501. 

  2501. 

  2502. :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>`
    2503. 

  2503. 

  2504. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2505. 

  2505. 

  2506. Returns number of items in the global menu with ID ``menu_root``.
    2507. 

  2507. 

  2508. \ **Note:** This method is implemented only on macOS.
    2509. 

  2509. 

  2510. .. rst-class:: classref-item-separator
    2511. 

  2511. 

  2512. ----
    2513. 

  2513. 

  2514. .. _class_DisplayServer_method_global_menu_get_item_icon:
    2515. 

  2515. 

  2516. .. rst-class:: classref-method
    2517. 

  2517. 

  2518. :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>`
    2519. 

  2519. 

  2520. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2521. 

  2521. 

  2522. Returns the icon of the item at index ``idx``.
    2523. 

  2523. 

  2524. \ **Note:** This method is implemented only on macOS.
    2525. 

  2525. 

  2526. .. rst-class:: classref-item-separator
    2527. 

  2527. 

  2528. ----
    2529. 

  2529. 

  2530. .. _class_DisplayServer_method_global_menu_get_item_indentation_level:
    2531. 

  2531. 

  2532. .. rst-class:: classref-method
    2533. 

  2533. 

  2534. :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>`
    2535. 

  2535. 

  2536. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2537. 

  2537. 

  2538. Returns the horizontal offset of the item at the given ``idx``.
    2539. 

  2539. 

  2540. \ **Note:** This method is implemented only on macOS.
    2541. 

  2541. 

  2542. .. rst-class:: classref-item-separator
    2543. 

  2543. 

  2544. ----
    2545. 

  2545. 

  2546. .. _class_DisplayServer_method_global_menu_get_item_index_from_tag:
    2547. 

  2547. 

  2548. .. rst-class:: classref-method
    2549. 

  2549. 

  2550. :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>`
    2551. 

  2551. 

  2552. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2553. 

  2553. 

  2554. 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.
    2555. 

  2555. 

  2556. \ **Note:** This method is implemented only on macOS.
    2557. 

  2557. 

  2558. .. rst-class:: classref-item-separator
    2559. 

  2559. 

  2560. ----
    2561. 

  2561. 

  2562. .. _class_DisplayServer_method_global_menu_get_item_index_from_text:
    2563. 

  2563. 

  2564. .. rst-class:: classref-method
    2565. 

  2565. 

  2566. :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>`
    2567. 

  2567. 

  2568. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2569. 

  2569. 

  2570. 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.
    2571. 

  2571. 

  2572. \ **Note:** This method is implemented only on macOS.
    2573. 

  2573. 

  2574. .. rst-class:: classref-item-separator
    2575. 

  2575. 

  2576. ----
    2577. 

  2577. 

  2578. .. _class_DisplayServer_method_global_menu_get_item_key_callback:
    2579. 

  2579. 

  2580. .. rst-class:: classref-method
    2581. 

  2581. 

  2582. :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>`
    2583. 

  2583. 

  2584. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2585. 

  2585. 

  2586. Returns the callback of the item accelerator at index ``idx``.
    2587. 

  2587. 

  2588. \ **Note:** This method is implemented only on macOS.
    2589. 

  2589. 

  2590. .. rst-class:: classref-item-separator
    2591. 

  2591. 

  2592. ----
    2593. 

  2593. 

  2594. .. _class_DisplayServer_method_global_menu_get_item_max_states:
    2595. 

  2595. 

  2596. .. rst-class:: classref-method
    2597. 

  2597. 

  2598. :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>`
    2599. 

  2599. 

  2600. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2601. 

  2601. 

  2602. 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.
    2603. 

  2603. 

  2604. \ **Note:** This method is implemented only on macOS.
    2605. 

  2605. 

  2606. .. rst-class:: classref-item-separator
    2607. 

  2607. 

  2608. ----
    2609. 

  2609. 

  2610. .. _class_DisplayServer_method_global_menu_get_item_state:
    2611. 

  2611. 

  2612. .. rst-class:: classref-method
    2613. 

  2613. 

  2614. :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>`
    2615. 

  2615. 

  2616. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2617. 

  2617. 

  2618. Returns the state of a multistate item. See :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
    2619. 

  2619. 

  2620. \ **Note:** This method is implemented only on macOS.
    2621. 

  2621. 

  2622. .. rst-class:: classref-item-separator
    2623. 

  2623. 

  2624. ----
    2625. 

  2625. 

  2626. .. _class_DisplayServer_method_global_menu_get_item_submenu:
    2627. 

  2627. 

  2628. .. rst-class:: classref-method
    2629. 

  2629. 

  2630. :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>`
    2631. 

  2631. 

  2632. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2633. 

  2633. 

  2634. 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.
    2635. 

  2635. 

  2636. \ **Note:** This method is implemented only on macOS.
    2637. 

  2637. 

  2638. .. rst-class:: classref-item-separator
    2639. 

  2639. 

  2640. ----
    2641. 

  2641. 

  2642. .. _class_DisplayServer_method_global_menu_get_item_tag:
    2643. 

  2643. 

  2644. .. rst-class:: classref-method
    2645. 

  2645. 

  2646. :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>`
    2647. 

  2647. 

  2648. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2649. 

  2649. 

  2650. 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.
    2651. 

  2651. 

  2652. \ **Note:** This method is implemented only on macOS.
    2653. 

  2653. 

  2654. .. rst-class:: classref-item-separator
    2655. 

  2655. 

  2656. ----
    2657. 

  2657. 

  2658. .. _class_DisplayServer_method_global_menu_get_item_text:
    2659. 

  2659. 

  2660. .. rst-class:: classref-method
    2661. 

  2661. 

  2662. :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>`
    2663. 

  2663. 

  2664. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2665. 

  2665. 

  2666. Returns the text of the item at index ``idx``.
    2667. 

  2667. 

  2668. \ **Note:** This method is implemented only on macOS.
    2669. 

  2669. 

  2670. .. rst-class:: classref-item-separator
    2671. 

  2671. 

  2672. ----
    2673. 

  2673. 

  2674. .. _class_DisplayServer_method_global_menu_get_item_tooltip:
    2675. 

  2675. 

  2676. .. rst-class:: classref-method
    2677. 

  2677. 

  2678. :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>`
    2679. 

  2679. 

  2680. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2681. 

  2681. 

  2682. Returns the tooltip associated with the specified index ``idx``.
    2683. 

  2683. 

  2684. \ **Note:** This method is implemented only on macOS.
    2685. 

  2685. 

  2686. .. rst-class:: classref-item-separator
    2687. 

  2687. 

  2688. ----
    2689. 

  2689. 

  2690. .. _class_DisplayServer_method_global_menu_get_system_menu_roots:
    2691. 

  2691. 

  2692. .. rst-class:: classref-method
    2693. 

  2693. 

  2694. :ref:`Dictionary<class_Dictionary>` **global_menu_get_system_menu_roots**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_global_menu_get_system_menu_roots>`
    2695. 

  2695. 

  2696. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2697. 

  2697. 

  2698. Returns Dictionary of supported system menu IDs and names.
    2699. 

  2699. 

  2700. \ **Note:** This method is implemented only on macOS.
    2701. 

  2701. 

  2702. .. rst-class:: classref-item-separator
    2703. 

  2703. 

  2704. ----
    2705. 

  2705. 

  2706. .. _class_DisplayServer_method_global_menu_is_item_checkable:
    2707. 

  2707. 

  2708. .. rst-class:: classref-method
    2709. 

  2709. 

  2710. :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>`
    2711. 

  2711. 

  2712. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2713. 

  2713. 

  2714. Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if it has a checkbox or radio button.
    2715. 

  2715. 

  2716. \ **Note:** This method is implemented only on macOS.
    2717. 

  2717. 

  2718. .. rst-class:: classref-item-separator
    2719. 

  2719. 

  2720. ----
    2721. 

  2721. 

  2722. .. _class_DisplayServer_method_global_menu_is_item_checked:
    2723. 

  2723. 

  2724. .. rst-class:: classref-method
    2725. 

  2725. 

  2726. :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>`
    2727. 

  2727. 

  2728. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2729. 

  2729. 

  2730. Returns ``true`` if the item at index ``idx`` is checked.
    2731. 

  2731. 

  2732. \ **Note:** This method is implemented only on macOS.
    2733. 

  2733. 

  2734. .. rst-class:: classref-item-separator
    2735. 

  2735. 

  2736. ----
    2737. 

  2737. 

  2738. .. _class_DisplayServer_method_global_menu_is_item_disabled:
    2739. 

  2739. 

  2740. .. rst-class:: classref-method
    2741. 

  2741. 

  2742. :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>`
    2743. 

  2743. 

  2744. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2745. 

  2745. 

  2746. Returns ``true`` if the item at index ``idx`` is disabled. When it is disabled it can't be selected, or its action invoked.
    2747. 

  2747. 

  2748. See :ref:`global_menu_set_item_disabled<class_DisplayServer_method_global_menu_set_item_disabled>` for more info on how to disable an item.
    2749. 

  2749. 

  2750. \ **Note:** This method is implemented only on macOS.
    2751. 

  2751. 

  2752. .. rst-class:: classref-item-separator
    2753. 

  2753. 

  2754. ----
    2755. 

  2755. 

  2756. .. _class_DisplayServer_method_global_menu_is_item_hidden:
    2757. 

  2757. 

  2758. .. rst-class:: classref-method
    2759. 

  2759. 

  2760. :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>`
    2761. 

  2761. 

  2762. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2763. 

  2763. 

  2764. Returns ``true`` if the item at index ``idx`` is hidden.
    2765. 

  2765. 

  2766. See :ref:`global_menu_set_item_hidden<class_DisplayServer_method_global_menu_set_item_hidden>` for more info on how to hide an item.
    2767. 

  2767. 

  2768. \ **Note:** This method is implemented only on macOS.
    2769. 

  2769. 

  2770. .. rst-class:: classref-item-separator
    2771. 

  2771. 

  2772. ----
    2773. 

  2773. 

  2774. .. _class_DisplayServer_method_global_menu_is_item_radio_checkable:
    2775. 

  2775. 

  2776. .. rst-class:: classref-method
    2777. 

  2777. 

  2778. :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>`
    2779. 

  2779. 

  2780. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2781. 

  2781. 

  2782. Returns ``true`` if the item at index ``idx`` has radio button-style checkability.
    2783. 

  2783. 

  2784. \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
    2785. 

  2785. 

  2786. \ **Note:** This method is implemented only on macOS.
    2787. 

  2787. 

  2788. .. rst-class:: classref-item-separator
    2789. 

  2789. 

  2790. ----
    2791. 

  2791. 

  2792. .. _class_DisplayServer_method_global_menu_remove_item:
    2793. 

  2793. 

  2794. .. rst-class:: classref-method
    2795. 

  2795. 

  2796. |void| **global_menu_remove_item**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_global_menu_remove_item>`
    2797. 

  2797. 

  2798. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2799. 

  2799. 

  2800. Removes the item at index ``idx`` from the global menu ``menu_root``.
    2801. 

  2801. 

  2802. \ **Note:** The indices of items after the removed item will be shifted by one.
    2803. 

  2803. 

  2804. \ **Note:** This method is implemented only on macOS.
    2805. 

  2805. 

  2806. .. rst-class:: classref-item-separator
    2807. 

  2807. 

  2808. ----
    2809. 

  2809. 

  2810. .. _class_DisplayServer_method_global_menu_set_item_accelerator:
    2811. 

  2811. 

  2812. .. rst-class:: classref-method
    2813. 

  2813. 

  2814. |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>`
    2815. 

  2815. 

  2816. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2817. 

  2817. 

  2818. 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`).
    2819. 

  2819. 

  2820. \ **Note:** This method is implemented only on macOS.
    2821. 

  2821. 

  2822. .. rst-class:: classref-item-separator
    2823. 

  2823. 

  2824. ----
    2825. 

  2825. 

  2826. .. _class_DisplayServer_method_global_menu_set_item_callback:
    2827. 

  2827. 

  2828. .. rst-class:: classref-method
    2829. 

  2829. 

  2830. |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>`
    2831. 

  2831. 

  2832. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2833. 

  2833. 

  2834. Sets the callback of the item at index ``idx``. Callback is emitted when an item is pressed.
    2835. 

  2835. 

  2836. \ **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.
    2837. 

  2837. 

  2838. \ **Note:** This method is implemented only on macOS.
    2839. 

  2839. 

  2840. .. rst-class:: classref-item-separator
    2841. 

  2841. 

  2842. ----
    2843. 

  2843. 

  2844. .. _class_DisplayServer_method_global_menu_set_item_checkable:
    2845. 

  2845. 

  2846. .. rst-class:: classref-method
    2847. 

  2847. 

  2848. |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>`
    2849. 

  2849. 

  2850. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2851. 

  2851. 

  2852. Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the type of the item to plain text.
    2853. 

  2853. 

  2854. \ **Note:** This method is implemented only on macOS.
    2855. 

  2855. 

  2856. .. rst-class:: classref-item-separator
    2857. 

  2857. 

  2858. ----
    2859. 

  2859. 

  2860. .. _class_DisplayServer_method_global_menu_set_item_checked:
    2861. 

  2861. 

  2862. .. rst-class:: classref-method
    2863. 

  2863. 

  2864. |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>`
    2865. 

  2865. 

  2866. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2867. 

  2867. 

  2868. Sets the checkstate status of the item at index ``idx``.
    2869. 

  2869. 

  2870. \ **Note:** This method is implemented only on macOS.
    2871. 

  2871. 

  2872. .. rst-class:: classref-item-separator
    2873. 

  2873. 

  2874. ----
    2875. 

  2875. 

  2876. .. _class_DisplayServer_method_global_menu_set_item_disabled:
    2877. 

  2877. 

  2878. .. rst-class:: classref-method
    2879. 

  2879. 

  2880. |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>`
    2881. 

  2881. 

  2882. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2883. 

  2883. 

  2884. Enables/disables the item at index ``idx``. When it is disabled, it can't be selected and its action can't be invoked.
    2885. 

  2885. 

  2886. \ **Note:** This method is implemented only on macOS.
    2887. 

  2887. 

  2888. .. rst-class:: classref-item-separator
    2889. 

  2889. 

  2890. ----
    2891. 

  2891. 

  2892. .. _class_DisplayServer_method_global_menu_set_item_hidden:
    2893. 

  2893. 

  2894. .. rst-class:: classref-method
    2895. 

  2895. 

  2896. |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>`
    2897. 

  2897. 

  2898. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2899. 

  2899. 

  2900. 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.
    2901. 

  2901. 

  2902. \ **Note:** This method is implemented only on macOS.
    2903. 

  2903. 

  2904. .. rst-class:: classref-item-separator
    2905. 

  2905. 

  2906. ----
    2907. 

  2907. 

  2908. .. _class_DisplayServer_method_global_menu_set_item_hover_callbacks:
    2909. 

  2909. 

  2910. .. rst-class:: classref-method
    2911. 

  2911. 

  2912. |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>`
    2913. 

  2913. 

  2914. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2915. 

  2915. 

  2916. Sets the callback of the item at index ``idx``. The callback is emitted when an item is hovered.
    2917. 

  2917. 

  2918. \ **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.
    2919. 

  2919. 

  2920. \ **Note:** This method is implemented only on macOS.
    2921. 

  2921. 

  2922. .. rst-class:: classref-item-separator
    2923. 

  2923. 

  2924. ----
    2925. 

  2925. 

  2926. .. _class_DisplayServer_method_global_menu_set_item_icon:
    2927. 

  2927. 

  2928. .. rst-class:: classref-method
    2929. 

  2929. 

  2930. |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>`
    2931. 

  2931. 

  2932. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2933. 

  2933. 

  2934. Replaces the :ref:`Texture2D<class_Texture2D>` icon of the specified ``idx``.
    2935. 

  2935. 

  2936. \ **Note:** This method is implemented only on macOS.
    2937. 

  2937. 

  2938. \ **Note:** This method is not supported by macOS "_dock" menu items.
    2939. 

  2939. 

  2940. .. rst-class:: classref-item-separator
    2941. 

  2941. 

  2942. ----
    2943. 

  2943. 

  2944. .. _class_DisplayServer_method_global_menu_set_item_indentation_level:
    2945. 

  2945. 

  2946. .. rst-class:: classref-method
    2947. 

  2947. 

  2948. |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>`
    2949. 

  2949. 

  2950. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2951. 

  2951. 

  2952. Sets the horizontal offset of the item at the given ``idx``.
    2953. 

  2953. 

  2954. \ **Note:** This method is implemented only on macOS.
    2955. 

  2955. 

  2956. .. rst-class:: classref-item-separator
    2957. 

  2957. 

  2958. ----
    2959. 

  2959. 

  2960. .. _class_DisplayServer_method_global_menu_set_item_key_callback:
    2961. 

  2961. 

  2962. .. rst-class:: classref-method
    2963. 

  2963. 

  2964. |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>`
    2965. 

  2965. 

  2966. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2967. 

  2967. 

  2968. Sets the callback of the item at index ``idx``. Callback is emitted when its accelerator is activated.
    2969. 

  2969. 

  2970. \ **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.
    2971. 

  2971. 

  2972. \ **Note:** This method is implemented only on macOS.
    2973. 

  2973. 

  2974. .. rst-class:: classref-item-separator
    2975. 

  2975. 

  2976. ----
    2977. 

  2977. 

  2978. .. _class_DisplayServer_method_global_menu_set_item_max_states:
    2979. 

  2979. 

  2980. .. rst-class:: classref-method
    2981. 

  2981. 

  2982. |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>`
    2983. 

  2983. 

  2984. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2985. 

  2985. 

  2986. 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.
    2987. 

  2987. 

  2988. \ **Note:** This method is implemented only on macOS.
    2989. 

  2989. 

  2990. .. rst-class:: classref-item-separator
    2991. 

  2991. 

  2992. ----
    2993. 

  2993. 

  2994. .. _class_DisplayServer_method_global_menu_set_item_radio_checkable:
    2995. 

  2995. 

  2996. .. rst-class:: classref-method
    2997. 

  2997. 

  2998. |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>`
    2999. 

  2999. 

  3000. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    3001. 

  3001. 

  3002. 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.
    3003. 

  3003. 

  3004. \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
    3005. 

  3005. 

  3006. \ **Note:** This method is implemented only on macOS.
    3007. 

  3007. 

  3008. .. rst-class:: classref-item-separator
    3009. 

  3009. 

  3010. ----
    3011. 

  3011. 

  3012. .. _class_DisplayServer_method_global_menu_set_item_state:
    3013. 

  3013. 

  3014. .. rst-class:: classref-method
    3015. 

  3015. 

  3016. |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>`
    3017. 

  3017. 

  3018. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    3019. 

  3019. 

  3020. Sets the state of a multistate item. See :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
    3021. 

  3021. 

  3022. \ **Note:** This method is implemented only on macOS.
    3023. 

  3023. 

  3024. .. rst-class:: classref-item-separator
    3025. 

  3025. 

  3026. ----
    3027. 

  3027. 

  3028. .. _class_DisplayServer_method_global_menu_set_item_submenu:
    3029. 

  3029. 

  3030. .. rst-class:: classref-method
    3031. 

  3031. 

  3032. |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>`
    3033. 

  3033. 

  3034. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    3035. 

  3035. 

  3036. 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.
    3037. 

  3037. 

  3038. \ **Note:** This method is implemented only on macOS.
    3039. 

  3039. 

  3040. .. rst-class:: classref-item-separator
    3041. 

  3041. 

  3042. ----
    3043. 

  3043. 

  3044. .. _class_DisplayServer_method_global_menu_set_item_tag:
    3045. 

  3045. 

  3046. .. rst-class:: classref-method
    3047. 

  3047. 

  3048. |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>`
    3049. 

  3049. 

  3050. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    3051. 

  3051. 

  3052. 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.
    3053. 

  3053. 

  3054. \ **Note:** This method is implemented only on macOS.
    3055. 

  3055. 

  3056. .. rst-class:: classref-item-separator
    3057. 

  3057. 

  3058. ----
    3059. 

  3059. 

  3060. .. _class_DisplayServer_method_global_menu_set_item_text:
    3061. 

  3061. 

  3062. .. rst-class:: classref-method
    3063. 

  3063. 

  3064. |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>`
    3065. 

  3065. 

  3066. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    3067. 

  3067. 

  3068. Sets the text of the item at index ``idx``.
    3069. 

  3069. 

  3070. \ **Note:** This method is implemented only on macOS.
    3071. 

  3071. 

  3072. .. rst-class:: classref-item-separator
    3073. 

  3073. 

  3074. ----
    3075. 

  3075. 

  3076. .. _class_DisplayServer_method_global_menu_set_item_tooltip:
    3077. 

  3077. 

  3078. .. rst-class:: classref-method
    3079. 

  3079. 

  3080. |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>`
    3081. 

  3081. 

  3082. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    3083. 

  3083. 

  3084. Sets the :ref:`String<class_String>` tooltip of the item at the specified index ``idx``.
    3085. 

  3085. 

  3086. \ **Note:** This method is implemented only on macOS.
    3087. 

  3087. 

  3088. .. rst-class:: classref-item-separator
    3089. 

  3089. 

  3090. ----
    3091. 

  3091. 

  3092. .. _class_DisplayServer_method_global_menu_set_popup_callbacks:
    3093. 

  3093. 

  3094. .. rst-class:: classref-method
    3095. 

  3095. 

  3096. |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>`
    3097. 

  3097. 

  3098. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    3099. 

  3099. 

  3100. Registers callables to emit when the menu is respectively about to show or closed. Callback methods should have zero arguments.
    3101. 

  3101. 

  3102. .. rst-class:: classref-item-separator
    3103. 

  3103. 

  3104. ----
    3105. 

  3105. 

  3106. .. _class_DisplayServer_method_has_additional_outputs:
    3107. 

  3107. 

  3108. .. rst-class:: classref-method
    3109. 

  3109. 

  3110. :ref:`bool<class_bool>` **has_additional_outputs**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_has_additional_outputs>`
    3111. 

  3111. 

  3112. Returns ``true`` if any additional outputs have been registered via :ref:`register_additional_output<class_DisplayServer_method_register_additional_output>`.
    3113. 

  3113. 

  3114. .. rst-class:: classref-item-separator
    3115. 

  3115. 

  3116. ----
    3117. 

  3117. 

  3118. .. _class_DisplayServer_method_has_feature:
    3119. 

  3119. 

  3120. .. rst-class:: classref-method
    3121. 

  3121. 

  3122. :ref:`bool<class_bool>` **has_feature**\ (\ feature\: :ref:`Feature<enum_DisplayServer_Feature>`\ ) |const| :ref:`🔗<class_DisplayServer_method_has_feature>`
    3123. 

  3123. 

  3124. Returns ``true`` if the specified ``feature`` is supported by the current **DisplayServer**, ``false`` otherwise.
    3125. 

  3125. 

  3126. .. rst-class:: classref-item-separator
    3127. 

  3127. 

  3128. ----
    3129. 

  3129. 

  3130. .. _class_DisplayServer_method_has_hardware_keyboard:
    3131. 

  3131. 

  3132. .. rst-class:: classref-method
    3133. 

  3133. 

  3134. :ref:`bool<class_bool>` **has_hardware_keyboard**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_has_hardware_keyboard>`
    3135. 

  3135. 

  3136. Returns ``true`` if hardware keyboard is connected.
    3137. 

  3137. 

  3138. \ **Note:** This method is implemented on Android and iOS, on other platforms this method always returns ``true``.
    3139. 

  3139. 

  3140. .. rst-class:: classref-item-separator
    3141. 

  3141. 

  3142. ----
    3143. 

  3143. 

  3144. .. _class_DisplayServer_method_help_set_search_callbacks:
    3145. 

  3145. 

  3146. .. rst-class:: classref-method
    3147. 

  3147. 

  3148. |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>`
    3149. 

  3149. 

  3150. Sets native help system search callbacks.
    3151. 

  3151. 

  3152. \ ``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.
    3153. 

  3153. 

  3154. \ ``action_callback`` has the following arguments: ``String key``. Called when the user selects a search result in the ``Help`` menu.
    3155. 

  3155. 

  3156. \ **Note:** This method is implemented only on macOS.
    3157. 

  3157. 

  3158. .. rst-class:: classref-item-separator
    3159. 

  3159. 

  3160. ----
    3161. 

  3161. 

  3162. .. _class_DisplayServer_method_ime_get_selection:
    3163. 

  3163. 

  3164. .. rst-class:: classref-method
    3165. 

  3165. 

  3166. :ref:`Vector2i<class_Vector2i>` **ime_get_selection**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_ime_get_selection>`
    3167. 

  3167. 

  3168. 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.
    3169. 

  3169. 

  3170. \ **Note:** This method is implemented only on macOS.
    3171. 

  3171. 

  3172. .. rst-class:: classref-item-separator
    3173. 

  3173. 

  3174. ----
    3175. 

  3175. 

  3176. .. _class_DisplayServer_method_ime_get_text:
    3177. 

  3177. 

  3178. .. rst-class:: classref-method
    3179. 

  3179. 

  3180. :ref:`String<class_String>` **ime_get_text**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_ime_get_text>`
    3181. 

  3181. 

  3182. Returns the composition string contained within the `Input Method Editor <https://en.wikipedia.org/wiki/Input_method>`__ window.
    3183. 

  3183. 

  3184. \ **Note:** This method is implemented only on macOS.
    3185. 

  3185. 

  3186. .. rst-class:: classref-item-separator
    3187. 

  3187. 

  3188. ----
    3189. 

  3189. 

  3190. .. _class_DisplayServer_method_is_dark_mode:
    3191. 

  3191. 

  3192. .. rst-class:: classref-method
    3193. 

  3193. 

  3194. :ref:`bool<class_bool>` **is_dark_mode**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_is_dark_mode>`
    3195. 

  3195. 

  3196. Returns ``true`` if OS is using dark mode.
    3197. 

  3197. 

  3198. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
    3199. 

  3199. 

  3200. .. rst-class:: classref-item-separator
    3201. 

  3201. 

  3202. ----
    3203. 

  3203. 

  3204. .. _class_DisplayServer_method_is_dark_mode_supported:
    3205. 

  3205. 

  3206. .. rst-class:: classref-method
    3207. 

  3207. 

  3208. :ref:`bool<class_bool>` **is_dark_mode_supported**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_is_dark_mode_supported>`
    3209. 

  3209. 

  3210. Returns ``true`` if OS supports dark mode.
    3211. 

  3211. 

  3212. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
    3213. 

  3213. 

  3214. .. rst-class:: classref-item-separator
    3215. 

  3215. 

  3216. ----
    3217. 

  3217. 

  3218. .. _class_DisplayServer_method_is_touchscreen_available:
    3219. 

  3219. 

  3220. .. rst-class:: classref-method
    3221. 

  3221. 

  3222. :ref:`bool<class_bool>` **is_touchscreen_available**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_is_touchscreen_available>`
    3223. 

  3223. 

  3224. 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``.
    3225. 

  3225. 

  3226. .. rst-class:: classref-item-separator
    3227. 

  3227. 

  3228. ----
    3229. 

  3229. 

  3230. .. _class_DisplayServer_method_is_window_transparency_available:
    3231. 

  3231. 

  3232. .. rst-class:: classref-method
    3233. 

  3233. 

  3234. :ref:`bool<class_bool>` **is_window_transparency_available**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_is_window_transparency_available>`
    3235. 

  3235. 

  3236. 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.
    3237. 

  3237. 

  3238. .. rst-class:: classref-item-separator
    3239. 

  3239. 

  3240. ----
    3241. 

  3241. 

  3242. .. _class_DisplayServer_method_keyboard_get_current_layout:
    3243. 

  3243. 

  3244. .. rst-class:: classref-method
    3245. 

  3245. 

  3246. :ref:`int<class_int>` **keyboard_get_current_layout**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_keyboard_get_current_layout>`
    3247. 

  3247. 

  3248. Returns active keyboard layout index.
    3249. 

  3249. 

  3250. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS, and Windows.
    3251. 

  3251. 

  3252. .. rst-class:: classref-item-separator
    3253. 

  3253. 

  3254. ----
    3255. 

  3255. 

  3256. .. _class_DisplayServer_method_keyboard_get_keycode_from_physical:
    3257. 

  3257. 

  3258. .. rst-class:: classref-method
    3259. 

  3259. 

  3260. :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>`
    3261. 

  3261. 

  3262. Converts a physical (US QWERTY) ``keycode`` to one in the active keyboard layout.
    3263. 

  3263. 

  3264. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3265. 

  3265. 

  3266. .. rst-class:: classref-item-separator
    3267. 

  3267. 

  3268. ----
    3269. 

  3269. 

  3270. .. _class_DisplayServer_method_keyboard_get_label_from_physical:
    3271. 

  3271. 

  3272. .. rst-class:: classref-method
    3273. 

  3273. 

  3274. :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>`
    3275. 

  3275. 

  3276. Converts a physical (US QWERTY) ``keycode`` to localized label printed on the key in the active keyboard layout.
    3277. 

  3277. 

  3278. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3279. 

  3279. 

  3280. .. rst-class:: classref-item-separator
    3281. 

  3281. 

  3282. ----
    3283. 

  3283. 

  3284. .. _class_DisplayServer_method_keyboard_get_layout_count:
    3285. 

  3285. 

  3286. .. rst-class:: classref-method
    3287. 

  3287. 

  3288. :ref:`int<class_int>` **keyboard_get_layout_count**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_keyboard_get_layout_count>`
    3289. 

  3289. 

  3290. Returns the number of keyboard layouts.
    3291. 

  3291. 

  3292. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3293. 

  3293. 

  3294. .. rst-class:: classref-item-separator
    3295. 

  3295. 

  3296. ----
    3297. 

  3297. 

  3298. .. _class_DisplayServer_method_keyboard_get_layout_language:
    3299. 

  3299. 

  3300. .. rst-class:: classref-method
    3301. 

  3301. 

  3302. :ref:`String<class_String>` **keyboard_get_layout_language**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_keyboard_get_layout_language>`
    3303. 

  3303. 

  3304. Returns the ISO-639/BCP-47 language code of the keyboard layout at position ``index``.
    3305. 

  3305. 

  3306. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3307. 

  3307. 

  3308. .. rst-class:: classref-item-separator
    3309. 

  3309. 

  3310. ----
    3311. 

  3311. 

  3312. .. _class_DisplayServer_method_keyboard_get_layout_name:
    3313. 

  3313. 

  3314. .. rst-class:: classref-method
    3315. 

  3315. 

  3316. :ref:`String<class_String>` **keyboard_get_layout_name**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_keyboard_get_layout_name>`
    3317. 

  3317. 

  3318. Returns the localized name of the keyboard layout at position ``index``.
    3319. 

  3319. 

  3320. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3321. 

  3321. 

  3322. .. rst-class:: classref-item-separator
    3323. 

  3323. 

  3324. ----
    3325. 

  3325. 

  3326. .. _class_DisplayServer_method_keyboard_set_current_layout:
    3327. 

  3327. 

  3328. .. rst-class:: classref-method
    3329. 

  3329. 

  3330. |void| **keyboard_set_current_layout**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_keyboard_set_current_layout>`
    3331. 

  3331. 

  3332. Sets the active keyboard layout.
    3333. 

  3333. 

  3334. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3335. 

  3335. 

  3336. .. rst-class:: classref-item-separator
    3337. 

  3337. 

  3338. ----
    3339. 

  3339. 

  3340. .. _class_DisplayServer_method_mouse_get_button_state:
    3341. 

  3341. 

  3342. .. rst-class:: classref-method
    3343. 

  3343. 

  3344. |bitfield|\[:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>`\] **mouse_get_button_state**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_mouse_get_button_state>`
    3345. 

  3345. 

  3346. 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>`.
    3347. 

  3347. 

  3348. .. rst-class:: classref-item-separator
    3349. 

  3349. 

  3350. ----
    3351. 

  3351. 

  3352. .. _class_DisplayServer_method_mouse_get_mode:
    3353. 

  3353. 

  3354. .. rst-class:: classref-method
    3355. 

  3355. 

  3356. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **mouse_get_mode**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_mouse_get_mode>`
    3357. 

  3357. 

  3358. Returns the current mouse mode. See also :ref:`mouse_set_mode<class_DisplayServer_method_mouse_set_mode>`.
    3359. 

  3359. 

  3360. .. rst-class:: classref-item-separator
    3361. 

  3361. 

  3362. ----
    3363. 

  3363. 

  3364. .. _class_DisplayServer_method_mouse_get_position:
    3365. 

  3365. 

  3366. .. rst-class:: classref-method
    3367. 

  3367. 

  3368. :ref:`Vector2i<class_Vector2i>` **mouse_get_position**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_mouse_get_position>`
    3369. 

  3369. 

  3370. Returns the mouse cursor's current position in screen coordinates.
    3371. 

  3371. 

  3372. .. rst-class:: classref-item-separator
    3373. 

  3373. 

  3374. ----
    3375. 

  3375. 

  3376. .. _class_DisplayServer_method_mouse_set_mode:
    3377. 

  3377. 

  3378. .. rst-class:: classref-method
    3379. 

  3379. 

  3380. |void| **mouse_set_mode**\ (\ mouse_mode\: :ref:`MouseMode<enum_DisplayServer_MouseMode>`\ ) :ref:`🔗<class_DisplayServer_method_mouse_set_mode>`
    3381. 

  3381. 

  3382. Sets the current mouse mode. See also :ref:`mouse_get_mode<class_DisplayServer_method_mouse_get_mode>`.
    3383. 

  3383. 

  3384. .. rst-class:: classref-item-separator
    3385. 

  3385. 

  3386. ----
    3387. 

  3387. 

  3388. .. _class_DisplayServer_method_process_events:
    3389. 

  3389. 

  3390. .. rst-class:: classref-method
    3391. 

  3391. 

  3392. |void| **process_events**\ (\ ) :ref:`🔗<class_DisplayServer_method_process_events>`
    3393. 

  3393. 

  3394. 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>`.
    3395. 

  3395. 

  3396. .. rst-class:: classref-item-separator
    3397. 

  3397. 

  3398. ----
    3399. 

  3399. 

  3400. .. _class_DisplayServer_method_register_additional_output:
    3401. 

  3401. 

  3402. .. rst-class:: classref-method
    3403. 

  3403. 

  3404. |void| **register_additional_output**\ (\ object\: :ref:`Object<class_Object>`\ ) :ref:`🔗<class_DisplayServer_method_register_additional_output>`
    3405. 

  3405. 

  3406. 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>`.
    3407. 

  3407. 

  3408. This can be used to prevent Godot from skipping rendering when no normal windows are visible.
    3409. 

  3409. 

  3410. .. rst-class:: classref-item-separator
    3411. 

  3411. 

  3412. ----
    3413. 

  3413. 

  3414. .. _class_DisplayServer_method_screen_get_dpi:
    3415. 

  3415. 

  3416. .. rst-class:: classref-method
    3417. 

  3417. 

  3418. :ref:`int<class_int>` **screen_get_dpi**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_dpi>`
    3419. 

  3419. 

  3420. Returns the dots per inch density of the specified screen. If ``screen`` is :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>` (the default value), a screen with the main window will be used.
    3421. 

  3421. 

  3422. \ **Note:** On macOS, returned value is inaccurate if fractional display scaling mode is used.
    3423. 

  3423. 

  3424. \ **Note:** On Android devices, the actual screen densities are grouped into six generalized densities:
    3425. 

  3425. 

  3426. .. code:: text
    3427. 

  3427. 

  3428.        ldpi - 120 dpi
    3429. 

  3429.        mdpi - 160 dpi
    3430. 

  3430.        hdpi - 240 dpi
    3431. 

  3431.       xhdpi - 320 dpi
    3432. 

  3432.      xxhdpi - 480 dpi
    3433. 

  3433.     xxxhdpi - 640 dpi
    3434. 

  3434. 

  3435. \ **Note:** This method is implemented on Android, Linux (X11/Wayland), macOS and Windows. Returns ``72`` on unsupported platforms.
    3436. 

  3436. 

  3437. .. rst-class:: classref-item-separator
    3438. 

  3438. 

  3439. ----
    3440. 

  3440. 

  3441. .. _class_DisplayServer_method_screen_get_image:
    3442. 

  3442. 

  3443. .. rst-class:: classref-method
    3444. 

  3444. 

  3445. :ref:`Image<class_Image>` **screen_get_image**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_image>`
    3446. 

  3446. 

  3447. Returns screenshot of the ``screen``.
    3448. 

  3448. 

  3449. \ **Note:** This method is implemented on Linux (X11), macOS, and Windows.
    3450. 

  3450. 

  3451. \ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.
    3452. 

  3452. 

  3453. .. rst-class:: classref-item-separator
    3454. 

  3454. 

  3455. ----
    3456. 

  3456. 

  3457. .. _class_DisplayServer_method_screen_get_image_rect:
    3458. 

  3458. 

  3459. .. rst-class:: classref-method
    3460. 

  3460. 

  3461. :ref:`Image<class_Image>` **screen_get_image_rect**\ (\ rect\: :ref:`Rect2i<class_Rect2i>`\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_image_rect>`
    3462. 

  3462. 

  3463. Returns screenshot of the screen ``rect``.
    3464. 

  3464. 

  3465. \ **Note:** This method is implemented on macOS and Windows.
    3466. 

  3466. 

  3467. \ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.
    3468. 

  3468. 

  3469. .. rst-class:: classref-item-separator
    3470. 

  3470. 

  3471. ----
    3472. 

  3472. 

  3473. .. _class_DisplayServer_method_screen_get_max_scale:
    3474. 

  3474. 

  3475. .. rst-class:: classref-method
    3476. 

  3476. 

  3477. :ref:`float<class_float>` **screen_get_max_scale**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_max_scale>`
    3478. 

  3478. 

  3479. Returns the greatest scale factor of all screens.
    3480. 

  3480. 

  3481. \ **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.
    3482. 

  3482. 

  3483. \ **Note:** This method is implemented only on macOS.
    3484. 

  3484. 

  3485. .. rst-class:: classref-item-separator
    3486. 

  3486. 

  3487. ----
    3488. 

  3488. 

  3489. .. _class_DisplayServer_method_screen_get_orientation:
    3490. 

  3490. 

  3491. .. rst-class:: classref-method
    3492. 

  3492. 

  3493. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **screen_get_orientation**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_orientation>`
    3494. 

  3494. 

  3495. Returns the ``screen``'s current orientation. See also :ref:`screen_set_orientation<class_DisplayServer_method_screen_set_orientation>`.
    3496. 

  3496. 

  3497. \ **Note:** This method is implemented on Android and iOS.
    3498. 

  3498. 

  3499. .. rst-class:: classref-item-separator
    3500. 

  3500. 

  3501. ----
    3502. 

  3502. 

  3503. .. _class_DisplayServer_method_screen_get_pixel:
    3504. 

  3504. 

  3505. .. rst-class:: classref-method
    3506. 

  3506. 

  3507. :ref:`Color<class_Color>` **screen_get_pixel**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_pixel>`
    3508. 

  3508. 

  3509. Returns color of the display pixel at the ``position``.
    3510. 

  3510. 

  3511. \ **Note:** This method is implemented on Linux (X11), macOS, and Windows.
    3512. 

  3512. 

  3513. \ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.
    3514. 

  3514. 

  3515. .. rst-class:: classref-item-separator
    3516. 

  3516. 

  3517. ----
    3518. 

  3518. 

  3519. .. _class_DisplayServer_method_screen_get_position:
    3520. 

  3520. 

  3521. .. rst-class:: classref-method
    3522. 

  3522. 

  3523. :ref:`Vector2i<class_Vector2i>` **screen_get_position**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_position>`
    3524. 

  3524. 

  3525. Returns the screen's top-left corner 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:
    3526. 

  3526. 

  3527. .. code:: text
    3528. 

  3528. 

  3529.     * (0, 0)        +-------+
    3530. 

  3530.                     |       |
    3531. 

  3531.     +-------------+ |       |
    3532. 

  3532.     |             | |       |
    3533. 

  3533.     |             | |       |
    3534. 

  3534.     +-------------+ +-------+
    3535. 

  3535. 

  3536. See also :ref:`screen_get_size<class_DisplayServer_method_screen_get_size>`.
    3537. 

  3537. 

  3538. \ **Note:** On Linux (Wayland) this method always returns ``(0, 0)``.
    3539. 

  3539. 

  3540. .. rst-class:: classref-item-separator
    3541. 

  3541. 

  3542. ----
    3543. 

  3543. 

  3544. .. _class_DisplayServer_method_screen_get_refresh_rate:
    3545. 

  3545. 

  3546. .. rst-class:: classref-method
    3547. 

  3547. 

  3548. :ref:`float<class_float>` **screen_get_refresh_rate**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_refresh_rate>`
    3549. 

  3549. 

  3550. Returns the current refresh rate of the specified screen. If ``screen`` is :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>` (the default value), a screen with the main window will be used.
    3551. 

  3551. 

  3552. \ **Note:** Returns ``-1.0`` if the DisplayServer fails to find the refresh rate for the specified screen. On Web, :ref:`screen_get_refresh_rate<class_DisplayServer_method_screen_get_refresh_rate>` will always return ``-1.0`` as there is no way to retrieve the refresh rate on that platform.
    3553. 

  3553. 

  3554. To fallback to a default refresh rate if the method fails, try:
    3555. 

  3555. 

  3556. ::
    3557. 

  3557. 

  3558.     var refresh_rate = DisplayServer.screen_get_refresh_rate()
    3559. 

  3559.     if refresh_rate < 0:
    3560. 

  3560.         refresh_rate = 60.0
    3561. 

  3561. 

  3562. .. rst-class:: classref-item-separator
    3563. 

  3563. 

  3564. ----
    3565. 

  3565. 

  3566. .. _class_DisplayServer_method_screen_get_scale:
    3567. 

  3567. 

  3568. .. rst-class:: classref-method
    3569. 

  3569. 

  3570. :ref:`float<class_float>` **screen_get_scale**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_scale>`
    3571. 

  3571. 

  3572. Returns the scale factor of the specified screen by index.
    3573. 

  3573. 

  3574. \ **Note:** On macOS, the returned value is ``2.0`` for hiDPI (Retina) screens, and ``1.0`` for all other cases.
    3575. 

  3575. 

  3576. \ **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``).
    3577. 

  3577. 

  3578. \ **Note:** This method is implemented on Android, iOS, Web, macOS, and Linux (Wayland).
    3579. 

  3579. 

  3580. .. rst-class:: classref-item-separator
    3581. 

  3581. 

  3582. ----
    3583. 

  3583. 

  3584. .. _class_DisplayServer_method_screen_get_size:
    3585. 

  3585. 

  3586. .. rst-class:: classref-method
    3587. 

  3587. 

  3588. :ref:`Vector2i<class_Vector2i>` **screen_get_size**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_size>`
    3589. 

  3589. 

  3590. 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>`.
    3591. 

  3591. 

  3592. .. rst-class:: classref-item-separator
    3593. 

  3593. 

  3594. ----
    3595. 

  3595. 

  3596. .. _class_DisplayServer_method_screen_get_usable_rect:
    3597. 

  3597. 

  3598. .. rst-class:: classref-method
    3599. 

  3599. 

  3600. :ref:`Rect2i<class_Rect2i>` **screen_get_usable_rect**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_get_usable_rect>`
    3601. 

  3601. 

  3602. 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>`.
    3603. 

  3603. 

  3604. .. rst-class:: classref-item-separator
    3605. 

  3605. 

  3606. ----
    3607. 

  3607. 

  3608. .. _class_DisplayServer_method_screen_is_kept_on:
    3609. 

  3609. 

  3610. .. rst-class:: classref-method
    3611. 

  3611. 

  3612. :ref:`bool<class_bool>` **screen_is_kept_on**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_screen_is_kept_on>`
    3613. 

  3613. 

  3614. 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>`.
    3615. 

  3615. 

  3616. .. rst-class:: classref-item-separator
    3617. 

  3617. 

  3618. ----
    3619. 

  3619. 

  3620. .. _class_DisplayServer_method_screen_set_keep_on:
    3621. 

  3621. 

  3622. .. rst-class:: classref-method
    3623. 

  3623. 

  3624. |void| **screen_set_keep_on**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_screen_set_keep_on>`
    3625. 

  3625. 

  3626. 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>`.
    3627. 

  3627. 

  3628. .. rst-class:: classref-item-separator
    3629. 

  3629. 

  3630. ----
    3631. 

  3631. 

  3632. .. _class_DisplayServer_method_screen_set_orientation:
    3633. 

  3633. 

  3634. .. rst-class:: classref-method
    3635. 

  3635. 

  3636. |void| **screen_set_orientation**\ (\ orientation\: :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>`, screen\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_DisplayServer_method_screen_set_orientation>`
    3637. 

  3637. 

  3638. Sets the ``screen``'s ``orientation``. See also :ref:`screen_get_orientation<class_DisplayServer_method_screen_get_orientation>`.
    3639. 

  3639. 

  3640. \ **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>`.
    3641. 

  3641. 

  3642. .. rst-class:: classref-item-separator
    3643. 

  3643. 

  3644. ----
    3645. 

  3645. 

  3646. .. _class_DisplayServer_method_set_icon:
    3647. 

  3647. 

  3648. .. rst-class:: classref-method
    3649. 

  3649. 

  3650. |void| **set_icon**\ (\ image\: :ref:`Image<class_Image>`\ ) :ref:`🔗<class_DisplayServer_method_set_icon>`
    3651. 

  3651. 

  3652. 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.
    3653. 

  3653. 

  3654. \ **Note:** Requires support for :ref:`FEATURE_ICON<class_DisplayServer_constant_FEATURE_ICON>`.
    3655. 

  3655. 

  3656. .. rst-class:: classref-item-separator
    3657. 

  3657. 

  3658. ----
    3659. 

  3659. 

  3660. .. _class_DisplayServer_method_set_native_icon:
    3661. 

  3661. 

  3662. .. rst-class:: classref-method
    3663. 

  3663. 

  3664. |void| **set_native_icon**\ (\ filename\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_set_native_icon>`
    3665. 

  3665. 

  3666. 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.
    3667. 

  3667. 

  3668. \ **Note:** Requires support for :ref:`FEATURE_NATIVE_ICON<class_DisplayServer_constant_FEATURE_NATIVE_ICON>`.
    3669. 

  3669. 

  3670. .. rst-class:: classref-item-separator
    3671. 

  3671. 

  3672. ----
    3673. 

  3673. 

  3674. .. _class_DisplayServer_method_set_system_theme_change_callback:
    3675. 

  3675. 

  3676. .. rst-class:: classref-method
    3677. 

  3677. 

  3678. |void| **set_system_theme_change_callback**\ (\ callable\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_set_system_theme_change_callback>`
    3679. 

  3679. 

  3680. Sets the ``callable`` that should be called when system theme settings are changed. Callback method should have zero arguments.
    3681. 

  3681. 

  3682. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
    3683. 

  3683. 

  3684. .. rst-class:: classref-item-separator
    3685. 

  3685. 

  3686. ----
    3687. 

  3687. 

  3688. .. _class_DisplayServer_method_show_emoji_and_symbol_picker:
    3689. 

  3689. 

  3690. .. rst-class:: classref-method
    3691. 

  3691. 

  3692. |void| **show_emoji_and_symbol_picker**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_show_emoji_and_symbol_picker>`
    3693. 

  3693. 

  3694. Opens system emoji and symbol picker.
    3695. 

  3695. 

  3696. \ **Note:** This method is implemented on macOS and Windows.
    3697. 

  3697. 

  3698. .. rst-class:: classref-item-separator
    3699. 

  3699. 

  3700. ----
    3701. 

  3701. 

  3702. .. _class_DisplayServer_method_status_indicator_get_rect:
    3703. 

  3703. 

  3704. .. rst-class:: classref-method
    3705. 

  3705. 

  3706. :ref:`Rect2<class_Rect2>` **status_indicator_get_rect**\ (\ id\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_status_indicator_get_rect>`
    3707. 

  3707. 

  3708. 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>`.
    3709. 

  3709. 

  3710. \ **Note:** This method is implemented on macOS and Windows.
    3711. 

  3711. 

  3712. .. rst-class:: classref-item-separator
    3713. 

  3713. 

  3714. ----
    3715. 

  3715. 

  3716. .. _class_DisplayServer_method_status_indicator_set_callback:
    3717. 

  3717. 

  3718. .. rst-class:: classref-method
    3719. 

  3719. 

  3720. |void| **status_indicator_set_callback**\ (\ id\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_status_indicator_set_callback>`
    3721. 

  3721. 

  3722. 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.
    3723. 

  3723. 

  3724. \ **Note:** This method is implemented on macOS and Windows.
    3725. 

  3725. 

  3726. .. rst-class:: classref-item-separator
    3727. 

  3727. 

  3728. ----
    3729. 

  3729. 

  3730. .. _class_DisplayServer_method_status_indicator_set_icon:
    3731. 

  3731. 

  3732. .. rst-class:: classref-method
    3733. 

  3733. 

  3734. |void| **status_indicator_set_icon**\ (\ id\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) :ref:`🔗<class_DisplayServer_method_status_indicator_set_icon>`
    3735. 

  3735. 

  3736. Sets the application status indicator icon.
    3737. 

  3737. 

  3738. \ **Note:** This method is implemented on macOS and Windows.
    3739. 

  3739. 

  3740. .. rst-class:: classref-item-separator
    3741. 

  3741. 

  3742. ----
    3743. 

  3743. 

  3744. .. _class_DisplayServer_method_status_indicator_set_menu:
    3745. 

  3745. 

  3746. .. rst-class:: classref-method
    3747. 

  3747. 

  3748. |void| **status_indicator_set_menu**\ (\ id\: :ref:`int<class_int>`, menu_rid\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_DisplayServer_method_status_indicator_set_menu>`
    3749. 

  3749. 

  3750. Sets the application status indicator native popup menu.
    3751. 

  3751. 

  3752. \ **Note:** On macOS, the menu is activated by any mouse button. Its activation callback is *not* triggered.
    3753. 

  3753. 

  3754. \ **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.
    3755. 

  3755. 

  3756. \ **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.
    3757. 

  3757. 

  3758. .. rst-class:: classref-item-separator
    3759. 

  3759. 

  3760. ----
    3761. 

  3761. 

  3762. .. _class_DisplayServer_method_status_indicator_set_tooltip:
    3763. 

  3763. 

  3764. .. rst-class:: classref-method
    3765. 

  3765. 

  3766. |void| **status_indicator_set_tooltip**\ (\ id\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_status_indicator_set_tooltip>`
    3767. 

  3767. 

  3768. Sets the application status indicator tooltip.
    3769. 

  3769. 

  3770. \ **Note:** This method is implemented on macOS and Windows.
    3771. 

  3771. 

  3772. .. rst-class:: classref-item-separator
    3773. 

  3773. 

  3774. ----
    3775. 

  3775. 

  3776. .. _class_DisplayServer_method_tablet_get_current_driver:
    3777. 

  3777. 

  3778. .. rst-class:: classref-method
    3779. 

  3779. 

  3780. :ref:`String<class_String>` **tablet_get_current_driver**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_tablet_get_current_driver>`
    3781. 

  3781. 

  3782. Returns current active tablet driver name.
    3783. 

  3783. 

  3784. \ **Note:** This method is implemented only on Windows.
    3785. 

  3785. 

  3786. .. rst-class:: classref-item-separator
    3787. 

  3787. 

  3788. ----
    3789. 

  3789. 

  3790. .. _class_DisplayServer_method_tablet_get_driver_count:
    3791. 

  3791. 

  3792. .. rst-class:: classref-method
    3793. 

  3793. 

  3794. :ref:`int<class_int>` **tablet_get_driver_count**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_tablet_get_driver_count>`
    3795. 

  3795. 

  3796. Returns the total number of available tablet drivers.
    3797. 

  3797. 

  3798. \ **Note:** This method is implemented only on Windows.
    3799. 

  3799. 

  3800. .. rst-class:: classref-item-separator
    3801. 

  3801. 

  3802. ----
    3803. 

  3803. 

  3804. .. _class_DisplayServer_method_tablet_get_driver_name:
    3805. 

  3805. 

  3806. .. rst-class:: classref-method
    3807. 

  3807. 

  3808. :ref:`String<class_String>` **tablet_get_driver_name**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_tablet_get_driver_name>`
    3809. 

  3809. 

  3810. Returns the tablet driver name for the given index.
    3811. 

  3811. 

  3812. \ **Note:** This method is implemented only on Windows.
    3813. 

  3813. 

  3814. .. rst-class:: classref-item-separator
    3815. 

  3815. 

  3816. ----
    3817. 

  3817. 

  3818. .. _class_DisplayServer_method_tablet_set_current_driver:
    3819. 

  3819. 

  3820. .. rst-class:: classref-method
    3821. 

  3821. 

  3822. |void| **tablet_set_current_driver**\ (\ name\: :ref:`String<class_String>`\ ) :ref:`🔗<class_DisplayServer_method_tablet_set_current_driver>`
    3823. 

  3823. 

  3824. Set active tablet driver name.
    3825. 

  3825. 

  3826. Supported drivers:
    3827. 

  3827. 

  3828. - ``winink``: Windows Ink API, default (Windows 8.1+ required).
    3829. 

  3829. 

  3830. - ``wintab``: Wacom Wintab API (compatible device driver required).
    3831. 

  3831. 

  3832. - ``dummy``: Dummy driver, tablet input is disabled.
    3833. 

  3833. 

  3834. \ **Note:** This method is implemented only on Windows.
    3835. 

  3835. 

  3836. .. rst-class:: classref-item-separator
    3837. 

  3837. 

  3838. ----
    3839. 

  3839. 

  3840. .. _class_DisplayServer_method_tts_get_voices:
    3841. 

  3841. 

  3842. .. rst-class:: classref-method
    3843. 

  3843. 

  3844. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **tts_get_voices**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_tts_get_voices>`
    3845. 

  3845. 

  3846. Returns an :ref:`Array<class_Array>` of voice information dictionaries.
    3847. 

  3847. 

  3848. Each :ref:`Dictionary<class_Dictionary>` contains two :ref:`String<class_String>` entries:
    3849. 

  3849. 

  3850. - ``name`` is voice name.
    3851. 

  3851. 

  3852. - ``id`` is voice identifier.
    3853. 

  3853. 

  3854. - ``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.
    3855. 

  3855. 

  3856. 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.
    3857. 

  3857. 

  3858. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3859. 

  3859. 

  3860. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3861. 

  3861. 

  3862. .. rst-class:: classref-item-separator
    3863. 

  3863. 

  3864. ----
    3865. 

  3865. 

  3866. .. _class_DisplayServer_method_tts_get_voices_for_language:
    3867. 

  3867. 

  3868. .. rst-class:: classref-method
    3869. 

  3869. 

  3870. :ref:`PackedStringArray<class_PackedStringArray>` **tts_get_voices_for_language**\ (\ language\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_DisplayServer_method_tts_get_voices_for_language>`
    3871. 

  3871. 

  3872. Returns an :ref:`PackedStringArray<class_PackedStringArray>` of voice identifiers for the ``language``.
    3873. 

  3873. 

  3874. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3875. 

  3875. 

  3876. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3877. 

  3877. 

  3878. .. rst-class:: classref-item-separator
    3879. 

  3879. 

  3880. ----
    3881. 

  3881. 

  3882. .. _class_DisplayServer_method_tts_is_paused:
    3883. 

  3883. 

  3884. .. rst-class:: classref-method
    3885. 

  3885. 

  3886. :ref:`bool<class_bool>` **tts_is_paused**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_tts_is_paused>`
    3887. 

  3887. 

  3888. Returns ``true`` if the synthesizer is in a paused state.
    3889. 

  3889. 

  3890. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3891. 

  3891. 

  3892. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3893. 

  3893. 

  3894. .. rst-class:: classref-item-separator
    3895. 

  3895. 

  3896. ----
    3897. 

  3897. 

  3898. .. _class_DisplayServer_method_tts_is_speaking:
    3899. 

  3899. 

  3900. .. rst-class:: classref-method
    3901. 

  3901. 

  3902. :ref:`bool<class_bool>` **tts_is_speaking**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_tts_is_speaking>`
    3903. 

  3903. 

  3904. Returns ``true`` if the synthesizer is generating speech, or have utterance waiting in the queue.
    3905. 

  3905. 

  3906. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3907. 

  3907. 

  3908. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3909. 

  3909. 

  3910. .. rst-class:: classref-item-separator
    3911. 

  3911. 

  3912. ----
    3913. 

  3913. 

  3914. .. _class_DisplayServer_method_tts_pause:
    3915. 

  3915. 

  3916. .. rst-class:: classref-method
    3917. 

  3917. 

  3918. |void| **tts_pause**\ (\ ) :ref:`🔗<class_DisplayServer_method_tts_pause>`
    3919. 

  3919. 

  3920. Puts the synthesizer into a paused state.
    3921. 

  3921. 

  3922. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3923. 

  3923. 

  3924. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3925. 

  3925. 

  3926. .. rst-class:: classref-item-separator
    3927. 

  3927. 

  3928. ----
    3929. 

  3929. 

  3930. .. _class_DisplayServer_method_tts_resume:
    3931. 

  3931. 

  3932. .. rst-class:: classref-method
    3933. 

  3933. 

  3934. |void| **tts_resume**\ (\ ) :ref:`🔗<class_DisplayServer_method_tts_resume>`
    3935. 

  3935. 

  3936. Resumes the synthesizer if it was paused.
    3937. 

  3937. 

  3938. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3939. 

  3939. 

  3940. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3941. 

  3941. 

  3942. .. rst-class:: classref-item-separator
    3943. 

  3943. 

  3944. ----
    3945. 

  3945. 

  3946. .. _class_DisplayServer_method_tts_set_utterance_callback:
    3947. 

  3947. 

  3948. .. rst-class:: classref-method
    3949. 

  3949. 

  3950. |void| **tts_set_utterance_callback**\ (\ event\: :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>`, callable\: :ref:`Callable<class_Callable>`\ ) :ref:`🔗<class_DisplayServer_method_tts_set_utterance_callback>`
    3951. 

  3951. 

  3952. Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary.
    3953. 

  3953. 

  3954. - :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.
    3955. 

  3955. 

  3956. - :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.
    3957. 

  3957. 

  3958. \ **Note:** The granularity of the boundary callbacks is engine dependent.
    3959. 

  3959. 

  3960. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3961. 

  3961. 

  3962. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3963. 

  3963. 

  3964. .. rst-class:: classref-item-separator
    3965. 

  3965. 

  3966. ----
    3967. 

  3967. 

  3968. .. _class_DisplayServer_method_tts_speak:
    3969. 

  3969. 

  3970. .. rst-class:: classref-method
    3971. 

  3971. 

  3972. |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>`
    3973. 

  3973. 

  3974. Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is cleared first.
    3975. 

  3975. 

  3976. - ``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>`.
    3977. 

  3977. 

  3978. - ``volume`` ranges from ``0`` (lowest) to ``100`` (highest).
    3979. 

  3979. 

  3980. - ``pitch`` ranges from ``0.0`` (lowest) to ``2.0`` (highest), ``1.0`` is default pitch for the current voice.
    3981. 

  3981. 

  3982. - ``rate`` ranges from ``0.1`` (lowest) to ``10.0`` (highest), ``1.0`` is a normal speaking rate. Other values act as a percentage relative.
    3983. 

  3983. 

  3984. - ``utterance_id`` is passed as a parameter to the callback functions.
    3985. 

  3985. 

  3986. \ **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>`.
    3987. 

  3987. 

  3988. \ **Note:** The granularity of pitch, rate, and volume is engine and voice dependent. Values may be truncated.
    3989. 

  3989. 

  3990. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3991. 

  3991. 

  3992. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3993. 

  3993. 

  3994. .. rst-class:: classref-item-separator
    3995. 

  3995. 

  3996. ----
    3997. 

  3997. 

  3998. .. _class_DisplayServer_method_tts_stop:
    3999. 

  3999. 

  4000. .. rst-class:: classref-method
    4001. 

  4001. 

  4002. |void| **tts_stop**\ (\ ) :ref:`🔗<class_DisplayServer_method_tts_stop>`
    4003. 

  4003. 

  4004. Stops synthesis in progress and removes all utterances from the queue.
    4005. 

  4005. 

  4006. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Linux), macOS, and Windows.
    4007. 

  4007. 

  4008. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    4009. 

  4009. 

  4010. .. rst-class:: classref-item-separator
    4011. 

  4011. 

  4012. ----
    4013. 

  4013. 

  4014. .. _class_DisplayServer_method_unregister_additional_output:
    4015. 

  4015. 

  4016. .. rst-class:: classref-method
    4017. 

  4017. 

  4018. |void| **unregister_additional_output**\ (\ object\: :ref:`Object<class_Object>`\ ) :ref:`🔗<class_DisplayServer_method_unregister_additional_output>`
    4019. 

  4019. 

  4020. Unregisters an :ref:`Object<class_Object>` representing an additional output, that was registered via :ref:`register_additional_output<class_DisplayServer_method_register_additional_output>`.
    4021. 

  4021. 

  4022. .. rst-class:: classref-item-separator
    4023. 

  4023. 

  4024. ----
    4025. 

  4025. 

  4026. .. _class_DisplayServer_method_virtual_keyboard_get_height:
    4027. 

  4027. 

  4028. .. rst-class:: classref-method
    4029. 

  4029. 

  4030. :ref:`int<class_int>` **virtual_keyboard_get_height**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_virtual_keyboard_get_height>`
    4031. 

  4031. 

  4032. Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.
    4033. 

  4033. 

  4034. .. rst-class:: classref-item-separator
    4035. 

  4035. 

  4036. ----
    4037. 

  4037. 

  4038. .. _class_DisplayServer_method_virtual_keyboard_hide:
    4039. 

  4039. 

  4040. .. rst-class:: classref-method
    4041. 

  4041. 

  4042. |void| **virtual_keyboard_hide**\ (\ ) :ref:`🔗<class_DisplayServer_method_virtual_keyboard_hide>`
    4043. 

  4043. 

  4044. Hides the virtual keyboard if it is shown, does nothing otherwise.
    4045. 

  4045. 

  4046. .. rst-class:: classref-item-separator
    4047. 

  4047. 

  4048. ----
    4049. 

  4049. 

  4050. .. _class_DisplayServer_method_virtual_keyboard_show:
    4051. 

  4051. 

  4052. .. rst-class:: classref-method
    4053. 

  4053. 

  4054. |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>`
    4055. 

  4055. 

  4056. Shows the virtual keyboard if the platform has one.
    4057. 

  4057. 

  4058. \ ``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).
    4059. 

  4059. 

  4060. \ ``position`` parameter is the screen space :ref:`Rect2<class_Rect2>` of the edited text.
    4061. 

  4061. 

  4062. \ ``type`` parameter allows configuring which type of virtual keyboard to show.
    4063. 

  4063. 

  4064. \ ``max_length`` limits the number of characters that can be entered if different from ``-1``.
    4065. 

  4065. 

  4066. \ ``cursor_start`` can optionally define the current text cursor position if ``cursor_end`` is not set.
    4067. 

  4067. 

  4068. \ ``cursor_start`` and ``cursor_end`` can optionally define the current text selection.
    4069. 

  4069. 

  4070. \ **Note:** This method is implemented on Android, iOS and Web.
    4071. 

  4071. 

  4072. .. rst-class:: classref-item-separator
    4073. 

  4073. 

  4074. ----
    4075. 

  4075. 

  4076. .. _class_DisplayServer_method_warp_mouse:
    4077. 

  4077. 

  4078. .. rst-class:: classref-method
    4079. 

  4079. 

  4080. |void| **warp_mouse**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`🔗<class_DisplayServer_method_warp_mouse>`
    4081. 

  4081. 

  4082. 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.
    4083. 

  4083. 

  4084. \ **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.
    4085. 

  4085. 

  4086. .. rst-class:: classref-item-separator
    4087. 

  4087. 

  4088. ----
    4089. 

  4089. 

  4090. .. _class_DisplayServer_method_window_can_draw:
    4091. 

  4091. 

  4092. .. rst-class:: classref-method
    4093. 

  4093. 

  4094. :ref:`bool<class_bool>` **window_can_draw**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_can_draw>`
    4095. 

  4095. 

  4096. 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``.
    4097. 

  4097. 

  4098. .. rst-class:: classref-item-separator
    4099. 

  4099. 

  4100. ----
    4101. 

  4101. 

  4102. .. _class_DisplayServer_method_window_get_active_popup:
    4103. 

  4103. 

  4104. .. rst-class:: classref-method
    4105. 

  4105. 

  4106. :ref:`int<class_int>` **window_get_active_popup**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_active_popup>`
    4107. 

  4107. 

  4108. Returns ID of the active popup window, or :ref:`INVALID_WINDOW_ID<class_DisplayServer_constant_INVALID_WINDOW_ID>` if there is none.
    4109. 

  4109. 

  4110. .. rst-class:: classref-item-separator
    4111. 

  4111. 

  4112. ----
    4113. 

  4113. 

  4114. .. _class_DisplayServer_method_window_get_attached_instance_id:
    4115. 

  4115. 

  4116. .. rst-class:: classref-method
    4117. 

  4117. 

  4118. :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>`
    4119. 

  4119. 

  4120. 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.
    4121. 

  4121. 

  4122. .. rst-class:: classref-item-separator
    4123. 

  4123. 

  4124. ----
    4125. 

  4125. 

  4126. .. _class_DisplayServer_method_window_get_current_screen:
    4127. 

  4127. 

  4128. .. rst-class:: classref-method
    4129. 

  4129. 

  4130. :ref:`int<class_int>` **window_get_current_screen**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_current_screen>`
    4131. 

  4131. 

  4132. 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>`.
    4133. 

  4133. 

  4134. .. rst-class:: classref-item-separator
    4135. 

  4135. 

  4136. ----
    4137. 

  4137. 

  4138. .. _class_DisplayServer_method_window_get_flag:
    4139. 

  4139. 

  4140. .. rst-class:: classref-method
    4141. 

  4141. 

  4142. :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>`
    4143. 

  4143. 

  4144. Returns the current value of the given window's ``flag``.
    4145. 

  4145. 

  4146. .. rst-class:: classref-item-separator
    4147. 

  4147. 

  4148. ----
    4149. 

  4149. 

  4150. .. _class_DisplayServer_method_window_get_max_size:
    4151. 

  4151. 

  4152. .. rst-class:: classref-method
    4153. 

  4153. 

  4154. :ref:`Vector2i<class_Vector2i>` **window_get_max_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_max_size>`
    4155. 

  4155. 

  4156. Returns the window's maximum size (in pixels). See also :ref:`window_set_max_size<class_DisplayServer_method_window_set_max_size>`.
    4157. 

  4157. 

  4158. .. rst-class:: classref-item-separator
    4159. 

  4159. 

  4160. ----
    4161. 

  4161. 

  4162. .. _class_DisplayServer_method_window_get_min_size:
    4163. 

  4163. 

  4164. .. rst-class:: classref-method
    4165. 

  4165. 

  4166. :ref:`Vector2i<class_Vector2i>` **window_get_min_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_min_size>`
    4167. 

  4167. 

  4168. Returns the window's minimum size (in pixels). See also :ref:`window_set_min_size<class_DisplayServer_method_window_set_min_size>`.
    4169. 

  4169. 

  4170. .. rst-class:: classref-item-separator
    4171. 

  4171. 

  4172. ----
    4173. 

  4173. 

  4174. .. _class_DisplayServer_method_window_get_mode:
    4175. 

  4175. 

  4176. .. rst-class:: classref-method
    4177. 

  4177. 

  4178. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **window_get_mode**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_mode>`
    4179. 

  4179. 

  4180. Returns the mode of the given window.
    4181. 

  4181. 

  4182. .. rst-class:: classref-item-separator
    4183. 

  4183. 

  4184. ----
    4185. 

  4185. 

  4186. .. _class_DisplayServer_method_window_get_native_handle:
    4187. 

  4187. 

  4188. .. rst-class:: classref-method
    4189. 

  4189. 

  4190. :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>`
    4191. 

  4191. 

  4192. Returns internal structure pointers for use in plugins.
    4193. 

  4193. 

  4194. \ **Note:** This method is implemented on Android, Linux (X11/Wayland), macOS, and Windows.
    4195. 

  4195. 

  4196. .. rst-class:: classref-item-separator
    4197. 

  4197. 

  4198. ----
    4199. 

  4199. 

  4200. .. _class_DisplayServer_method_window_get_popup_safe_rect:
    4201. 

  4201. 

  4202. .. rst-class:: classref-method
    4203. 

  4203. 

  4204. :ref:`Rect2i<class_Rect2i>` **window_get_popup_safe_rect**\ (\ window\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_popup_safe_rect>`
    4205. 

  4205. 

  4206. Returns the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system.
    4207. 

  4207. 

  4208. .. rst-class:: classref-item-separator
    4209. 

  4209. 

  4210. ----
    4211. 

  4211. 

  4212. .. _class_DisplayServer_method_window_get_position:
    4213. 

  4213. 

  4214. .. rst-class:: classref-method
    4215. 

  4215. 

  4216. :ref:`Vector2i<class_Vector2i>` **window_get_position**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_position>`
    4217. 

  4217. 

  4218. Returns the position of the client area of the given window on the screen.
    4219. 

  4219. 

  4220. .. rst-class:: classref-item-separator
    4221. 

  4221. 

  4222. ----
    4223. 

  4223. 

  4224. .. _class_DisplayServer_method_window_get_position_with_decorations:
    4225. 

  4225. 

  4226. .. rst-class:: classref-method
    4227. 

  4227. 

  4228. :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>`
    4229. 

  4229. 

  4230. 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>`.
    4231. 

  4231. 

  4232. .. rst-class:: classref-item-separator
    4233. 

  4233. 

  4234. ----
    4235. 

  4235. 

  4236. .. _class_DisplayServer_method_window_get_safe_title_margins:
    4237. 

  4237. 

  4238. .. rst-class:: classref-method
    4239. 

  4239. 

  4240. :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>`
    4241. 

  4241. 

  4242. 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.
    4243. 

  4243. 

  4244. .. rst-class:: classref-item-separator
    4245. 

  4245. 

  4246. ----
    4247. 

  4247. 

  4248. .. _class_DisplayServer_method_window_get_size:
    4249. 

  4249. 

  4250. .. rst-class:: classref-method
    4251. 

  4251. 

  4252. :ref:`Vector2i<class_Vector2i>` **window_get_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_get_size>`
    4253. 

  4253. 

  4254. 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>`.
    4255. 

  4255. 

  4256. .. rst-class:: classref-item-separator
    4257. 

  4257. 

  4258. ----
    4259. 

  4259. 

  4260. .. _class_DisplayServer_method_window_get_size_with_decorations:
    4261. 

  4261. 

  4262. .. rst-class:: classref-method
    4263. 

  4263. 

  4264. :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>`
    4265. 

  4265. 

  4266. 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>`.
    4267. 

  4267. 

  4268. .. rst-class:: classref-item-separator
    4269. 

  4269. 

  4270. ----
    4271. 

  4271. 

  4272. .. _class_DisplayServer_method_window_get_title_size:
    4273. 

  4273. 

  4274. .. rst-class:: classref-method
    4275. 

  4275. 

  4276. :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>`
    4277. 

  4277. 

  4278. 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.
    4279. 

  4279. 

  4280. \ **Note:** This method is implemented on macOS and Windows.
    4281. 

  4281. 

  4282. .. rst-class:: classref-item-separator
    4283. 

  4283. 

  4284. ----
    4285. 

  4285. 

  4286. .. _class_DisplayServer_method_window_get_vsync_mode:
    4287. 

  4287. 

  4288. .. rst-class:: classref-method
    4289. 

  4289. 

  4290. :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>`
    4291. 

  4291. 

  4292. Returns the V-Sync mode of the given window.
    4293. 

  4293. 

  4294. .. rst-class:: classref-item-separator
    4295. 

  4295. 

  4296. ----
    4297. 

  4297. 

  4298. .. _class_DisplayServer_method_window_is_focused:
    4299. 

  4299. 

  4300. .. rst-class:: classref-method
    4301. 

  4301. 

  4302. :ref:`bool<class_bool>` **window_is_focused**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_is_focused>`
    4303. 

  4303. 

  4304. Returns ``true`` if the window specified by ``window_id`` is focused.
    4305. 

  4305. 

  4306. .. rst-class:: classref-item-separator
    4307. 

  4307. 

  4308. ----
    4309. 

  4309. 

  4310. .. _class_DisplayServer_method_window_is_maximize_allowed:
    4311. 

  4311. 

  4312. .. rst-class:: classref-method
    4313. 

  4313. 

  4314. :ref:`bool<class_bool>` **window_is_maximize_allowed**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_DisplayServer_method_window_is_maximize_allowed>`
    4315. 

  4315. 

  4316. Returns ``true`` if the given window can be maximized (the maximize button is enabled).
    4317. 

  4317. 

  4318. .. rst-class:: classref-item-separator
    4319. 

  4319. 

  4320. ----
    4321. 

  4321. 

  4322. .. _class_DisplayServer_method_window_maximize_on_title_dbl_click:
    4323. 

  4323. 

  4324. .. rst-class:: classref-method
    4325. 

  4325. 

  4326. :ref:`bool<class_bool>` **window_maximize_on_title_dbl_click**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_window_maximize_on_title_dbl_click>`
    4327. 

  4327. 

  4328. Returns ``true``, if double-click on a window title should maximize it.
    4329. 

  4329. 

  4330. \ **Note:** This method is implemented only on macOS.
    4331. 

  4331. 

  4332. .. rst-class:: classref-item-separator
    4333. 

  4333. 

  4334. ----
    4335. 

  4335. 

  4336. .. _class_DisplayServer_method_window_minimize_on_title_dbl_click:
    4337. 

  4337. 

  4338. .. rst-class:: classref-method
    4339. 

  4339. 

  4340. :ref:`bool<class_bool>` **window_minimize_on_title_dbl_click**\ (\ ) |const| :ref:`🔗<class_DisplayServer_method_window_minimize_on_title_dbl_click>`
    4341. 

  4341. 

  4342. Returns ``true``, if double-click on a window title should minimize it.
    4343. 

  4343. 

  4344. \ **Note:** This method is implemented only on macOS.
    4345. 

  4345. 

  4346. .. rst-class:: classref-item-separator
    4347. 

  4347. 

  4348. ----
    4349. 

  4349. 

  4350. .. _class_DisplayServer_method_window_move_to_foreground:
    4351. 

  4351. 

  4352. .. rst-class:: classref-method
    4353. 

  4353. 

  4354. |void| **window_move_to_foreground**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_move_to_foreground>`
    4355. 

  4355. 

  4356. Moves the window specified by ``window_id`` to the foreground, so that it is visible over other windows.
    4357. 

  4357. 

  4358. .. rst-class:: classref-item-separator
    4359. 

  4359. 

  4360. ----
    4361. 

  4361. 

  4362. .. _class_DisplayServer_method_window_request_attention:
    4363. 

  4363. 

  4364. .. rst-class:: classref-method
    4365. 

  4365. 

  4366. |void| **window_request_attention**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_request_attention>`
    4367. 

  4367. 

  4368. 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.
    4369. 

  4369. 

  4370. .. rst-class:: classref-item-separator
    4371. 

  4371. 

  4372. ----
    4373. 

  4373. 

  4374. .. _class_DisplayServer_method_window_set_current_screen:
    4375. 

  4375. 

  4376. .. rst-class:: classref-method
    4377. 

  4377. 

  4378. |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>`
    4379. 

  4379. 

  4380. 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>`.
    4381. 

  4381. 

  4382. .. rst-class:: classref-item-separator
    4383. 

  4383. 

  4384. ----
    4385. 

  4385. 

  4386. .. _class_DisplayServer_method_window_set_drop_files_callback:
    4387. 

  4387. 

  4388. .. rst-class:: classref-method
    4389. 

  4389. 

  4390. |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>`
    4391. 

  4391. 

  4392. 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.
    4393. 

  4393. 

  4394. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
    4395. 

  4395. 

  4396. \ **Note:** This method is implemented on Windows, macOS, Linux (X11/Wayland), and Web.
    4397. 

  4397. 

  4398. .. rst-class:: classref-item-separator
    4399. 

  4399. 

  4400. ----
    4401. 

  4401. 

  4402. .. _class_DisplayServer_method_window_set_exclusive:
    4403. 

  4403. 

  4404. .. rst-class:: classref-method
    4405. 

  4405. 

  4406. |void| **window_set_exclusive**\ (\ window_id\: :ref:`int<class_int>`, exclusive\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_DisplayServer_method_window_set_exclusive>`
    4407. 

  4407. 

  4408. 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.
    4409. 

  4409. 

  4410. \ **Note:** On macOS, exclusive windows are confined to the same space (virtual desktop or screen) as the parent window.
    4411. 

  4411. 

  4412. \ **Note:** This method is implemented on macOS and Windows.
    4413. 

  4413. 

  4414. .. rst-class:: classref-item-separator
    4415. 

  4415. 

  4416. ----
    4417. 

  4417. 

  4418. .. _class_DisplayServer_method_window_set_flag:
    4419. 

  4419. 

  4420. .. rst-class:: classref-method
    4421. 

  4421. 

  4422. |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>`
    4423. 

  4423. 

  4424. Enables or disables the given window's given ``flag``. See :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` for possible values and their behavior.
    4425. 

  4425. 

  4426. .. rst-class:: classref-item-separator
    4427. 

  4427. 

  4428. ----
    4429. 

  4429. 

  4430. .. _class_DisplayServer_method_window_set_ime_active:
    4431. 

  4431. 

  4432. .. rst-class:: classref-method
    4433. 

  4433. 

  4434. |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>`
    4435. 

  4435. 

  4436. 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>`.
    4437. 

  4437. 

  4438. .. rst-class:: classref-item-separator
    4439. 

  4439. 

  4440. ----
    4441. 

  4441. 

  4442. .. _class_DisplayServer_method_window_set_ime_position:
    4443. 

  4443. 

  4444. .. rst-class:: classref-method
    4445. 

  4445. 

  4446. |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>`
    4447. 

  4447. 

  4448. 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``.
    4449. 

  4449. 

  4450. .. rst-class:: classref-item-separator
    4451. 

  4451. 

  4452. ----
    4453. 

  4453. 

  4454. .. _class_DisplayServer_method_window_set_input_event_callback:
    4455. 

  4455. 

  4456. .. rst-class:: classref-method
    4457. 

  4457. 

  4458. |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>`
    4459. 

  4459. 

  4460. Sets the ``callback`` that should be called when any :ref:`InputEvent<class_InputEvent>` is sent to the window specified by ``window_id``.
    4461. 

  4461. 

  4462. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
    4463. 

  4463. 

  4464. .. rst-class:: classref-item-separator
    4465. 

  4465. 

  4466. ----
    4467. 

  4467. 

  4468. .. _class_DisplayServer_method_window_set_input_text_callback:
    4469. 

  4469. 

  4470. .. rst-class:: classref-method
    4471. 

  4471. 

  4472. |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>`
    4473. 

  4473. 

  4474. Sets the ``callback`` that should be called when text is entered using the virtual keyboard to the window specified by ``window_id``.
    4475. 

  4475. 

  4476. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
    4477. 

  4477. 

  4478. .. rst-class:: classref-item-separator
    4479. 

  4479. 

  4480. ----
    4481. 

  4481. 

  4482. .. _class_DisplayServer_method_window_set_max_size:
    4483. 

  4483. 

  4484. .. rst-class:: classref-method
    4485. 

  4485. 

  4486. |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>`
    4487. 

  4487. 

  4488. 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>`.
    4489. 

  4489. 

  4490. \ **Note:** It's recommended to change this value using :ref:`Window.max_size<class_Window_property_max_size>` instead.
    4491. 

  4491. 

  4492. \ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.
    4493. 

  4493. 

  4494. .. rst-class:: classref-item-separator
    4495. 

  4495. 

  4496. ----
    4497. 

  4497. 

  4498. .. _class_DisplayServer_method_window_set_min_size:
    4499. 

  4499. 

  4500. .. rst-class:: classref-method
    4501. 

  4501. 

  4502. |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>`
    4503. 

  4503. 

  4504. 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>`.
    4505. 

  4505. 

  4506. \ **Note:** It's recommended to change this value using :ref:`Window.min_size<class_Window_property_min_size>` instead.
    4507. 

  4507. 

  4508. \ **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.
    4509. 

  4509. 

  4510. \ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.
    4511. 

  4511. 

  4512. .. rst-class:: classref-item-separator
    4513. 

  4513. 

  4514. ----
    4515. 

  4515. 

  4516. .. _class_DisplayServer_method_window_set_mode:
    4517. 

  4517. 

  4518. .. rst-class:: classref-method
    4519. 

  4519. 

  4520. |void| **window_set_mode**\ (\ mode\: :ref:`WindowMode<enum_DisplayServer_WindowMode>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_mode>`
    4521. 

  4521. 

  4522. Sets window mode for the given window to ``mode``. See :ref:`WindowMode<enum_DisplayServer_WindowMode>` for possible values and how each mode behaves.
    4523. 

  4523. 

  4524. \ **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.
    4525. 

  4525. 

  4526. \ **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.
    4527. 

  4527. 

  4528. .. rst-class:: classref-item-separator
    4529. 

  4529. 

  4530. ----
    4531. 

  4531. 

  4532. .. _class_DisplayServer_method_window_set_mouse_passthrough:
    4533. 

  4533. 

  4534. .. rst-class:: classref-method
    4535. 

  4535. 

  4536. |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>`
    4537. 

  4537. 

  4538. Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through.
    4539. 

  4539. 

  4540. Passing an empty array will disable passthrough support (all mouse events will be intercepted by the window, which is the default behavior).
    4541. 

  4541. 

  4542. 

  4543. .. tabs::
    4544. 

  4544. 

  4545.  .. code-tab:: gdscript
    4546. 

  4546. 

  4547.     # Set region, using Path2D node.
    4548. 

  4548.     DisplayServer.window_set_mouse_passthrough($Path2D.curve.get_baked_points())
    4549. 

  4549.     
    4550. 

  4550.     # Set region, using Polygon2D node.
    4551. 

  4551.     DisplayServer.window_set_mouse_passthrough($Polygon2D.polygon)
    4552. 

  4552.     
    4553. 

  4553.     # Reset region to default.
    4554. 

  4554.     DisplayServer.window_set_mouse_passthrough([])
    4555. 

  4555. 

  4556.  .. code-tab:: csharp
    4557. 

  4557. 

  4558.     // Set region, using Path2D node.
    4559. 

  4559.     DisplayServer.WindowSetMousePassthrough(GetNode<Path2D>("Path2D").Curve.GetBakedPoints());
    4560. 

  4560.     
    4561. 

  4561.     // Set region, using Polygon2D node.
    4562. 

  4562.     DisplayServer.WindowSetMousePassthrough(GetNode<Polygon2D>("Polygon2D").Polygon);
    4563. 

  4563.     
    4564. 

  4564.     // Reset region to default.
    4565. 

  4565.     DisplayServer.WindowSetMousePassthrough([]);
    4566. 

  4566. 

  4567. 

  4568. 

  4569. \ **Note:** On Windows, the portion of a window that lies outside the region is not drawn, while on Linux (X11) and macOS it is.
    4570. 

  4570. 

  4571. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    4572. 

  4572. 

  4573. .. rst-class:: classref-item-separator
    4574. 

  4574. 

  4575. ----
    4576. 

  4576. 

  4577. .. _class_DisplayServer_method_window_set_popup_safe_rect:
    4578. 

  4578. 

  4579. .. rst-class:: classref-method
    4580. 

  4580. 

  4581. |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>`
    4582. 

  4582. 

  4583. 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.
    4584. 

  4584. 

  4585. .. rst-class:: classref-item-separator
    4586. 

  4586. 

  4587. ----
    4588. 

  4588. 

  4589. .. _class_DisplayServer_method_window_set_position:
    4590. 

  4590. 

  4591. .. rst-class:: classref-method
    4592. 

  4592. 

  4593. |void| **window_set_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_position>`
    4594. 

  4594. 

  4595. 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:
    4596. 

  4596. 

  4597. .. code:: text
    4598. 

  4598. 

  4599.     * (0, 0)        +-------+
    4600. 

  4600.                     |       |
    4601. 

  4601.     +-------------+ |       |
    4602. 

  4602.     |             | |       |
    4603. 

  4603.     |             | |       |
    4604. 

  4604.     +-------------+ +-------+
    4605. 

  4605. 

  4606. See also :ref:`window_get_position<class_DisplayServer_method_window_get_position>` and :ref:`window_set_size<class_DisplayServer_method_window_set_size>`.
    4607. 

  4607. 

  4608. \ **Note:** It's recommended to change this value using :ref:`Window.position<class_Window_property_position>` instead.
    4609. 

  4609. 

  4610. \ **Note:** On Linux (Wayland): this method is a no-op.
    4611. 

  4611. 

  4612. .. rst-class:: classref-item-separator
    4613. 

  4613. 

  4614. ----
    4615. 

  4615. 

  4616. .. _class_DisplayServer_method_window_set_rect_changed_callback:
    4617. 

  4617. 

  4618. .. rst-class:: classref-method
    4619. 

  4619. 

  4620. |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>`
    4621. 

  4621. 

  4622. Sets the ``callback`` that will be called when the window specified by ``window_id`` is moved or resized.
    4623. 

  4623. 

  4624. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
    4625. 

  4625. 

  4626. .. rst-class:: classref-item-separator
    4627. 

  4627. 

  4628. ----
    4629. 

  4629. 

  4630. .. _class_DisplayServer_method_window_set_size:
    4631. 

  4631. 

  4632. .. rst-class:: classref-method
    4633. 

  4633. 

  4634. |void| **window_set_size**\ (\ size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_size>`
    4635. 

  4635. 

  4636. 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>`.
    4637. 

  4637. 

  4638. \ **Note:** It's recommended to change this value using :ref:`Window.size<class_Window_property_size>` instead.
    4639. 

  4639. 

  4640. .. rst-class:: classref-item-separator
    4641. 

  4641. 

  4642. ----
    4643. 

  4643. 

  4644. .. _class_DisplayServer_method_window_set_title:
    4645. 

  4645. 

  4646. .. rst-class:: classref-method
    4647. 

  4647. 

  4648. |void| **window_set_title**\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_set_title>`
    4649. 

  4649. 

  4650. Sets the title of the given window to ``title``.
    4651. 

  4651. 

  4652. \ **Note:** It's recommended to change this value using :ref:`Window.title<class_Window_property_title>` instead.
    4653. 

  4653. 

  4654. \ **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.
    4655. 

  4655. 

  4656. .. rst-class:: classref-item-separator
    4657. 

  4657. 

  4658. ----
    4659. 

  4659. 

  4660. .. _class_DisplayServer_method_window_set_transient:
    4661. 

  4661. 

  4662. .. rst-class:: classref-method
    4663. 

  4663. 

  4664. |void| **window_set_transient**\ (\ window_id\: :ref:`int<class_int>`, parent_window_id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_DisplayServer_method_window_set_transient>`
    4665. 

  4665. 

  4666. 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.
    4667. 

  4667. 

  4668. \ **Note:** It's recommended to change this value using :ref:`Window.transient<class_Window_property_transient>` instead.
    4669. 

  4669. 

  4670. \ **Note:** The behavior might be different depending on the platform.
    4671. 

  4671. 

  4672. .. rst-class:: classref-item-separator
    4673. 

  4673. 

  4674. ----
    4675. 

  4675. 

  4676. .. _class_DisplayServer_method_window_set_vsync_mode:
    4677. 

  4677. 

  4678. .. rst-class:: classref-method
    4679. 

  4679. 

  4680. |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>`
    4681. 

  4681. 

  4682. 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>`.
    4683. 

  4683. 

  4684. See :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` for possible values and how they affect the behavior of your application.
    4685. 

  4685. 

  4686. 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.
    4687. 

  4687. 

  4688. \ **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.
    4689. 

  4689. 

  4690. .. rst-class:: classref-item-separator
    4691. 

  4691. 

  4692. ----
    4693. 

  4693. 

  4694. .. _class_DisplayServer_method_window_set_window_buttons_offset:
    4695. 

  4695. 

  4696. .. rst-class:: classref-method
    4697. 

  4697. 

  4698. |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>`
    4699. 

  4699. 

  4700. 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.
    4701. 

  4701. 

  4702. \ **Note:** This flag is implemented only on macOS.
    4703. 

  4703. 

  4704. .. rst-class:: classref-item-separator
    4705. 

  4705. 

  4706. ----
    4707. 

  4707. 

  4708. .. _class_DisplayServer_method_window_set_window_event_callback:
    4709. 

  4709. 

  4710. .. rst-class:: classref-method
    4711. 

  4711. 

  4712. |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>`
    4713. 

  4713. 

  4714. Sets the ``callback`` that will be called when an event occurs in the window specified by ``window_id``.
    4715. 

  4715. 

  4716. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
    4717. 

  4717. 

  4718. .. rst-class:: classref-item-separator
    4719. 

  4719. 

  4720. ----
    4721. 

  4721. 

  4722. .. _class_DisplayServer_method_window_start_drag:
    4723. 

  4723. 

  4724. .. rst-class:: classref-method
    4725. 

  4725. 

  4726. |void| **window_start_drag**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_start_drag>`
    4727. 

  4727. 

  4728. 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.
    4729. 

  4729. 

  4730. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS, and Windows.
    4731. 

  4731. 

  4732. .. rst-class:: classref-item-separator
    4733. 

  4733. 

  4734. ----
    4735. 

  4735. 

  4736. .. _class_DisplayServer_method_window_start_resize:
    4737. 

  4737. 

  4738. .. rst-class:: classref-method
    4739. 

  4739. 

  4740. |void| **window_start_resize**\ (\ edge\: :ref:`WindowResizeEdge<enum_DisplayServer_WindowResizeEdge>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_DisplayServer_method_window_start_resize>`
    4741. 

  4741. 

  4742. 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.
    4743. 

  4743. 

  4744. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS, and Windows.
    4745. 

  4745. 

  4746. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    4747. 

  4747. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    4748. 

  4748. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    4749. 

  4749. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    4750. 

  4750. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    4751. 

  4751. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    4752. 

  4752. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    4753. 

  4753. .. |void| replace:: :abbr:`void (No return value.)`
    4754. 

  4754.