首页 发现 帮助
登录
Godot
/
godot-docs
镜像自地址 https://github.com/godotengine/godot-docs.git
2
0
派生 0
文件 工单管理 0 Wiki
目录树: 4779a1dbdf
分支列表 标签列表
godot-docs
/
classes
/
class_displayserver.rst

class_displayserver.rst 367 KB
文件历史 原始文件

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353 
  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.    | :ref:`String<class_String>`                                             | :ref:`clipboard_get<class_DisplayServer_method_clipboard_get>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    36. 

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

  37.    | :ref:`Image<class_Image>`                                               | :ref:`clipboard_get_image<class_DisplayServer_method_clipboard_get_image>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
    38. 

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

  39.    | :ref:`String<class_String>`                                             | :ref:`clipboard_get_primary<class_DisplayServer_method_clipboard_get_primary>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    40. 

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

  41.    | :ref:`bool<class_bool>`                                                 | :ref:`clipboard_has<class_DisplayServer_method_clipboard_has>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    42. 

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

  43.    | :ref:`bool<class_bool>`                                                 | :ref:`clipboard_has_image<class_DisplayServer_method_clipboard_has_image>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
    44. 

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

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

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

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

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

  49.    | :ref:`int<class_int>`                                                   | :ref:`create_status_indicator<class_DisplayServer_method_create_status_indicator>`\ (\ icon\: :ref:`Image<class_Image>`, tooltip\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ )                                                                                                                                                                                                                                                                                                                                                       |
    50. 

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

  51.    | :ref:`CursorShape<enum_DisplayServer_CursorShape>`                      | :ref:`cursor_get_shape<class_DisplayServer_method_cursor_get_shape>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    52. 

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

  53.    | |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)\ )                                                                                                                                                                                                                                                                                                         |
    54. 

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

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

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

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

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

  59.    | :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>`\ )                                                                                                                                                                                                                                                                                                               |
    60. 

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

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

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

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

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

  65.    | :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>`\ )                                                                                                                                           |
    66. 

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

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

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

  69.    | |void|                                                                  | :ref:`force_process_and_drop_events<class_DisplayServer_method_force_process_and_drop_events>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    70. 

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

  71.    | :ref:`Color<class_Color>`                                               | :ref:`get_accent_color<class_DisplayServer_method_get_accent_color>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    72. 

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

  73.    | :ref:`Color<class_Color>`                                               | :ref:`get_base_color<class_DisplayServer_method_get_base_color>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    74. 

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

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

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

  77.    | :ref:`Rect2i<class_Rect2i>`                                             | :ref:`get_display_safe_area<class_DisplayServer_method_get_display_safe_area>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    78. 

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

  79.    | :ref:`int<class_int>`                                                   | :ref:`get_keyboard_focus_screen<class_DisplayServer_method_get_keyboard_focus_screen>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    80. 

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

  81.    | :ref:`String<class_String>`                                             | :ref:`get_name<class_DisplayServer_method_get_name>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    82. 

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

  83.    | :ref:`int<class_int>`                                                   | :ref:`get_primary_screen<class_DisplayServer_method_get_primary_screen>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    84. 

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

  85.    | :ref:`int<class_int>`                                                   | :ref:`get_screen_count<class_DisplayServer_method_get_screen_count>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    86. 

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

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

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

  89.    | :ref:`bool<class_bool>`                                                 | :ref:`get_swap_cancel_ok<class_DisplayServer_method_get_swap_cancel_ok>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    90. 

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

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

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

  93.    | :ref:`PackedInt32Array<class_PackedInt32Array>`                         | :ref:`get_window_list<class_DisplayServer_method_get_window_list>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    94. 

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

  95.    | :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\ )                                                                                                                             |
    96. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  115.    | :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|                                                                                                                                                                                                                                                                                                                                                                            |
    116. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  143.    | :ref:`Dictionary<class_Dictionary>`                                     | :ref:`global_menu_get_system_menu_roots<class_DisplayServer_method_global_menu_get_system_menu_roots>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    144. 

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

  145.    | :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|                                                                                                                                                                                                                                                                                                                                                                                  |
    146. 

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

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

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

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

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

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

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

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

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

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

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

  157.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                       |
    158. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  195.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                                                  |
    196. 

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

  197.    | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`ime_get_selection<class_DisplayServer_method_ime_get_selection>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    198. 

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

  199.    | :ref:`String<class_String>`                                             | :ref:`ime_get_text<class_DisplayServer_method_ime_get_text>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    200. 

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

  201.    | :ref:`bool<class_bool>`                                                 | :ref:`is_dark_mode<class_DisplayServer_method_is_dark_mode>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    202. 

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

  203.    | :ref:`bool<class_bool>`                                                 | :ref:`is_dark_mode_supported<class_DisplayServer_method_is_dark_mode_supported>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    204. 

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

  205.    | :ref:`bool<class_bool>`                                                 | :ref:`is_touchscreen_available<class_DisplayServer_method_is_touchscreen_available>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    206. 

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

  207.    | :ref:`int<class_int>`                                                   | :ref:`keyboard_get_current_layout<class_DisplayServer_method_keyboard_get_current_layout>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
    208. 

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

  209.    | :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|                                                                                                                                                                                                                                                                                                                                                                                                 |
    210. 

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

  211.    | :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|                                                                                                                                                                                                                                                                                                                                                                                                     |
    212. 

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

  213.    | :ref:`int<class_int>`                                                   | :ref:`keyboard_get_layout_count<class_DisplayServer_method_keyboard_get_layout_count>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    214. 

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

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

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

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

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

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

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

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

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

  223.    | :ref:`MouseMode<enum_DisplayServer_MouseMode>`                          | :ref:`mouse_get_mode<class_DisplayServer_method_mouse_get_mode>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    224. 

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

  225.    | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`mouse_get_position<class_DisplayServer_method_mouse_get_position>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    226. 

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

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

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

  229.    | |void|                                                                  | :ref:`process_events<class_DisplayServer_method_process_events>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    230. 

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

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

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

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

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

  235.    | :ref:`float<class_float>`                                               | :ref:`screen_get_max_scale<class_DisplayServer_method_screen_get_max_scale>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    236. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  251.    | :ref:`bool<class_bool>`                                                 | :ref:`screen_is_kept_on<class_DisplayServer_method_screen_is_kept_on>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    252. 

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

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

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

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

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

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

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

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

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

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

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

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

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

  265.    | |void|                                                                  | :ref:`status_indicator_set_icon<class_DisplayServer_method_status_indicator_set_icon>`\ (\ id\: :ref:`int<class_int>`, icon\: :ref:`Image<class_Image>`\ )                                                                                                                                                                                                                                                                                                                                                                                                          |
    266. 

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

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

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

  269.    | :ref:`String<class_String>`                                             | :ref:`tablet_get_current_driver<class_DisplayServer_method_tablet_get_current_driver>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    270. 

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

  271.    | :ref:`int<class_int>`                                                   | :ref:`tablet_get_driver_count<class_DisplayServer_method_tablet_get_driver_count>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    272. 

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

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

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

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

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

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

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

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

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

  281.    | :ref:`bool<class_bool>`                                                 | :ref:`tts_is_paused<class_DisplayServer_method_tts_is_paused>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    282. 

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

  283.    | :ref:`bool<class_bool>`                                                 | :ref:`tts_is_speaking<class_DisplayServer_method_tts_is_speaking>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    284. 

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

  285.    | |void|                                                                  | :ref:`tts_pause<class_DisplayServer_method_tts_pause>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    286. 

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

  287.    | |void|                                                                  | :ref:`tts_resume<class_DisplayServer_method_tts_resume>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    288. 

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

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

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

  291.    | |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\ )                                                                                                                                                                                                                  |
    292. 

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

  293.    | |void|                                                                  | :ref:`tts_stop<class_DisplayServer_method_tts_stop>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    294. 

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

  295.    | :ref:`int<class_int>`                                                   | :ref:`virtual_keyboard_get_height<class_DisplayServer_method_virtual_keyboard_get_height>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
    296. 

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

  297.    | |void|                                                                  | :ref:`virtual_keyboard_hide<class_DisplayServer_method_virtual_keyboard_hide>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    298. 

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

  299.    | |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\ )                                                                                                                                                             |
    300. 

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

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

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

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

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

  305.    | :ref:`int<class_int>`                                                   | :ref:`window_get_active_popup<class_DisplayServer_method_window_get_active_popup>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    306. 

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

  307.    | :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|                                                                                                                                                                                                                                                                                                                                                                                                             |
    308. 

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

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

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

  311.    | :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|                                                                                                                                                                                                                                                                                                                                                                                  |
    312. 

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

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

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

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

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

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

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

  319.    | :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|                                                                                                                                                                                                                                                                                                                                                           |
    320. 

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

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

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

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

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

  325.    | :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|                                                                                                                                                                                                                                                                                                                                                                                                   |
    326. 

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

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

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

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

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

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

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

  333.    | :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|                                                                                                                                                                                                                                                                                                                                                                                            |
    334. 

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

  335.    | :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|                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    336. 

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

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

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

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

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

  341.    | :ref:`bool<class_bool>`                                                 | :ref:`window_maximize_on_title_dbl_click<class_DisplayServer_method_window_maximize_on_title_dbl_click>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    342. 

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

  343.    | :ref:`bool<class_bool>`                                                 | :ref:`window_minimize_on_title_dbl_click<class_DisplayServer_method_window_minimize_on_title_dbl_click>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    344. 

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

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

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

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

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

  349.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                                                 |
    350. 

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

  351.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                           |
    352. 

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

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

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

  355.    | |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\ )                                                                                                                                                                                                                                                                                                                                                       |
    356. 

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

  357.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                                                       |
    358. 

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

  359.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                                         |
    360. 

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

  361.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                         |
    362. 

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

  363.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                           |
    364. 

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

  365.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                                                 |
    366. 

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

  367.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                                                 |
    368. 

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

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

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

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

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

  373.    | |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>`\ )                                                                                                                                                                                                                                                                                                                                                                                                  |
    374. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  389.    | |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\ )                                                                                                                                                                                                                                                                                                                                                                       |
    390. 

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

  391. 

  392. .. rst-class:: classref-section-separator
    393. 

  393. 

  394. ----
    395. 

  395. 

  396. .. rst-class:: classref-descriptions-group
    397. 

  397. 

  398. Enumerations
    399. 

  399. ------------
    400. 

  400. 

  401. .. _enum_DisplayServer_Feature:
    402. 

  402. 

  403. .. rst-class:: classref-enumeration
    404. 

  404. 

  405. enum **Feature**:
    406. 

  406. 

  407. .. _class_DisplayServer_constant_FEATURE_GLOBAL_MENU:
    408. 

  408. 

  409. .. rst-class:: classref-enumeration-constant
    410. 

  410. 

  411. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_GLOBAL_MENU** = ``0``
    412. 

  412. 

  413. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    414. 

  414. 

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

  416. 

  417. .. _class_DisplayServer_constant_FEATURE_SUBWINDOWS:
    418. 

  418. 

  419. .. rst-class:: classref-enumeration-constant
    420. 

  420. 

  421. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SUBWINDOWS** = ``1``
    422. 

  422. 

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

  424. 

  425. .. _class_DisplayServer_constant_FEATURE_TOUCHSCREEN:
    426. 

  426. 

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

  428. 

  429. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TOUCHSCREEN** = ``2``
    430. 

  430. 

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

  432. 

  433. .. _class_DisplayServer_constant_FEATURE_MOUSE:
    434. 

  434. 

  435. .. rst-class:: classref-enumeration-constant
    436. 

  436. 

  437. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE** = ``3``
    438. 

  438. 

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

  440. 

  441. .. _class_DisplayServer_constant_FEATURE_MOUSE_WARP:
    442. 

  442. 

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

  444. 

  445. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE_WARP** = ``4``
    446. 

  446. 

  447. 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)**
    448. 

  448. 

  449. .. _class_DisplayServer_constant_FEATURE_CLIPBOARD:
    450. 

  450. 

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

  452. 

  453. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD** = ``5``
    454. 

  454. 

  455. 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**
    456. 

  456. 

  457. .. _class_DisplayServer_constant_FEATURE_VIRTUAL_KEYBOARD:
    458. 

  458. 

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

  460. 

  461. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_VIRTUAL_KEYBOARD** = ``6``
    462. 

  462. 

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

  464. 

  465. .. _class_DisplayServer_constant_FEATURE_CURSOR_SHAPE:
    466. 

  466. 

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

  468. 

  469. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CURSOR_SHAPE** = ``7``
    470. 

  470. 

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

  472. 

  473. .. _class_DisplayServer_constant_FEATURE_CUSTOM_CURSOR_SHAPE:
    474. 

  474. 

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

  476. 

  477. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CUSTOM_CURSOR_SHAPE** = ``8``
    478. 

  478. 

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

  480. 

  481. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG:
    482. 

  482. 

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

  484. 

  485. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG** = ``9``
    486. 

  486. 

  487. 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**
    488. 

  488. 

  489. .. _class_DisplayServer_constant_FEATURE_IME:
    490. 

  490. 

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

  492. 

  493. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_IME** = ``10``
    494. 

  494. 

  495. 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)**
    496. 

  496. 

  497. .. _class_DisplayServer_constant_FEATURE_WINDOW_TRANSPARENCY:
    498. 

  498. 

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

  500. 

  501. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_TRANSPARENCY** = ``11``
    502. 

  502. 

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

  504. 

  505. .. _class_DisplayServer_constant_FEATURE_HIDPI:
    506. 

  506. 

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

  508. 

  509. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_HIDPI** = ``12``
    510. 

  510. 

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

  512. 

  513. .. _class_DisplayServer_constant_FEATURE_ICON:
    514. 

  514. 

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

  516. 

  517. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ICON** = ``13``
    518. 

  518. 

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

  520. 

  521. .. _class_DisplayServer_constant_FEATURE_NATIVE_ICON:
    522. 

  522. 

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

  524. 

  525. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_ICON** = ``14``
    526. 

  526. 

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

  528. 

  529. .. _class_DisplayServer_constant_FEATURE_ORIENTATION:
    530. 

  530. 

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

  532. 

  533. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ORIENTATION** = ``15``
    534. 

  534. 

  535. Display server supports changing the screen orientation. **Android, iOS**
    536. 

  536. 

  537. .. _class_DisplayServer_constant_FEATURE_SWAP_BUFFERS:
    538. 

  538. 

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

  540. 

  541. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SWAP_BUFFERS** = ``16``
    542. 

  542. 

  543. 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)**
    544. 

  544. 

  545. .. _class_DisplayServer_constant_FEATURE_CLIPBOARD_PRIMARY:
    546. 

  546. 

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

  548. 

  549. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD_PRIMARY** = ``18``
    550. 

  550. 

  551. 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)**
    552. 

  552. 

  553. .. _class_DisplayServer_constant_FEATURE_TEXT_TO_SPEECH:
    554. 

  554. 

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

  556. 

  557. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TEXT_TO_SPEECH** = ``19``
    558. 

  558. 

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

  560. 

  561. .. _class_DisplayServer_constant_FEATURE_EXTEND_TO_TITLE:
    562. 

  562. 

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

  564. 

  565. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_EXTEND_TO_TITLE** = ``20``
    566. 

  566. 

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

  568. 

  569. .. _class_DisplayServer_constant_FEATURE_SCREEN_CAPTURE:
    570. 

  570. 

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

  572. 

  573. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SCREEN_CAPTURE** = ``21``
    574. 

  574. 

  575. Display server supports reading screen pixels. See :ref:`screen_get_pixel<class_DisplayServer_method_screen_get_pixel>`.
    576. 

  576. 

  577. .. _class_DisplayServer_constant_FEATURE_STATUS_INDICATOR:
    578. 

  578. 

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

  580. 

  581. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_STATUS_INDICATOR** = ``22``
    582. 

  582. 

  583. Display server supports application status indicators.
    584. 

  584. 

  585. .. _class_DisplayServer_constant_FEATURE_NATIVE_HELP:
    586. 

  586. 

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

  588. 

  589. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_HELP** = ``23``
    590. 

  590. 

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

  592. 

  593. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_INPUT:
    594. 

  594. 

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

  596. 

  597. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_INPUT** = ``24``
    598. 

  598. 

  599. 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**
    600. 

  600. 

  601. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE:
    602. 

  602. 

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

  604. 

  605. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE** = ``25``
    606. 

  606. 

  607. 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>` and :ref:`file_dialog_with_options_show<class_DisplayServer_method_file_dialog_with_options_show>`. **Windows, macOS, Linux (X11/Wayland)**
    608. 

  608. 

  609. .. rst-class:: classref-item-separator
    610. 

  610. 

  611. ----
    612. 

  612. 

  613. .. _enum_DisplayServer_MouseMode:
    614. 

  614. 

  615. .. rst-class:: classref-enumeration
    616. 

  616. 

  617. enum **MouseMode**:
    618. 

  618. 

  619. .. _class_DisplayServer_constant_MOUSE_MODE_VISIBLE:
    620. 

  620. 

  621. .. rst-class:: classref-enumeration-constant
    622. 

  622. 

  623. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_VISIBLE** = ``0``
    624. 

  624. 

  625. Makes the mouse cursor visible if it is hidden.
    626. 

  626. 

  627. .. _class_DisplayServer_constant_MOUSE_MODE_HIDDEN:
    628. 

  628. 

  629. .. rst-class:: classref-enumeration-constant
    630. 

  630. 

  631. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_HIDDEN** = ``1``
    632. 

  632. 

  633. Makes the mouse cursor hidden if it is visible.
    634. 

  634. 

  635. .. _class_DisplayServer_constant_MOUSE_MODE_CAPTURED:
    636. 

  636. 

  637. .. rst-class:: classref-enumeration-constant
    638. 

  638. 

  639. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CAPTURED** = ``2``
    640. 

  640. 

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

  642. 

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

  644. 

  645. .. _class_DisplayServer_constant_MOUSE_MODE_CONFINED:
    646. 

  646. 

  647. .. rst-class:: classref-enumeration-constant
    648. 

  648. 

  649. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED** = ``3``
    650. 

  650. 

  651. Confines the mouse cursor to the game window, and make it visible.
    652. 

  652. 

  653. .. _class_DisplayServer_constant_MOUSE_MODE_CONFINED_HIDDEN:
    654. 

  654. 

  655. .. rst-class:: classref-enumeration-constant
    656. 

  656. 

  657. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED_HIDDEN** = ``4``
    658. 

  658. 

  659. Confines the mouse cursor to the game window, and make it hidden.
    660. 

  660. 

  661. .. rst-class:: classref-item-separator
    662. 

  662. 

  663. ----
    664. 

  664. 

  665. .. _enum_DisplayServer_ScreenOrientation:
    666. 

  666. 

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

  668. 

  669. enum **ScreenOrientation**:
    670. 

  670. 

  671. .. _class_DisplayServer_constant_SCREEN_LANDSCAPE:
    672. 

  672. 

  673. .. rst-class:: classref-enumeration-constant
    674. 

  674. 

  675. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_LANDSCAPE** = ``0``
    676. 

  676. 

  677. Default landscape orientation.
    678. 

  678. 

  679. .. _class_DisplayServer_constant_SCREEN_PORTRAIT:
    680. 

  680. 

  681. .. rst-class:: classref-enumeration-constant
    682. 

  682. 

  683. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_PORTRAIT** = ``1``
    684. 

  684. 

  685. Default portrait orientation.
    686. 

  686. 

  687. .. _class_DisplayServer_constant_SCREEN_REVERSE_LANDSCAPE:
    688. 

  688. 

  689. .. rst-class:: classref-enumeration-constant
    690. 

  690. 

  691. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_LANDSCAPE** = ``2``
    692. 

  692. 

  693. Reverse landscape orientation (upside down).
    694. 

  694. 

  695. .. _class_DisplayServer_constant_SCREEN_REVERSE_PORTRAIT:
    696. 

  696. 

  697. .. rst-class:: classref-enumeration-constant
    698. 

  698. 

  699. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_PORTRAIT** = ``3``
    700. 

  700. 

  701. Reverse portrait orientation (upside down).
    702. 

  702. 

  703. .. _class_DisplayServer_constant_SCREEN_SENSOR_LANDSCAPE:
    704. 

  704. 

  705. .. rst-class:: classref-enumeration-constant
    706. 

  706. 

  707. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_LANDSCAPE** = ``4``
    708. 

  708. 

  709. Automatic landscape orientation (default or reverse depending on sensor).
    710. 

  710. 

  711. .. _class_DisplayServer_constant_SCREEN_SENSOR_PORTRAIT:
    712. 

  712. 

  713. .. rst-class:: classref-enumeration-constant
    714. 

  714. 

  715. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_PORTRAIT** = ``5``
    716. 

  716. 

  717. Automatic portrait orientation (default or reverse depending on sensor).
    718. 

  718. 

  719. .. _class_DisplayServer_constant_SCREEN_SENSOR:
    720. 

  720. 

  721. .. rst-class:: classref-enumeration-constant
    722. 

  722. 

  723. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR** = ``6``
    724. 

  724. 

  725. Automatic landscape or portrait orientation (default or reverse depending on sensor).
    726. 

  726. 

  727. .. rst-class:: classref-item-separator
    728. 

  728. 

  729. ----
    730. 

  730. 

  731. .. _enum_DisplayServer_VirtualKeyboardType:
    732. 

  732. 

  733. .. rst-class:: classref-enumeration
    734. 

  734. 

  735. enum **VirtualKeyboardType**:
    736. 

  736. 

  737. .. _class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT:
    738. 

  738. 

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

  740. 

  741. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_DEFAULT** = ``0``
    742. 

  742. 

  743. Default text virtual keyboard.
    744. 

  744. 

  745. .. _class_DisplayServer_constant_KEYBOARD_TYPE_MULTILINE:
    746. 

  746. 

  747. .. rst-class:: classref-enumeration-constant
    748. 

  748. 

  749. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_MULTILINE** = ``1``
    750. 

  750. 

  751. Multiline virtual keyboard.
    752. 

  752. 

  753. .. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER:
    754. 

  754. 

  755. .. rst-class:: classref-enumeration-constant
    756. 

  756. 

  757. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER** = ``2``
    758. 

  758. 

  759. Virtual number keypad, useful for PIN entry.
    760. 

  760. 

  761. .. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER_DECIMAL:
    762. 

  762. 

  763. .. rst-class:: classref-enumeration-constant
    764. 

  764. 

  765. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER_DECIMAL** = ``3``
    766. 

  766. 

  767. Virtual number keypad, useful for entering fractional numbers.
    768. 

  768. 

  769. .. _class_DisplayServer_constant_KEYBOARD_TYPE_PHONE:
    770. 

  770. 

  771. .. rst-class:: classref-enumeration-constant
    772. 

  772. 

  773. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PHONE** = ``4``
    774. 

  774. 

  775. Virtual phone number keypad.
    776. 

  776. 

  777. .. _class_DisplayServer_constant_KEYBOARD_TYPE_EMAIL_ADDRESS:
    778. 

  778. 

  779. .. rst-class:: classref-enumeration-constant
    780. 

  780. 

  781. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_EMAIL_ADDRESS** = ``5``
    782. 

  782. 

  783. Virtual keyboard with additional keys to assist with typing email addresses.
    784. 

  784. 

  785. .. _class_DisplayServer_constant_KEYBOARD_TYPE_PASSWORD:
    786. 

  786. 

  787. .. rst-class:: classref-enumeration-constant
    788. 

  788. 

  789. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PASSWORD** = ``6``
    790. 

  790. 

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

  792. 

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

  794. 

  795. .. _class_DisplayServer_constant_KEYBOARD_TYPE_URL:
    796. 

  796. 

  797. .. rst-class:: classref-enumeration-constant
    798. 

  798. 

  799. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_URL** = ``7``
    800. 

  800. 

  801. Virtual keyboard with additional keys to assist with typing URLs.
    802. 

  802. 

  803. .. rst-class:: classref-item-separator
    804. 

  804. 

  805. ----
    806. 

  806. 

  807. .. _enum_DisplayServer_CursorShape:
    808. 

  808. 

  809. .. rst-class:: classref-enumeration
    810. 

  810. 

  811. enum **CursorShape**:
    812. 

  812. 

  813. .. _class_DisplayServer_constant_CURSOR_ARROW:
    814. 

  814. 

  815. .. rst-class:: classref-enumeration-constant
    816. 

  816. 

  817. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_ARROW** = ``0``
    818. 

  818. 

  819. 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>`.
    820. 

  820. 

  821. .. _class_DisplayServer_constant_CURSOR_IBEAM:
    822. 

  822. 

  823. .. rst-class:: classref-enumeration-constant
    824. 

  824. 

  825. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_IBEAM** = ``1``
    826. 

  826. 

  827. 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>`.
    828. 

  828. 

  829. .. _class_DisplayServer_constant_CURSOR_POINTING_HAND:
    830. 

  830. 

  831. .. rst-class:: classref-enumeration-constant
    832. 

  832. 

  833. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_POINTING_HAND** = ``2``
    834. 

  834. 

  835. 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>`.
    836. 

  836. 

  837. .. _class_DisplayServer_constant_CURSOR_CROSS:
    838. 

  838. 

  839. .. rst-class:: classref-enumeration-constant
    840. 

  840. 

  841. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CROSS** = ``3``
    842. 

  842. 

  843. 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.
    844. 

  844. 

  845. .. _class_DisplayServer_constant_CURSOR_WAIT:
    846. 

  846. 

  847. .. rst-class:: classref-enumeration-constant
    848. 

  848. 

  849. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_WAIT** = ``4``
    850. 

  850. 

  851. 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>`.
    852. 

  852. 

  853. .. _class_DisplayServer_constant_CURSOR_BUSY:
    854. 

  854. 

  855. .. rst-class:: classref-enumeration-constant
    856. 

  856. 

  857. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BUSY** = ``5``
    858. 

  858. 

  859. 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>`.
    860. 

  860. 

  861. .. _class_DisplayServer_constant_CURSOR_DRAG:
    862. 

  862. 

  863. .. rst-class:: classref-enumeration-constant
    864. 

  864. 

  865. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_DRAG** = ``6``
    866. 

  866. 

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

  868. 

  869. .. _class_DisplayServer_constant_CURSOR_CAN_DROP:
    870. 

  870. 

  871. .. rst-class:: classref-enumeration-constant
    872. 

  872. 

  873. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CAN_DROP** = ``7``
    874. 

  874. 

  875. "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>`.
    876. 

  876. 

  877. .. _class_DisplayServer_constant_CURSOR_FORBIDDEN:
    878. 

  878. 

  879. .. rst-class:: classref-enumeration-constant
    880. 

  880. 

  881. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FORBIDDEN** = ``8``
    882. 

  882. 

  883. 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.
    884. 

  884. 

  885. .. _class_DisplayServer_constant_CURSOR_VSIZE:
    886. 

  886. 

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

  888. 

  889. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSIZE** = ``9``
    890. 

  890. 

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

  892. 

  893. .. _class_DisplayServer_constant_CURSOR_HSIZE:
    894. 

  894. 

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

  896. 

  897. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSIZE** = ``10``
    898. 

  898. 

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

  900. 

  901. .. _class_DisplayServer_constant_CURSOR_BDIAGSIZE:
    902. 

  902. 

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

  904. 

  905. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BDIAGSIZE** = ``11``
    906. 

  906. 

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

  908. 

  909. .. _class_DisplayServer_constant_CURSOR_FDIAGSIZE:
    910. 

  910. 

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

  912. 

  913. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FDIAGSIZE** = ``12``
    914. 

  914. 

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

  916. 

  917. .. _class_DisplayServer_constant_CURSOR_MOVE:
    918. 

  918. 

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

  920. 

  921. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MOVE** = ``13``
    922. 

  922. 

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

  924. 

  925. .. _class_DisplayServer_constant_CURSOR_VSPLIT:
    926. 

  926. 

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

  928. 

  929. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSPLIT** = ``14``
    930. 

  930. 

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

  932. 

  933. .. _class_DisplayServer_constant_CURSOR_HSPLIT:
    934. 

  934. 

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

  936. 

  937. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSPLIT** = ``15``
    938. 

  938. 

  939. 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>`.
    940. 

  940. 

  941. .. _class_DisplayServer_constant_CURSOR_HELP:
    942. 

  942. 

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

  944. 

  945. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HELP** = ``16``
    946. 

  946. 

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

  948. 

  949. .. _class_DisplayServer_constant_CURSOR_MAX:
    950. 

  950. 

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

  952. 

  953. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MAX** = ``17``
    954. 

  954. 

  955. Represents the size of the :ref:`CursorShape<enum_DisplayServer_CursorShape>` enum.
    956. 

  956. 

  957. .. rst-class:: classref-item-separator
    958. 

  958. 

  959. ----
    960. 

  960. 

  961. .. _enum_DisplayServer_FileDialogMode:
    962. 

  962. 

  963. .. rst-class:: classref-enumeration
    964. 

  964. 

  965. enum **FileDialogMode**:
    966. 

  966. 

  967. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILE:
    968. 

  968. 

  969. .. rst-class:: classref-enumeration-constant
    970. 

  970. 

  971. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILE** = ``0``
    972. 

  972. 

  973. The native file dialog allows selecting one, and only one file.
    974. 

  974. 

  975. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILES:
    976. 

  976. 

  977. .. rst-class:: classref-enumeration-constant
    978. 

  978. 

  979. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILES** = ``1``
    980. 

  980. 

  981. The native file dialog allows selecting multiple files.
    982. 

  982. 

  983. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_DIR:
    984. 

  984. 

  985. .. rst-class:: classref-enumeration-constant
    986. 

  986. 

  987. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_DIR** = ``2``
    988. 

  988. 

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

  990. 

  991. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_ANY:
    992. 

  992. 

  993. .. rst-class:: classref-enumeration-constant
    994. 

  994. 

  995. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_ANY** = ``3``
    996. 

  996. 

  997. The native file dialog allows selecting one file or directory.
    998. 

  998. 

  999. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_SAVE_FILE:
    1000. 

  1000. 

  1001. .. rst-class:: classref-enumeration-constant
    1002. 

  1002. 

  1003. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_SAVE_FILE** = ``4``
    1004. 

  1004. 

  1005. The native file dialog will warn when a file exists.
    1006. 

  1006. 

  1007. .. rst-class:: classref-item-separator
    1008. 

  1008. 

  1009. ----
    1010. 

  1010. 

  1011. .. _enum_DisplayServer_WindowMode:
    1012. 

  1012. 

  1013. .. rst-class:: classref-enumeration
    1014. 

  1014. 

  1015. enum **WindowMode**:
    1016. 

  1016. 

  1017. .. _class_DisplayServer_constant_WINDOW_MODE_WINDOWED:
    1018. 

  1018. 

  1019. .. rst-class:: classref-enumeration-constant
    1020. 

  1020. 

  1021. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_WINDOWED** = ``0``
    1022. 

  1022. 

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

  1024. 

  1025. .. _class_DisplayServer_constant_WINDOW_MODE_MINIMIZED:
    1026. 

  1026. 

  1027. .. rst-class:: classref-enumeration-constant
    1028. 

  1028. 

  1029. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MINIMIZED** = ``1``
    1030. 

  1030. 

  1031. 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.
    1032. 

  1032. 

  1033. .. _class_DisplayServer_constant_WINDOW_MODE_MAXIMIZED:
    1034. 

  1034. 

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

  1036. 

  1037. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MAXIMIZED** = ``2``
    1038. 

  1038. 

  1039. 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.
    1040. 

  1040. 

  1041. .. _class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN:
    1042. 

  1042. 

  1043. .. rst-class:: classref-enumeration-constant
    1044. 

  1044. 

  1045. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_FULLSCREEN** = ``3``
    1046. 

  1046. 

  1047. Full screen mode with full multi-window support.
    1048. 

  1048. 

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

  1050. 

  1051. \ **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.
    1052. 

  1052. 

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

  1054. 

  1055. \ **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.
    1056. 

  1056. 

  1057. .. _class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN:
    1058. 

  1058. 

  1059. .. rst-class:: classref-enumeration-constant
    1060. 

  1060. 

  1061. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_EXCLUSIVE_FULLSCREEN** = ``4``
    1062. 

  1062. 

  1063. 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).
    1064. 

  1064. 

  1065. 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.
    1066. 

  1066. 

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

  1068. 

  1069. \ **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.
    1070. 

  1070. 

  1071. \ **On Linux (X11):** Exclusive full screen mode bypasses compositor.
    1072. 

  1072. 

  1073. \ **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.
    1074. 

  1074. 

  1075. .. rst-class:: classref-item-separator
    1076. 

  1076. 

  1077. ----
    1078. 

  1078. 

  1079. .. _enum_DisplayServer_WindowFlags:
    1080. 

  1080. 

  1081. .. rst-class:: classref-enumeration
    1082. 

  1082. 

  1083. enum **WindowFlags**:
    1084. 

  1084. 

  1085. .. _class_DisplayServer_constant_WINDOW_FLAG_RESIZE_DISABLED:
    1086. 

  1086. 

  1087. .. rst-class:: classref-enumeration-constant
    1088. 

  1088. 

  1089. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_RESIZE_DISABLED** = ``0``
    1090. 

  1090. 

  1091. 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.
    1092. 

  1092. 

  1093. .. _class_DisplayServer_constant_WINDOW_FLAG_BORDERLESS:
    1094. 

  1094. 

  1095. .. rst-class:: classref-enumeration-constant
    1096. 

  1096. 

  1097. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_BORDERLESS** = ``1``
    1098. 

  1098. 

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

  1100. 

  1101. .. _class_DisplayServer_constant_WINDOW_FLAG_ALWAYS_ON_TOP:
    1102. 

  1102. 

  1103. .. rst-class:: classref-enumeration-constant
    1104. 

  1104. 

  1105. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_ALWAYS_ON_TOP** = ``2``
    1106. 

  1106. 

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

  1108. 

  1109. .. _class_DisplayServer_constant_WINDOW_FLAG_TRANSPARENT:
    1110. 

  1110. 

  1111. .. rst-class:: classref-enumeration-constant
    1112. 

  1112. 

  1113. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_TRANSPARENT** = ``3``
    1114. 

  1114. 

  1115. The window background can be transparent.
    1116. 

  1116. 

  1117. \ **Note:** This flag has no effect if :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>` is set to ``false``.
    1118. 

  1118. 

  1119. \ **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.
    1120. 

  1120. 

  1121. .. _class_DisplayServer_constant_WINDOW_FLAG_NO_FOCUS:
    1122. 

  1122. 

  1123. .. rst-class:: classref-enumeration-constant
    1124. 

  1124. 

  1125. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_NO_FOCUS** = ``4``
    1126. 

  1126. 

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

  1128. 

  1129. .. _class_DisplayServer_constant_WINDOW_FLAG_POPUP:
    1130. 

  1130. 

  1131. .. rst-class:: classref-enumeration-constant
    1132. 

  1132. 

  1133. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_POPUP** = ``5``
    1134. 

  1134. 

  1135. 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>`).
    1136. 

  1136. 

  1137. .. _class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE:
    1138. 

  1138. 

  1139. .. rst-class:: classref-enumeration-constant
    1140. 

  1140. 

  1141. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_EXTEND_TO_TITLE** = ``6``
    1142. 

  1142. 

  1143. 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.
    1144. 

  1144. 

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

  1146. 

  1147. 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.
    1148. 

  1148. 

  1149. \ **Note:** This flag is implemented only on macOS.
    1150. 

  1150. 

  1151. .. _class_DisplayServer_constant_WINDOW_FLAG_MOUSE_PASSTHROUGH:
    1152. 

  1152. 

  1153. .. rst-class:: classref-enumeration-constant
    1154. 

  1154. 

  1155. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MOUSE_PASSTHROUGH** = ``7``
    1156. 

  1156. 

  1157. All mouse events are passed to the underlying window of the same application.
    1158. 

  1158. 

  1159. .. _class_DisplayServer_constant_WINDOW_FLAG_MAX:
    1160. 

  1160. 

  1161. .. rst-class:: classref-enumeration-constant
    1162. 

  1162. 

  1163. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MAX** = ``8``
    1164. 

  1164. 

  1165. Max value of the :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`.
    1166. 

  1166. 

  1167. .. rst-class:: classref-item-separator
    1168. 

  1168. 

  1169. ----
    1170. 

  1170. 

  1171. .. _enum_DisplayServer_WindowEvent:
    1172. 

  1172. 

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

  1174. 

  1175. enum **WindowEvent**:
    1176. 

  1176. 

  1177. .. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_ENTER:
    1178. 

  1178. 

  1179. .. rst-class:: classref-enumeration-constant
    1180. 

  1180. 

  1181. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_ENTER** = ``0``
    1182. 

  1182. 

  1183. Sent when the mouse pointer enters the window.
    1184. 

  1184. 

  1185. .. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_EXIT:
    1186. 

  1186. 

  1187. .. rst-class:: classref-enumeration-constant
    1188. 

  1188. 

  1189. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_EXIT** = ``1``
    1190. 

  1190. 

  1191. Sent when the mouse pointer exits the window.
    1192. 

  1192. 

  1193. .. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_IN:
    1194. 

  1194. 

  1195. .. rst-class:: classref-enumeration-constant
    1196. 

  1196. 

  1197. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_IN** = ``2``
    1198. 

  1198. 

  1199. Sent when the window grabs focus.
    1200. 

  1200. 

  1201. .. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_OUT:
    1202. 

  1202. 

  1203. .. rst-class:: classref-enumeration-constant
    1204. 

  1204. 

  1205. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_OUT** = ``3``
    1206. 

  1206. 

  1207. Sent when the window loses focus.
    1208. 

  1208. 

  1209. .. _class_DisplayServer_constant_WINDOW_EVENT_CLOSE_REQUEST:
    1210. 

  1210. 

  1211. .. rst-class:: classref-enumeration-constant
    1212. 

  1212. 

  1213. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_CLOSE_REQUEST** = ``4``
    1214. 

  1214. 

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

  1216. 

  1217. .. _class_DisplayServer_constant_WINDOW_EVENT_GO_BACK_REQUEST:
    1218. 

  1218. 

  1219. .. rst-class:: classref-enumeration-constant
    1220. 

  1220. 

  1221. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_GO_BACK_REQUEST** = ``5``
    1222. 

  1222. 

  1223. Sent when the device "Back" button is pressed.
    1224. 

  1224. 

  1225. \ **Note:** This event is implemented only on Android.
    1226. 

  1226. 

  1227. .. _class_DisplayServer_constant_WINDOW_EVENT_DPI_CHANGE:
    1228. 

  1228. 

  1229. .. rst-class:: classref-enumeration-constant
    1230. 

  1230. 

  1231. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_DPI_CHANGE** = ``6``
    1232. 

  1232. 

  1233. Sent when the window is moved to the display with different DPI, or display DPI is changed.
    1234. 

  1234. 

  1235. \ **Note:** This flag is implemented only on macOS.
    1236. 

  1236. 

  1237. .. _class_DisplayServer_constant_WINDOW_EVENT_TITLEBAR_CHANGE:
    1238. 

  1238. 

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

  1240. 

  1241. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_TITLEBAR_CHANGE** = ``7``
    1242. 

  1242. 

  1243. 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).
    1244. 

  1244. 

  1245. \ **Note:** This flag is implemented only on macOS.
    1246. 

  1246. 

  1247. .. rst-class:: classref-item-separator
    1248. 

  1248. 

  1249. ----
    1250. 

  1250. 

  1251. .. _enum_DisplayServer_VSyncMode:
    1252. 

  1252. 

  1253. .. rst-class:: classref-enumeration
    1254. 

  1254. 

  1255. enum **VSyncMode**:
    1256. 

  1256. 

  1257. .. _class_DisplayServer_constant_VSYNC_DISABLED:
    1258. 

  1258. 

  1259. .. rst-class:: classref-enumeration-constant
    1260. 

  1260. 

  1261. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_DISABLED** = ``0``
    1262. 

  1262. 

  1263. 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>`).
    1264. 

  1264. 

  1265. .. _class_DisplayServer_constant_VSYNC_ENABLED:
    1266. 

  1266. 

  1267. .. rst-class:: classref-enumeration-constant
    1268. 

  1268. 

  1269. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ENABLED** = ``1``
    1270. 

  1270. 

  1271. 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>`).
    1272. 

  1272. 

  1273. .. _class_DisplayServer_constant_VSYNC_ADAPTIVE:
    1274. 

  1274. 

  1275. .. rst-class:: classref-enumeration-constant
    1276. 

  1276. 

  1277. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ADAPTIVE** = ``2``
    1278. 

  1278. 

  1279. 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.
    1280. 

  1280. 

  1281. .. _class_DisplayServer_constant_VSYNC_MAILBOX:
    1282. 

  1282. 

  1283. .. rst-class:: classref-enumeration-constant
    1284. 

  1284. 

  1285. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_MAILBOX** = ``3``
    1286. 

  1286. 

  1287. 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>`).
    1288. 

  1288. 

  1289. 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.
    1290. 

  1290. 

  1291. .. rst-class:: classref-item-separator
    1292. 

  1292. 

  1293. ----
    1294. 

  1294. 

  1295. .. _enum_DisplayServer_HandleType:
    1296. 

  1296. 

  1297. .. rst-class:: classref-enumeration
    1298. 

  1298. 

  1299. enum **HandleType**:
    1300. 

  1300. 

  1301. .. _class_DisplayServer_constant_DISPLAY_HANDLE:
    1302. 

  1302. 

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

  1304. 

  1305. :ref:`HandleType<enum_DisplayServer_HandleType>` **DISPLAY_HANDLE** = ``0``
    1306. 

  1306. 

  1307. Display handle:
    1308. 

  1308. 

  1309. - Linux (X11): ``X11::Display*`` for the display.
    1310. 

  1310. 

  1311. - Android: ``EGLDisplay`` for the display.
    1312. 

  1312. 

  1313. .. _class_DisplayServer_constant_WINDOW_HANDLE:
    1314. 

  1314. 

  1315. .. rst-class:: classref-enumeration-constant
    1316. 

  1316. 

  1317. :ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_HANDLE** = ``1``
    1318. 

  1318. 

  1319. Window handle:
    1320. 

  1320. 

  1321. - Windows: ``HWND`` for the window.
    1322. 

  1322. 

  1323. - Linux (X11): ``X11::Window*`` for the window.
    1324. 

  1324. 

  1325. - macOS: ``NSWindow*`` for the window.
    1326. 

  1326. 

  1327. - iOS: ``UIViewController*`` for the view controller.
    1328. 

  1328. 

  1329. - Android: ``jObject`` for the activity.
    1330. 

  1330. 

  1331. .. _class_DisplayServer_constant_WINDOW_VIEW:
    1332. 

  1332. 

  1333. .. rst-class:: classref-enumeration-constant
    1334. 

  1334. 

  1335. :ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_VIEW** = ``2``
    1336. 

  1336. 

  1337. Window view:
    1338. 

  1338. 

  1339. - Windows: ``HDC`` for the window (only with the GL Compatibility renderer).
    1340. 

  1340. 

  1341. - macOS: ``NSView*`` for the window main view.
    1342. 

  1342. 

  1343. - iOS: ``UIView*`` for the window main view.
    1344. 

  1344. 

  1345. .. _class_DisplayServer_constant_OPENGL_CONTEXT:
    1346. 

  1346. 

  1347. .. rst-class:: classref-enumeration-constant
    1348. 

  1348. 

  1349. :ref:`HandleType<enum_DisplayServer_HandleType>` **OPENGL_CONTEXT** = ``3``
    1350. 

  1350. 

  1351. OpenGL context (only with the GL Compatibility renderer):
    1352. 

  1352. 

  1353. - Windows: ``HGLRC`` for the window (native GL), or ``EGLContext`` for the window (ANGLE).
    1354. 

  1354. 

  1355. - Linux (X11): ``GLXContext*`` for the window.
    1356. 

  1356. 

  1357. - macOS: ``NSOpenGLContext*`` for the window (native GL), or ``EGLContext`` for the window (ANGLE).
    1358. 

  1358. 

  1359. - Android: ``EGLContext`` for the window.
    1360. 

  1360. 

  1361. .. rst-class:: classref-item-separator
    1362. 

  1362. 

  1363. ----
    1364. 

  1364. 

  1365. .. _enum_DisplayServer_TTSUtteranceEvent:
    1366. 

  1366. 

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

  1368. 

  1369. enum **TTSUtteranceEvent**:
    1370. 

  1370. 

  1371. .. _class_DisplayServer_constant_TTS_UTTERANCE_STARTED:
    1372. 

  1372. 

  1373. .. rst-class:: classref-enumeration-constant
    1374. 

  1374. 

  1375. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_STARTED** = ``0``
    1376. 

  1376. 

  1377. Utterance has begun to be spoken.
    1378. 

  1378. 

  1379. .. _class_DisplayServer_constant_TTS_UTTERANCE_ENDED:
    1380. 

  1380. 

  1381. .. rst-class:: classref-enumeration-constant
    1382. 

  1382. 

  1383. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_ENDED** = ``1``
    1384. 

  1384. 

  1385. Utterance was successfully finished.
    1386. 

  1386. 

  1387. .. _class_DisplayServer_constant_TTS_UTTERANCE_CANCELED:
    1388. 

  1388. 

  1389. .. rst-class:: classref-enumeration-constant
    1390. 

  1390. 

  1391. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_CANCELED** = ``2``
    1392. 

  1392. 

  1393. Utterance was canceled, or TTS service was unable to process it.
    1394. 

  1394. 

  1395. .. _class_DisplayServer_constant_TTS_UTTERANCE_BOUNDARY:
    1396. 

  1396. 

  1397. .. rst-class:: classref-enumeration-constant
    1398. 

  1398. 

  1399. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_BOUNDARY** = ``3``
    1400. 

  1400. 

  1401. Utterance reached a word or sentence boundary.
    1402. 

  1402. 

  1403. .. rst-class:: classref-section-separator
    1404. 

  1404. 

  1405. ----
    1406. 

  1406. 

  1407. .. rst-class:: classref-descriptions-group
    1408. 

  1408. 

  1409. Constants
    1410. 

  1410. ---------
    1411. 

  1411. 

  1412. .. _class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS:
    1413. 

  1413. 

  1414. .. rst-class:: classref-constant
    1415. 

  1415. 

  1416. **SCREEN_WITH_MOUSE_FOCUS** = ``-4``
    1417. 

  1417. 

  1418. Represents the screen containing the mouse pointer.
    1419. 

  1419. 

  1420. \ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``.
    1421. 

  1421. 

  1422. .. _class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS:
    1423. 

  1423. 

  1424. .. rst-class:: classref-constant
    1425. 

  1425. 

  1426. **SCREEN_WITH_KEYBOARD_FOCUS** = ``-3``
    1427. 

  1427. 

  1428. Represents the screen containing the window with the keyboard focus.
    1429. 

  1429. 

  1430. \ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``.
    1431. 

  1431. 

  1432. .. _class_DisplayServer_constant_SCREEN_PRIMARY:
    1433. 

  1433. 

  1434. .. rst-class:: classref-constant
    1435. 

  1435. 

  1436. **SCREEN_PRIMARY** = ``-2``
    1437. 

  1437. 

  1438. Represents the primary screen.
    1439. 

  1439. 

  1440. \ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``.
    1441. 

  1441. 

  1442. .. _class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW:
    1443. 

  1443. 

  1444. .. rst-class:: classref-constant
    1445. 

  1445. 

  1446. **SCREEN_OF_MAIN_WINDOW** = ``-1``
    1447. 

  1447. 

  1448. Represents the screen where the main window is located. This is usually the default value in functions that allow specifying one of several screens.
    1449. 

  1449. 

  1450. \ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``.
    1451. 

  1451. 

  1452. .. _class_DisplayServer_constant_MAIN_WINDOW_ID:
    1453. 

  1453. 

  1454. .. rst-class:: classref-constant
    1455. 

  1455. 

  1456. **MAIN_WINDOW_ID** = ``0``
    1457. 

  1457. 

  1458. The ID of the main window spawned by the engine, which can be passed to methods expecting a ``window_id``.
    1459. 

  1459. 

  1460. .. _class_DisplayServer_constant_INVALID_WINDOW_ID:
    1461. 

  1461. 

  1462. .. rst-class:: classref-constant
    1463. 

  1463. 

  1464. **INVALID_WINDOW_ID** = ``-1``
    1465. 

  1465. 

  1466. The ID that refers to a nonexistent window. This is returned by some **DisplayServer** methods if no window matches the requested result.
    1467. 

  1467. 

  1468. .. _class_DisplayServer_constant_INVALID_INDICATOR_ID:
    1469. 

  1469. 

  1470. .. rst-class:: classref-constant
    1471. 

  1471. 

  1472. **INVALID_INDICATOR_ID** = ``-1``
    1473. 

  1473. 

  1474. The ID that refers to a nonexistent application status indicator.
    1475. 

  1475. 

  1476. .. rst-class:: classref-section-separator
    1477. 

  1477. 

  1478. ----
    1479. 

  1479. 

  1480. .. rst-class:: classref-descriptions-group
    1481. 

  1481. 

  1482. Method Descriptions
    1483. 

  1483. -------------------
    1484. 

  1484. 

  1485. .. _class_DisplayServer_method_clipboard_get:
    1486. 

  1486. 

  1487. .. rst-class:: classref-method
    1488. 

  1488. 

  1489. :ref:`String<class_String>` **clipboard_get**\ (\ ) |const|
    1490. 

  1490. 

  1491. Returns the user's clipboard as a string if possible.
    1492. 

  1492. 

  1493. .. rst-class:: classref-item-separator
    1494. 

  1494. 

  1495. ----
    1496. 

  1496. 

  1497. .. _class_DisplayServer_method_clipboard_get_image:
    1498. 

  1498. 

  1499. .. rst-class:: classref-method
    1500. 

  1500. 

  1501. :ref:`Image<class_Image>` **clipboard_get_image**\ (\ ) |const|
    1502. 

  1502. 

  1503. Returns the user's clipboard as an image if possible.
    1504. 

  1504. 

  1505. .. rst-class:: classref-item-separator
    1506. 

  1506. 

  1507. ----
    1508. 

  1508. 

  1509. .. _class_DisplayServer_method_clipboard_get_primary:
    1510. 

  1510. 

  1511. .. rst-class:: classref-method
    1512. 

  1512. 

  1513. :ref:`String<class_String>` **clipboard_get_primary**\ (\ ) |const|
    1514. 

  1514. 

  1515. 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.
    1516. 

  1516. 

  1517. \ **Note:** This method is only implemented on Linux (X11/Wayland).
    1518. 

  1518. 

  1519. .. rst-class:: classref-item-separator
    1520. 

  1520. 

  1521. ----
    1522. 

  1522. 

  1523. .. _class_DisplayServer_method_clipboard_has:
    1524. 

  1524. 

  1525. .. rst-class:: classref-method
    1526. 

  1526. 

  1527. :ref:`bool<class_bool>` **clipboard_has**\ (\ ) |const|
    1528. 

  1528. 

  1529. Returns ``true`` if there is a text content on the user's clipboard.
    1530. 

  1530. 

  1531. .. rst-class:: classref-item-separator
    1532. 

  1532. 

  1533. ----
    1534. 

  1534. 

  1535. .. _class_DisplayServer_method_clipboard_has_image:
    1536. 

  1536. 

  1537. .. rst-class:: classref-method
    1538. 

  1538. 

  1539. :ref:`bool<class_bool>` **clipboard_has_image**\ (\ ) |const|
    1540. 

  1540. 

  1541. Returns ``true`` if there is an image content on the user's clipboard.
    1542. 

  1542. 

  1543. .. rst-class:: classref-item-separator
    1544. 

  1544. 

  1545. ----
    1546. 

  1546. 

  1547. .. _class_DisplayServer_method_clipboard_set:
    1548. 

  1548. 

  1549. .. rst-class:: classref-method
    1550. 

  1550. 

  1551. |void| **clipboard_set**\ (\ clipboard\: :ref:`String<class_String>`\ )
    1552. 

  1552. 

  1553. Sets the user's clipboard content to the given string.
    1554. 

  1554. 

  1555. .. rst-class:: classref-item-separator
    1556. 

  1556. 

  1557. ----
    1558. 

  1558. 

  1559. .. _class_DisplayServer_method_clipboard_set_primary:
    1560. 

  1560. 

  1561. .. rst-class:: classref-method
    1562. 

  1562. 

  1563. |void| **clipboard_set_primary**\ (\ clipboard_primary\: :ref:`String<class_String>`\ )
    1564. 

  1564. 

  1565. 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.
    1566. 

  1566. 

  1567. \ **Note:** This method is only implemented on Linux (X11/Wayland).
    1568. 

  1568. 

  1569. .. rst-class:: classref-item-separator
    1570. 

  1570. 

  1571. ----
    1572. 

  1572. 

  1573. .. _class_DisplayServer_method_create_status_indicator:
    1574. 

  1574. 

  1575. .. rst-class:: classref-method
    1576. 

  1576. 

  1577. :ref:`int<class_int>` **create_status_indicator**\ (\ icon\: :ref:`Image<class_Image>`, tooltip\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ )
    1578. 

  1578. 

  1579. Creates a new application status indicator with the specified icon, tooltip, and activation callback.
    1580. 

  1580. 

  1581. .. rst-class:: classref-item-separator
    1582. 

  1582. 

  1583. ----
    1584. 

  1584. 

  1585. .. _class_DisplayServer_method_cursor_get_shape:
    1586. 

  1586. 

  1587. .. rst-class:: classref-method
    1588. 

  1588. 

  1589. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **cursor_get_shape**\ (\ ) |const|
    1590. 

  1590. 

  1591. Returns the default mouse cursor shape set by :ref:`cursor_set_shape<class_DisplayServer_method_cursor_set_shape>`.
    1592. 

  1592. 

  1593. .. rst-class:: classref-item-separator
    1594. 

  1594. 

  1595. ----
    1596. 

  1596. 

  1597. .. _class_DisplayServer_method_cursor_set_custom_image:
    1598. 

  1598. 

  1599. .. rst-class:: classref-method
    1600. 

  1600. 

  1601. |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)\ )
    1602. 

  1602. 

  1603. 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.
    1604. 

  1604. 

  1605. \ ``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>`.
    1606. 

  1606. 

  1607. .. rst-class:: classref-item-separator
    1608. 

  1608. 

  1609. ----
    1610. 

  1610. 

  1611. .. _class_DisplayServer_method_cursor_set_shape:
    1612. 

  1612. 

  1613. .. rst-class:: classref-method
    1614. 

  1614. 

  1615. |void| **cursor_set_shape**\ (\ shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>`\ )
    1616. 

  1616. 

  1617. 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>`.
    1618. 

  1618. 

  1619. .. rst-class:: classref-item-separator
    1620. 

  1620. 

  1621. ----
    1622. 

  1622. 

  1623. .. _class_DisplayServer_method_delete_status_indicator:
    1624. 

  1624. 

  1625. .. rst-class:: classref-method
    1626. 

  1626. 

  1627. |void| **delete_status_indicator**\ (\ id\: :ref:`int<class_int>`\ )
    1628. 

  1628. 

  1629. Removes the application status indicator.
    1630. 

  1630. 

  1631. .. rst-class:: classref-item-separator
    1632. 

  1632. 

  1633. ----
    1634. 

  1634. 

  1635. .. _class_DisplayServer_method_dialog_input_text:
    1636. 

  1636. 

  1637. .. rst-class:: classref-method
    1638. 

  1638. 

  1639. :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>`\ )
    1640. 

  1640. 

  1641. 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.
    1642. 

  1642. 

  1643. \ **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 and Windows.
    1644. 

  1644. 

  1645. .. rst-class:: classref-item-separator
    1646. 

  1646. 

  1647. ----
    1648. 

  1648. 

  1649. .. _class_DisplayServer_method_dialog_show:
    1650. 

  1650. 

  1651. .. rst-class:: classref-method
    1652. 

  1652. 

  1653. :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>`\ )
    1654. 

  1654. 

  1655. 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.
    1656. 

  1656. 

  1657. \ **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 and Windows.
    1658. 

  1658. 

  1659. .. rst-class:: classref-item-separator
    1660. 

  1660. 

  1661. ----
    1662. 

  1662. 

  1663. .. _class_DisplayServer_method_enable_for_stealing_focus:
    1664. 

  1664. 

  1665. .. rst-class:: classref-method
    1666. 

  1666. 

  1667. |void| **enable_for_stealing_focus**\ (\ process_id\: :ref:`int<class_int>`\ )
    1668. 

  1668. 

  1669. 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.
    1670. 

  1670. 

  1671. \ **Note:** This method is implemented only on Windows.
    1672. 

  1672. 

  1673. .. rst-class:: classref-item-separator
    1674. 

  1674. 

  1675. ----
    1676. 

  1676. 

  1677. .. _class_DisplayServer_method_file_dialog_show:
    1678. 

  1678. 

  1679. .. rst-class:: classref-method
    1680. 

  1680. 

  1681. :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>`\ )
    1682. 

  1682. 

  1683. Displays OS native dialog for selecting files or directories in the file system.
    1684. 

  1684. 

  1685. Each filter string in the ``filters`` array should be formatted like this: ``*.txt,*.doc;Text Files``. The description text of the filter is optional and can be omitted. See also :ref:`FileDialog.filters<class_FileDialog_property_filters>`.
    1686. 

  1686. 

  1687. Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int``.
    1688. 

  1688. 

  1689. \ **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, and macOS.
    1690. 

  1690. 

  1691. \ **Note:** ``current_directory`` might be ignored.
    1692. 

  1692. 

  1693. \ **Note:** On Linux, ``show_hidden`` is ignored.
    1694. 

  1694. 

  1695. \ **Note:** On macOS, native file dialogs have no title.
    1696. 

  1696. 

  1697. \ **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.
    1698. 

  1698. 

  1699. .. rst-class:: classref-item-separator
    1700. 

  1700. 

  1701. ----
    1702. 

  1702. 

  1703. .. _class_DisplayServer_method_file_dialog_with_options_show:
    1704. 

  1704. 

  1705. .. rst-class:: classref-method
    1706. 

  1706. 

  1707. :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>`\ )
    1708. 

  1708. 

  1709. Displays OS native dialog for selecting files or directories in the file system with additional user selectable options.
    1710. 

  1710. 

  1711. Each filter string in the ``filters`` array should be formatted like this: ``*.txt,*.doc;Text Files``. The description text of the filter is optional and can be omitted. See also :ref:`FileDialog.filters<class_FileDialog_property_filters>`.
    1712. 

  1712. 

  1713. \ ``options`` is array of :ref:`Dictionary<class_Dictionary>`\ s with the following keys:
    1714. 

  1714. 

  1715. - ``"name"`` - option's name :ref:`String<class_String>`.
    1716. 

  1716. 

  1717. - ``"values"`` - :ref:`PackedStringArray<class_PackedStringArray>` of values. If empty, boolean option (check box) is used.
    1718. 

  1718. 

  1719. - ``"default"`` - default selected option index (:ref:`int<class_int>`) or default boolean value (:ref:`bool<class_bool>`).
    1720. 

  1720. 

  1721. Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int, selected_option: Dictionary``.
    1722. 

  1722. 

  1723. \ **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, and macOS.
    1724. 

  1724. 

  1725. \ **Note:** ``current_directory`` might be ignored.
    1726. 

  1726. 

  1727. \ **Note:** On Linux (X11), ``show_hidden`` is ignored.
    1728. 

  1728. 

  1729. \ **Note:** On macOS, native file dialogs have no title.
    1730. 

  1730. 

  1731. \ **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.
    1732. 

  1732. 

  1733. .. rst-class:: classref-item-separator
    1734. 

  1734. 

  1735. ----
    1736. 

  1736. 

  1737. .. _class_DisplayServer_method_force_process_and_drop_events:
    1738. 

  1738. 

  1739. .. rst-class:: classref-method
    1740. 

  1740. 

  1741. |void| **force_process_and_drop_events**\ (\ )
    1742. 

  1742. 

  1743. Forces window manager processing while ignoring all :ref:`InputEvent<class_InputEvent>`\ s. See also :ref:`process_events<class_DisplayServer_method_process_events>`.
    1744. 

  1744. 

  1745. \ **Note:** This method is implemented on Windows and macOS.
    1746. 

  1746. 

  1747. .. rst-class:: classref-item-separator
    1748. 

  1748. 

  1749. ----
    1750. 

  1750. 

  1751. .. _class_DisplayServer_method_get_accent_color:
    1752. 

  1752. 

  1753. .. rst-class:: classref-method
    1754. 

  1754. 

  1755. :ref:`Color<class_Color>` **get_accent_color**\ (\ ) |const|
    1756. 

  1756. 

  1757. Returns OS theme accent color. Returns ``Color(0, 0, 0, 0)``, if accent color is unknown.
    1758. 

  1758. 

  1759. \ **Note:** This method is implemented on macOS and Windows.
    1760. 

  1760. 

  1761. .. rst-class:: classref-item-separator
    1762. 

  1762. 

  1763. ----
    1764. 

  1764. 

  1765. .. _class_DisplayServer_method_get_base_color:
    1766. 

  1766. 

  1767. .. rst-class:: classref-method
    1768. 

  1768. 

  1769. :ref:`Color<class_Color>` **get_base_color**\ (\ ) |const|
    1770. 

  1770. 

  1771. Returns the OS theme base color (default control background). Returns ``Color(0, 0, 0, 0)`` if the base color is unknown.
    1772. 

  1772. 

  1773. \ **Note:** This method is implemented on macOS and Windows.
    1774. 

  1774. 

  1775. .. rst-class:: classref-item-separator
    1776. 

  1776. 

  1777. ----
    1778. 

  1778. 

  1779. .. _class_DisplayServer_method_get_display_cutouts:
    1780. 

  1780. 

  1781. .. rst-class:: classref-method
    1782. 

  1782. 

  1783. :ref:`Array<class_Array>`\[:ref:`Rect2<class_Rect2>`\] **get_display_cutouts**\ (\ ) |const|
    1784. 

  1784. 

  1785. 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>`.
    1786. 

  1786. 

  1787. \ **Note:** Currently only implemented on Android. Other platforms will return an empty array even if they do have display cutouts or notches.
    1788. 

  1788. 

  1789. .. rst-class:: classref-item-separator
    1790. 

  1790. 

  1791. ----
    1792. 

  1792. 

  1793. .. _class_DisplayServer_method_get_display_safe_area:
    1794. 

  1794. 

  1795. .. rst-class:: classref-method
    1796. 

  1796. 

  1797. :ref:`Rect2i<class_Rect2i>` **get_display_safe_area**\ (\ ) |const|
    1798. 

  1798. 

  1799. 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>`.
    1800. 

  1800. 

  1801. .. rst-class:: classref-item-separator
    1802. 

  1802. 

  1803. ----
    1804. 

  1804. 

  1805. .. _class_DisplayServer_method_get_keyboard_focus_screen:
    1806. 

  1806. 

  1807. .. rst-class:: classref-method
    1808. 

  1808. 

  1809. :ref:`int<class_int>` **get_keyboard_focus_screen**\ (\ ) |const|
    1810. 

  1810. 

  1811. Returns the index of the screen containing the window with the keyboard focus, or the primary screen if there's no focused window.
    1812. 

  1812. 

  1813. .. rst-class:: classref-item-separator
    1814. 

  1814. 

  1815. ----
    1816. 

  1816. 

  1817. .. _class_DisplayServer_method_get_name:
    1818. 

  1818. 

  1819. .. rst-class:: classref-method
    1820. 

  1820. 

  1821. :ref:`String<class_String>` **get_name**\ (\ ) |const|
    1822. 

  1822. 

  1823. 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).
    1824. 

  1824. 

  1825. 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>`).
    1826. 

  1826. 

  1827. .. rst-class:: classref-item-separator
    1828. 

  1828. 

  1829. ----
    1830. 

  1830. 

  1831. .. _class_DisplayServer_method_get_primary_screen:
    1832. 

  1832. 

  1833. .. rst-class:: classref-method
    1834. 

  1834. 

  1835. :ref:`int<class_int>` **get_primary_screen**\ (\ ) |const|
    1836. 

  1836. 

  1837. Returns index of the primary screen.
    1838. 

  1838. 

  1839. .. rst-class:: classref-item-separator
    1840. 

  1840. 

  1841. ----
    1842. 

  1842. 

  1843. .. _class_DisplayServer_method_get_screen_count:
    1844. 

  1844. 

  1845. .. rst-class:: classref-method
    1846. 

  1846. 

  1847. :ref:`int<class_int>` **get_screen_count**\ (\ ) |const|
    1848. 

  1848. 

  1849. Returns the number of displays available.
    1850. 

  1850. 

  1851. .. rst-class:: classref-item-separator
    1852. 

  1852. 

  1853. ----
    1854. 

  1854. 

  1855. .. _class_DisplayServer_method_get_screen_from_rect:
    1856. 

  1856. 

  1857. .. rst-class:: classref-method
    1858. 

  1858. 

  1859. :ref:`int<class_int>` **get_screen_from_rect**\ (\ rect\: :ref:`Rect2<class_Rect2>`\ ) |const|
    1860. 

  1860. 

  1861. Returns index of the screen which contains specified rectangle.
    1862. 

  1862. 

  1863. .. rst-class:: classref-item-separator
    1864. 

  1864. 

  1865. ----
    1866. 

  1866. 

  1867. .. _class_DisplayServer_method_get_swap_cancel_ok:
    1868. 

  1868. 

  1869. .. rst-class:: classref-method
    1870. 

  1870. 

  1871. :ref:`bool<class_bool>` **get_swap_cancel_ok**\ (\ )
    1872. 

  1872. 

  1873. 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>`.
    1874. 

  1874. 

  1875. \ **Note:** This doesn't affect native dialogs such as the ones spawned by :ref:`dialog_show<class_DisplayServer_method_dialog_show>`.
    1876. 

  1876. 

  1877. .. rst-class:: classref-item-separator
    1878. 

  1878. 

  1879. ----
    1880. 

  1880. 

  1881. .. _class_DisplayServer_method_get_window_at_screen_position:
    1882. 

  1882. 

  1883. .. rst-class:: classref-method
    1884. 

  1884. 

  1885. :ref:`int<class_int>` **get_window_at_screen_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const|
    1886. 

  1886. 

  1887. 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:
    1888. 

  1888. 

  1889. .. code:: text
    1890. 

  1890. 

  1891.     * (0, 0)        +-------+
    1892. 

  1892.                     |       |
    1893. 

  1893.     +-------------+ |       |
    1894. 

  1894.     |             | |       |
    1895. 

  1895.     |             | |       |
    1896. 

  1896.     +-------------+ +-------+
    1897. 

  1897. 

  1898. .. rst-class:: classref-item-separator
    1899. 

  1899. 

  1900. ----
    1901. 

  1901. 

  1902. .. _class_DisplayServer_method_get_window_list:
    1903. 

  1903. 

  1904. .. rst-class:: classref-method
    1905. 

  1905. 

  1906. :ref:`PackedInt32Array<class_PackedInt32Array>` **get_window_list**\ (\ ) |const|
    1907. 

  1907. 

  1908. Returns the list of Godot window IDs belonging to this process.
    1909. 

  1909. 

  1910. \ **Note:** Native dialogs are not included in this list.
    1911. 

  1911. 

  1912. .. rst-class:: classref-item-separator
    1913. 

  1913. 

  1914. ----
    1915. 

  1915. 

  1916. .. _class_DisplayServer_method_global_menu_add_check_item:
    1917. 

  1917. 

  1918. .. rst-class:: classref-method
    1919. 

  1919. 

  1920. :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\ )
    1921. 

  1921. 

  1922. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    1923. 

  1923. 

  1924. Adds a new checkable item with text ``label`` to the global menu with ID ``menu_root``.
    1925. 

  1925. 

  1926. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    1927. 

  1927. 

  1928. 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`).
    1929. 

  1929. 

  1930. \ **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``.
    1931. 

  1931. 

  1932. \ **Note:** This method is implemented only on macOS.
    1933. 

  1933. 

  1934. \ **Supported system menu IDs:**\ 
    1935. 

  1935. 

  1936. .. code:: text
    1937. 

  1937. 

  1938.     "_main" - Main menu (macOS).
    1939. 

  1939.     "_dock" - Dock popup menu (macOS).
    1940. 

  1940.     "_apple" - Apple menu (macOS, custom items added before "Services").
    1941. 

  1941.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    1942. 

  1942.     "_help" - Help menu (macOS).
    1943. 

  1943. 

  1944. .. rst-class:: classref-item-separator
    1945. 

  1945. 

  1946. ----
    1947. 

  1947. 

  1948. .. _class_DisplayServer_method_global_menu_add_icon_check_item:
    1949. 

  1949. 

  1950. .. rst-class:: classref-method
    1951. 

  1951. 

  1952. :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\ )
    1953. 

  1953. 

  1954. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    1955. 

  1955. 

  1956. Adds a new checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
    1957. 

  1957. 

  1958. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    1959. 

  1959. 

  1960. 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`).
    1961. 

  1961. 

  1962. \ **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``.
    1963. 

  1963. 

  1964. \ **Note:** This method is implemented only on macOS.
    1965. 

  1965. 

  1966. \ **Supported system menu IDs:**\ 
    1967. 

  1967. 

  1968. .. code:: text
    1969. 

  1969. 

  1970.     "_main" - Main menu (macOS).
    1971. 

  1971.     "_dock" - Dock popup menu (macOS).
    1972. 

  1972.     "_apple" - Apple menu (macOS, custom items added before "Services").
    1973. 

  1973.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    1974. 

  1974.     "_help" - Help menu (macOS).
    1975. 

  1975. 

  1976. .. rst-class:: classref-item-separator
    1977. 

  1977. 

  1978. ----
    1979. 

  1979. 

  1980. .. _class_DisplayServer_method_global_menu_add_icon_item:
    1981. 

  1981. 

  1982. .. rst-class:: classref-method
    1983. 

  1983. 

  1984. :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\ )
    1985. 

  1985. 

  1986. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    1987. 

  1987. 

  1988. Adds a new item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
    1989. 

  1989. 

  1990. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    1991. 

  1991. 

  1992. 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`).
    1993. 

  1993. 

  1994. \ **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``.
    1995. 

  1995. 

  1996. \ **Note:** This method is implemented only on macOS.
    1997. 

  1997. 

  1998. \ **Supported system menu IDs:**\ 
    1999. 

  1999. 

  2000. .. code:: text
    2001. 

  2001. 

  2002.     "_main" - Main menu (macOS).
    2003. 

  2003.     "_dock" - Dock popup menu (macOS).
    2004. 

  2004.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2005. 

  2005.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2006. 

  2006.     "_help" - Help menu (macOS).
    2007. 

  2007. 

  2008. .. rst-class:: classref-item-separator
    2009. 

  2009. 

  2010. ----
    2011. 

  2011. 

  2012. .. _class_DisplayServer_method_global_menu_add_icon_radio_check_item:
    2013. 

  2013. 

  2014. .. rst-class:: classref-method
    2015. 

  2015. 

  2016. :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\ )
    2017. 

  2017. 

  2018. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2019. 

  2019. 

  2020. Adds a new radio-checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
    2021. 

  2021. 

  2022. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    2023. 

  2023. 

  2024. 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`).
    2025. 

  2025. 

  2026. \ **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.
    2027. 

  2027. 

  2028. \ **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``.
    2029. 

  2029. 

  2030. \ **Note:** This method is implemented only on macOS.
    2031. 

  2031. 

  2032. \ **Supported system menu IDs:**\ 
    2033. 

  2033. 

  2034. .. code:: text
    2035. 

  2035. 

  2036.     "_main" - Main menu (macOS).
    2037. 

  2037.     "_dock" - Dock popup menu (macOS).
    2038. 

  2038.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2039. 

  2039.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2040. 

  2040.     "_help" - Help menu (macOS).
    2041. 

  2041. 

  2042. .. rst-class:: classref-item-separator
    2043. 

  2043. 

  2044. ----
    2045. 

  2045. 

  2046. .. _class_DisplayServer_method_global_menu_add_item:
    2047. 

  2047. 

  2048. .. rst-class:: classref-method
    2049. 

  2049. 

  2050. :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\ )
    2051. 

  2051. 

  2052. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2053. 

  2053. 

  2054. Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
    2055. 

  2055. 

  2056. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    2057. 

  2057. 

  2058. 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`).
    2059. 

  2059. 

  2060. \ **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``.
    2061. 

  2061. 

  2062. \ **Note:** This method is implemented only on macOS.
    2063. 

  2063. 

  2064. \ **Supported system menu IDs:**\ 
    2065. 

  2065. 

  2066. .. code:: text
    2067. 

  2067. 

  2068.     "_main" - Main menu (macOS).
    2069. 

  2069.     "_dock" - Dock popup menu (macOS).
    2070. 

  2070.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2071. 

  2071.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2072. 

  2072.     "_help" - Help menu (macOS).
    2073. 

  2073. 

  2074. .. rst-class:: classref-item-separator
    2075. 

  2075. 

  2076. ----
    2077. 

  2077. 

  2078. .. _class_DisplayServer_method_global_menu_add_multistate_item:
    2079. 

  2079. 

  2080. .. rst-class:: classref-method
    2081. 

  2081. 

  2082. :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\ )
    2083. 

  2083. 

  2084. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2085. 

  2085. 

  2086. Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
    2087. 

  2087. 

  2088. 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``.
    2089. 

  2089. 

  2090. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    2091. 

  2091. 

  2092. 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`).
    2093. 

  2093. 

  2094. \ **Note:** By default, there's no indication of the current item state, it should be changed manually.
    2095. 

  2095. 

  2096. \ **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``.
    2097. 

  2097. 

  2098. \ **Note:** This method is implemented only on macOS.
    2099. 

  2099. 

  2100. \ **Supported system menu IDs:**\ 
    2101. 

  2101. 

  2102. .. code:: text
    2103. 

  2103. 

  2104.     "_main" - Main menu (macOS).
    2105. 

  2105.     "_dock" - Dock popup menu (macOS).
    2106. 

  2106.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2107. 

  2107.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2108. 

  2108.     "_help" - Help menu (macOS).
    2109. 

  2109. 

  2110. .. rst-class:: classref-item-separator
    2111. 

  2111. 

  2112. ----
    2113. 

  2113. 

  2114. .. _class_DisplayServer_method_global_menu_add_radio_check_item:
    2115. 

  2115. 

  2116. .. rst-class:: classref-method
    2117. 

  2117. 

  2118. :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\ )
    2119. 

  2119. 

  2120. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2121. 

  2121. 

  2122. Adds a new radio-checkable item with text ``label`` to the global menu with ID ``menu_root``.
    2123. 

  2123. 

  2124. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    2125. 

  2125. 

  2126. 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`).
    2127. 

  2127. 

  2128. \ **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.
    2129. 

  2129. 

  2130. \ **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``.
    2131. 

  2131. 

  2132. \ **Note:** This method is implemented only on macOS.
    2133. 

  2133. 

  2134. \ **Supported system menu IDs:**\ 
    2135. 

  2135. 

  2136. .. code:: text
    2137. 

  2137. 

  2138.     "_main" - Main menu (macOS).
    2139. 

  2139.     "_dock" - Dock popup menu (macOS).
    2140. 

  2140.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2141. 

  2141.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2142. 

  2142.     "_help" - Help menu (macOS).
    2143. 

  2143. 

  2144. .. rst-class:: classref-item-separator
    2145. 

  2145. 

  2146. ----
    2147. 

  2147. 

  2148. .. _class_DisplayServer_method_global_menu_add_separator:
    2149. 

  2149. 

  2150. .. rst-class:: classref-method
    2151. 

  2151. 

  2152. :ref:`int<class_int>` **global_menu_add_separator**\ (\ menu_root\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ )
    2153. 

  2153. 

  2154. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2155. 

  2155. 

  2156. Adds a separator between items to the global menu with ID ``menu_root``. Separators also occupy an index.
    2157. 

  2157. 

  2158. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    2159. 

  2159. 

  2160. \ **Note:** This method is implemented only on macOS.
    2161. 

  2161. 

  2162. \ **Supported system menu IDs:**\ 
    2163. 

  2163. 

  2164. .. code:: text
    2165. 

  2165. 

  2166.     "_main" - Main menu (macOS).
    2167. 

  2167.     "_dock" - Dock popup menu (macOS).
    2168. 

  2168.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2169. 

  2169.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2170. 

  2170.     "_help" - Help menu (macOS).
    2171. 

  2171. 

  2172. .. rst-class:: classref-item-separator
    2173. 

  2173. 

  2174. ----
    2175. 

  2175. 

  2176. .. _class_DisplayServer_method_global_menu_add_submenu_item:
    2177. 

  2177. 

  2178. .. rst-class:: classref-method
    2179. 

  2179. 

  2180. :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\ )
    2181. 

  2181. 

  2182. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2183. 

  2183. 

  2184. 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.
    2185. 

  2185. 

  2186. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    2187. 

  2187. 

  2188. \ **Note:** This method is implemented only on macOS.
    2189. 

  2189. 

  2190. \ **Supported system menu IDs:**\ 
    2191. 

  2191. 

  2192. .. code:: text
    2193. 

  2193. 

  2194.     "_main" - Main menu (macOS).
    2195. 

  2195.     "_dock" - Dock popup menu (macOS).
    2196. 

  2196.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2197. 

  2197.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2198. 

  2198.     "_help" - Help menu (macOS).
    2199. 

  2199. 

  2200. .. rst-class:: classref-item-separator
    2201. 

  2201. 

  2202. ----
    2203. 

  2203. 

  2204. .. _class_DisplayServer_method_global_menu_clear:
    2205. 

  2205. 

  2206. .. rst-class:: classref-method
    2207. 

  2207. 

  2208. |void| **global_menu_clear**\ (\ menu_root\: :ref:`String<class_String>`\ )
    2209. 

  2209. 

  2210. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2211. 

  2211. 

  2212. Removes all items from the global menu with ID ``menu_root``.
    2213. 

  2213. 

  2214. \ **Note:** This method is implemented only on macOS.
    2215. 

  2215. 

  2216. \ **Supported system menu IDs:**\ 
    2217. 

  2217. 

  2218. .. code:: text
    2219. 

  2219. 

  2220.     "_main" - Main menu (macOS).
    2221. 

  2221.     "_dock" - Dock popup menu (macOS).
    2222. 

  2222.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2223. 

  2223.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2224. 

  2224.     "_help" - Help menu (macOS).
    2225. 

  2225. 

  2226. .. rst-class:: classref-item-separator
    2227. 

  2227. 

  2228. ----
    2229. 

  2229. 

  2230. .. _class_DisplayServer_method_global_menu_get_item_accelerator:
    2231. 

  2231. 

  2232. .. rst-class:: classref-method
    2233. 

  2233. 

  2234. :ref:`Key<enum_@GlobalScope_Key>` **global_menu_get_item_accelerator**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2235. 

  2235. 

  2236. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2237. 

  2237. 

  2238. 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.
    2239. 

  2239. 

  2240. \ **Note:** This method is implemented only on macOS.
    2241. 

  2241. 

  2242. .. rst-class:: classref-item-separator
    2243. 

  2243. 

  2244. ----
    2245. 

  2245. 

  2246. .. _class_DisplayServer_method_global_menu_get_item_callback:
    2247. 

  2247. 

  2248. .. rst-class:: classref-method
    2249. 

  2249. 

  2250. :ref:`Callable<class_Callable>` **global_menu_get_item_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2251. 

  2251. 

  2252. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2253. 

  2253. 

  2254. Returns the callback of the item at index ``idx``.
    2255. 

  2255. 

  2256. \ **Note:** This method is implemented only on macOS.
    2257. 

  2257. 

  2258. .. rst-class:: classref-item-separator
    2259. 

  2259. 

  2260. ----
    2261. 

  2261. 

  2262. .. _class_DisplayServer_method_global_menu_get_item_count:
    2263. 

  2263. 

  2264. .. rst-class:: classref-method
    2265. 

  2265. 

  2266. :ref:`int<class_int>` **global_menu_get_item_count**\ (\ menu_root\: :ref:`String<class_String>`\ ) |const|
    2267. 

  2267. 

  2268. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2269. 

  2269. 

  2270. Returns number of items in the global menu with ID ``menu_root``.
    2271. 

  2271. 

  2272. \ **Note:** This method is implemented only on macOS.
    2273. 

  2273. 

  2274. .. rst-class:: classref-item-separator
    2275. 

  2275. 

  2276. ----
    2277. 

  2277. 

  2278. .. _class_DisplayServer_method_global_menu_get_item_icon:
    2279. 

  2279. 

  2280. .. rst-class:: classref-method
    2281. 

  2281. 

  2282. :ref:`Texture2D<class_Texture2D>` **global_menu_get_item_icon**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2283. 

  2283. 

  2284. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2285. 

  2285. 

  2286. Returns the icon of the item at index ``idx``.
    2287. 

  2287. 

  2288. \ **Note:** This method is implemented only on macOS.
    2289. 

  2289. 

  2290. .. rst-class:: classref-item-separator
    2291. 

  2291. 

  2292. ----
    2293. 

  2293. 

  2294. .. _class_DisplayServer_method_global_menu_get_item_indentation_level:
    2295. 

  2295. 

  2296. .. rst-class:: classref-method
    2297. 

  2297. 

  2298. :ref:`int<class_int>` **global_menu_get_item_indentation_level**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2299. 

  2299. 

  2300. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2301. 

  2301. 

  2302. Returns the horizontal offset of the item at the given ``idx``.
    2303. 

  2303. 

  2304. \ **Note:** This method is implemented only on macOS.
    2305. 

  2305. 

  2306. .. rst-class:: classref-item-separator
    2307. 

  2307. 

  2308. ----
    2309. 

  2309. 

  2310. .. _class_DisplayServer_method_global_menu_get_item_index_from_tag:
    2311. 

  2311. 

  2312. .. rst-class:: classref-method
    2313. 

  2313. 

  2314. :ref:`int<class_int>` **global_menu_get_item_index_from_tag**\ (\ menu_root\: :ref:`String<class_String>`, tag\: :ref:`Variant<class_Variant>`\ ) |const|
    2315. 

  2315. 

  2316. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2317. 

  2317. 

  2318. 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.
    2319. 

  2319. 

  2320. \ **Note:** This method is implemented only on macOS.
    2321. 

  2321. 

  2322. .. rst-class:: classref-item-separator
    2323. 

  2323. 

  2324. ----
    2325. 

  2325. 

  2326. .. _class_DisplayServer_method_global_menu_get_item_index_from_text:
    2327. 

  2327. 

  2328. .. rst-class:: classref-method
    2329. 

  2329. 

  2330. :ref:`int<class_int>` **global_menu_get_item_index_from_text**\ (\ menu_root\: :ref:`String<class_String>`, text\: :ref:`String<class_String>`\ ) |const|
    2331. 

  2331. 

  2332. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2333. 

  2333. 

  2334. 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.
    2335. 

  2335. 

  2336. \ **Note:** This method is implemented only on macOS.
    2337. 

  2337. 

  2338. .. rst-class:: classref-item-separator
    2339. 

  2339. 

  2340. ----
    2341. 

  2341. 

  2342. .. _class_DisplayServer_method_global_menu_get_item_key_callback:
    2343. 

  2343. 

  2344. .. rst-class:: classref-method
    2345. 

  2345. 

  2346. :ref:`Callable<class_Callable>` **global_menu_get_item_key_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2347. 

  2347. 

  2348. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2349. 

  2349. 

  2350. Returns the callback of the item accelerator at index ``idx``.
    2351. 

  2351. 

  2352. \ **Note:** This method is implemented only on macOS.
    2353. 

  2353. 

  2354. .. rst-class:: classref-item-separator
    2355. 

  2355. 

  2356. ----
    2357. 

  2357. 

  2358. .. _class_DisplayServer_method_global_menu_get_item_max_states:
    2359. 

  2359. 

  2360. .. rst-class:: classref-method
    2361. 

  2361. 

  2362. :ref:`int<class_int>` **global_menu_get_item_max_states**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2363. 

  2363. 

  2364. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2365. 

  2365. 

  2366. 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.
    2367. 

  2367. 

  2368. \ **Note:** This method is implemented only on macOS.
    2369. 

  2369. 

  2370. .. rst-class:: classref-item-separator
    2371. 

  2371. 

  2372. ----
    2373. 

  2373. 

  2374. .. _class_DisplayServer_method_global_menu_get_item_state:
    2375. 

  2375. 

  2376. .. rst-class:: classref-method
    2377. 

  2377. 

  2378. :ref:`int<class_int>` **global_menu_get_item_state**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2379. 

  2379. 

  2380. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2381. 

  2381. 

  2382. Returns the state of a multistate item. See :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
    2383. 

  2383. 

  2384. \ **Note:** This method is implemented only on macOS.
    2385. 

  2385. 

  2386. .. rst-class:: classref-item-separator
    2387. 

  2387. 

  2388. ----
    2389. 

  2389. 

  2390. .. _class_DisplayServer_method_global_menu_get_item_submenu:
    2391. 

  2391. 

  2392. .. rst-class:: classref-method
    2393. 

  2393. 

  2394. :ref:`String<class_String>` **global_menu_get_item_submenu**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2395. 

  2395. 

  2396. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2397. 

  2397. 

  2398. 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.
    2399. 

  2399. 

  2400. \ **Note:** This method is implemented only on macOS.
    2401. 

  2401. 

  2402. .. rst-class:: classref-item-separator
    2403. 

  2403. 

  2404. ----
    2405. 

  2405. 

  2406. .. _class_DisplayServer_method_global_menu_get_item_tag:
    2407. 

  2407. 

  2408. .. rst-class:: classref-method
    2409. 

  2409. 

  2410. :ref:`Variant<class_Variant>` **global_menu_get_item_tag**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2411. 

  2411. 

  2412. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2413. 

  2413. 

  2414. 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.
    2415. 

  2415. 

  2416. \ **Note:** This method is implemented only on macOS.
    2417. 

  2417. 

  2418. .. rst-class:: classref-item-separator
    2419. 

  2419. 

  2420. ----
    2421. 

  2421. 

  2422. .. _class_DisplayServer_method_global_menu_get_item_text:
    2423. 

  2423. 

  2424. .. rst-class:: classref-method
    2425. 

  2425. 

  2426. :ref:`String<class_String>` **global_menu_get_item_text**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2427. 

  2427. 

  2428. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2429. 

  2429. 

  2430. Returns the text of the item at index ``idx``.
    2431. 

  2431. 

  2432. \ **Note:** This method is implemented only on macOS.
    2433. 

  2433. 

  2434. .. rst-class:: classref-item-separator
    2435. 

  2435. 

  2436. ----
    2437. 

  2437. 

  2438. .. _class_DisplayServer_method_global_menu_get_item_tooltip:
    2439. 

  2439. 

  2440. .. rst-class:: classref-method
    2441. 

  2441. 

  2442. :ref:`String<class_String>` **global_menu_get_item_tooltip**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2443. 

  2443. 

  2444. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2445. 

  2445. 

  2446. Returns the tooltip associated with the specified index ``idx``.
    2447. 

  2447. 

  2448. \ **Note:** This method is implemented only on macOS.
    2449. 

  2449. 

  2450. .. rst-class:: classref-item-separator
    2451. 

  2451. 

  2452. ----
    2453. 

  2453. 

  2454. .. _class_DisplayServer_method_global_menu_get_system_menu_roots:
    2455. 

  2455. 

  2456. .. rst-class:: classref-method
    2457. 

  2457. 

  2458. :ref:`Dictionary<class_Dictionary>` **global_menu_get_system_menu_roots**\ (\ ) |const|
    2459. 

  2459. 

  2460. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2461. 

  2461. 

  2462. Returns Dictionary of supported system menu IDs and names.
    2463. 

  2463. 

  2464. \ **Note:** This method is implemented only on macOS.
    2465. 

  2465. 

  2466. .. rst-class:: classref-item-separator
    2467. 

  2467. 

  2468. ----
    2469. 

  2469. 

  2470. .. _class_DisplayServer_method_global_menu_is_item_checkable:
    2471. 

  2471. 

  2472. .. rst-class:: classref-method
    2473. 

  2473. 

  2474. :ref:`bool<class_bool>` **global_menu_is_item_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2475. 

  2475. 

  2476. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2477. 

  2477. 

  2478. Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if it has a checkbox or radio button.
    2479. 

  2479. 

  2480. \ **Note:** This method is implemented only on macOS.
    2481. 

  2481. 

  2482. .. rst-class:: classref-item-separator
    2483. 

  2483. 

  2484. ----
    2485. 

  2485. 

  2486. .. _class_DisplayServer_method_global_menu_is_item_checked:
    2487. 

  2487. 

  2488. .. rst-class:: classref-method
    2489. 

  2489. 

  2490. :ref:`bool<class_bool>` **global_menu_is_item_checked**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2491. 

  2491. 

  2492. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2493. 

  2493. 

  2494. Returns ``true`` if the item at index ``idx`` is checked.
    2495. 

  2495. 

  2496. \ **Note:** This method is implemented only on macOS.
    2497. 

  2497. 

  2498. .. rst-class:: classref-item-separator
    2499. 

  2499. 

  2500. ----
    2501. 

  2501. 

  2502. .. _class_DisplayServer_method_global_menu_is_item_disabled:
    2503. 

  2503. 

  2504. .. rst-class:: classref-method
    2505. 

  2505. 

  2506. :ref:`bool<class_bool>` **global_menu_is_item_disabled**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2507. 

  2507. 

  2508. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2509. 

  2509. 

  2510. Returns ``true`` if the item at index ``idx`` is disabled. When it is disabled it can't be selected, or its action invoked.
    2511. 

  2511. 

  2512. See :ref:`global_menu_set_item_disabled<class_DisplayServer_method_global_menu_set_item_disabled>` for more info on how to disable an item.
    2513. 

  2513. 

  2514. \ **Note:** This method is implemented only on macOS.
    2515. 

  2515. 

  2516. .. rst-class:: classref-item-separator
    2517. 

  2517. 

  2518. ----
    2519. 

  2519. 

  2520. .. _class_DisplayServer_method_global_menu_is_item_hidden:
    2521. 

  2521. 

  2522. .. rst-class:: classref-method
    2523. 

  2523. 

  2524. :ref:`bool<class_bool>` **global_menu_is_item_hidden**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2525. 

  2525. 

  2526. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2527. 

  2527. 

  2528. Returns ``true`` if the item at index ``idx`` is hidden.
    2529. 

  2529. 

  2530. See :ref:`global_menu_set_item_hidden<class_DisplayServer_method_global_menu_set_item_hidden>` for more info on how to hide an item.
    2531. 

  2531. 

  2532. \ **Note:** This method is implemented only on macOS.
    2533. 

  2533. 

  2534. .. rst-class:: classref-item-separator
    2535. 

  2535. 

  2536. ----
    2537. 

  2537. 

  2538. .. _class_DisplayServer_method_global_menu_is_item_radio_checkable:
    2539. 

  2539. 

  2540. .. rst-class:: classref-method
    2541. 

  2541. 

  2542. :ref:`bool<class_bool>` **global_menu_is_item_radio_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|
    2543. 

  2543. 

  2544. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2545. 

  2545. 

  2546. Returns ``true`` if the item at index ``idx`` has radio button-style checkability.
    2547. 

  2547. 

  2548. \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
    2549. 

  2549. 

  2550. \ **Note:** This method is implemented only on macOS.
    2551. 

  2551. 

  2552. .. rst-class:: classref-item-separator
    2553. 

  2553. 

  2554. ----
    2555. 

  2555. 

  2556. .. _class_DisplayServer_method_global_menu_remove_item:
    2557. 

  2557. 

  2558. .. rst-class:: classref-method
    2559. 

  2559. 

  2560. |void| **global_menu_remove_item**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ )
    2561. 

  2561. 

  2562. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2563. 

  2563. 

  2564. Removes the item at index ``idx`` from the global menu ``menu_root``.
    2565. 

  2565. 

  2566. \ **Note:** The indices of items after the removed item will be shifted by one.
    2567. 

  2567. 

  2568. \ **Note:** This method is implemented only on macOS.
    2569. 

  2569. 

  2570. .. rst-class:: classref-item-separator
    2571. 

  2571. 

  2572. ----
    2573. 

  2573. 

  2574. .. _class_DisplayServer_method_global_menu_set_item_accelerator:
    2575. 

  2575. 

  2576. .. rst-class:: classref-method
    2577. 

  2577. 

  2578. |void| **global_menu_set_item_accelerator**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ )
    2579. 

  2579. 

  2580. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2581. 

  2581. 

  2582. 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`).
    2583. 

  2583. 

  2584. \ **Note:** This method is implemented only on macOS.
    2585. 

  2585. 

  2586. .. rst-class:: classref-item-separator
    2587. 

  2587. 

  2588. ----
    2589. 

  2589. 

  2590. .. _class_DisplayServer_method_global_menu_set_item_callback:
    2591. 

  2591. 

  2592. .. rst-class:: classref-method
    2593. 

  2593. 

  2594. |void| **global_menu_set_item_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ )
    2595. 

  2595. 

  2596. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2597. 

  2597. 

  2598. Sets the callback of the item at index ``idx``. Callback is emitted when an item is pressed.
    2599. 

  2599. 

  2600. \ **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.
    2601. 

  2601. 

  2602. \ **Note:** This method is implemented only on macOS.
    2603. 

  2603. 

  2604. .. rst-class:: classref-item-separator
    2605. 

  2605. 

  2606. ----
    2607. 

  2607. 

  2608. .. _class_DisplayServer_method_global_menu_set_item_checkable:
    2609. 

  2609. 

  2610. .. rst-class:: classref-method
    2611. 

  2611. 

  2612. |void| **global_menu_set_item_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ )
    2613. 

  2613. 

  2614. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2615. 

  2615. 

  2616. Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the type of the item to plain text.
    2617. 

  2617. 

  2618. \ **Note:** This method is implemented only on macOS.
    2619. 

  2619. 

  2620. .. rst-class:: classref-item-separator
    2621. 

  2621. 

  2622. ----
    2623. 

  2623. 

  2624. .. _class_DisplayServer_method_global_menu_set_item_checked:
    2625. 

  2625. 

  2626. .. rst-class:: classref-method
    2627. 

  2627. 

  2628. |void| **global_menu_set_item_checked**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checked\: :ref:`bool<class_bool>`\ )
    2629. 

  2629. 

  2630. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2631. 

  2631. 

  2632. Sets the checkstate status of the item at index ``idx``.
    2633. 

  2633. 

  2634. \ **Note:** This method is implemented only on macOS.
    2635. 

  2635. 

  2636. .. rst-class:: classref-item-separator
    2637. 

  2637. 

  2638. ----
    2639. 

  2639. 

  2640. .. _class_DisplayServer_method_global_menu_set_item_disabled:
    2641. 

  2641. 

  2642. .. rst-class:: classref-method
    2643. 

  2643. 

  2644. |void| **global_menu_set_item_disabled**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ )
    2645. 

  2645. 

  2646. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2647. 

  2647. 

  2648. Enables/disables the item at index ``idx``. When it is disabled, it can't be selected and its action can't be invoked.
    2649. 

  2649. 

  2650. \ **Note:** This method is implemented only on macOS.
    2651. 

  2651. 

  2652. .. rst-class:: classref-item-separator
    2653. 

  2653. 

  2654. ----
    2655. 

  2655. 

  2656. .. _class_DisplayServer_method_global_menu_set_item_hidden:
    2657. 

  2657. 

  2658. .. rst-class:: classref-method
    2659. 

  2659. 

  2660. |void| **global_menu_set_item_hidden**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, hidden\: :ref:`bool<class_bool>`\ )
    2661. 

  2661. 

  2662. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2663. 

  2663. 

  2664. 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.
    2665. 

  2665. 

  2666. \ **Note:** This method is implemented only on macOS.
    2667. 

  2667. 

  2668. .. rst-class:: classref-item-separator
    2669. 

  2669. 

  2670. ----
    2671. 

  2671. 

  2672. .. _class_DisplayServer_method_global_menu_set_item_hover_callbacks:
    2673. 

  2673. 

  2674. .. rst-class:: classref-method
    2675. 

  2675. 

  2676. |void| **global_menu_set_item_hover_callbacks**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ )
    2677. 

  2677. 

  2678. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2679. 

  2679. 

  2680. Sets the callback of the item at index ``idx``. The callback is emitted when an item is hovered.
    2681. 

  2681. 

  2682. \ **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.
    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_set_item_icon:
    2691. 

  2691. 

  2692. .. rst-class:: classref-method
    2693. 

  2693. 

  2694. |void| **global_menu_set_item_icon**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ )
    2695. 

  2695. 

  2696. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2697. 

  2697. 

  2698. Replaces the :ref:`Texture2D<class_Texture2D>` icon of the specified ``idx``.
    2699. 

  2699. 

  2700. \ **Note:** This method is implemented only on macOS.
    2701. 

  2701. 

  2702. \ **Note:** This method is not supported by macOS "_dock" menu items.
    2703. 

  2703. 

  2704. .. rst-class:: classref-item-separator
    2705. 

  2705. 

  2706. ----
    2707. 

  2707. 

  2708. .. _class_DisplayServer_method_global_menu_set_item_indentation_level:
    2709. 

  2709. 

  2710. .. rst-class:: classref-method
    2711. 

  2711. 

  2712. |void| **global_menu_set_item_indentation_level**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, level\: :ref:`int<class_int>`\ )
    2713. 

  2713. 

  2714. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2715. 

  2715. 

  2716. Sets the horizontal offset of the item at the given ``idx``.
    2717. 

  2717. 

  2718. \ **Note:** This method is implemented only on macOS.
    2719. 

  2719. 

  2720. .. rst-class:: classref-item-separator
    2721. 

  2721. 

  2722. ----
    2723. 

  2723. 

  2724. .. _class_DisplayServer_method_global_menu_set_item_key_callback:
    2725. 

  2725. 

  2726. .. rst-class:: classref-method
    2727. 

  2727. 

  2728. |void| **global_menu_set_item_key_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, key_callback\: :ref:`Callable<class_Callable>`\ )
    2729. 

  2729. 

  2730. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2731. 

  2731. 

  2732. Sets the callback of the item at index ``idx``. Callback is emitted when its accelerator is activated.
    2733. 

  2733. 

  2734. \ **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.
    2735. 

  2735. 

  2736. \ **Note:** This method is implemented only on macOS.
    2737. 

  2737. 

  2738. .. rst-class:: classref-item-separator
    2739. 

  2739. 

  2740. ----
    2741. 

  2741. 

  2742. .. _class_DisplayServer_method_global_menu_set_item_max_states:
    2743. 

  2743. 

  2744. .. rst-class:: classref-method
    2745. 

  2745. 

  2746. |void| **global_menu_set_item_max_states**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, max_states\: :ref:`int<class_int>`\ )
    2747. 

  2747. 

  2748. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2749. 

  2749. 

  2750. 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.
    2751. 

  2751. 

  2752. \ **Note:** This method is implemented only on macOS.
    2753. 

  2753. 

  2754. .. rst-class:: classref-item-separator
    2755. 

  2755. 

  2756. ----
    2757. 

  2757. 

  2758. .. _class_DisplayServer_method_global_menu_set_item_radio_checkable:
    2759. 

  2759. 

  2760. .. rst-class:: classref-method
    2761. 

  2761. 

  2762. |void| **global_menu_set_item_radio_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ )
    2763. 

  2763. 

  2764. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2765. 

  2765. 

  2766. Sets the type of the item at the specified index ``idx`` to radio button. If ``false``, sets the type of the item to plain text.
    2767. 

  2767. 

  2768. \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
    2769. 

  2769. 

  2770. \ **Note:** This method is implemented only on macOS.
    2771. 

  2771. 

  2772. .. rst-class:: classref-item-separator
    2773. 

  2773. 

  2774. ----
    2775. 

  2775. 

  2776. .. _class_DisplayServer_method_global_menu_set_item_state:
    2777. 

  2777. 

  2778. .. rst-class:: classref-method
    2779. 

  2779. 

  2780. |void| **global_menu_set_item_state**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, state\: :ref:`int<class_int>`\ )
    2781. 

  2781. 

  2782. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2783. 

  2783. 

  2784. Sets the state of a multistate item. See :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
    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_set_item_submenu:
    2793. 

  2793. 

  2794. .. rst-class:: classref-method
    2795. 

  2795. 

  2796. |void| **global_menu_set_item_submenu**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, submenu\: :ref:`String<class_String>`\ )
    2797. 

  2797. 

  2798. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2799. 

  2799. 

  2800. 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.
    2801. 

  2801. 

  2802. \ **Note:** This method is implemented only on macOS.
    2803. 

  2803. 

  2804. .. rst-class:: classref-item-separator
    2805. 

  2805. 

  2806. ----
    2807. 

  2807. 

  2808. .. _class_DisplayServer_method_global_menu_set_item_tag:
    2809. 

  2809. 

  2810. .. rst-class:: classref-method
    2811. 

  2811. 

  2812. |void| **global_menu_set_item_tag**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tag\: :ref:`Variant<class_Variant>`\ )
    2813. 

  2813. 

  2814. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2815. 

  2815. 

  2816. 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.
    2817. 

  2817. 

  2818. \ **Note:** This method is implemented only on macOS.
    2819. 

  2819. 

  2820. .. rst-class:: classref-item-separator
    2821. 

  2821. 

  2822. ----
    2823. 

  2823. 

  2824. .. _class_DisplayServer_method_global_menu_set_item_text:
    2825. 

  2825. 

  2826. .. rst-class:: classref-method
    2827. 

  2827. 

  2828. |void| **global_menu_set_item_text**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, text\: :ref:`String<class_String>`\ )
    2829. 

  2829. 

  2830. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2831. 

  2831. 

  2832. Sets the text of the item at index ``idx``.
    2833. 

  2833. 

  2834. \ **Note:** This method is implemented only on macOS.
    2835. 

  2835. 

  2836. .. rst-class:: classref-item-separator
    2837. 

  2837. 

  2838. ----
    2839. 

  2839. 

  2840. .. _class_DisplayServer_method_global_menu_set_item_tooltip:
    2841. 

  2841. 

  2842. .. rst-class:: classref-method
    2843. 

  2843. 

  2844. |void| **global_menu_set_item_tooltip**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ )
    2845. 

  2845. 

  2846. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2847. 

  2847. 

  2848. Sets the :ref:`String<class_String>` tooltip of the item at the specified index ``idx``.
    2849. 

  2849. 

  2850. \ **Note:** This method is implemented only on macOS.
    2851. 

  2851. 

  2852. .. rst-class:: classref-item-separator
    2853. 

  2853. 

  2854. ----
    2855. 

  2855. 

  2856. .. _class_DisplayServer_method_global_menu_set_popup_callbacks:
    2857. 

  2857. 

  2858. .. rst-class:: classref-method
    2859. 

  2859. 

  2860. |void| **global_menu_set_popup_callbacks**\ (\ menu_root\: :ref:`String<class_String>`, open_callback\: :ref:`Callable<class_Callable>`, close_callback\: :ref:`Callable<class_Callable>`\ )
    2861. 

  2861. 

  2862. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2863. 

  2863. 

  2864. Registers callables to emit when the menu is respectively about to show or closed.
    2865. 

  2865. 

  2866. .. rst-class:: classref-item-separator
    2867. 

  2867. 

  2868. ----
    2869. 

  2869. 

  2870. .. _class_DisplayServer_method_has_feature:
    2871. 

  2871. 

  2872. .. rst-class:: classref-method
    2873. 

  2873. 

  2874. :ref:`bool<class_bool>` **has_feature**\ (\ feature\: :ref:`Feature<enum_DisplayServer_Feature>`\ ) |const|
    2875. 

  2875. 

  2876. Returns ``true`` if the specified ``feature`` is supported by the current **DisplayServer**, ``false`` otherwise.
    2877. 

  2877. 

  2878. .. rst-class:: classref-item-separator
    2879. 

  2879. 

  2880. ----
    2881. 

  2881. 

  2882. .. _class_DisplayServer_method_help_set_search_callbacks:
    2883. 

  2883. 

  2884. .. rst-class:: classref-method
    2885. 

  2885. 

  2886. |void| **help_set_search_callbacks**\ (\ search_callback\: :ref:`Callable<class_Callable>`, action_callback\: :ref:`Callable<class_Callable>`\ )
    2887. 

  2887. 

  2888. Sets native help system search callbacks.
    2889. 

  2889. 

  2890. \ ``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.
    2891. 

  2891. 

  2892. \ ``action_callback`` has the following arguments: ``String key``. Called when the user selects a search result in the ``Help`` menu.
    2893. 

  2893. 

  2894. \ **Note:** This method is implemented only on macOS.
    2895. 

  2895. 

  2896. .. rst-class:: classref-item-separator
    2897. 

  2897. 

  2898. ----
    2899. 

  2899. 

  2900. .. _class_DisplayServer_method_ime_get_selection:
    2901. 

  2901. 

  2902. .. rst-class:: classref-method
    2903. 

  2903. 

  2904. :ref:`Vector2i<class_Vector2i>` **ime_get_selection**\ (\ ) |const|
    2905. 

  2905. 

  2906. 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.
    2907. 

  2907. 

  2908. \ **Note:** This method is implemented only on macOS.
    2909. 

  2909. 

  2910. .. rst-class:: classref-item-separator
    2911. 

  2911. 

  2912. ----
    2913. 

  2913. 

  2914. .. _class_DisplayServer_method_ime_get_text:
    2915. 

  2915. 

  2916. .. rst-class:: classref-method
    2917. 

  2917. 

  2918. :ref:`String<class_String>` **ime_get_text**\ (\ ) |const|
    2919. 

  2919. 

  2920. Returns the composition string contained within the `Input Method Editor <https://en.wikipedia.org/wiki/Input_method>`__ window.
    2921. 

  2921. 

  2922. \ **Note:** This method is implemented only on macOS.
    2923. 

  2923. 

  2924. .. rst-class:: classref-item-separator
    2925. 

  2925. 

  2926. ----
    2927. 

  2927. 

  2928. .. _class_DisplayServer_method_is_dark_mode:
    2929. 

  2929. 

  2930. .. rst-class:: classref-method
    2931. 

  2931. 

  2932. :ref:`bool<class_bool>` **is_dark_mode**\ (\ ) |const|
    2933. 

  2933. 

  2934. Returns ``true`` if OS is using dark mode.
    2935. 

  2935. 

  2936. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
    2937. 

  2937. 

  2938. .. rst-class:: classref-item-separator
    2939. 

  2939. 

  2940. ----
    2941. 

  2941. 

  2942. .. _class_DisplayServer_method_is_dark_mode_supported:
    2943. 

  2943. 

  2944. .. rst-class:: classref-method
    2945. 

  2945. 

  2946. :ref:`bool<class_bool>` **is_dark_mode_supported**\ (\ ) |const|
    2947. 

  2947. 

  2948. Returns ``true`` if OS supports dark mode.
    2949. 

  2949. 

  2950. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
    2951. 

  2951. 

  2952. .. rst-class:: classref-item-separator
    2953. 

  2953. 

  2954. ----
    2955. 

  2955. 

  2956. .. _class_DisplayServer_method_is_touchscreen_available:
    2957. 

  2957. 

  2958. .. rst-class:: classref-method
    2959. 

  2959. 

  2960. :ref:`bool<class_bool>` **is_touchscreen_available**\ (\ ) |const|
    2961. 

  2961. 

  2962. 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``.
    2963. 

  2963. 

  2964. .. rst-class:: classref-item-separator
    2965. 

  2965. 

  2966. ----
    2967. 

  2967. 

  2968. .. _class_DisplayServer_method_keyboard_get_current_layout:
    2969. 

  2969. 

  2970. .. rst-class:: classref-method
    2971. 

  2971. 

  2972. :ref:`int<class_int>` **keyboard_get_current_layout**\ (\ ) |const|
    2973. 

  2973. 

  2974. Returns active keyboard layout index.
    2975. 

  2975. 

  2976. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS, and Windows.
    2977. 

  2977. 

  2978. .. rst-class:: classref-item-separator
    2979. 

  2979. 

  2980. ----
    2981. 

  2981. 

  2982. .. _class_DisplayServer_method_keyboard_get_keycode_from_physical:
    2983. 

  2983. 

  2984. .. rst-class:: classref-method
    2985. 

  2985. 

  2986. :ref:`Key<enum_@GlobalScope_Key>` **keyboard_get_keycode_from_physical**\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const|
    2987. 

  2987. 

  2988. Converts a physical (US QWERTY) ``keycode`` to one in the active keyboard layout.
    2989. 

  2989. 

  2990. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    2991. 

  2991. 

  2992. .. rst-class:: classref-item-separator
    2993. 

  2993. 

  2994. ----
    2995. 

  2995. 

  2996. .. _class_DisplayServer_method_keyboard_get_label_from_physical:
    2997. 

  2997. 

  2998. .. rst-class:: classref-method
    2999. 

  2999. 

  3000. :ref:`Key<enum_@GlobalScope_Key>` **keyboard_get_label_from_physical**\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const|
    3001. 

  3001. 

  3002. Converts a physical (US QWERTY) ``keycode`` to localized label printed on the key in the active keyboard layout.
    3003. 

  3003. 

  3004. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3005. 

  3005. 

  3006. .. rst-class:: classref-item-separator
    3007. 

  3007. 

  3008. ----
    3009. 

  3009. 

  3010. .. _class_DisplayServer_method_keyboard_get_layout_count:
    3011. 

  3011. 

  3012. .. rst-class:: classref-method
    3013. 

  3013. 

  3014. :ref:`int<class_int>` **keyboard_get_layout_count**\ (\ ) |const|
    3015. 

  3015. 

  3016. Returns the number of keyboard layouts.
    3017. 

  3017. 

  3018. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3019. 

  3019. 

  3020. .. rst-class:: classref-item-separator
    3021. 

  3021. 

  3022. ----
    3023. 

  3023. 

  3024. .. _class_DisplayServer_method_keyboard_get_layout_language:
    3025. 

  3025. 

  3026. .. rst-class:: classref-method
    3027. 

  3027. 

  3028. :ref:`String<class_String>` **keyboard_get_layout_language**\ (\ index\: :ref:`int<class_int>`\ ) |const|
    3029. 

  3029. 

  3030. Returns the ISO-639/BCP-47 language code of the keyboard layout at position ``index``.
    3031. 

  3031. 

  3032. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3033. 

  3033. 

  3034. .. rst-class:: classref-item-separator
    3035. 

  3035. 

  3036. ----
    3037. 

  3037. 

  3038. .. _class_DisplayServer_method_keyboard_get_layout_name:
    3039. 

  3039. 

  3040. .. rst-class:: classref-method
    3041. 

  3041. 

  3042. :ref:`String<class_String>` **keyboard_get_layout_name**\ (\ index\: :ref:`int<class_int>`\ ) |const|
    3043. 

  3043. 

  3044. Returns the localized name of the keyboard layout at position ``index``.
    3045. 

  3045. 

  3046. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3047. 

  3047. 

  3048. .. rst-class:: classref-item-separator
    3049. 

  3049. 

  3050. ----
    3051. 

  3051. 

  3052. .. _class_DisplayServer_method_keyboard_set_current_layout:
    3053. 

  3053. 

  3054. .. rst-class:: classref-method
    3055. 

  3055. 

  3056. |void| **keyboard_set_current_layout**\ (\ index\: :ref:`int<class_int>`\ )
    3057. 

  3057. 

  3058. Sets the active keyboard layout.
    3059. 

  3059. 

  3060. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3061. 

  3061. 

  3062. .. rst-class:: classref-item-separator
    3063. 

  3063. 

  3064. ----
    3065. 

  3065. 

  3066. .. _class_DisplayServer_method_mouse_get_button_state:
    3067. 

  3067. 

  3068. .. rst-class:: classref-method
    3069. 

  3069. 

  3070. |bitfield|\[:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>`\] **mouse_get_button_state**\ (\ ) |const|
    3071. 

  3071. 

  3072. 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>`.
    3073. 

  3073. 

  3074. .. rst-class:: classref-item-separator
    3075. 

  3075. 

  3076. ----
    3077. 

  3077. 

  3078. .. _class_DisplayServer_method_mouse_get_mode:
    3079. 

  3079. 

  3080. .. rst-class:: classref-method
    3081. 

  3081. 

  3082. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **mouse_get_mode**\ (\ ) |const|
    3083. 

  3083. 

  3084. Returns the current mouse mode. See also :ref:`mouse_set_mode<class_DisplayServer_method_mouse_set_mode>`.
    3085. 

  3085. 

  3086. .. rst-class:: classref-item-separator
    3087. 

  3087. 

  3088. ----
    3089. 

  3089. 

  3090. .. _class_DisplayServer_method_mouse_get_position:
    3091. 

  3091. 

  3092. .. rst-class:: classref-method
    3093. 

  3093. 

  3094. :ref:`Vector2i<class_Vector2i>` **mouse_get_position**\ (\ ) |const|
    3095. 

  3095. 

  3096. Returns the mouse cursor's current position in screen coordinates.
    3097. 

  3097. 

  3098. .. rst-class:: classref-item-separator
    3099. 

  3099. 

  3100. ----
    3101. 

  3101. 

  3102. .. _class_DisplayServer_method_mouse_set_mode:
    3103. 

  3103. 

  3104. .. rst-class:: classref-method
    3105. 

  3105. 

  3106. |void| **mouse_set_mode**\ (\ mouse_mode\: :ref:`MouseMode<enum_DisplayServer_MouseMode>`\ )
    3107. 

  3107. 

  3108. Sets the current mouse mode. See also :ref:`mouse_get_mode<class_DisplayServer_method_mouse_get_mode>`.
    3109. 

  3109. 

  3110. .. rst-class:: classref-item-separator
    3111. 

  3111. 

  3112. ----
    3113. 

  3113. 

  3114. .. _class_DisplayServer_method_process_events:
    3115. 

  3115. 

  3116. .. rst-class:: classref-method
    3117. 

  3117. 

  3118. |void| **process_events**\ (\ )
    3119. 

  3119. 

  3120. 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>`.
    3121. 

  3121. 

  3122. .. rst-class:: classref-item-separator
    3123. 

  3123. 

  3124. ----
    3125. 

  3125. 

  3126. .. _class_DisplayServer_method_screen_get_dpi:
    3127. 

  3127. 

  3128. .. rst-class:: classref-method
    3129. 

  3129. 

  3130. :ref:`int<class_int>` **screen_get_dpi**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|
    3131. 

  3131. 

  3132. 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.
    3133. 

  3133. 

  3134. \ **Note:** On macOS, returned value is inaccurate if fractional display scaling mode is used.
    3135. 

  3135. 

  3136. \ **Note:** On Android devices, the actual screen densities are grouped into six generalized densities:
    3137. 

  3137. 

  3138. .. code:: text
    3139. 

  3139. 

  3140.        ldpi - 120 dpi
    3141. 

  3141.        mdpi - 160 dpi
    3142. 

  3142.        hdpi - 240 dpi
    3143. 

  3143.       xhdpi - 320 dpi
    3144. 

  3144.      xxhdpi - 480 dpi
    3145. 

  3145.     xxxhdpi - 640 dpi
    3146. 

  3146. 

  3147. \ **Note:** This method is implemented on Android, Linux (X11/Wayland), macOS and Windows. Returns ``72`` on unsupported platforms.
    3148. 

  3148. 

  3149. .. rst-class:: classref-item-separator
    3150. 

  3150. 

  3151. ----
    3152. 

  3152. 

  3153. .. _class_DisplayServer_method_screen_get_image:
    3154. 

  3154. 

  3155. .. rst-class:: classref-method
    3156. 

  3156. 

  3157. :ref:`Image<class_Image>` **screen_get_image**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|
    3158. 

  3158. 

  3159. Returns screenshot of the ``screen``.
    3160. 

  3160. 

  3161. \ **Note:** This method is implemented on Linux (X11), macOS, and Windows.
    3162. 

  3162. 

  3163. \ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.
    3164. 

  3164. 

  3165. .. rst-class:: classref-item-separator
    3166. 

  3166. 

  3167. ----
    3168. 

  3168. 

  3169. .. _class_DisplayServer_method_screen_get_max_scale:
    3170. 

  3170. 

  3171. .. rst-class:: classref-method
    3172. 

  3172. 

  3173. :ref:`float<class_float>` **screen_get_max_scale**\ (\ ) |const|
    3174. 

  3174. 

  3175. Returns the greatest scale factor of all screens.
    3176. 

  3176. 

  3177. \ **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.
    3178. 

  3178. 

  3179. \ **Note:** This method is implemented only on macOS.
    3180. 

  3180. 

  3181. .. rst-class:: classref-item-separator
    3182. 

  3182. 

  3183. ----
    3184. 

  3184. 

  3185. .. _class_DisplayServer_method_screen_get_orientation:
    3186. 

  3186. 

  3187. .. rst-class:: classref-method
    3188. 

  3188. 

  3189. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **screen_get_orientation**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|
    3190. 

  3190. 

  3191. Returns the ``screen``'s current orientation. See also :ref:`screen_set_orientation<class_DisplayServer_method_screen_set_orientation>`.
    3192. 

  3192. 

  3193. \ **Note:** This method is implemented on Android and iOS.
    3194. 

  3194. 

  3195. .. rst-class:: classref-item-separator
    3196. 

  3196. 

  3197. ----
    3198. 

  3198. 

  3199. .. _class_DisplayServer_method_screen_get_pixel:
    3200. 

  3200. 

  3201. .. rst-class:: classref-method
    3202. 

  3202. 

  3203. :ref:`Color<class_Color>` **screen_get_pixel**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const|
    3204. 

  3204. 

  3205. Returns color of the display pixel at the ``position``.
    3206. 

  3206. 

  3207. \ **Note:** This method is implemented on Linux (X11), macOS, and Windows.
    3208. 

  3208. 

  3209. \ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.
    3210. 

  3210. 

  3211. .. rst-class:: classref-item-separator
    3212. 

  3212. 

  3213. ----
    3214. 

  3214. 

  3215. .. _class_DisplayServer_method_screen_get_position:
    3216. 

  3216. 

  3217. .. rst-class:: classref-method
    3218. 

  3218. 

  3219. :ref:`Vector2i<class_Vector2i>` **screen_get_position**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|
    3220. 

  3220. 

  3221. 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:
    3222. 

  3222. 

  3223. .. code:: text
    3224. 

  3224. 

  3225.     * (0, 0)        +-------+
    3226. 

  3226.                     |       |
    3227. 

  3227.     +-------------+ |       |
    3228. 

  3228.     |             | |       |
    3229. 

  3229.     |             | |       |
    3230. 

  3230.     +-------------+ +-------+
    3231. 

  3231. 

  3232. See also :ref:`screen_get_size<class_DisplayServer_method_screen_get_size>`.
    3233. 

  3233. 

  3234. \ **Note:** On Linux (Wayland) this method always returns ``(0, 0)``.
    3235. 

  3235. 

  3236. .. rst-class:: classref-item-separator
    3237. 

  3237. 

  3238. ----
    3239. 

  3239. 

  3240. .. _class_DisplayServer_method_screen_get_refresh_rate:
    3241. 

  3241. 

  3242. .. rst-class:: classref-method
    3243. 

  3243. 

  3244. :ref:`float<class_float>` **screen_get_refresh_rate**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|
    3245. 

  3245. 

  3246. 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.
    3247. 

  3247. 

  3248. \ **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.
    3249. 

  3249. 

  3250. To fallback to a default refresh rate if the method fails, try:
    3251. 

  3251. 

  3252. ::
    3253. 

  3253. 

  3254.     var refresh_rate = DisplayServer.screen_get_refresh_rate()
    3255. 

  3255.     if refresh_rate < 0:
    3256. 

  3256.         refresh_rate = 60.0
    3257. 

  3257. 

  3258. .. rst-class:: classref-item-separator
    3259. 

  3259. 

  3260. ----
    3261. 

  3261. 

  3262. .. _class_DisplayServer_method_screen_get_scale:
    3263. 

  3263. 

  3264. .. rst-class:: classref-method
    3265. 

  3265. 

  3266. :ref:`float<class_float>` **screen_get_scale**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|
    3267. 

  3267. 

  3268. Returns the scale factor of the specified screen by index.
    3269. 

  3269. 

  3270. \ **Note:** On macOS returned value is ``2.0`` for hiDPI (Retina) screen, and ``1.0`` for all other cases.
    3271. 

  3271. 

  3272. \ **Note:** This method is implemented only on macOS.
    3273. 

  3273. 

  3274. .. rst-class:: classref-item-separator
    3275. 

  3275. 

  3276. ----
    3277. 

  3277. 

  3278. .. _class_DisplayServer_method_screen_get_size:
    3279. 

  3279. 

  3280. .. rst-class:: classref-method
    3281. 

  3281. 

  3282. :ref:`Vector2i<class_Vector2i>` **screen_get_size**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|
    3283. 

  3283. 

  3284. 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>`.
    3285. 

  3285. 

  3286. .. rst-class:: classref-item-separator
    3287. 

  3287. 

  3288. ----
    3289. 

  3289. 

  3290. .. _class_DisplayServer_method_screen_get_usable_rect:
    3291. 

  3291. 

  3292. .. rst-class:: classref-method
    3293. 

  3293. 

  3294. :ref:`Rect2i<class_Rect2i>` **screen_get_usable_rect**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const|
    3295. 

  3295. 

  3296. 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>`.
    3297. 

  3297. 

  3298. .. rst-class:: classref-item-separator
    3299. 

  3299. 

  3300. ----
    3301. 

  3301. 

  3302. .. _class_DisplayServer_method_screen_is_kept_on:
    3303. 

  3303. 

  3304. .. rst-class:: classref-method
    3305. 

  3305. 

  3306. :ref:`bool<class_bool>` **screen_is_kept_on**\ (\ ) |const|
    3307. 

  3307. 

  3308. 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>`.
    3309. 

  3309. 

  3310. .. rst-class:: classref-item-separator
    3311. 

  3311. 

  3312. ----
    3313. 

  3313. 

  3314. .. _class_DisplayServer_method_screen_set_keep_on:
    3315. 

  3315. 

  3316. .. rst-class:: classref-method
    3317. 

  3317. 

  3318. |void| **screen_set_keep_on**\ (\ enable\: :ref:`bool<class_bool>`\ )
    3319. 

  3319. 

  3320. 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>`.
    3321. 

  3321. 

  3322. .. rst-class:: classref-item-separator
    3323. 

  3323. 

  3324. ----
    3325. 

  3325. 

  3326. .. _class_DisplayServer_method_screen_set_orientation:
    3327. 

  3327. 

  3328. .. rst-class:: classref-method
    3329. 

  3329. 

  3330. |void| **screen_set_orientation**\ (\ orientation\: :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>`, screen\: :ref:`int<class_int>` = -1\ )
    3331. 

  3331. 

  3332. Sets the ``screen``'s ``orientation``. See also :ref:`screen_get_orientation<class_DisplayServer_method_screen_get_orientation>`.
    3333. 

  3333. 

  3334. \ **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>`.
    3335. 

  3335. 

  3336. .. rst-class:: classref-item-separator
    3337. 

  3337. 

  3338. ----
    3339. 

  3339. 

  3340. .. _class_DisplayServer_method_set_icon:
    3341. 

  3341. 

  3342. .. rst-class:: classref-method
    3343. 

  3343. 

  3344. |void| **set_icon**\ (\ image\: :ref:`Image<class_Image>`\ )
    3345. 

  3345. 

  3346. 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.
    3347. 

  3347. 

  3348. \ **Note:** Requires support for :ref:`FEATURE_ICON<class_DisplayServer_constant_FEATURE_ICON>`.
    3349. 

  3349. 

  3350. .. rst-class:: classref-item-separator
    3351. 

  3351. 

  3352. ----
    3353. 

  3353. 

  3354. .. _class_DisplayServer_method_set_native_icon:
    3355. 

  3355. 

  3356. .. rst-class:: classref-method
    3357. 

  3357. 

  3358. |void| **set_native_icon**\ (\ filename\: :ref:`String<class_String>`\ )
    3359. 

  3359. 

  3360. 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.
    3361. 

  3361. 

  3362. \ **Note:** Requires support for :ref:`FEATURE_NATIVE_ICON<class_DisplayServer_constant_FEATURE_NATIVE_ICON>`.
    3363. 

  3363. 

  3364. .. rst-class:: classref-item-separator
    3365. 

  3365. 

  3366. ----
    3367. 

  3367. 

  3368. .. _class_DisplayServer_method_set_system_theme_change_callback:
    3369. 

  3369. 

  3370. .. rst-class:: classref-method
    3371. 

  3371. 

  3372. |void| **set_system_theme_change_callback**\ (\ callable\: :ref:`Callable<class_Callable>`\ )
    3373. 

  3373. 

  3374. Sets the ``callable`` that should be called when system theme settings are changed. Callback method should have zero arguments.
    3375. 

  3375. 

  3376. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
    3377. 

  3377. 

  3378. .. rst-class:: classref-item-separator
    3379. 

  3379. 

  3380. ----
    3381. 

  3381. 

  3382. .. _class_DisplayServer_method_status_indicator_set_callback:
    3383. 

  3383. 

  3384. .. rst-class:: classref-method
    3385. 

  3385. 

  3386. |void| **status_indicator_set_callback**\ (\ id\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ )
    3387. 

  3387. 

  3388. Sets the application status indicator activation callback.
    3389. 

  3389. 

  3390. .. rst-class:: classref-item-separator
    3391. 

  3391. 

  3392. ----
    3393. 

  3393. 

  3394. .. _class_DisplayServer_method_status_indicator_set_icon:
    3395. 

  3395. 

  3396. .. rst-class:: classref-method
    3397. 

  3397. 

  3398. |void| **status_indicator_set_icon**\ (\ id\: :ref:`int<class_int>`, icon\: :ref:`Image<class_Image>`\ )
    3399. 

  3399. 

  3400. Sets the application status indicator icon.
    3401. 

  3401. 

  3402. .. rst-class:: classref-item-separator
    3403. 

  3403. 

  3404. ----
    3405. 

  3405. 

  3406. .. _class_DisplayServer_method_status_indicator_set_tooltip:
    3407. 

  3407. 

  3408. .. rst-class:: classref-method
    3409. 

  3409. 

  3410. |void| **status_indicator_set_tooltip**\ (\ id\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ )
    3411. 

  3411. 

  3412. Sets the application status indicator tooltip.
    3413. 

  3413. 

  3414. .. rst-class:: classref-item-separator
    3415. 

  3415. 

  3416. ----
    3417. 

  3417. 

  3418. .. _class_DisplayServer_method_tablet_get_current_driver:
    3419. 

  3419. 

  3420. .. rst-class:: classref-method
    3421. 

  3421. 

  3422. :ref:`String<class_String>` **tablet_get_current_driver**\ (\ ) |const|
    3423. 

  3423. 

  3424. Returns current active tablet driver name.
    3425. 

  3425. 

  3426. \ **Note:** This method is implemented only on Windows.
    3427. 

  3427. 

  3428. .. rst-class:: classref-item-separator
    3429. 

  3429. 

  3430. ----
    3431. 

  3431. 

  3432. .. _class_DisplayServer_method_tablet_get_driver_count:
    3433. 

  3433. 

  3434. .. rst-class:: classref-method
    3435. 

  3435. 

  3436. :ref:`int<class_int>` **tablet_get_driver_count**\ (\ ) |const|
    3437. 

  3437. 

  3438. Returns the total number of available tablet drivers.
    3439. 

  3439. 

  3440. \ **Note:** This method is implemented only on Windows.
    3441. 

  3441. 

  3442. .. rst-class:: classref-item-separator
    3443. 

  3443. 

  3444. ----
    3445. 

  3445. 

  3446. .. _class_DisplayServer_method_tablet_get_driver_name:
    3447. 

  3447. 

  3448. .. rst-class:: classref-method
    3449. 

  3449. 

  3450. :ref:`String<class_String>` **tablet_get_driver_name**\ (\ idx\: :ref:`int<class_int>`\ ) |const|
    3451. 

  3451. 

  3452. Returns the tablet driver name for the given index.
    3453. 

  3453. 

  3454. \ **Note:** This method is implemented only on Windows.
    3455. 

  3455. 

  3456. .. rst-class:: classref-item-separator
    3457. 

  3457. 

  3458. ----
    3459. 

  3459. 

  3460. .. _class_DisplayServer_method_tablet_set_current_driver:
    3461. 

  3461. 

  3462. .. rst-class:: classref-method
    3463. 

  3463. 

  3464. |void| **tablet_set_current_driver**\ (\ name\: :ref:`String<class_String>`\ )
    3465. 

  3465. 

  3466. Set active tablet driver name.
    3467. 

  3467. 

  3468. Supported drivers:
    3469. 

  3469. 

  3470. - ``winink``: Windows Ink API, default (Windows 8.1+ required).
    3471. 

  3471. 

  3472. - ``wintab``: Wacom Wintab API (compatible device driver required).
    3473. 

  3473. 

  3474. - ``dummy``: Dummy driver, tablet input is disabled.
    3475. 

  3475. 

  3476. \ **Note:** This method is implemented only on Windows.
    3477. 

  3477. 

  3478. .. rst-class:: classref-item-separator
    3479. 

  3479. 

  3480. ----
    3481. 

  3481. 

  3482. .. _class_DisplayServer_method_tts_get_voices:
    3483. 

  3483. 

  3484. .. rst-class:: classref-method
    3485. 

  3485. 

  3486. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **tts_get_voices**\ (\ ) |const|
    3487. 

  3487. 

  3488. Returns an :ref:`Array<class_Array>` of voice information dictionaries.
    3489. 

  3489. 

  3490. Each :ref:`Dictionary<class_Dictionary>` contains two :ref:`String<class_String>` entries:
    3491. 

  3491. 

  3492. - ``name`` is voice name.
    3493. 

  3493. 

  3494. - ``id`` is voice identifier.
    3495. 

  3495. 

  3496. - ``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.
    3497. 

  3497. 

  3498. 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.
    3499. 

  3499. 

  3500. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3501. 

  3501. 

  3502. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3503. 

  3503. 

  3504. .. rst-class:: classref-item-separator
    3505. 

  3505. 

  3506. ----
    3507. 

  3507. 

  3508. .. _class_DisplayServer_method_tts_get_voices_for_language:
    3509. 

  3509. 

  3510. .. rst-class:: classref-method
    3511. 

  3511. 

  3512. :ref:`PackedStringArray<class_PackedStringArray>` **tts_get_voices_for_language**\ (\ language\: :ref:`String<class_String>`\ ) |const|
    3513. 

  3513. 

  3514. Returns an :ref:`PackedStringArray<class_PackedStringArray>` of voice identifiers for the ``language``.
    3515. 

  3515. 

  3516. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3517. 

  3517. 

  3518. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3519. 

  3519. 

  3520. .. rst-class:: classref-item-separator
    3521. 

  3521. 

  3522. ----
    3523. 

  3523. 

  3524. .. _class_DisplayServer_method_tts_is_paused:
    3525. 

  3525. 

  3526. .. rst-class:: classref-method
    3527. 

  3527. 

  3528. :ref:`bool<class_bool>` **tts_is_paused**\ (\ ) |const|
    3529. 

  3529. 

  3530. Returns ``true`` if the synthesizer is in a paused state.
    3531. 

  3531. 

  3532. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3533. 

  3533. 

  3534. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3535. 

  3535. 

  3536. .. rst-class:: classref-item-separator
    3537. 

  3537. 

  3538. ----
    3539. 

  3539. 

  3540. .. _class_DisplayServer_method_tts_is_speaking:
    3541. 

  3541. 

  3542. .. rst-class:: classref-method
    3543. 

  3543. 

  3544. :ref:`bool<class_bool>` **tts_is_speaking**\ (\ ) |const|
    3545. 

  3545. 

  3546. Returns ``true`` if the synthesizer is generating speech, or have utterance waiting in the queue.
    3547. 

  3547. 

  3548. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3549. 

  3549. 

  3550. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3551. 

  3551. 

  3552. .. rst-class:: classref-item-separator
    3553. 

  3553. 

  3554. ----
    3555. 

  3555. 

  3556. .. _class_DisplayServer_method_tts_pause:
    3557. 

  3557. 

  3558. .. rst-class:: classref-method
    3559. 

  3559. 

  3560. |void| **tts_pause**\ (\ )
    3561. 

  3561. 

  3562. Puts the synthesizer into a paused state.
    3563. 

  3563. 

  3564. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3565. 

  3565. 

  3566. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3567. 

  3567. 

  3568. .. rst-class:: classref-item-separator
    3569. 

  3569. 

  3570. ----
    3571. 

  3571. 

  3572. .. _class_DisplayServer_method_tts_resume:
    3573. 

  3573. 

  3574. .. rst-class:: classref-method
    3575. 

  3575. 

  3576. |void| **tts_resume**\ (\ )
    3577. 

  3577. 

  3578. Resumes the synthesizer if it was paused.
    3579. 

  3579. 

  3580. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3581. 

  3581. 

  3582. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3583. 

  3583. 

  3584. .. rst-class:: classref-item-separator
    3585. 

  3585. 

  3586. ----
    3587. 

  3587. 

  3588. .. _class_DisplayServer_method_tts_set_utterance_callback:
    3589. 

  3589. 

  3590. .. rst-class:: classref-method
    3591. 

  3591. 

  3592. |void| **tts_set_utterance_callback**\ (\ event\: :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>`, callable\: :ref:`Callable<class_Callable>`\ )
    3593. 

  3593. 

  3594. Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary.
    3595. 

  3595. 

  3596. - :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.
    3597. 

  3597. 

  3598. - :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.
    3599. 

  3599. 

  3600. \ **Note:** The granularity of the boundary callbacks is engine dependent.
    3601. 

  3601. 

  3602. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3603. 

  3603. 

  3604. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3605. 

  3605. 

  3606. .. rst-class:: classref-item-separator
    3607. 

  3607. 

  3608. ----
    3609. 

  3609. 

  3610. .. _class_DisplayServer_method_tts_speak:
    3611. 

  3611. 

  3612. .. rst-class:: classref-method
    3613. 

  3613. 

  3614. |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\ )
    3615. 

  3615. 

  3616. Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is cleared first.
    3617. 

  3617. 

  3618. - ``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>`.
    3619. 

  3619. 

  3620. - ``volume`` ranges from ``0`` (lowest) to ``100`` (highest).
    3621. 

  3621. 

  3622. - ``pitch`` ranges from ``0.0`` (lowest) to ``2.0`` (highest), ``1.0`` is default pitch for the current voice.
    3623. 

  3623. 

  3624. - ``rate`` ranges from ``0.1`` (lowest) to ``10.0`` (highest), ``1.0`` is a normal speaking rate. Other values act as a percentage relative.
    3625. 

  3625. 

  3626. - ``utterance_id`` is passed as a parameter to the callback functions.
    3627. 

  3627. 

  3628. \ **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>`.
    3629. 

  3629. 

  3630. \ **Note:** The granularity of pitch, rate, and volume is engine and voice dependent. Values may be truncated.
    3631. 

  3631. 

  3632. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3633. 

  3633. 

  3634. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3635. 

  3635. 

  3636. .. rst-class:: classref-item-separator
    3637. 

  3637. 

  3638. ----
    3639. 

  3639. 

  3640. .. _class_DisplayServer_method_tts_stop:
    3641. 

  3641. 

  3642. .. rst-class:: classref-method
    3643. 

  3643. 

  3644. |void| **tts_stop**\ (\ )
    3645. 

  3645. 

  3646. Stops synthesis in progress and removes all utterances from the queue.
    3647. 

  3647. 

  3648. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Linux), macOS, and Windows.
    3649. 

  3649. 

  3650. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3651. 

  3651. 

  3652. .. rst-class:: classref-item-separator
    3653. 

  3653. 

  3654. ----
    3655. 

  3655. 

  3656. .. _class_DisplayServer_method_virtual_keyboard_get_height:
    3657. 

  3657. 

  3658. .. rst-class:: classref-method
    3659. 

  3659. 

  3660. :ref:`int<class_int>` **virtual_keyboard_get_height**\ (\ ) |const|
    3661. 

  3661. 

  3662. Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.
    3663. 

  3663. 

  3664. .. rst-class:: classref-item-separator
    3665. 

  3665. 

  3666. ----
    3667. 

  3667. 

  3668. .. _class_DisplayServer_method_virtual_keyboard_hide:
    3669. 

  3669. 

  3670. .. rst-class:: classref-method
    3671. 

  3671. 

  3672. |void| **virtual_keyboard_hide**\ (\ )
    3673. 

  3673. 

  3674. Hides the virtual keyboard if it is shown, does nothing otherwise.
    3675. 

  3675. 

  3676. .. rst-class:: classref-item-separator
    3677. 

  3677. 

  3678. ----
    3679. 

  3679. 

  3680. .. _class_DisplayServer_method_virtual_keyboard_show:
    3681. 

  3681. 

  3682. .. rst-class:: classref-method
    3683. 

  3683. 

  3684. |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\ )
    3685. 

  3685. 

  3686. Shows the virtual keyboard if the platform has one.
    3687. 

  3687. 

  3688. \ ``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).
    3689. 

  3689. 

  3690. \ ``position`` parameter is the screen space :ref:`Rect2<class_Rect2>` of the edited text.
    3691. 

  3691. 

  3692. \ ``type`` parameter allows configuring which type of virtual keyboard to show.
    3693. 

  3693. 

  3694. \ ``max_length`` limits the number of characters that can be entered if different from ``-1``.
    3695. 

  3695. 

  3696. \ ``cursor_start`` can optionally define the current text cursor position if ``cursor_end`` is not set.
    3697. 

  3697. 

  3698. \ ``cursor_start`` and ``cursor_end`` can optionally define the current text selection.
    3699. 

  3699. 

  3700. \ **Note:** This method is implemented on Android, iOS and Web.
    3701. 

  3701. 

  3702. .. rst-class:: classref-item-separator
    3703. 

  3703. 

  3704. ----
    3705. 

  3705. 

  3706. .. _class_DisplayServer_method_warp_mouse:
    3707. 

  3707. 

  3708. .. rst-class:: classref-method
    3709. 

  3709. 

  3710. |void| **warp_mouse**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ )
    3711. 

  3711. 

  3712. 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.
    3713. 

  3713. 

  3714. \ **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.
    3715. 

  3715. 

  3716. .. rst-class:: classref-item-separator
    3717. 

  3717. 

  3718. ----
    3719. 

  3719. 

  3720. .. _class_DisplayServer_method_window_can_draw:
    3721. 

  3721. 

  3722. .. rst-class:: classref-method
    3723. 

  3723. 

  3724. :ref:`bool<class_bool>` **window_can_draw**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3725. 

  3725. 

  3726. 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``.
    3727. 

  3727. 

  3728. .. rst-class:: classref-item-separator
    3729. 

  3729. 

  3730. ----
    3731. 

  3731. 

  3732. .. _class_DisplayServer_method_window_get_active_popup:
    3733. 

  3733. 

  3734. .. rst-class:: classref-method
    3735. 

  3735. 

  3736. :ref:`int<class_int>` **window_get_active_popup**\ (\ ) |const|
    3737. 

  3737. 

  3738. Returns ID of the active popup window, or :ref:`INVALID_WINDOW_ID<class_DisplayServer_constant_INVALID_WINDOW_ID>` if there is none.
    3739. 

  3739. 

  3740. .. rst-class:: classref-item-separator
    3741. 

  3741. 

  3742. ----
    3743. 

  3743. 

  3744. .. _class_DisplayServer_method_window_get_attached_instance_id:
    3745. 

  3745. 

  3746. .. rst-class:: classref-method
    3747. 

  3747. 

  3748. :ref:`int<class_int>` **window_get_attached_instance_id**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3749. 

  3749. 

  3750. 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.
    3751. 

  3751. 

  3752. .. rst-class:: classref-item-separator
    3753. 

  3753. 

  3754. ----
    3755. 

  3755. 

  3756. .. _class_DisplayServer_method_window_get_current_screen:
    3757. 

  3757. 

  3758. .. rst-class:: classref-method
    3759. 

  3759. 

  3760. :ref:`int<class_int>` **window_get_current_screen**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3761. 

  3761. 

  3762. 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>`.
    3763. 

  3763. 

  3764. .. rst-class:: classref-item-separator
    3765. 

  3765. 

  3766. ----
    3767. 

  3767. 

  3768. .. _class_DisplayServer_method_window_get_flag:
    3769. 

  3769. 

  3770. .. rst-class:: classref-method
    3771. 

  3771. 

  3772. :ref:`bool<class_bool>` **window_get_flag**\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3773. 

  3773. 

  3774. Returns the current value of the given window's ``flag``.
    3775. 

  3775. 

  3776. .. rst-class:: classref-item-separator
    3777. 

  3777. 

  3778. ----
    3779. 

  3779. 

  3780. .. _class_DisplayServer_method_window_get_max_size:
    3781. 

  3781. 

  3782. .. rst-class:: classref-method
    3783. 

  3783. 

  3784. :ref:`Vector2i<class_Vector2i>` **window_get_max_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3785. 

  3785. 

  3786. Returns the window's maximum size (in pixels). See also :ref:`window_set_max_size<class_DisplayServer_method_window_set_max_size>`.
    3787. 

  3787. 

  3788. .. rst-class:: classref-item-separator
    3789. 

  3789. 

  3790. ----
    3791. 

  3791. 

  3792. .. _class_DisplayServer_method_window_get_min_size:
    3793. 

  3793. 

  3794. .. rst-class:: classref-method
    3795. 

  3795. 

  3796. :ref:`Vector2i<class_Vector2i>` **window_get_min_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3797. 

  3797. 

  3798. Returns the window's minimum size (in pixels). See also :ref:`window_set_min_size<class_DisplayServer_method_window_set_min_size>`.
    3799. 

  3799. 

  3800. .. rst-class:: classref-item-separator
    3801. 

  3801. 

  3802. ----
    3803. 

  3803. 

  3804. .. _class_DisplayServer_method_window_get_mode:
    3805. 

  3805. 

  3806. .. rst-class:: classref-method
    3807. 

  3807. 

  3808. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **window_get_mode**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3809. 

  3809. 

  3810. Returns the mode of the given window.
    3811. 

  3811. 

  3812. .. rst-class:: classref-item-separator
    3813. 

  3813. 

  3814. ----
    3815. 

  3815. 

  3816. .. _class_DisplayServer_method_window_get_native_handle:
    3817. 

  3817. 

  3818. .. rst-class:: classref-method
    3819. 

  3819. 

  3820. :ref:`int<class_int>` **window_get_native_handle**\ (\ handle_type\: :ref:`HandleType<enum_DisplayServer_HandleType>`, window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3821. 

  3821. 

  3822. Returns internal structure pointers for use in plugins.
    3823. 

  3823. 

  3824. \ **Note:** This method is implemented on Android, Linux (X11/Wayland), macOS, and Windows.
    3825. 

  3825. 

  3826. .. rst-class:: classref-item-separator
    3827. 

  3827. 

  3828. ----
    3829. 

  3829. 

  3830. .. _class_DisplayServer_method_window_get_popup_safe_rect:
    3831. 

  3831. 

  3832. .. rst-class:: classref-method
    3833. 

  3833. 

  3834. :ref:`Rect2i<class_Rect2i>` **window_get_popup_safe_rect**\ (\ window\: :ref:`int<class_int>`\ ) |const|
    3835. 

  3835. 

  3836. Returns the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system.
    3837. 

  3837. 

  3838. .. rst-class:: classref-item-separator
    3839. 

  3839. 

  3840. ----
    3841. 

  3841. 

  3842. .. _class_DisplayServer_method_window_get_position:
    3843. 

  3843. 

  3844. .. rst-class:: classref-method
    3845. 

  3845. 

  3846. :ref:`Vector2i<class_Vector2i>` **window_get_position**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3847. 

  3847. 

  3848. Returns the position of the client area of the given window on the screen.
    3849. 

  3849. 

  3850. .. rst-class:: classref-item-separator
    3851. 

  3851. 

  3852. ----
    3853. 

  3853. 

  3854. .. _class_DisplayServer_method_window_get_position_with_decorations:
    3855. 

  3855. 

  3856. .. rst-class:: classref-method
    3857. 

  3857. 

  3858. :ref:`Vector2i<class_Vector2i>` **window_get_position_with_decorations**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3859. 

  3859. 

  3860. 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>`.
    3861. 

  3861. 

  3862. .. rst-class:: classref-item-separator
    3863. 

  3863. 

  3864. ----
    3865. 

  3865. 

  3866. .. _class_DisplayServer_method_window_get_safe_title_margins:
    3867. 

  3867. 

  3868. .. rst-class:: classref-method
    3869. 

  3869. 

  3870. :ref:`Vector3i<class_Vector3i>` **window_get_safe_title_margins**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3871. 

  3871. 

  3872. 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.
    3873. 

  3873. 

  3874. .. rst-class:: classref-item-separator
    3875. 

  3875. 

  3876. ----
    3877. 

  3877. 

  3878. .. _class_DisplayServer_method_window_get_size:
    3879. 

  3879. 

  3880. .. rst-class:: classref-method
    3881. 

  3881. 

  3882. :ref:`Vector2i<class_Vector2i>` **window_get_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3883. 

  3883. 

  3884. 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>`.
    3885. 

  3885. 

  3886. .. rst-class:: classref-item-separator
    3887. 

  3887. 

  3888. ----
    3889. 

  3889. 

  3890. .. _class_DisplayServer_method_window_get_size_with_decorations:
    3891. 

  3891. 

  3892. .. rst-class:: classref-method
    3893. 

  3893. 

  3894. :ref:`Vector2i<class_Vector2i>` **window_get_size_with_decorations**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3895. 

  3895. 

  3896. 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>`.
    3897. 

  3897. 

  3898. .. rst-class:: classref-item-separator
    3899. 

  3899. 

  3900. ----
    3901. 

  3901. 

  3902. .. _class_DisplayServer_method_window_get_title_size:
    3903. 

  3903. 

  3904. .. rst-class:: classref-method
    3905. 

  3905. 

  3906. :ref:`Vector2i<class_Vector2i>` **window_get_title_size**\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3907. 

  3907. 

  3908. 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.
    3909. 

  3909. 

  3910. \ **Note:** This method is implemented on macOS and Windows.
    3911. 

  3911. 

  3912. .. rst-class:: classref-item-separator
    3913. 

  3913. 

  3914. ----
    3915. 

  3915. 

  3916. .. _class_DisplayServer_method_window_get_vsync_mode:
    3917. 

  3917. 

  3918. .. rst-class:: classref-method
    3919. 

  3919. 

  3920. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **window_get_vsync_mode**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3921. 

  3921. 

  3922. Returns the V-Sync mode of the given window.
    3923. 

  3923. 

  3924. .. rst-class:: classref-item-separator
    3925. 

  3925. 

  3926. ----
    3927. 

  3927. 

  3928. .. _class_DisplayServer_method_window_is_focused:
    3929. 

  3929. 

  3930. .. rst-class:: classref-method
    3931. 

  3931. 

  3932. :ref:`bool<class_bool>` **window_is_focused**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3933. 

  3933. 

  3934. Returns ``true`` if the window specified by ``window_id`` is focused.
    3935. 

  3935. 

  3936. .. rst-class:: classref-item-separator
    3937. 

  3937. 

  3938. ----
    3939. 

  3939. 

  3940. .. _class_DisplayServer_method_window_is_maximize_allowed:
    3941. 

  3941. 

  3942. .. rst-class:: classref-method
    3943. 

  3943. 

  3944. :ref:`bool<class_bool>` **window_is_maximize_allowed**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|
    3945. 

  3945. 

  3946. Returns ``true`` if the given window can be maximized (the maximize button is enabled).
    3947. 

  3947. 

  3948. .. rst-class:: classref-item-separator
    3949. 

  3949. 

  3950. ----
    3951. 

  3951. 

  3952. .. _class_DisplayServer_method_window_maximize_on_title_dbl_click:
    3953. 

  3953. 

  3954. .. rst-class:: classref-method
    3955. 

  3955. 

  3956. :ref:`bool<class_bool>` **window_maximize_on_title_dbl_click**\ (\ ) |const|
    3957. 

  3957. 

  3958. Returns ``true``, if double-click on a window title should maximize it.
    3959. 

  3959. 

  3960. \ **Note:** This method is implemented only on macOS.
    3961. 

  3961. 

  3962. .. rst-class:: classref-item-separator
    3963. 

  3963. 

  3964. ----
    3965. 

  3965. 

  3966. .. _class_DisplayServer_method_window_minimize_on_title_dbl_click:
    3967. 

  3967. 

  3968. .. rst-class:: classref-method
    3969. 

  3969. 

  3970. :ref:`bool<class_bool>` **window_minimize_on_title_dbl_click**\ (\ ) |const|
    3971. 

  3971. 

  3972. Returns ``true``, if double-click on a window title should minimize it.
    3973. 

  3973. 

  3974. \ **Note:** This method is implemented only on macOS.
    3975. 

  3975. 

  3976. .. rst-class:: classref-item-separator
    3977. 

  3977. 

  3978. ----
    3979. 

  3979. 

  3980. .. _class_DisplayServer_method_window_move_to_foreground:
    3981. 

  3981. 

  3982. .. rst-class:: classref-method
    3983. 

  3983. 

  3984. |void| **window_move_to_foreground**\ (\ window_id\: :ref:`int<class_int>` = 0\ )
    3985. 

  3985. 

  3986. Moves the window specified by ``window_id`` to the foreground, so that it is visible over other windows.
    3987. 

  3987. 

  3988. .. rst-class:: classref-item-separator
    3989. 

  3989. 

  3990. ----
    3991. 

  3991. 

  3992. .. _class_DisplayServer_method_window_request_attention:
    3993. 

  3993. 

  3994. .. rst-class:: classref-method
    3995. 

  3995. 

  3996. |void| **window_request_attention**\ (\ window_id\: :ref:`int<class_int>` = 0\ )
    3997. 

  3997. 

  3998. 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.
    3999. 

  3999. 

  4000. .. rst-class:: classref-item-separator
    4001. 

  4001. 

  4002. ----
    4003. 

  4003. 

  4004. .. _class_DisplayServer_method_window_set_current_screen:
    4005. 

  4005. 

  4006. .. rst-class:: classref-method
    4007. 

  4007. 

  4008. |void| **window_set_current_screen**\ (\ screen\: :ref:`int<class_int>`, window_id\: :ref:`int<class_int>` = 0\ )
    4009. 

  4009. 

  4010. 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>`.
    4011. 

  4011. 

  4012. .. rst-class:: classref-item-separator
    4013. 

  4013. 

  4014. ----
    4015. 

  4015. 

  4016. .. _class_DisplayServer_method_window_set_drop_files_callback:
    4017. 

  4017. 

  4018. .. rst-class:: classref-method
    4019. 

  4019. 

  4020. |void| **window_set_drop_files_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ )
    4021. 

  4021. 

  4022. 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``.
    4023. 

  4023. 

  4024. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
    4025. 

  4025. 

  4026. \ **Note:** This method is implemented on Windows, macOS, Linux (X11/Wayland), and Web.
    4027. 

  4027. 

  4028. .. rst-class:: classref-item-separator
    4029. 

  4029. 

  4030. ----
    4031. 

  4031. 

  4032. .. _class_DisplayServer_method_window_set_exclusive:
    4033. 

  4033. 

  4034. .. rst-class:: classref-method
    4035. 

  4035. 

  4036. |void| **window_set_exclusive**\ (\ window_id\: :ref:`int<class_int>`, exclusive\: :ref:`bool<class_bool>`\ )
    4037. 

  4037. 

  4038. 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.
    4039. 

  4039. 

  4040. \ **Note:** On macOS, exclusive windows are confined to the same space (virtual desktop or screen) as the parent window.
    4041. 

  4041. 

  4042. \ **Note:** This method is implemented on macOS and Windows.
    4043. 

  4043. 

  4044. .. rst-class:: classref-item-separator
    4045. 

  4045. 

  4046. ----
    4047. 

  4047. 

  4048. .. _class_DisplayServer_method_window_set_flag:
    4049. 

  4049. 

  4050. .. rst-class:: classref-method
    4051. 

  4051. 

  4052. |void| **window_set_flag**\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, enabled\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ )
    4053. 

  4053. 

  4054. Enables or disables the given window's given ``flag``. See :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` for possible values and their behavior.
    4055. 

  4055. 

  4056. .. rst-class:: classref-item-separator
    4057. 

  4057. 

  4058. ----
    4059. 

  4059. 

  4060. .. _class_DisplayServer_method_window_set_ime_active:
    4061. 

  4061. 

  4062. .. rst-class:: classref-method
    4063. 

  4063. 

  4064. |void| **window_set_ime_active**\ (\ active\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ )
    4065. 

  4065. 

  4066. 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>`.
    4067. 

  4067. 

  4068. .. rst-class:: classref-item-separator
    4069. 

  4069. 

  4070. ----
    4071. 

  4071. 

  4072. .. _class_DisplayServer_method_window_set_ime_position:
    4073. 

  4073. 

  4074. .. rst-class:: classref-method
    4075. 

  4075. 

  4076. |void| **window_set_ime_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ )
    4077. 

  4077. 

  4078. 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``.
    4079. 

  4079. 

  4080. .. rst-class:: classref-item-separator
    4081. 

  4081. 

  4082. ----
    4083. 

  4083. 

  4084. .. _class_DisplayServer_method_window_set_input_event_callback:
    4085. 

  4085. 

  4086. .. rst-class:: classref-method
    4087. 

  4087. 

  4088. |void| **window_set_input_event_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ )
    4089. 

  4089. 

  4090. Sets the ``callback`` that should be called when any :ref:`InputEvent<class_InputEvent>` is sent to the window specified by ``window_id``.
    4091. 

  4091. 

  4092. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
    4093. 

  4093. 

  4094. .. rst-class:: classref-item-separator
    4095. 

  4095. 

  4096. ----
    4097. 

  4097. 

  4098. .. _class_DisplayServer_method_window_set_input_text_callback:
    4099. 

  4099. 

  4100. .. rst-class:: classref-method
    4101. 

  4101. 

  4102. |void| **window_set_input_text_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ )
    4103. 

  4103. 

  4104. Sets the ``callback`` that should be called when text is entered using the virtual keyboard to the window specified by ``window_id``.
    4105. 

  4105. 

  4106. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
    4107. 

  4107. 

  4108. .. rst-class:: classref-item-separator
    4109. 

  4109. 

  4110. ----
    4111. 

  4111. 

  4112. .. _class_DisplayServer_method_window_set_max_size:
    4113. 

  4113. 

  4114. .. rst-class:: classref-method
    4115. 

  4115. 

  4116. |void| **window_set_max_size**\ (\ max_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ )
    4117. 

  4117. 

  4118. 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 smaller than the specified size. See also :ref:`window_get_max_size<class_DisplayServer_method_window_get_max_size>`.
    4119. 

  4119. 

  4120. \ **Note:** It's recommended to change this value using :ref:`Window.max_size<class_Window_property_max_size>` instead.
    4121. 

  4121. 

  4122. \ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.
    4123. 

  4123. 

  4124. .. rst-class:: classref-item-separator
    4125. 

  4125. 

  4126. ----
    4127. 

  4127. 

  4128. .. _class_DisplayServer_method_window_set_min_size:
    4129. 

  4129. 

  4130. .. rst-class:: classref-method
    4131. 

  4131. 

  4132. |void| **window_set_min_size**\ (\ min_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ )
    4133. 

  4133. 

  4134. 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 larger than the specified size. See also :ref:`window_get_min_size<class_DisplayServer_method_window_get_min_size>`.
    4135. 

  4135. 

  4136. \ **Note:** It's recommended to change this value using :ref:`Window.min_size<class_Window_property_min_size>` instead.
    4137. 

  4137. 

  4138. \ **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.
    4139. 

  4139. 

  4140. \ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.
    4141. 

  4141. 

  4142. .. rst-class:: classref-item-separator
    4143. 

  4143. 

  4144. ----
    4145. 

  4145. 

  4146. .. _class_DisplayServer_method_window_set_mode:
    4147. 

  4147. 

  4148. .. rst-class:: classref-method
    4149. 

  4149. 

  4150. |void| **window_set_mode**\ (\ mode\: :ref:`WindowMode<enum_DisplayServer_WindowMode>`, window_id\: :ref:`int<class_int>` = 0\ )
    4151. 

  4151. 

  4152. Sets window mode for the given window to ``mode``. See :ref:`WindowMode<enum_DisplayServer_WindowMode>` for possible values and how each mode behaves.
    4153. 

  4153. 

  4154. \ **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.
    4155. 

  4155. 

  4156. .. rst-class:: classref-item-separator
    4157. 

  4157. 

  4158. ----
    4159. 

  4159. 

  4160. .. _class_DisplayServer_method_window_set_mouse_passthrough:
    4161. 

  4161. 

  4162. .. rst-class:: classref-method
    4163. 

  4163. 

  4164. |void| **window_set_mouse_passthrough**\ (\ region\: :ref:`PackedVector2Array<class_PackedVector2Array>`, window_id\: :ref:`int<class_int>` = 0\ )
    4165. 

  4165. 

  4166. Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through.
    4167. 

  4167. 

  4168. Passing an empty array will disable passthrough support (all mouse events will be intercepted by the window, which is the default behavior).
    4169. 

  4169. 

  4170. 

  4171. .. tabs::
    4172. 

  4172. 

  4173.  .. code-tab:: gdscript
    4174. 

  4174. 

  4175.     # Set region, using Path2D node.
    4176. 

  4176.     DisplayServer.window_set_mouse_passthrough($Path2D.curve.get_baked_points())
    4177. 

  4177.     
    4178. 

  4178.     # Set region, using Polygon2D node.
    4179. 

  4179.     DisplayServer.window_set_mouse_passthrough($Polygon2D.polygon)
    4180. 

  4180.     
    4181. 

  4181.     # Reset region to default.
    4182. 

  4182.     DisplayServer.window_set_mouse_passthrough([])
    4183. 

  4183. 

  4184.  .. code-tab:: csharp
    4185. 

  4185. 

  4186.     // Set region, using Path2D node.
    4187. 

  4187.     DisplayServer.WindowSetMousePassthrough(GetNode<Path2D>("Path2D").Curve.GetBakedPoints());
    4188. 

  4188.     
    4189. 

  4189.     // Set region, using Polygon2D node.
    4190. 

  4190.     DisplayServer.WindowSetMousePassthrough(GetNode<Polygon2D>("Polygon2D").Polygon);
    4191. 

  4191.     
    4192. 

  4192.     // Reset region to default.
    4193. 

  4193.     DisplayServer.WindowSetMousePassthrough(new Vector2[] {});
    4194. 

  4194. 

  4195. 

  4196. 

  4197. \ **Note:** On Windows, the portion of a window that lies outside the region is not drawn, while on Linux (X11) and macOS it is.
    4198. 

  4198. 

  4199. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    4200. 

  4200. 

  4201. .. rst-class:: classref-item-separator
    4202. 

  4202. 

  4203. ----
    4204. 

  4204. 

  4205. .. _class_DisplayServer_method_window_set_popup_safe_rect:
    4206. 

  4206. 

  4207. .. rst-class:: classref-method
    4208. 

  4208. 

  4209. |void| **window_set_popup_safe_rect**\ (\ window\: :ref:`int<class_int>`, rect\: :ref:`Rect2i<class_Rect2i>`\ )
    4210. 

  4210. 

  4211. 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.
    4212. 

  4212. 

  4213. .. rst-class:: classref-item-separator
    4214. 

  4214. 

  4215. ----
    4216. 

  4216. 

  4217. .. _class_DisplayServer_method_window_set_position:
    4218. 

  4218. 

  4219. .. rst-class:: classref-method
    4220. 

  4220. 

  4221. |void| **window_set_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ )
    4222. 

  4222. 

  4223. 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:
    4224. 

  4224. 

  4225. .. code:: text
    4226. 

  4226. 

  4227.     * (0, 0)        +-------+
    4228. 

  4228.                     |       |
    4229. 

  4229.     +-------------+ |       |
    4230. 

  4230.     |             | |       |
    4231. 

  4231.     |             | |       |
    4232. 

  4232.     +-------------+ +-------+
    4233. 

  4233. 

  4234. See also :ref:`window_get_position<class_DisplayServer_method_window_get_position>` and :ref:`window_set_size<class_DisplayServer_method_window_set_size>`.
    4235. 

  4235. 

  4236. \ **Note:** It's recommended to change this value using :ref:`Window.position<class_Window_property_position>` instead.
    4237. 

  4237. 

  4238. \ **Note:** On Linux (Wayland): this method is a no-op.
    4239. 

  4239. 

  4240. .. rst-class:: classref-item-separator
    4241. 

  4241. 

  4242. ----
    4243. 

  4243. 

  4244. .. _class_DisplayServer_method_window_set_rect_changed_callback:
    4245. 

  4245. 

  4246. .. rst-class:: classref-method
    4247. 

  4247. 

  4248. |void| **window_set_rect_changed_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ )
    4249. 

  4249. 

  4250. Sets the ``callback`` that will be called when the window specified by ``window_id`` is moved or resized.
    4251. 

  4251. 

  4252. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
    4253. 

  4253. 

  4254. .. rst-class:: classref-item-separator
    4255. 

  4255. 

  4256. ----
    4257. 

  4257. 

  4258. .. _class_DisplayServer_method_window_set_size:
    4259. 

  4259. 

  4260. .. rst-class:: classref-method
    4261. 

  4261. 

  4262. |void| **window_set_size**\ (\ size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ )
    4263. 

  4263. 

  4264. 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>`.
    4265. 

  4265. 

  4266. \ **Note:** It's recommended to change this value using :ref:`Window.size<class_Window_property_size>` instead.
    4267. 

  4267. 

  4268. .. rst-class:: classref-item-separator
    4269. 

  4269. 

  4270. ----
    4271. 

  4271. 

  4272. .. _class_DisplayServer_method_window_set_title:
    4273. 

  4273. 

  4274. .. rst-class:: classref-method
    4275. 

  4275. 

  4276. |void| **window_set_title**\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ )
    4277. 

  4277. 

  4278. Sets the title of the given window to ``title``.
    4279. 

  4279. 

  4280. \ **Note:** It's recommended to change this value using :ref:`Window.title<class_Window_property_title>` instead.
    4281. 

  4281. 

  4282. \ **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.
    4283. 

  4283. 

  4284. .. rst-class:: classref-item-separator
    4285. 

  4285. 

  4286. ----
    4287. 

  4287. 

  4288. .. _class_DisplayServer_method_window_set_transient:
    4289. 

  4289. 

  4290. .. rst-class:: classref-method
    4291. 

  4291. 

  4292. |void| **window_set_transient**\ (\ window_id\: :ref:`int<class_int>`, parent_window_id\: :ref:`int<class_int>`\ )
    4293. 

  4293. 

  4294. Sets window transient parent. Transient window is 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.
    4295. 

  4295. 

  4296. \ **Note:** It's recommended to change this value using :ref:`Window.transient<class_Window_property_transient>` instead.
    4297. 

  4297. 

  4298. \ **Note:** The behavior might be different depending on the platform.
    4299. 

  4299. 

  4300. .. rst-class:: classref-item-separator
    4301. 

  4301. 

  4302. ----
    4303. 

  4303. 

  4304. .. _class_DisplayServer_method_window_set_vsync_mode:
    4305. 

  4305. 

  4306. .. rst-class:: classref-method
    4307. 

  4307. 

  4308. |void| **window_set_vsync_mode**\ (\ vsync_mode\: :ref:`VSyncMode<enum_DisplayServer_VSyncMode>`, window_id\: :ref:`int<class_int>` = 0\ )
    4309. 

  4309. 

  4310. 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>`.
    4311. 

  4311. 

  4312. See :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` for possible values and how they affect the behavior of your application.
    4313. 

  4313. 

  4314. 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.
    4315. 

  4315. 

  4316. \ **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.
    4317. 

  4317. 

  4318. .. rst-class:: classref-item-separator
    4319. 

  4319. 

  4320. ----
    4321. 

  4321. 

  4322. .. _class_DisplayServer_method_window_set_window_buttons_offset:
    4323. 

  4323. 

  4324. .. rst-class:: classref-method
    4325. 

  4325. 

  4326. |void| **window_set_window_buttons_offset**\ (\ offset\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ )
    4327. 

  4327. 

  4328. 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.
    4329. 

  4329. 

  4330. \ **Note:** This flag is implemented only on macOS.
    4331. 

  4331. 

  4332. .. rst-class:: classref-item-separator
    4333. 

  4333. 

  4334. ----
    4335. 

  4335. 

  4336. .. _class_DisplayServer_method_window_set_window_event_callback:
    4337. 

  4337. 

  4338. .. rst-class:: classref-method
    4339. 

  4339. 

  4340. |void| **window_set_window_event_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ )
    4341. 

  4341. 

  4342. Sets the ``callback`` that will be called when an event occurs in the window specified by ``window_id``.
    4343. 

  4343. 

  4344. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
    4345. 

  4345. 

  4346. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    4347. 

  4347. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    4348. 

  4348. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    4349. 

  4349. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    4350. 

  4350. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    4351. 

  4351. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    4352. 

  4352. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    4353. 

  4353. .. |void| replace:: :abbr:`void (No return value.)`
    4354.