Kezdőlap Felfedezés Súgó
Bejelentkezés
Godot
/
godot-docs
tükrözi: https://github.com/godotengine/godot-docs.git
2
0
Másolás 0
Fájlok Problémák 0 Wiki
Fa: f9340bddb2
Branch-ok Tag-ek
godot-docs
/
classes
/
class_displayserver.rst

class_displayserver.rst 289 KB
Előzmények Nyers

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747 
  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:`String<class_String>`                                    | :ref:`clipboard_get_primary<class_DisplayServer_method_clipboard_get_primary>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                              |
    38. 

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

  39.    | :ref:`bool<class_bool>`                                        | :ref:`clipboard_has<class_DisplayServer_method_clipboard_has>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                              |
    40. 

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

  41.    | void                                                           | :ref:`clipboard_set<class_DisplayServer_method_clipboard_set>` **(** :ref:`String<class_String>` clipboard **)**                                                                                                                                                                                                                                                                                                                                                                |
    42. 

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

  43.    | void                                                           | :ref:`clipboard_set_primary<class_DisplayServer_method_clipboard_set_primary>` **(** :ref:`String<class_String>` clipboard_primary **)**                                                                                                                                                                                                                                                                                                                                        |
    44. 

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

  45.    | :ref:`CursorShape<enum_DisplayServer_CursorShape>`             | :ref:`cursor_get_shape<class_DisplayServer_method_cursor_get_shape>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                        |
    46. 

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

  47.    | void                                                           | :ref:`cursor_set_custom_image<class_DisplayServer_method_cursor_set_custom_image>` **(** :ref:`Resource<class_Resource>` cursor, :ref:`CursorShape<enum_DisplayServer_CursorShape>` shape=0, :ref:`Vector2<class_Vector2>` hotspot=Vector2(0, 0) **)**                                                                                                                                                                                                                          |
    48. 

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

  49.    | void                                                           | :ref:`cursor_set_shape<class_DisplayServer_method_cursor_set_shape>` **(** :ref:`CursorShape<enum_DisplayServer_CursorShape>` shape **)**                                                                                                                                                                                                                                                                                                                                       |
    50. 

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

  51.    | :ref:`Error<enum_@GlobalScope_Error>`                          | :ref:`dialog_input_text<class_DisplayServer_method_dialog_input_text>` **(** :ref:`String<class_String>` title, :ref:`String<class_String>` description, :ref:`String<class_String>` existing_text, :ref:`Callable<class_Callable>` callback **)**                                                                                                                                                                                                                              |
    52. 

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

  53.    | :ref:`Error<enum_@GlobalScope_Error>`                          | :ref:`dialog_show<class_DisplayServer_method_dialog_show>` **(** :ref:`String<class_String>` title, :ref:`String<class_String>` description, :ref:`PackedStringArray<class_PackedStringArray>` buttons, :ref:`Callable<class_Callable>` callback **)**                                                                                                                                                                                                                          |
    54. 

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

  55.    | void                                                           | :ref:`enable_for_stealing_focus<class_DisplayServer_method_enable_for_stealing_focus>` **(** :ref:`int<class_int>` process_id **)**                                                                                                                                                                                                                                                                                                                                             |
    56. 

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

  57.    | void                                                           | :ref:`force_process_and_drop_events<class_DisplayServer_method_force_process_and_drop_events>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                      |
    58. 

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

  59.    | :ref:`Color<class_Color>`                                      | :ref:`get_accent_color<class_DisplayServer_method_get_accent_color>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                        |
    60. 

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

  61.    | :ref:`Rect2[]<class_Rect2>`                                    | :ref:`get_display_cutouts<class_DisplayServer_method_get_display_cutouts>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                  |
    62. 

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

  63.    | :ref:`Rect2i<class_Rect2i>`                                    | :ref:`get_display_safe_area<class_DisplayServer_method_get_display_safe_area>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                              |
    64. 

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

  65.    | :ref:`int<class_int>`                                          | :ref:`get_keyboard_focus_screen<class_DisplayServer_method_get_keyboard_focus_screen>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                      |
    66. 

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

  67.    | :ref:`String<class_String>`                                    | :ref:`get_name<class_DisplayServer_method_get_name>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                        |
    68. 

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

  69.    | :ref:`int<class_int>`                                          | :ref:`get_primary_screen<class_DisplayServer_method_get_primary_screen>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                    |
    70. 

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

  71.    | :ref:`int<class_int>`                                          | :ref:`get_screen_count<class_DisplayServer_method_get_screen_count>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                        |
    72. 

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

  73.    | :ref:`int<class_int>`                                          | :ref:`get_screen_from_rect<class_DisplayServer_method_get_screen_from_rect>` **(** :ref:`Rect2<class_Rect2>` rect **)** |const|                                                                                                                                                                                                                                                                                                                                                 |
    74. 

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

  75.    | :ref:`bool<class_bool>`                                        | :ref:`get_swap_cancel_ok<class_DisplayServer_method_get_swap_cancel_ok>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                            |
    76. 

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

  77.    | :ref:`int<class_int>`                                          | :ref:`get_window_at_screen_position<class_DisplayServer_method_get_window_at_screen_position>` **(** :ref:`Vector2i<class_Vector2i>` position **)** |const|                                                                                                                                                                                                                                                                                                                     |
    78. 

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

  79.    | :ref:`PackedInt32Array<class_PackedInt32Array>`                | :ref:`get_window_list<class_DisplayServer_method_get_window_list>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                          |
    80. 

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

  81.    | :ref:`int<class_int>`                                          | :ref:`global_menu_add_check_item<class_DisplayServer_method_global_menu_add_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Callable<class_Callable>` key_callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**                                                                                  |
    82. 

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

  83.    | :ref:`int<class_int>`                                          | :ref:`global_menu_add_icon_check_item<class_DisplayServer_method_global_menu_add_icon_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Callable<class_Callable>` key_callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**                                |
    84. 

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

  85.    | :ref:`int<class_int>`                                          | :ref:`global_menu_add_icon_item<class_DisplayServer_method_global_menu_add_icon_item>` **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Callable<class_Callable>` key_callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**                                            |
    86. 

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

  87.    | :ref:`int<class_int>`                                          | :ref:`global_menu_add_icon_radio_check_item<class_DisplayServer_method_global_menu_add_icon_radio_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Callable<class_Callable>` key_callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**                    |
    88. 

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

  89.    | :ref:`int<class_int>`                                          | :ref:`global_menu_add_item<class_DisplayServer_method_global_menu_add_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Callable<class_Callable>` key_callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**                                                                                              |
    90. 

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

  91.    | :ref:`int<class_int>`                                          | :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`int<class_int>` max_states, :ref:`int<class_int>` default_state, :ref:`Callable<class_Callable>` callback, :ref:`Callable<class_Callable>` key_callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
    92. 

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

  93.    | :ref:`int<class_int>`                                          | :ref:`global_menu_add_radio_check_item<class_DisplayServer_method_global_menu_add_radio_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Callable<class_Callable>` key_callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**                                                                      |
    94. 

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

  95.    | :ref:`int<class_int>`                                          | :ref:`global_menu_add_separator<class_DisplayServer_method_global_menu_add_separator>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` index=-1 **)**                                                                                                                                                                                                                                                                                                        |
    96. 

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

  97.    | :ref:`int<class_int>`                                          | :ref:`global_menu_add_submenu_item<class_DisplayServer_method_global_menu_add_submenu_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`String<class_String>` submenu, :ref:`int<class_int>` index=-1 **)**                                                                                                                                                                                                                          |
    98. 

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

  99.    | void                                                           | :ref:`global_menu_clear<class_DisplayServer_method_global_menu_clear>` **(** :ref:`String<class_String>` menu_root **)**                                                                                                                                                                                                                                                                                                                                                        |
    100. 

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

  101.    | :ref:`Key<enum_@GlobalScope_Key>`                              | :ref:`global_menu_get_item_accelerator<class_DisplayServer_method_global_menu_get_item_accelerator>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                       |
    102. 

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

  103.    | :ref:`Callable<class_Callable>`                                | :ref:`global_menu_get_item_callback<class_DisplayServer_method_global_menu_get_item_callback>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                             |
    104. 

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

  105.    | :ref:`int<class_int>`                                          | :ref:`global_menu_get_item_count<class_DisplayServer_method_global_menu_get_item_count>` **(** :ref:`String<class_String>` menu_root **)** |const|                                                                                                                                                                                                                                                                                                                              |
    106. 

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

  107.    | :ref:`Texture2D<class_Texture2D>`                              | :ref:`global_menu_get_item_icon<class_DisplayServer_method_global_menu_get_item_icon>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                     |
    108. 

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

  109.    | :ref:`int<class_int>`                                          | :ref:`global_menu_get_item_indentation_level<class_DisplayServer_method_global_menu_get_item_indentation_level>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                           |
    110. 

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

  111.    | :ref:`int<class_int>`                                          | :ref:`global_menu_get_item_index_from_tag<class_DisplayServer_method_global_menu_get_item_index_from_tag>` **(** :ref:`String<class_String>` menu_root, :ref:`Variant<class_Variant>` tag **)** |const|                                                                                                                                                                                                                                                                         |
    112. 

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

  113.    | :ref:`int<class_int>`                                          | :ref:`global_menu_get_item_index_from_text<class_DisplayServer_method_global_menu_get_item_index_from_text>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` text **)** |const|                                                                                                                                                                                                                                                                        |
    114. 

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

  115.    | :ref:`Callable<class_Callable>`                                | :ref:`global_menu_get_item_key_callback<class_DisplayServer_method_global_menu_get_item_key_callback>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                     |
    116. 

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

  117.    | :ref:`int<class_int>`                                          | :ref:`global_menu_get_item_max_states<class_DisplayServer_method_global_menu_get_item_max_states>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                         |
    118. 

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

  119.    | :ref:`int<class_int>`                                          | :ref:`global_menu_get_item_state<class_DisplayServer_method_global_menu_get_item_state>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                   |
    120. 

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

  121.    | :ref:`String<class_String>`                                    | :ref:`global_menu_get_item_submenu<class_DisplayServer_method_global_menu_get_item_submenu>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                               |
    122. 

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

  123.    | :ref:`Variant<class_Variant>`                                  | :ref:`global_menu_get_item_tag<class_DisplayServer_method_global_menu_get_item_tag>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                       |
    124. 

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

  125.    | :ref:`String<class_String>`                                    | :ref:`global_menu_get_item_text<class_DisplayServer_method_global_menu_get_item_text>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                     |
    126. 

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

  127.    | :ref:`String<class_String>`                                    | :ref:`global_menu_get_item_tooltip<class_DisplayServer_method_global_menu_get_item_tooltip>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                               |
    128. 

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

  129.    | :ref:`bool<class_bool>`                                        | :ref:`global_menu_is_item_checkable<class_DisplayServer_method_global_menu_is_item_checkable>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                             |
    130. 

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

  131.    | :ref:`bool<class_bool>`                                        | :ref:`global_menu_is_item_checked<class_DisplayServer_method_global_menu_is_item_checked>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                 |
    132. 

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

  133.    | :ref:`bool<class_bool>`                                        | :ref:`global_menu_is_item_disabled<class_DisplayServer_method_global_menu_is_item_disabled>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                               |
    134. 

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

  135.    | :ref:`bool<class_bool>`                                        | :ref:`global_menu_is_item_radio_checkable<class_DisplayServer_method_global_menu_is_item_radio_checkable>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                 |
    136. 

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

  137.    | void                                                           | :ref:`global_menu_remove_item<class_DisplayServer_method_global_menu_remove_item>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                                                 |
    138. 

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

  139.    | void                                                           | :ref:`global_menu_set_item_accelerator<class_DisplayServer_method_global_menu_set_item_accelerator>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Key<enum_@GlobalScope_Key>` keycode **)**                                                                                                                                                                                                                                                    |
    140. 

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

  141.    | void                                                           | :ref:`global_menu_set_item_callback<class_DisplayServer_method_global_menu_set_item_callback>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Callable<class_Callable>` callback **)**                                                                                                                                                                                                                                                           |
    142. 

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

  143.    | void                                                           | :ref:`global_menu_set_item_checkable<class_DisplayServer_method_global_menu_set_item_checkable>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checkable **)**                                                                                                                                                                                                                                                                |
    144. 

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

  145.    | void                                                           | :ref:`global_menu_set_item_checked<class_DisplayServer_method_global_menu_set_item_checked>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checked **)**                                                                                                                                                                                                                                                                      |
    146. 

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

  147.    | void                                                           | :ref:`global_menu_set_item_disabled<class_DisplayServer_method_global_menu_set_item_disabled>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)**                                                                                                                                                                                                                                                                   |
    148. 

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

  149.    | void                                                           | :ref:`global_menu_set_item_icon<class_DisplayServer_method_global_menu_set_item_icon>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Texture2D<class_Texture2D>` icon **)**                                                                                                                                                                                                                                                                     |
    150. 

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

  151.    | void                                                           | :ref:`global_menu_set_item_indentation_level<class_DisplayServer_method_global_menu_set_item_indentation_level>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` level **)**                                                                                                                                                                                                                                                      |
    152. 

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

  153.    | void                                                           | :ref:`global_menu_set_item_key_callback<class_DisplayServer_method_global_menu_set_item_key_callback>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Callable<class_Callable>` key_callback **)**                                                                                                                                                                                                                                               |
    154. 

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

  155.    | void                                                           | :ref:`global_menu_set_item_max_states<class_DisplayServer_method_global_menu_set_item_max_states>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` max_states **)**                                                                                                                                                                                                                                                               |
    156. 

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

  157.    | void                                                           | :ref:`global_menu_set_item_radio_checkable<class_DisplayServer_method_global_menu_set_item_radio_checkable>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checkable **)**                                                                                                                                                                                                                                                    |
    158. 

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

  159.    | void                                                           | :ref:`global_menu_set_item_state<class_DisplayServer_method_global_menu_set_item_state>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` state **)**                                                                                                                                                                                                                                                                              |
    160. 

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

  161.    | void                                                           | :ref:`global_menu_set_item_submenu<class_DisplayServer_method_global_menu_set_item_submenu>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`String<class_String>` submenu **)**                                                                                                                                                                                                                                                                  |
    162. 

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

  163.    | void                                                           | :ref:`global_menu_set_item_tag<class_DisplayServer_method_global_menu_set_item_tag>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` tag **)**                                                                                                                                                                                                                                                                            |
    164. 

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

  165.    | void                                                           | :ref:`global_menu_set_item_text<class_DisplayServer_method_global_menu_set_item_text>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`String<class_String>` text **)**                                                                                                                                                                                                                                                                           |
    166. 

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

  167.    | void                                                           | :ref:`global_menu_set_item_tooltip<class_DisplayServer_method_global_menu_set_item_tooltip>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`String<class_String>` tooltip **)**                                                                                                                                                                                                                                                                  |
    168. 

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

  169.    | :ref:`bool<class_bool>`                                        | :ref:`has_feature<class_DisplayServer_method_has_feature>` **(** :ref:`Feature<enum_DisplayServer_Feature>` feature **)** |const|                                                                                                                                                                                                                                                                                                                                               |
    170. 

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

  171.    | :ref:`Vector2i<class_Vector2i>`                                | :ref:`ime_get_selection<class_DisplayServer_method_ime_get_selection>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                      |
    172. 

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

  173.    | :ref:`String<class_String>`                                    | :ref:`ime_get_text<class_DisplayServer_method_ime_get_text>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                |
    174. 

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

  175.    | :ref:`bool<class_bool>`                                        | :ref:`is_dark_mode<class_DisplayServer_method_is_dark_mode>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                |
    176. 

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

  177.    | :ref:`bool<class_bool>`                                        | :ref:`is_dark_mode_supported<class_DisplayServer_method_is_dark_mode_supported>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                            |
    178. 

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

  179.    | :ref:`bool<class_bool>`                                        | :ref:`is_touchscreen_available<class_DisplayServer_method_is_touchscreen_available>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                        |
    180. 

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

  181.    | :ref:`int<class_int>`                                          | :ref:`keyboard_get_current_layout<class_DisplayServer_method_keyboard_get_current_layout>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                  |
    182. 

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

  183.    | :ref:`Key<enum_@GlobalScope_Key>`                              | :ref:`keyboard_get_keycode_from_physical<class_DisplayServer_method_keyboard_get_keycode_from_physical>` **(** :ref:`Key<enum_@GlobalScope_Key>` keycode **)** |const|                                                                                                                                                                                                                                                                                                          |
    184. 

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

  185.    | :ref:`int<class_int>`                                          | :ref:`keyboard_get_layout_count<class_DisplayServer_method_keyboard_get_layout_count>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                      |
    186. 

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

  187.    | :ref:`String<class_String>`                                    | :ref:`keyboard_get_layout_language<class_DisplayServer_method_keyboard_get_layout_language>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                                                                                                                                                                                                    |
    188. 

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

  189.    | :ref:`String<class_String>`                                    | :ref:`keyboard_get_layout_name<class_DisplayServer_method_keyboard_get_layout_name>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                                                                                                                                                                                                            |
    190. 

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

  191.    | void                                                           | :ref:`keyboard_set_current_layout<class_DisplayServer_method_keyboard_set_current_layout>` **(** :ref:`int<class_int>` index **)**                                                                                                                                                                                                                                                                                                                                              |
    192. 

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

  193.    | :ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>`      | :ref:`mouse_get_button_state<class_DisplayServer_method_mouse_get_button_state>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                            |
    194. 

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

  195.    | :ref:`MouseMode<enum_DisplayServer_MouseMode>`                 | :ref:`mouse_get_mode<class_DisplayServer_method_mouse_get_mode>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                            |
    196. 

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

  197.    | :ref:`Vector2i<class_Vector2i>`                                | :ref:`mouse_get_position<class_DisplayServer_method_mouse_get_position>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                    |
    198. 

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

  199.    | void                                                           | :ref:`mouse_set_mode<class_DisplayServer_method_mouse_set_mode>` **(** :ref:`MouseMode<enum_DisplayServer_MouseMode>` mouse_mode **)**                                                                                                                                                                                                                                                                                                                                          |
    200. 

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

  201.    | void                                                           | :ref:`process_events<class_DisplayServer_method_process_events>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                    |
    202. 

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

  203.    | :ref:`int<class_int>`                                          | :ref:`screen_get_dpi<class_DisplayServer_method_screen_get_dpi>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                                            |
    204. 

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

  205.    | :ref:`Image<class_Image>`                                      | :ref:`screen_get_image<class_DisplayServer_method_screen_get_image>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                                        |
    206. 

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

  207.    | :ref:`float<class_float>`                                      | :ref:`screen_get_max_scale<class_DisplayServer_method_screen_get_max_scale>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                |
    208. 

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

  209.    | :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` | :ref:`screen_get_orientation<class_DisplayServer_method_screen_get_orientation>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                            |
    210. 

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

  211.    | :ref:`Color<class_Color>`                                      | :ref:`screen_get_pixel<class_DisplayServer_method_screen_get_pixel>` **(** :ref:`Vector2i<class_Vector2i>` position **)** |const|                                                                                                                                                                                                                                                                                                                                               |
    212. 

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

  213.    | :ref:`Vector2i<class_Vector2i>`                                | :ref:`screen_get_position<class_DisplayServer_method_screen_get_position>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                                  |
    214. 

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

  215.    | :ref:`float<class_float>`                                      | :ref:`screen_get_refresh_rate<class_DisplayServer_method_screen_get_refresh_rate>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                          |
    216. 

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

  217.    | :ref:`float<class_float>`                                      | :ref:`screen_get_scale<class_DisplayServer_method_screen_get_scale>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                                        |
    218. 

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

  219.    | :ref:`Vector2i<class_Vector2i>`                                | :ref:`screen_get_size<class_DisplayServer_method_screen_get_size>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                                          |
    220. 

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

  221.    | :ref:`Rect2i<class_Rect2i>`                                    | :ref:`screen_get_usable_rect<class_DisplayServer_method_screen_get_usable_rect>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                            |
    222. 

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

  223.    | :ref:`bool<class_bool>`                                        | :ref:`screen_is_kept_on<class_DisplayServer_method_screen_is_kept_on>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                      |
    224. 

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

  225.    | void                                                           | :ref:`screen_set_keep_on<class_DisplayServer_method_screen_set_keep_on>` **(** :ref:`bool<class_bool>` enable **)**                                                                                                                                                                                                                                                                                                                                                             |
    226. 

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

  227.    | void                                                           | :ref:`screen_set_orientation<class_DisplayServer_method_screen_set_orientation>` **(** :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` orientation, :ref:`int<class_int>` screen=-1 **)**                                                                                                                                                                                                                                                                        |
    228. 

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

  229.    | void                                                           | :ref:`set_icon<class_DisplayServer_method_set_icon>` **(** :ref:`Image<class_Image>` image **)**                                                                                                                                                                                                                                                                                                                                                                                |
    230. 

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

  231.    | void                                                           | :ref:`set_native_icon<class_DisplayServer_method_set_native_icon>` **(** :ref:`String<class_String>` filename **)**                                                                                                                                                                                                                                                                                                                                                             |
    232. 

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

  233.    | :ref:`String<class_String>`                                    | :ref:`tablet_get_current_driver<class_DisplayServer_method_tablet_get_current_driver>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                      |
    234. 

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

  235.    | :ref:`int<class_int>`                                          | :ref:`tablet_get_driver_count<class_DisplayServer_method_tablet_get_driver_count>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                          |
    236. 

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

  237.    | :ref:`String<class_String>`                                    | :ref:`tablet_get_driver_name<class_DisplayServer_method_tablet_get_driver_name>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                                                                  |
    238. 

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

  239.    | void                                                           | :ref:`tablet_set_current_driver<class_DisplayServer_method_tablet_set_current_driver>` **(** :ref:`String<class_String>` name **)**                                                                                                                                                                                                                                                                                                                                             |
    240. 

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

  241.    | :ref:`Dictionary[]<class_Dictionary>`                          | :ref:`tts_get_voices<class_DisplayServer_method_tts_get_voices>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                            |
    242. 

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

  243.    | :ref:`PackedStringArray<class_PackedStringArray>`              | :ref:`tts_get_voices_for_language<class_DisplayServer_method_tts_get_voices_for_language>` **(** :ref:`String<class_String>` language **)** |const|                                                                                                                                                                                                                                                                                                                             |
    244. 

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

  245.    | :ref:`bool<class_bool>`                                        | :ref:`tts_is_paused<class_DisplayServer_method_tts_is_paused>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                              |
    246. 

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

  247.    | :ref:`bool<class_bool>`                                        | :ref:`tts_is_speaking<class_DisplayServer_method_tts_is_speaking>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                          |
    248. 

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

  249.    | void                                                           | :ref:`tts_pause<class_DisplayServer_method_tts_pause>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                              |
    250. 

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

  251.    | void                                                           | :ref:`tts_resume<class_DisplayServer_method_tts_resume>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                            |
    252. 

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

  253.    | void                                                           | :ref:`tts_set_utterance_callback<class_DisplayServer_method_tts_set_utterance_callback>` **(** :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` event, :ref:`Callable<class_Callable>` callable **)**                                                                                                                                                                                                                                                             |
    254. 

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

  255.    | void                                                           | :ref:`tts_speak<class_DisplayServer_method_tts_speak>` **(** :ref:`String<class_String>` text, :ref:`String<class_String>` voice, :ref:`int<class_int>` volume=50, :ref:`float<class_float>` pitch=1.0, :ref:`float<class_float>` rate=1.0, :ref:`int<class_int>` utterance_id=0, :ref:`bool<class_bool>` interrupt=false **)**                                                                                                                                                 |
    256. 

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

  257.    | void                                                           | :ref:`tts_stop<class_DisplayServer_method_tts_stop>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                                |
    258. 

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

  259.    | :ref:`int<class_int>`                                          | :ref:`virtual_keyboard_get_height<class_DisplayServer_method_virtual_keyboard_get_height>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                  |
    260. 

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

  261.    | void                                                           | :ref:`virtual_keyboard_hide<class_DisplayServer_method_virtual_keyboard_hide>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                      |
    262. 

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

  263.    | void                                                           | :ref:`virtual_keyboard_show<class_DisplayServer_method_virtual_keyboard_show>` **(** :ref:`String<class_String>` existing_text, :ref:`Rect2<class_Rect2>` position=Rect2(0, 0, 0, 0), :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` type=0, :ref:`int<class_int>` max_length=-1, :ref:`int<class_int>` cursor_start=-1, :ref:`int<class_int>` cursor_end=-1 **)**                                                                                          |
    264. 

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

  265.    | void                                                           | :ref:`warp_mouse<class_DisplayServer_method_warp_mouse>` **(** :ref:`Vector2i<class_Vector2i>` position **)**                                                                                                                                                                                                                                                                                                                                                                   |
    266. 

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

  267.    | :ref:`bool<class_bool>`                                        | :ref:`window_can_draw<class_DisplayServer_method_window_can_draw>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                        |
    268. 

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

  269.    | :ref:`int<class_int>`                                          | :ref:`window_get_active_popup<class_DisplayServer_method_window_get_active_popup>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                          |
    270. 

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

  271.    | :ref:`int<class_int>`                                          | :ref:`window_get_attached_instance_id<class_DisplayServer_method_window_get_attached_instance_id>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                        |
    272. 

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

  273.    | :ref:`int<class_int>`                                          | :ref:`window_get_current_screen<class_DisplayServer_method_window_get_current_screen>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                    |
    274. 

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

  275.    | :ref:`bool<class_bool>`                                        | :ref:`window_get_flag<class_DisplayServer_method_window_get_flag>` **(** :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` flag, :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                               |
    276. 

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

  277.    | :ref:`Vector2i<class_Vector2i>`                                | :ref:`window_get_max_size<class_DisplayServer_method_window_get_max_size>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                |
    278. 

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

  279.    | :ref:`Vector2i<class_Vector2i>`                                | :ref:`window_get_min_size<class_DisplayServer_method_window_get_min_size>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                |
    280. 

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

  281.    | :ref:`WindowMode<enum_DisplayServer_WindowMode>`               | :ref:`window_get_mode<class_DisplayServer_method_window_get_mode>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                        |
    282. 

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

  283.    | :ref:`int<class_int>`                                          | :ref:`window_get_native_handle<class_DisplayServer_method_window_get_native_handle>` **(** :ref:`HandleType<enum_DisplayServer_HandleType>` handle_type, :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                        |
    284. 

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

  285.    | :ref:`Rect2i<class_Rect2i>`                                    | :ref:`window_get_popup_safe_rect<class_DisplayServer_method_window_get_popup_safe_rect>` **(** :ref:`int<class_int>` window **)** |const|                                                                                                                                                                                                                                                                                                                                       |
    286. 

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

  287.    | :ref:`Vector2i<class_Vector2i>`                                | :ref:`window_get_position<class_DisplayServer_method_window_get_position>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                |
    288. 

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

  289.    | :ref:`Vector2i<class_Vector2i>`                                | :ref:`window_get_position_with_decorations<class_DisplayServer_method_window_get_position_with_decorations>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                              |
    290. 

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

  291.    | :ref:`Vector3i<class_Vector3i>`                                | :ref:`window_get_safe_title_margins<class_DisplayServer_method_window_get_safe_title_margins>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                            |
    292. 

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

  293.    | :ref:`Vector2i<class_Vector2i>`                                | :ref:`window_get_size<class_DisplayServer_method_window_get_size>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                        |
    294. 

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

  295.    | :ref:`Vector2i<class_Vector2i>`                                | :ref:`window_get_size_with_decorations<class_DisplayServer_method_window_get_size_with_decorations>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                      |
    296. 

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

  297.    | :ref:`VSyncMode<enum_DisplayServer_VSyncMode>`                 | :ref:`window_get_vsync_mode<class_DisplayServer_method_window_get_vsync_mode>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                            |
    298. 

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

  299.    | :ref:`bool<class_bool>`                                        | :ref:`window_is_maximize_allowed<class_DisplayServer_method_window_is_maximize_allowed>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                  |
    300. 

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

  301.    | :ref:`bool<class_bool>`                                        | :ref:`window_maximize_on_title_dbl_click<class_DisplayServer_method_window_maximize_on_title_dbl_click>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                    |
    302. 

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

  303.    | :ref:`bool<class_bool>`                                        | :ref:`window_minimize_on_title_dbl_click<class_DisplayServer_method_window_minimize_on_title_dbl_click>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                    |
    304. 

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

  305.    | void                                                           | :ref:`window_move_to_foreground<class_DisplayServer_method_window_move_to_foreground>` **(** :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                                            |
    306. 

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

  307.    | void                                                           | :ref:`window_request_attention<class_DisplayServer_method_window_request_attention>` **(** :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                                              |
    308. 

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

  309.    | void                                                           | :ref:`window_set_current_screen<class_DisplayServer_method_window_set_current_screen>` **(** :ref:`int<class_int>` screen, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                              |
    310. 

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

  311.    | void                                                           | :ref:`window_set_drop_files_callback<class_DisplayServer_method_window_set_drop_files_callback>` **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                        |
    312. 

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

  313.    | void                                                           | :ref:`window_set_exclusive<class_DisplayServer_method_window_set_exclusive>` **(** :ref:`int<class_int>` window_id, :ref:`bool<class_bool>` exclusive **)**                                                                                                                                                                                                                                                                                                                     |
    314. 

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

  315.    | void                                                           | :ref:`window_set_flag<class_DisplayServer_method_window_set_flag>` **(** :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` flag, :ref:`bool<class_bool>` enabled, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                      |
    316. 

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

  317.    | void                                                           | :ref:`window_set_ime_active<class_DisplayServer_method_window_set_ime_active>` **(** :ref:`bool<class_bool>` active, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                    |
    318. 

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

  319.    | void                                                           | :ref:`window_set_ime_position<class_DisplayServer_method_window_set_ime_position>` **(** :ref:`Vector2i<class_Vector2i>` position, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                      |
    320. 

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

  321.    | void                                                           | :ref:`window_set_input_event_callback<class_DisplayServer_method_window_set_input_event_callback>` **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                      |
    322. 

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

  323.    | void                                                           | :ref:`window_set_input_text_callback<class_DisplayServer_method_window_set_input_text_callback>` **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                        |
    324. 

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

  325.    | void                                                           | :ref:`window_set_max_size<class_DisplayServer_method_window_set_max_size>` **(** :ref:`Vector2i<class_Vector2i>` max_size, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                              |
    326. 

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

  327.    | void                                                           | :ref:`window_set_min_size<class_DisplayServer_method_window_set_min_size>` **(** :ref:`Vector2i<class_Vector2i>` min_size, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                              |
    328. 

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

  329.    | void                                                           | :ref:`window_set_mode<class_DisplayServer_method_window_set_mode>` **(** :ref:`WindowMode<enum_DisplayServer_WindowMode>` mode, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                         |
    330. 

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

  331.    | void                                                           | :ref:`window_set_mouse_passthrough<class_DisplayServer_method_window_set_mouse_passthrough>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` region, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                          |
    332. 

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

  333.    | void                                                           | :ref:`window_set_popup_safe_rect<class_DisplayServer_method_window_set_popup_safe_rect>` **(** :ref:`int<class_int>` window, :ref:`Rect2i<class_Rect2i>` rect **)**                                                                                                                                                                                                                                                                                                             |
    334. 

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

  335.    | void                                                           | :ref:`window_set_position<class_DisplayServer_method_window_set_position>` **(** :ref:`Vector2i<class_Vector2i>` position, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                              |
    336. 

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

  337.    | void                                                           | :ref:`window_set_rect_changed_callback<class_DisplayServer_method_window_set_rect_changed_callback>` **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                    |
    338. 

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

  339.    | void                                                           | :ref:`window_set_size<class_DisplayServer_method_window_set_size>` **(** :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                          |
    340. 

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

  341.    | void                                                           | :ref:`window_set_title<class_DisplayServer_method_window_set_title>` **(** :ref:`String<class_String>` title, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                           |
    342. 

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

  343.    | void                                                           | :ref:`window_set_transient<class_DisplayServer_method_window_set_transient>` **(** :ref:`int<class_int>` window_id, :ref:`int<class_int>` parent_window_id **)**                                                                                                                                                                                                                                                                                                                |
    344. 

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

  345.    | void                                                           | :ref:`window_set_vsync_mode<class_DisplayServer_method_window_set_vsync_mode>` **(** :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` vsync_mode, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                         |
    346. 

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

  347.    | void                                                           | :ref:`window_set_window_buttons_offset<class_DisplayServer_method_window_set_window_buttons_offset>` **(** :ref:`Vector2i<class_Vector2i>` offset, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                      |
    348. 

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

  349.    | void                                                           | :ref:`window_set_window_event_callback<class_DisplayServer_method_window_set_window_event_callback>` **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                    |
    350. 

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

  351. 

  352. .. rst-class:: classref-section-separator
    353. 

  353. 

  354. ----
    355. 

  355. 

  356. .. rst-class:: classref-descriptions-group
    357. 

  357. 

  358. Enumerations
    359. 

  359. ------------
    360. 

  360. 

  361. .. _enum_DisplayServer_Feature:
    362. 

  362. 

  363. .. rst-class:: classref-enumeration
    364. 

  364. 

  365. enum **Feature**:
    366. 

  366. 

  367. .. _class_DisplayServer_constant_FEATURE_GLOBAL_MENU:
    368. 

  368. 

  369. .. rst-class:: classref-enumeration-constant
    370. 

  370. 

  371. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_GLOBAL_MENU** = ``0``
    372. 

  372. 

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

  374. 

  375. .. _class_DisplayServer_constant_FEATURE_SUBWINDOWS:
    376. 

  376. 

  377. .. rst-class:: classref-enumeration-constant
    378. 

  378. 

  379. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SUBWINDOWS** = ``1``
    380. 

  380. 

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

  382. 

  383. .. _class_DisplayServer_constant_FEATURE_TOUCHSCREEN:
    384. 

  384. 

  385. .. rst-class:: classref-enumeration-constant
    386. 

  386. 

  387. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TOUCHSCREEN** = ``2``
    388. 

  388. 

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

  390. 

  391. .. _class_DisplayServer_constant_FEATURE_MOUSE:
    392. 

  392. 

  393. .. rst-class:: classref-enumeration-constant
    394. 

  394. 

  395. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE** = ``3``
    396. 

  396. 

  397. Display server supports mouse input. **Windows, macOS, Linux (X11), Android, Web**
    398. 

  398. 

  399. .. _class_DisplayServer_constant_FEATURE_MOUSE_WARP:
    400. 

  400. 

  401. .. rst-class:: classref-enumeration-constant
    402. 

  402. 

  403. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE_WARP** = ``4``
    404. 

  404. 

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

  406. 

  407. .. _class_DisplayServer_constant_FEATURE_CLIPBOARD:
    408. 

  408. 

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

  410. 

  411. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD** = ``5``
    412. 

  412. 

  413. Display server supports setting and getting clipboard data. See also :ref:`FEATURE_CLIPBOARD_PRIMARY<class_DisplayServer_constant_FEATURE_CLIPBOARD_PRIMARY>`. **Windows, macOS, Linux (X11), Android, iOS, Web**
    414. 

  414. 

  415. .. _class_DisplayServer_constant_FEATURE_VIRTUAL_KEYBOARD:
    416. 

  416. 

  417. .. rst-class:: classref-enumeration-constant
    418. 

  418. 

  419. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_VIRTUAL_KEYBOARD** = ``6``
    420. 

  420. 

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

  422. 

  423. .. _class_DisplayServer_constant_FEATURE_CURSOR_SHAPE:
    424. 

  424. 

  425. .. rst-class:: classref-enumeration-constant
    426. 

  426. 

  427. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CURSOR_SHAPE** = ``7``
    428. 

  428. 

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

  430. 

  431. .. _class_DisplayServer_constant_FEATURE_CUSTOM_CURSOR_SHAPE:
    432. 

  432. 

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

  434. 

  435. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CUSTOM_CURSOR_SHAPE** = ``8``
    436. 

  436. 

  437. Display server supports setting the mouse cursor shape to a custom image. **Windows, macOS, Linux (X11), Web**
    438. 

  438. 

  439. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG:
    440. 

  440. 

  441. .. rst-class:: classref-enumeration-constant
    442. 

  442. 

  443. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG** = ``9``
    444. 

  444. 

  445. Display server supports spawning dialogs using the operating system's native look-and-feel. **macOS**
    446. 

  446. 

  447. .. _class_DisplayServer_constant_FEATURE_IME:
    448. 

  448. 

  449. .. rst-class:: classref-enumeration-constant
    450. 

  450. 

  451. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_IME** = ``10``
    452. 

  452. 

  453. 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)**
    454. 

  454. 

  455. .. _class_DisplayServer_constant_FEATURE_WINDOW_TRANSPARENCY:
    456. 

  456. 

  457. .. rst-class:: classref-enumeration-constant
    458. 

  458. 

  459. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_TRANSPARENCY** = ``11``
    460. 

  460. 

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

  462. 

  463. .. _class_DisplayServer_constant_FEATURE_HIDPI:
    464. 

  464. 

  465. .. rst-class:: classref-enumeration-constant
    466. 

  466. 

  467. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_HIDPI** = ``12``
    468. 

  468. 

  469. 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, macOS**
    470. 

  470. 

  471. .. _class_DisplayServer_constant_FEATURE_ICON:
    472. 

  472. 

  473. .. rst-class:: classref-enumeration-constant
    474. 

  474. 

  475. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ICON** = ``13``
    476. 

  476. 

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

  478. 

  479. .. _class_DisplayServer_constant_FEATURE_NATIVE_ICON:
    480. 

  480. 

  481. .. rst-class:: classref-enumeration-constant
    482. 

  482. 

  483. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_ICON** = ``14``
    484. 

  484. 

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

  486. 

  487. .. _class_DisplayServer_constant_FEATURE_ORIENTATION:
    488. 

  488. 

  489. .. rst-class:: classref-enumeration-constant
    490. 

  490. 

  491. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ORIENTATION** = ``15``
    492. 

  492. 

  493. Display server supports changing the screen orientation. **Android, iOS**
    494. 

  494. 

  495. .. _class_DisplayServer_constant_FEATURE_SWAP_BUFFERS:
    496. 

  496. 

  497. .. rst-class:: classref-enumeration-constant
    498. 

  498. 

  499. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SWAP_BUFFERS** = ``16``
    500. 

  500. 

  501. 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)**
    502. 

  502. 

  503. .. _class_DisplayServer_constant_FEATURE_CLIPBOARD_PRIMARY:
    504. 

  504. 

  505. .. rst-class:: classref-enumeration-constant
    506. 

  506. 

  507. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD_PRIMARY** = ``18``
    508. 

  508. 

  509. Display server supports Primary clipboard can be used. This is a different clipboard from :ref:`FEATURE_CLIPBOARD<class_DisplayServer_constant_FEATURE_CLIPBOARD>`. **Linux (X11)**
    510. 

  510. 

  511. .. _class_DisplayServer_constant_FEATURE_TEXT_TO_SPEECH:
    512. 

  512. 

  513. .. rst-class:: classref-enumeration-constant
    514. 

  514. 

  515. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TEXT_TO_SPEECH** = ``19``
    516. 

  516. 

  517. Display server supports text-to-speech. See ``tts_*`` methods. **Windows, macOS, Linux (X11), Android, iOS, Web**
    518. 

  518. 

  519. .. _class_DisplayServer_constant_FEATURE_EXTEND_TO_TITLE:
    520. 

  520. 

  521. .. rst-class:: classref-enumeration-constant
    522. 

  522. 

  523. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_EXTEND_TO_TITLE** = ``20``
    524. 

  524. 

  525. 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**
    526. 

  526. 

  527. .. _class_DisplayServer_constant_FEATURE_SCREEN_CAPTURE:
    528. 

  528. 

  529. .. rst-class:: classref-enumeration-constant
    530. 

  530. 

  531. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SCREEN_CAPTURE** = ``21``
    532. 

  532. 

  533. Display server supports reading screen pixels. See :ref:`screen_get_pixel<class_DisplayServer_method_screen_get_pixel>`.
    534. 

  534. 

  535. .. rst-class:: classref-item-separator
    536. 

  536. 

  537. ----
    538. 

  538. 

  539. .. _enum_DisplayServer_MouseMode:
    540. 

  540. 

  541. .. rst-class:: classref-enumeration
    542. 

  542. 

  543. enum **MouseMode**:
    544. 

  544. 

  545. .. _class_DisplayServer_constant_MOUSE_MODE_VISIBLE:
    546. 

  546. 

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

  548. 

  549. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_VISIBLE** = ``0``
    550. 

  550. 

  551. Makes the mouse cursor visible if it is hidden.
    552. 

  552. 

  553. .. _class_DisplayServer_constant_MOUSE_MODE_HIDDEN:
    554. 

  554. 

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

  556. 

  557. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_HIDDEN** = ``1``
    558. 

  558. 

  559. Makes the mouse cursor hidden if it is visible.
    560. 

  560. 

  561. .. _class_DisplayServer_constant_MOUSE_MODE_CAPTURED:
    562. 

  562. 

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

  564. 

  565. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CAPTURED** = ``2``
    566. 

  566. 

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

  568. 

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

  570. 

  571. .. _class_DisplayServer_constant_MOUSE_MODE_CONFINED:
    572. 

  572. 

  573. .. rst-class:: classref-enumeration-constant
    574. 

  574. 

  575. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED** = ``3``
    576. 

  576. 

  577. Confines the mouse cursor to the game window, and make it visible.
    578. 

  578. 

  579. .. _class_DisplayServer_constant_MOUSE_MODE_CONFINED_HIDDEN:
    580. 

  580. 

  581. .. rst-class:: classref-enumeration-constant
    582. 

  582. 

  583. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED_HIDDEN** = ``4``
    584. 

  584. 

  585. Confines the mouse cursor to the game window, and make it hidden.
    586. 

  586. 

  587. .. rst-class:: classref-item-separator
    588. 

  588. 

  589. ----
    590. 

  590. 

  591. .. _enum_DisplayServer_ScreenOrientation:
    592. 

  592. 

  593. .. rst-class:: classref-enumeration
    594. 

  594. 

  595. enum **ScreenOrientation**:
    596. 

  596. 

  597. .. _class_DisplayServer_constant_SCREEN_LANDSCAPE:
    598. 

  598. 

  599. .. rst-class:: classref-enumeration-constant
    600. 

  600. 

  601. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_LANDSCAPE** = ``0``
    602. 

  602. 

  603. Default landscape orientation.
    604. 

  604. 

  605. .. _class_DisplayServer_constant_SCREEN_PORTRAIT:
    606. 

  606. 

  607. .. rst-class:: classref-enumeration-constant
    608. 

  608. 

  609. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_PORTRAIT** = ``1``
    610. 

  610. 

  611. Default portrait orientation.
    612. 

  612. 

  613. .. _class_DisplayServer_constant_SCREEN_REVERSE_LANDSCAPE:
    614. 

  614. 

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

  616. 

  617. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_LANDSCAPE** = ``2``
    618. 

  618. 

  619. Reverse landscape orientation (upside down).
    620. 

  620. 

  621. .. _class_DisplayServer_constant_SCREEN_REVERSE_PORTRAIT:
    622. 

  622. 

  623. .. rst-class:: classref-enumeration-constant
    624. 

  624. 

  625. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_PORTRAIT** = ``3``
    626. 

  626. 

  627. Reverse portrait orientation (upside down).
    628. 

  628. 

  629. .. _class_DisplayServer_constant_SCREEN_SENSOR_LANDSCAPE:
    630. 

  630. 

  631. .. rst-class:: classref-enumeration-constant
    632. 

  632. 

  633. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_LANDSCAPE** = ``4``
    634. 

  634. 

  635. Automatic landscape orientation (default or reverse depending on sensor).
    636. 

  636. 

  637. .. _class_DisplayServer_constant_SCREEN_SENSOR_PORTRAIT:
    638. 

  638. 

  639. .. rst-class:: classref-enumeration-constant
    640. 

  640. 

  641. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_PORTRAIT** = ``5``
    642. 

  642. 

  643. Automatic portrait orientation (default or reverse depending on sensor).
    644. 

  644. 

  645. .. _class_DisplayServer_constant_SCREEN_SENSOR:
    646. 

  646. 

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

  648. 

  649. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR** = ``6``
    650. 

  650. 

  651. Automatic landscape or portrait orientation (default or reverse depending on sensor).
    652. 

  652. 

  653. .. rst-class:: classref-item-separator
    654. 

  654. 

  655. ----
    656. 

  656. 

  657. .. _enum_DisplayServer_VirtualKeyboardType:
    658. 

  658. 

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

  660. 

  661. enum **VirtualKeyboardType**:
    662. 

  662. 

  663. .. _class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT:
    664. 

  664. 

  665. .. rst-class:: classref-enumeration-constant
    666. 

  666. 

  667. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_DEFAULT** = ``0``
    668. 

  668. 

  669. Default text virtual keyboard.
    670. 

  670. 

  671. .. _class_DisplayServer_constant_KEYBOARD_TYPE_MULTILINE:
    672. 

  672. 

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

  674. 

  675. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_MULTILINE** = ``1``
    676. 

  676. 

  677. Multiline virtual keyboard.
    678. 

  678. 

  679. .. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER:
    680. 

  680. 

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

  682. 

  683. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER** = ``2``
    684. 

  684. 

  685. Virtual number keypad, useful for PIN entry.
    686. 

  686. 

  687. .. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER_DECIMAL:
    688. 

  688. 

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

  690. 

  691. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER_DECIMAL** = ``3``
    692. 

  692. 

  693. Virtual number keypad, useful for entering fractional numbers.
    694. 

  694. 

  695. .. _class_DisplayServer_constant_KEYBOARD_TYPE_PHONE:
    696. 

  696. 

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

  698. 

  699. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PHONE** = ``4``
    700. 

  700. 

  701. Virtual phone number keypad.
    702. 

  702. 

  703. .. _class_DisplayServer_constant_KEYBOARD_TYPE_EMAIL_ADDRESS:
    704. 

  704. 

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

  706. 

  707. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_EMAIL_ADDRESS** = ``5``
    708. 

  708. 

  709. Virtual keyboard with additional keys to assist with typing email addresses.
    710. 

  710. 

  711. .. _class_DisplayServer_constant_KEYBOARD_TYPE_PASSWORD:
    712. 

  712. 

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

  714. 

  715. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PASSWORD** = ``6``
    716. 

  716. 

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

  718. 

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

  720. 

  721. .. _class_DisplayServer_constant_KEYBOARD_TYPE_URL:
    722. 

  722. 

  723. .. rst-class:: classref-enumeration-constant
    724. 

  724. 

  725. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_URL** = ``7``
    726. 

  726. 

  727. Virtual keyboard with additional keys to assist with typing URLs.
    728. 

  728. 

  729. .. rst-class:: classref-item-separator
    730. 

  730. 

  731. ----
    732. 

  732. 

  733. .. _enum_DisplayServer_CursorShape:
    734. 

  734. 

  735. .. rst-class:: classref-enumeration
    736. 

  736. 

  737. enum **CursorShape**:
    738. 

  738. 

  739. .. _class_DisplayServer_constant_CURSOR_ARROW:
    740. 

  740. 

  741. .. rst-class:: classref-enumeration-constant
    742. 

  742. 

  743. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_ARROW** = ``0``
    744. 

  744. 

  745. 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>`.
    746. 

  746. 

  747. .. _class_DisplayServer_constant_CURSOR_IBEAM:
    748. 

  748. 

  749. .. rst-class:: classref-enumeration-constant
    750. 

  750. 

  751. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_IBEAM** = ``1``
    752. 

  752. 

  753. 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>`.
    754. 

  754. 

  755. .. _class_DisplayServer_constant_CURSOR_POINTING_HAND:
    756. 

  756. 

  757. .. rst-class:: classref-enumeration-constant
    758. 

  758. 

  759. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_POINTING_HAND** = ``2``
    760. 

  760. 

  761. 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>`.
    762. 

  762. 

  763. .. _class_DisplayServer_constant_CURSOR_CROSS:
    764. 

  764. 

  765. .. rst-class:: classref-enumeration-constant
    766. 

  766. 

  767. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CROSS** = ``3``
    768. 

  768. 

  769. 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.
    770. 

  770. 

  771. .. _class_DisplayServer_constant_CURSOR_WAIT:
    772. 

  772. 

  773. .. rst-class:: classref-enumeration-constant
    774. 

  774. 

  775. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_WAIT** = ``4``
    776. 

  776. 

  777. 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>`.
    778. 

  778. 

  779. .. _class_DisplayServer_constant_CURSOR_BUSY:
    780. 

  780. 

  781. .. rst-class:: classref-enumeration-constant
    782. 

  782. 

  783. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BUSY** = ``5``
    784. 

  784. 

  785. 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>`.
    786. 

  786. 

  787. .. _class_DisplayServer_constant_CURSOR_DRAG:
    788. 

  788. 

  789. .. rst-class:: classref-enumeration-constant
    790. 

  790. 

  791. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_DRAG** = ``6``
    792. 

  792. 

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

  794. 

  795. .. _class_DisplayServer_constant_CURSOR_CAN_DROP:
    796. 

  796. 

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

  798. 

  799. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CAN_DROP** = ``7``
    800. 

  800. 

  801. "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>`.
    802. 

  802. 

  803. .. _class_DisplayServer_constant_CURSOR_FORBIDDEN:
    804. 

  804. 

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

  806. 

  807. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FORBIDDEN** = ``8``
    808. 

  808. 

  809. 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.
    810. 

  810. 

  811. .. _class_DisplayServer_constant_CURSOR_VSIZE:
    812. 

  812. 

  813. .. rst-class:: classref-enumeration-constant
    814. 

  814. 

  815. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSIZE** = ``9``
    816. 

  816. 

  817. 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>`.
    818. 

  818. 

  819. .. _class_DisplayServer_constant_CURSOR_HSIZE:
    820. 

  820. 

  821. .. rst-class:: classref-enumeration-constant
    822. 

  822. 

  823. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSIZE** = ``10``
    824. 

  824. 

  825. 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>`.
    826. 

  826. 

  827. .. _class_DisplayServer_constant_CURSOR_BDIAGSIZE:
    828. 

  828. 

  829. .. rst-class:: classref-enumeration-constant
    830. 

  830. 

  831. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BDIAGSIZE** = ``11``
    832. 

  832. 

  833. 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.
    834. 

  834. 

  835. .. _class_DisplayServer_constant_CURSOR_FDIAGSIZE:
    836. 

  836. 

  837. .. rst-class:: classref-enumeration-constant
    838. 

  838. 

  839. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FDIAGSIZE** = ``12``
    840. 

  840. 

  841. 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.
    842. 

  842. 

  843. .. _class_DisplayServer_constant_CURSOR_MOVE:
    844. 

  844. 

  845. .. rst-class:: classref-enumeration-constant
    846. 

  846. 

  847. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MOVE** = ``13``
    848. 

  848. 

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

  850. 

  851. .. _class_DisplayServer_constant_CURSOR_VSPLIT:
    852. 

  852. 

  853. .. rst-class:: classref-enumeration-constant
    854. 

  854. 

  855. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSPLIT** = ``14``
    856. 

  856. 

  857. 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>`.
    858. 

  858. 

  859. .. _class_DisplayServer_constant_CURSOR_HSPLIT:
    860. 

  860. 

  861. .. rst-class:: classref-enumeration-constant
    862. 

  862. 

  863. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSPLIT** = ``15``
    864. 

  864. 

  865. 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>`.
    866. 

  866. 

  867. .. _class_DisplayServer_constant_CURSOR_HELP:
    868. 

  868. 

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

  870. 

  871. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HELP** = ``16``
    872. 

  872. 

  873. 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.
    874. 

  874. 

  875. .. _class_DisplayServer_constant_CURSOR_MAX:
    876. 

  876. 

  877. .. rst-class:: classref-enumeration-constant
    878. 

  878. 

  879. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MAX** = ``17``
    880. 

  880. 

  881. Represents the size of the :ref:`CursorShape<enum_DisplayServer_CursorShape>` enum.
    882. 

  882. 

  883. .. rst-class:: classref-item-separator
    884. 

  884. 

  885. ----
    886. 

  886. 

  887. .. _enum_DisplayServer_WindowMode:
    888. 

  888. 

  889. .. rst-class:: classref-enumeration
    890. 

  890. 

  891. enum **WindowMode**:
    892. 

  892. 

  893. .. _class_DisplayServer_constant_WINDOW_MODE_WINDOWED:
    894. 

  894. 

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

  896. 

  897. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_WINDOWED** = ``0``
    898. 

  898. 

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

  900. 

  901. .. _class_DisplayServer_constant_WINDOW_MODE_MINIMIZED:
    902. 

  902. 

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

  904. 

  905. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MINIMIZED** = ``1``
    906. 

  906. 

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

  908. 

  909. .. _class_DisplayServer_constant_WINDOW_MODE_MAXIMIZED:
    910. 

  910. 

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

  912. 

  913. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MAXIMIZED** = ``2``
    914. 

  914. 

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

  916. 

  917. .. _class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN:
    918. 

  918. 

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

  920. 

  921. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_FULLSCREEN** = ``3``
    922. 

  922. 

  923. Full screen mode with full multi-window support.
    924. 

  924. 

  925. Full screen window cover the entire display area of a screen, have no border or decorations. Display video mode is not changed.
    926. 

  926. 

  927. \ **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.
    928. 

  928. 

  929. .. _class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN:
    930. 

  930. 

  931. .. rst-class:: classref-enumeration-constant
    932. 

  932. 

  933. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_EXCLUSIVE_FULLSCREEN** = ``4``
    934. 

  934. 

  935. 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).
    936. 

  936. 

  937. Full screen window cover the entire display area of a screen, have no border or decorations. Display video mode is not changed.
    938. 

  938. 

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

  940. 

  941. \ **On macOS:** Exclusive full screen mode prevents Dock and Menu from showing up when the mouse pointer is hovering the edge of the screen.
    942. 

  942. 

  943. \ **On Linux (X11):** Exclusive full screen mode bypasses compositor.
    944. 

  944. 

  945. \ **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.
    946. 

  946. 

  947. .. rst-class:: classref-item-separator
    948. 

  948. 

  949. ----
    950. 

  950. 

  951. .. _enum_DisplayServer_WindowFlags:
    952. 

  952. 

  953. .. rst-class:: classref-enumeration
    954. 

  954. 

  955. enum **WindowFlags**:
    956. 

  956. 

  957. .. _class_DisplayServer_constant_WINDOW_FLAG_RESIZE_DISABLED:
    958. 

  958. 

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

  960. 

  961. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_RESIZE_DISABLED** = ``0``
    962. 

  962. 

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

  964. 

  965. .. _class_DisplayServer_constant_WINDOW_FLAG_BORDERLESS:
    966. 

  966. 

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

  968. 

  969. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_BORDERLESS** = ``1``
    970. 

  970. 

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

  972. 

  973. .. _class_DisplayServer_constant_WINDOW_FLAG_ALWAYS_ON_TOP:
    974. 

  974. 

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

  976. 

  977. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_ALWAYS_ON_TOP** = ``2``
    978. 

  978. 

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

  980. 

  981. .. _class_DisplayServer_constant_WINDOW_FLAG_TRANSPARENT:
    982. 

  982. 

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

  984. 

  985. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_TRANSPARENT** = ``3``
    986. 

  986. 

  987. The window background can be transparent.
    988. 

  988. 

  989. \ **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``.
    990. 

  990. 

  991. \ **Note:** Transparency support is implemented on Linux (X11), macOS and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities.
    992. 

  992. 

  993. .. _class_DisplayServer_constant_WINDOW_FLAG_NO_FOCUS:
    994. 

  994. 

  995. .. rst-class:: classref-enumeration-constant
    996. 

  996. 

  997. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_NO_FOCUS** = ``4``
    998. 

  998. 

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

  1000. 

  1001. .. _class_DisplayServer_constant_WINDOW_FLAG_POPUP:
    1002. 

  1002. 

  1003. .. rst-class:: classref-enumeration-constant
    1004. 

  1004. 

  1005. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_POPUP** = ``5``
    1006. 

  1006. 

  1007. 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>`).
    1008. 

  1008. 

  1009. .. _class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE:
    1010. 

  1010. 

  1011. .. rst-class:: classref-enumeration-constant
    1012. 

  1012. 

  1013. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_EXTEND_TO_TITLE** = ``6``
    1014. 

  1014. 

  1015. 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.
    1016. 

  1016. 

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

  1018. 

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

  1020. 

  1021. \ **Note:** This flag is implemented only on macOS.
    1022. 

  1022. 

  1023. .. _class_DisplayServer_constant_WINDOW_FLAG_MOUSE_PASSTHROUGH:
    1024. 

  1024. 

  1025. .. rst-class:: classref-enumeration-constant
    1026. 

  1026. 

  1027. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MOUSE_PASSTHROUGH** = ``7``
    1028. 

  1028. 

  1029. All mouse events are passed to the underlying window of the same application.
    1030. 

  1030. 

  1031. .. _class_DisplayServer_constant_WINDOW_FLAG_MAX:
    1032. 

  1032. 

  1033. .. rst-class:: classref-enumeration-constant
    1034. 

  1034. 

  1035. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MAX** = ``8``
    1036. 

  1036. 

  1037. Max value of the :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`.
    1038. 

  1038. 

  1039. .. rst-class:: classref-item-separator
    1040. 

  1040. 

  1041. ----
    1042. 

  1042. 

  1043. .. _enum_DisplayServer_WindowEvent:
    1044. 

  1044. 

  1045. .. rst-class:: classref-enumeration
    1046. 

  1046. 

  1047. enum **WindowEvent**:
    1048. 

  1048. 

  1049. .. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_ENTER:
    1050. 

  1050. 

  1051. .. rst-class:: classref-enumeration-constant
    1052. 

  1052. 

  1053. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_ENTER** = ``0``
    1054. 

  1054. 

  1055. Sent when the mouse pointer enters the window, see :ref:`window_set_window_event_callback<class_DisplayServer_method_window_set_window_event_callback>`.
    1056. 

  1056. 

  1057. .. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_EXIT:
    1058. 

  1058. 

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

  1060. 

  1061. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_EXIT** = ``1``
    1062. 

  1062. 

  1063. Sent when the mouse pointer exits the window, see :ref:`window_set_window_event_callback<class_DisplayServer_method_window_set_window_event_callback>`.
    1064. 

  1064. 

  1065. .. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_IN:
    1066. 

  1066. 

  1067. .. rst-class:: classref-enumeration-constant
    1068. 

  1068. 

  1069. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_IN** = ``2``
    1070. 

  1070. 

  1071. Sent when the window grabs focus, see :ref:`window_set_window_event_callback<class_DisplayServer_method_window_set_window_event_callback>`.
    1072. 

  1072. 

  1073. .. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_OUT:
    1074. 

  1074. 

  1075. .. rst-class:: classref-enumeration-constant
    1076. 

  1076. 

  1077. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_OUT** = ``3``
    1078. 

  1078. 

  1079. Sent when the window loses focus, see :ref:`window_set_window_event_callback<class_DisplayServer_method_window_set_window_event_callback>`.
    1080. 

  1080. 

  1081. .. _class_DisplayServer_constant_WINDOW_EVENT_CLOSE_REQUEST:
    1082. 

  1082. 

  1083. .. rst-class:: classref-enumeration-constant
    1084. 

  1084. 

  1085. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_CLOSE_REQUEST** = ``4``
    1086. 

  1086. 

  1087. Sent when the user has attempted to close the window (e.g. close button is pressed), see :ref:`window_set_window_event_callback<class_DisplayServer_method_window_set_window_event_callback>`.
    1088. 

  1088. 

  1089. .. _class_DisplayServer_constant_WINDOW_EVENT_GO_BACK_REQUEST:
    1090. 

  1090. 

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

  1092. 

  1093. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_GO_BACK_REQUEST** = ``5``
    1094. 

  1094. 

  1095. Sent when the device "Back" button is pressed, see :ref:`window_set_window_event_callback<class_DisplayServer_method_window_set_window_event_callback>`.
    1096. 

  1096. 

  1097. \ **Note:** This event is implemented only on Android.
    1098. 

  1098. 

  1099. .. _class_DisplayServer_constant_WINDOW_EVENT_DPI_CHANGE:
    1100. 

  1100. 

  1101. .. rst-class:: classref-enumeration-constant
    1102. 

  1102. 

  1103. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_DPI_CHANGE** = ``6``
    1104. 

  1104. 

  1105. Sent when the window is moved to the display with different DPI, or display DPI is changed, see :ref:`window_set_window_event_callback<class_DisplayServer_method_window_set_window_event_callback>`.
    1106. 

  1106. 

  1107. \ **Note:** This flag is implemented only on macOS.
    1108. 

  1108. 

  1109. .. _class_DisplayServer_constant_WINDOW_EVENT_TITLEBAR_CHANGE:
    1110. 

  1110. 

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

  1112. 

  1113. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_TITLEBAR_CHANGE** = ``7``
    1114. 

  1114. 

  1115. 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), see :ref:`window_set_window_event_callback<class_DisplayServer_method_window_set_window_event_callback>`.
    1116. 

  1116. 

  1117. \ **Note:** This flag is implemented only on macOS.
    1118. 

  1118. 

  1119. .. rst-class:: classref-item-separator
    1120. 

  1120. 

  1121. ----
    1122. 

  1122. 

  1123. .. _enum_DisplayServer_VSyncMode:
    1124. 

  1124. 

  1125. .. rst-class:: classref-enumeration
    1126. 

  1126. 

  1127. enum **VSyncMode**:
    1128. 

  1128. 

  1129. .. _class_DisplayServer_constant_VSYNC_DISABLED:
    1130. 

  1130. 

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

  1132. 

  1133. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_DISABLED** = ``0``
    1134. 

  1134. 

  1135. No vertical synchronization, which means the engine will display frames as fast as possible (tearing may be visible). Framerate is unlimited (nonwithstanding :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
    1136. 

  1136. 

  1137. .. _class_DisplayServer_constant_VSYNC_ENABLED:
    1138. 

  1138. 

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

  1140. 

  1141. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ENABLED** = ``1``
    1142. 

  1142. 

  1143. 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 (nonwithstanding :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
    1144. 

  1144. 

  1145. .. _class_DisplayServer_constant_VSYNC_ADAPTIVE:
    1146. 

  1146. 

  1147. .. rst-class:: classref-enumeration-constant
    1148. 

  1148. 

  1149. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ADAPTIVE** = ``2``
    1150. 

  1150. 

  1151. 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 (nonwithstanding :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.
    1152. 

  1152. 

  1153. .. _class_DisplayServer_constant_VSYNC_MAILBOX:
    1154. 

  1154. 

  1155. .. rst-class:: classref-enumeration-constant
    1156. 

  1156. 

  1157. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_MAILBOX** = ``3``
    1158. 

  1158. 

  1159. 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 (nonwithstanding :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
    1160. 

  1160. 

  1161. 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.
    1162. 

  1162. 

  1163. .. rst-class:: classref-item-separator
    1164. 

  1164. 

  1165. ----
    1166. 

  1166. 

  1167. .. _enum_DisplayServer_HandleType:
    1168. 

  1168. 

  1169. .. rst-class:: classref-enumeration
    1170. 

  1170. 

  1171. enum **HandleType**:
    1172. 

  1172. 

  1173. .. _class_DisplayServer_constant_DISPLAY_HANDLE:
    1174. 

  1174. 

  1175. .. rst-class:: classref-enumeration-constant
    1176. 

  1176. 

  1177. :ref:`HandleType<enum_DisplayServer_HandleType>` **DISPLAY_HANDLE** = ``0``
    1178. 

  1178. 

  1179. Display handle:
    1180. 

  1180. 

  1181. - Linux (X11): ``X11::Display*`` for the display.
    1182. 

  1182. 

  1183. - Android: ``EGLDisplay`` for the display.
    1184. 

  1184. 

  1185. .. _class_DisplayServer_constant_WINDOW_HANDLE:
    1186. 

  1186. 

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

  1188. 

  1189. :ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_HANDLE** = ``1``
    1190. 

  1190. 

  1191. Window handle:
    1192. 

  1192. 

  1193. - Windows: ``HWND`` for the window.
    1194. 

  1194. 

  1195. - Linux (X11): ``X11::Window*`` for the window.
    1196. 

  1196. 

  1197. - macOS: ``NSWindow*`` for the window.
    1198. 

  1198. 

  1199. - iOS: ``UIViewController*`` for the view controller.
    1200. 

  1200. 

  1201. - Android: ``jObject`` for the activity.
    1202. 

  1202. 

  1203. .. _class_DisplayServer_constant_WINDOW_VIEW:
    1204. 

  1204. 

  1205. .. rst-class:: classref-enumeration-constant
    1206. 

  1206. 

  1207. :ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_VIEW** = ``2``
    1208. 

  1208. 

  1209. Window view:
    1210. 

  1210. 

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

  1212. 

  1213. - macOS: ``NSView*`` for the window main view.
    1214. 

  1214. 

  1215. - iOS: ``UIView*`` for the window main view.
    1216. 

  1216. 

  1217. .. _class_DisplayServer_constant_OPENGL_CONTEXT:
    1218. 

  1218. 

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

  1220. 

  1221. :ref:`HandleType<enum_DisplayServer_HandleType>` **OPENGL_CONTEXT** = ``3``
    1222. 

  1222. 

  1223. OpenGL context (only with the GL Compatibility renderer):
    1224. 

  1224. 

  1225. - Windows: ``HGLRC`` for the window.
    1226. 

  1226. 

  1227. - Linux: ``GLXContext*`` for the window.
    1228. 

  1228. 

  1229. - macOS: ``NSOpenGLContext*`` for the window.
    1230. 

  1230. 

  1231. - Android: ``EGLContext`` for the window.
    1232. 

  1232. 

  1233. .. rst-class:: classref-item-separator
    1234. 

  1234. 

  1235. ----
    1236. 

  1236. 

  1237. .. _enum_DisplayServer_TTSUtteranceEvent:
    1238. 

  1238. 

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

  1240. 

  1241. enum **TTSUtteranceEvent**:
    1242. 

  1242. 

  1243. .. _class_DisplayServer_constant_TTS_UTTERANCE_STARTED:
    1244. 

  1244. 

  1245. .. rst-class:: classref-enumeration-constant
    1246. 

  1246. 

  1247. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_STARTED** = ``0``
    1248. 

  1248. 

  1249. Utterance has begun to be spoken.
    1250. 

  1250. 

  1251. .. _class_DisplayServer_constant_TTS_UTTERANCE_ENDED:
    1252. 

  1252. 

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

  1254. 

  1255. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_ENDED** = ``1``
    1256. 

  1256. 

  1257. Utterance was successfully finished.
    1258. 

  1258. 

  1259. .. _class_DisplayServer_constant_TTS_UTTERANCE_CANCELED:
    1260. 

  1260. 

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

  1262. 

  1263. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_CANCELED** = ``2``
    1264. 

  1264. 

  1265. Utterance was canceled, or TTS service was unable to process it.
    1266. 

  1266. 

  1267. .. _class_DisplayServer_constant_TTS_UTTERANCE_BOUNDARY:
    1268. 

  1268. 

  1269. .. rst-class:: classref-enumeration-constant
    1270. 

  1270. 

  1271. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_BOUNDARY** = ``3``
    1272. 

  1272. 

  1273. Utterance reached a word or sentence boundary.
    1274. 

  1274. 

  1275. .. rst-class:: classref-section-separator
    1276. 

  1276. 

  1277. ----
    1278. 

  1278. 

  1279. .. rst-class:: classref-descriptions-group
    1280. 

  1280. 

  1281. Constants
    1282. 

  1282. ---------
    1283. 

  1283. 

  1284. .. _class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS:
    1285. 

  1285. 

  1286. .. rst-class:: classref-constant
    1287. 

  1287. 

  1288. **SCREEN_WITH_MOUSE_FOCUS** = ``-4``
    1289. 

  1289. 

  1290. Represents the screen containing the mouse pointer.
    1291. 

  1291. 

  1292. .. _class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS:
    1293. 

  1293. 

  1294. .. rst-class:: classref-constant
    1295. 

  1295. 

  1296. **SCREEN_WITH_KEYBOARD_FOCUS** = ``-3``
    1297. 

  1297. 

  1298. Represents the screen containing the window with the keyboard focus.
    1299. 

  1299. 

  1300. .. _class_DisplayServer_constant_SCREEN_PRIMARY:
    1301. 

  1301. 

  1302. .. rst-class:: classref-constant
    1303. 

  1303. 

  1304. **SCREEN_PRIMARY** = ``-2``
    1305. 

  1305. 

  1306. Represents the primary screen.
    1307. 

  1307. 

  1308. .. _class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW:
    1309. 

  1309. 

  1310. .. rst-class:: classref-constant
    1311. 

  1311. 

  1312. **SCREEN_OF_MAIN_WINDOW** = ``-1``
    1313. 

  1313. 

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

  1315. 

  1316. .. _class_DisplayServer_constant_MAIN_WINDOW_ID:
    1317. 

  1317. 

  1318. .. rst-class:: classref-constant
    1319. 

  1319. 

  1320. **MAIN_WINDOW_ID** = ``0``
    1321. 

  1321. 

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

  1323. 

  1324. .. _class_DisplayServer_constant_INVALID_WINDOW_ID:
    1325. 

  1325. 

  1326. .. rst-class:: classref-constant
    1327. 

  1327. 

  1328. **INVALID_WINDOW_ID** = ``-1``
    1329. 

  1329. 

  1330. The ID that refers to a nonexisting window. This is be returned by some **DisplayServer** methods if no window matches the requested result.
    1331. 

  1331. 

  1332. .. rst-class:: classref-section-separator
    1333. 

  1333. 

  1334. ----
    1335. 

  1335. 

  1336. .. rst-class:: classref-descriptions-group
    1337. 

  1337. 

  1338. Method Descriptions
    1339. 

  1339. -------------------
    1340. 

  1340. 

  1341. .. _class_DisplayServer_method_clipboard_get:
    1342. 

  1342. 

  1343. .. rst-class:: classref-method
    1344. 

  1344. 

  1345. :ref:`String<class_String>` **clipboard_get** **(** **)** |const|
    1346. 

  1346. 

  1347. Returns the user's clipboard as a string if possible.
    1348. 

  1348. 

  1349. .. rst-class:: classref-item-separator
    1350. 

  1350. 

  1351. ----
    1352. 

  1352. 

  1353. .. _class_DisplayServer_method_clipboard_get_primary:
    1354. 

  1354. 

  1355. .. rst-class:: classref-method
    1356. 

  1356. 

  1357. :ref:`String<class_String>` **clipboard_get_primary** **(** **)** |const|
    1358. 

  1358. 

  1359. 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.
    1360. 

  1360. 

  1361. \ **Note:** This method is only implemented on Linux (X11).
    1362. 

  1362. 

  1363. .. rst-class:: classref-item-separator
    1364. 

  1364. 

  1365. ----
    1366. 

  1366. 

  1367. .. _class_DisplayServer_method_clipboard_has:
    1368. 

  1368. 

  1369. .. rst-class:: classref-method
    1370. 

  1370. 

  1371. :ref:`bool<class_bool>` **clipboard_has** **(** **)** |const|
    1372. 

  1372. 

  1373. Returns ``true`` if there is content on the user's clipboard.
    1374. 

  1374. 

  1375. .. rst-class:: classref-item-separator
    1376. 

  1376. 

  1377. ----
    1378. 

  1378. 

  1379. .. _class_DisplayServer_method_clipboard_set:
    1380. 

  1380. 

  1381. .. rst-class:: classref-method
    1382. 

  1382. 

  1383. void **clipboard_set** **(** :ref:`String<class_String>` clipboard **)**
    1384. 

  1384. 

  1385. Sets the user's clipboard content to the given string.
    1386. 

  1386. 

  1387. .. rst-class:: classref-item-separator
    1388. 

  1388. 

  1389. ----
    1390. 

  1390. 

  1391. .. _class_DisplayServer_method_clipboard_set_primary:
    1392. 

  1392. 

  1393. .. rst-class:: classref-method
    1394. 

  1394. 

  1395. void **clipboard_set_primary** **(** :ref:`String<class_String>` clipboard_primary **)**
    1396. 

  1396. 

  1397. 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.
    1398. 

  1398. 

  1399. \ **Note:** This method is only implemented on Linux (X11).
    1400. 

  1400. 

  1401. .. rst-class:: classref-item-separator
    1402. 

  1402. 

  1403. ----
    1404. 

  1404. 

  1405. .. _class_DisplayServer_method_cursor_get_shape:
    1406. 

  1406. 

  1407. .. rst-class:: classref-method
    1408. 

  1408. 

  1409. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **cursor_get_shape** **(** **)** |const|
    1410. 

  1410. 

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

  1412. 

  1413. .. rst-class:: classref-item-separator
    1414. 

  1414. 

  1415. ----
    1416. 

  1416. 

  1417. .. _class_DisplayServer_method_cursor_set_custom_image:
    1418. 

  1418. 

  1419. .. rst-class:: classref-method
    1420. 

  1420. 

  1421. void **cursor_set_custom_image** **(** :ref:`Resource<class_Resource>` cursor, :ref:`CursorShape<enum_DisplayServer_CursorShape>` shape=0, :ref:`Vector2<class_Vector2>` hotspot=Vector2(0, 0) **)**
    1422. 

  1422. 

  1423. Sets a custom mouse cursor image for the defined ``shape``. This means the user's operating system and mouse cursor theme will no longer influence the mouse cursor's appearance. The image must be ``256x256`` or smaller for correct appearance. ``hotspot`` can optionally be set to define the area where the cursor will click. By default, ``hotspot`` is set to ``Vector2(0, 0)``, which is the top-left corner of the image. See also :ref:`cursor_set_shape<class_DisplayServer_method_cursor_set_shape>`.
    1424. 

  1424. 

  1425. .. rst-class:: classref-item-separator
    1426. 

  1426. 

  1427. ----
    1428. 

  1428. 

  1429. .. _class_DisplayServer_method_cursor_set_shape:
    1430. 

  1430. 

  1431. .. rst-class:: classref-method
    1432. 

  1432. 

  1433. void **cursor_set_shape** **(** :ref:`CursorShape<enum_DisplayServer_CursorShape>` shape **)**
    1434. 

  1434. 

  1435. 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>`.
    1436. 

  1436. 

  1437. .. rst-class:: classref-item-separator
    1438. 

  1438. 

  1439. ----
    1440. 

  1440. 

  1441. .. _class_DisplayServer_method_dialog_input_text:
    1442. 

  1442. 

  1443. .. rst-class:: classref-method
    1444. 

  1444. 

  1445. :ref:`Error<enum_@GlobalScope_Error>` **dialog_input_text** **(** :ref:`String<class_String>` title, :ref:`String<class_String>` description, :ref:`String<class_String>` existing_text, :ref:`Callable<class_Callable>` callback **)**
    1446. 

  1446. 

  1447. Shows a text input dialog which uses the operating system's native look-and-feel. ``callback`` will be called with a :ref:`String<class_String>` argument equal to the text field's contents when the dialog is closed for any reason.
    1448. 

  1448. 

  1449. \ **Note:** This method is implemented only on macOS.
    1450. 

  1450. 

  1451. .. rst-class:: classref-item-separator
    1452. 

  1452. 

  1453. ----
    1454. 

  1454. 

  1455. .. _class_DisplayServer_method_dialog_show:
    1456. 

  1456. 

  1457. .. rst-class:: classref-method
    1458. 

  1458. 

  1459. :ref:`Error<enum_@GlobalScope_Error>` **dialog_show** **(** :ref:`String<class_String>` title, :ref:`String<class_String>` description, :ref:`PackedStringArray<class_PackedStringArray>` buttons, :ref:`Callable<class_Callable>` callback **)**
    1460. 

  1460. 

  1461. Shows a text dialog which uses the operating system's native look-and-feel. ``callback`` will be called when the dialog is closed for any reason.
    1462. 

  1462. 

  1463. \ **Note:** This method is implemented only on macOS.
    1464. 

  1464. 

  1465. .. rst-class:: classref-item-separator
    1466. 

  1466. 

  1467. ----
    1468. 

  1468. 

  1469. .. _class_DisplayServer_method_enable_for_stealing_focus:
    1470. 

  1470. 

  1471. .. rst-class:: classref-method
    1472. 

  1472. 

  1473. void **enable_for_stealing_focus** **(** :ref:`int<class_int>` process_id **)**
    1474. 

  1474. 

  1475. 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.
    1476. 

  1476. 

  1477. \ **Note:** This method is implemented only on Windows.
    1478. 

  1478. 

  1479. .. rst-class:: classref-item-separator
    1480. 

  1480. 

  1481. ----
    1482. 

  1482. 

  1483. .. _class_DisplayServer_method_force_process_and_drop_events:
    1484. 

  1484. 

  1485. .. rst-class:: classref-method
    1486. 

  1486. 

  1487. void **force_process_and_drop_events** **(** **)**
    1488. 

  1488. 

  1489. Forces window manager processing while ignoring all :ref:`InputEvent<class_InputEvent>`\ s. See also :ref:`process_events<class_DisplayServer_method_process_events>`.
    1490. 

  1490. 

  1491. \ **Note:** This method is implemented on Windows and macOS.
    1492. 

  1492. 

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

  1494. 

  1495. ----
    1496. 

  1496. 

  1497. .. _class_DisplayServer_method_get_accent_color:
    1498. 

  1498. 

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

  1500. 

  1501. :ref:`Color<class_Color>` **get_accent_color** **(** **)** |const|
    1502. 

  1502. 

  1503. Returns OS theme accent color. Returns ``Color(0, 0, 0, 0)``, if accent color is unknown.
    1504. 

  1504. 

  1505. \ **Note:** This method is implemented on macOS and Windows.
    1506. 

  1506. 

  1507. .. rst-class:: classref-item-separator
    1508. 

  1508. 

  1509. ----
    1510. 

  1510. 

  1511. .. _class_DisplayServer_method_get_display_cutouts:
    1512. 

  1512. 

  1513. .. rst-class:: classref-method
    1514. 

  1514. 

  1515. :ref:`Rect2[]<class_Rect2>` **get_display_cutouts** **(** **)** |const|
    1516. 

  1516. 

  1517. 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>`.
    1518. 

  1518. 

  1519. \ **Note:** Currently only implemented on Android. Other platforms will return an empty array even if they do have display cutouts or notches.
    1520. 

  1520. 

  1521. .. rst-class:: classref-item-separator
    1522. 

  1522. 

  1523. ----
    1524. 

  1524. 

  1525. .. _class_DisplayServer_method_get_display_safe_area:
    1526. 

  1526. 

  1527. .. rst-class:: classref-method
    1528. 

  1528. 

  1529. :ref:`Rect2i<class_Rect2i>` **get_display_safe_area** **(** **)** |const|
    1530. 

  1530. 

  1531. 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>`.
    1532. 

  1532. 

  1533. .. rst-class:: classref-item-separator
    1534. 

  1534. 

  1535. ----
    1536. 

  1536. 

  1537. .. _class_DisplayServer_method_get_keyboard_focus_screen:
    1538. 

  1538. 

  1539. .. rst-class:: classref-method
    1540. 

  1540. 

  1541. :ref:`int<class_int>` **get_keyboard_focus_screen** **(** **)** |const|
    1542. 

  1542. 

  1543. Returns the index of the screen containing the window with the keyboard focus, or the primary screen if there's no focused window.
    1544. 

  1544. 

  1545. .. rst-class:: classref-item-separator
    1546. 

  1546. 

  1547. ----
    1548. 

  1548. 

  1549. .. _class_DisplayServer_method_get_name:
    1550. 

  1550. 

  1551. .. rst-class:: classref-method
    1552. 

  1552. 

  1553. :ref:`String<class_String>` **get_name** **(** **)** |const|
    1554. 

  1554. 

  1555. 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** (although only X11 is currently implemented in Godot).
    1556. 

  1556. 

  1557. The names of built-in display servers are ``Windows``, ``macOS``, ``X11`` (Linux), ``Android``, ``iOS``, ``web`` (HTML5) and ``headless`` (when started with the ``--headless`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>`).
    1558. 

  1558. 

  1559. .. rst-class:: classref-item-separator
    1560. 

  1560. 

  1561. ----
    1562. 

  1562. 

  1563. .. _class_DisplayServer_method_get_primary_screen:
    1564. 

  1564. 

  1565. .. rst-class:: classref-method
    1566. 

  1566. 

  1567. :ref:`int<class_int>` **get_primary_screen** **(** **)** |const|
    1568. 

  1568. 

  1569. Returns index of the primary screen.
    1570. 

  1570. 

  1571. .. rst-class:: classref-item-separator
    1572. 

  1572. 

  1573. ----
    1574. 

  1574. 

  1575. .. _class_DisplayServer_method_get_screen_count:
    1576. 

  1576. 

  1577. .. rst-class:: classref-method
    1578. 

  1578. 

  1579. :ref:`int<class_int>` **get_screen_count** **(** **)** |const|
    1580. 

  1580. 

  1581. Returns the number of displays available.
    1582. 

  1582. 

  1583. .. rst-class:: classref-item-separator
    1584. 

  1584. 

  1585. ----
    1586. 

  1586. 

  1587. .. _class_DisplayServer_method_get_screen_from_rect:
    1588. 

  1588. 

  1589. .. rst-class:: classref-method
    1590. 

  1590. 

  1591. :ref:`int<class_int>` **get_screen_from_rect** **(** :ref:`Rect2<class_Rect2>` rect **)** |const|
    1592. 

  1592. 

  1593. Returns index of the screen which contains specified rectangle.
    1594. 

  1594. 

  1595. .. rst-class:: classref-item-separator
    1596. 

  1596. 

  1597. ----
    1598. 

  1598. 

  1599. .. _class_DisplayServer_method_get_swap_cancel_ok:
    1600. 

  1600. 

  1601. .. rst-class:: classref-method
    1602. 

  1602. 

  1603. :ref:`bool<class_bool>` **get_swap_cancel_ok** **(** **)**
    1604. 

  1604. 

  1605. Returns ``true`` if positions of **OK** and **Cancel** buttons are swapped in dialogs. This is enabled by default on Windows and UWP to follow interface conventions, and be toggled by changing :ref:`ProjectSettings.gui/common/swap_cancel_ok<class_ProjectSettings_property_gui/common/swap_cancel_ok>`.
    1606. 

  1606. 

  1607. \ **Note:** This doesn't affect native dialogs such as the ones spawned by :ref:`dialog_show<class_DisplayServer_method_dialog_show>`.
    1608. 

  1608. 

  1609. .. rst-class:: classref-item-separator
    1610. 

  1610. 

  1611. ----
    1612. 

  1612. 

  1613. .. _class_DisplayServer_method_get_window_at_screen_position:
    1614. 

  1614. 

  1615. .. rst-class:: classref-method
    1616. 

  1616. 

  1617. :ref:`int<class_int>` **get_window_at_screen_position** **(** :ref:`Vector2i<class_Vector2i>` position **)** |const|
    1618. 

  1618. 

  1619. 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:
    1620. 

  1620. 

  1621. ::
    1622. 

  1622. 

  1623.     * (0, 0)        +-------+
    1624. 

  1624.                     |       |
    1625. 

  1625.     +-------------+ |       |
    1626. 

  1626.     |             | |       |
    1627. 

  1627.     |             | |       |
    1628. 

  1628.     +-------------+ +-------+
    1629. 

  1629. 

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

  1631. 

  1632. ----
    1633. 

  1633. 

  1634. .. _class_DisplayServer_method_get_window_list:
    1635. 

  1635. 

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

  1637. 

  1638. :ref:`PackedInt32Array<class_PackedInt32Array>` **get_window_list** **(** **)** |const|
    1639. 

  1639. 

  1640. Returns the list of Godot window IDs belonging to this process.
    1641. 

  1641. 

  1642. \ **Note:** Native dialogs are not included in this list.
    1643. 

  1643. 

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

  1645. 

  1646. ----
    1647. 

  1647. 

  1648. .. _class_DisplayServer_method_global_menu_add_check_item:
    1649. 

  1649. 

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

  1651. 

  1652. :ref:`int<class_int>` **global_menu_add_check_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Callable<class_Callable>` key_callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
    1653. 

  1653. 

  1654. Adds a new checkable item with text ``label`` to the global menu with ID ``menu_root``.
    1655. 

  1655. 

  1656. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    1657. 

  1657. 

  1658. 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`).
    1659. 

  1659. 

  1660. \ **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``.
    1661. 

  1661. 

  1662. \ **Note:** This method is implemented only on macOS.
    1663. 

  1663. 

  1664. \ **Supported system menu IDs:**\ 
    1665. 

  1665. 

  1666. ::
    1667. 

  1667. 

  1668.     "_main" - Main menu (macOS).
    1669. 

  1669.     "_dock" - Dock popup menu (macOS).
    1670. 

  1670. 

  1671. .. rst-class:: classref-item-separator
    1672. 

  1672. 

  1673. ----
    1674. 

  1674. 

  1675. .. _class_DisplayServer_method_global_menu_add_icon_check_item:
    1676. 

  1676. 

  1677. .. rst-class:: classref-method
    1678. 

  1678. 

  1679. :ref:`int<class_int>` **global_menu_add_icon_check_item** **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Callable<class_Callable>` key_callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
    1680. 

  1680. 

  1681. Adds a new checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
    1682. 

  1682. 

  1683. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    1684. 

  1684. 

  1685. 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`).
    1686. 

  1686. 

  1687. \ **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``.
    1688. 

  1688. 

  1689. \ **Note:** This method is implemented only on macOS.
    1690. 

  1690. 

  1691. \ **Supported system menu IDs:**\ 
    1692. 

  1692. 

  1693. ::
    1694. 

  1694. 

  1695.     "_main" - Main menu (macOS).
    1696. 

  1696.     "_dock" - Dock popup menu (macOS).
    1697. 

  1697. 

  1698. .. rst-class:: classref-item-separator
    1699. 

  1699. 

  1700. ----
    1701. 

  1701. 

  1702. .. _class_DisplayServer_method_global_menu_add_icon_item:
    1703. 

  1703. 

  1704. .. rst-class:: classref-method
    1705. 

  1705. 

  1706. :ref:`int<class_int>` **global_menu_add_icon_item** **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Callable<class_Callable>` key_callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
    1707. 

  1707. 

  1708. Adds a new item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
    1709. 

  1709. 

  1710. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    1711. 

  1711. 

  1712. 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`).
    1713. 

  1713. 

  1714. \ **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``.
    1715. 

  1715. 

  1716. \ **Note:** This method is implemented only on macOS.
    1717. 

  1717. 

  1718. \ **Supported system menu IDs:**\ 
    1719. 

  1719. 

  1720. ::
    1721. 

  1721. 

  1722.     "_main" - Main menu (macOS).
    1723. 

  1723.     "_dock" - Dock popup menu (macOS).
    1724. 

  1724. 

  1725. .. rst-class:: classref-item-separator
    1726. 

  1726. 

  1727. ----
    1728. 

  1728. 

  1729. .. _class_DisplayServer_method_global_menu_add_icon_radio_check_item:
    1730. 

  1730. 

  1731. .. rst-class:: classref-method
    1732. 

  1732. 

  1733. :ref:`int<class_int>` **global_menu_add_icon_radio_check_item** **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Callable<class_Callable>` key_callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
    1734. 

  1734. 

  1735. Adds a new radio-checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
    1736. 

  1736. 

  1737. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    1738. 

  1738. 

  1739. 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`).
    1740. 

  1740. 

  1741. \ **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.
    1742. 

  1742. 

  1743. \ **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``.
    1744. 

  1744. 

  1745. \ **Note:** This method is implemented only on macOS.
    1746. 

  1746. 

  1747. \ **Supported system menu IDs:**\ 
    1748. 

  1748. 

  1749. ::
    1750. 

  1750. 

  1751.     "_main" - Main menu (macOS).
    1752. 

  1752.     "_dock" - Dock popup menu (macOS).
    1753. 

  1753. 

  1754. .. rst-class:: classref-item-separator
    1755. 

  1755. 

  1756. ----
    1757. 

  1757. 

  1758. .. _class_DisplayServer_method_global_menu_add_item:
    1759. 

  1759. 

  1760. .. rst-class:: classref-method
    1761. 

  1761. 

  1762. :ref:`int<class_int>` **global_menu_add_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Callable<class_Callable>` key_callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
    1763. 

  1763. 

  1764. Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
    1765. 

  1765. 

  1766. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    1767. 

  1767. 

  1768. 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`).
    1769. 

  1769. 

  1770. \ **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``.
    1771. 

  1771. 

  1772. \ **Note:** This method is implemented only on macOS.
    1773. 

  1773. 

  1774. \ **Supported system menu IDs:**\ 
    1775. 

  1775. 

  1776. ::
    1777. 

  1777. 

  1778.     "_main" - Main menu (macOS).
    1779. 

  1779.     "_dock" - Dock popup menu (macOS).
    1780. 

  1780. 

  1781. .. rst-class:: classref-item-separator
    1782. 

  1782. 

  1783. ----
    1784. 

  1784. 

  1785. .. _class_DisplayServer_method_global_menu_add_multistate_item:
    1786. 

  1786. 

  1787. .. rst-class:: classref-method
    1788. 

  1788. 

  1789. :ref:`int<class_int>` **global_menu_add_multistate_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`int<class_int>` max_states, :ref:`int<class_int>` default_state, :ref:`Callable<class_Callable>` callback, :ref:`Callable<class_Callable>` key_callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
    1790. 

  1790. 

  1791. Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
    1792. 

  1792. 

  1793. 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``.
    1794. 

  1794. 

  1795. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    1796. 

  1796. 

  1797. 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`).
    1798. 

  1798. 

  1799. \ **Note:** By default, there's no indication of the current item state, it should be changed manually.
    1800. 

  1800. 

  1801. \ **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``.
    1802. 

  1802. 

  1803. \ **Note:** This method is implemented only on macOS.
    1804. 

  1804. 

  1805. \ **Supported system menu IDs:**\ 
    1806. 

  1806. 

  1807. ::
    1808. 

  1808. 

  1809.     "_main" - Main menu (macOS).
    1810. 

  1810.     "_dock" - Dock popup menu (macOS).
    1811. 

  1811. 

  1812. .. rst-class:: classref-item-separator
    1813. 

  1813. 

  1814. ----
    1815. 

  1815. 

  1816. .. _class_DisplayServer_method_global_menu_add_radio_check_item:
    1817. 

  1817. 

  1818. .. rst-class:: classref-method
    1819. 

  1819. 

  1820. :ref:`int<class_int>` **global_menu_add_radio_check_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback, :ref:`Callable<class_Callable>` key_callback, :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**
    1821. 

  1821. 

  1822. Adds a new radio-checkable item with text ``label`` to the global menu with ID ``menu_root``.
    1823. 

  1823. 

  1824. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    1825. 

  1825. 

  1826. 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`).
    1827. 

  1827. 

  1828. \ **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.
    1829. 

  1829. 

  1830. \ **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``.
    1831. 

  1831. 

  1832. \ **Note:** This method is implemented only on macOS.
    1833. 

  1833. 

  1834. \ **Supported system menu IDs:**\ 
    1835. 

  1835. 

  1836. ::
    1837. 

  1837. 

  1838.     "_main" - Main menu (macOS).
    1839. 

  1839.     "_dock" - Dock popup menu (macOS).
    1840. 

  1840. 

  1841. .. rst-class:: classref-item-separator
    1842. 

  1842. 

  1843. ----
    1844. 

  1844. 

  1845. .. _class_DisplayServer_method_global_menu_add_separator:
    1846. 

  1846. 

  1847. .. rst-class:: classref-method
    1848. 

  1848. 

  1849. :ref:`int<class_int>` **global_menu_add_separator** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` index=-1 **)**
    1850. 

  1850. 

  1851. Adds a separator between items to the global menu with ID ``menu_root``. Separators also occupy an index.
    1852. 

  1852. 

  1853. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    1854. 

  1854. 

  1855. \ **Note:** This method is implemented only on macOS.
    1856. 

  1856. 

  1857. \ **Supported system menu IDs:**\ 
    1858. 

  1858. 

  1859. ::
    1860. 

  1860. 

  1861.     "_main" - Main menu (macOS).
    1862. 

  1862.     "_dock" - Dock popup menu (macOS).
    1863. 

  1863. 

  1864. .. rst-class:: classref-item-separator
    1865. 

  1865. 

  1866. ----
    1867. 

  1867. 

  1868. .. _class_DisplayServer_method_global_menu_add_submenu_item:
    1869. 

  1869. 

  1870. .. rst-class:: classref-method
    1871. 

  1871. 

  1872. :ref:`int<class_int>` **global_menu_add_submenu_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`String<class_String>` submenu, :ref:`int<class_int>` index=-1 **)**
    1873. 

  1873. 

  1874. 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.
    1875. 

  1875. 

  1876. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
    1877. 

  1877. 

  1878. \ **Note:** This method is implemented only on macOS.
    1879. 

  1879. 

  1880. \ **Supported system menu IDs:**\ 
    1881. 

  1881. 

  1882. ::
    1883. 

  1883. 

  1884.     "_main" - Main menu (macOS).
    1885. 

  1885.     "_dock" - Dock popup menu (macOS).
    1886. 

  1886. 

  1887. .. rst-class:: classref-item-separator
    1888. 

  1888. 

  1889. ----
    1890. 

  1890. 

  1891. .. _class_DisplayServer_method_global_menu_clear:
    1892. 

  1892. 

  1893. .. rst-class:: classref-method
    1894. 

  1894. 

  1895. void **global_menu_clear** **(** :ref:`String<class_String>` menu_root **)**
    1896. 

  1896. 

  1897. Removes all items from the global menu with ID ``menu_root``.
    1898. 

  1898. 

  1899. \ **Note:** This method is implemented only on macOS.
    1900. 

  1900. 

  1901. \ **Supported system menu IDs:**\ 
    1902. 

  1902. 

  1903. ::
    1904. 

  1904. 

  1905.     "_main" - Main menu (macOS).
    1906. 

  1906.     "_dock" - Dock popup menu (macOS).
    1907. 

  1907. 

  1908. .. rst-class:: classref-item-separator
    1909. 

  1909. 

  1910. ----
    1911. 

  1911. 

  1912. .. _class_DisplayServer_method_global_menu_get_item_accelerator:
    1913. 

  1913. 

  1914. .. rst-class:: classref-method
    1915. 

  1915. 

  1916. :ref:`Key<enum_@GlobalScope_Key>` **global_menu_get_item_accelerator** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    1917. 

  1917. 

  1918. 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.
    1919. 

  1919. 

  1920. \ **Note:** This method is implemented only on macOS.
    1921. 

  1921. 

  1922. .. rst-class:: classref-item-separator
    1923. 

  1923. 

  1924. ----
    1925. 

  1925. 

  1926. .. _class_DisplayServer_method_global_menu_get_item_callback:
    1927. 

  1927. 

  1928. .. rst-class:: classref-method
    1929. 

  1929. 

  1930. :ref:`Callable<class_Callable>` **global_menu_get_item_callback** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    1931. 

  1931. 

  1932. Returns the callback of the item at index ``idx``.
    1933. 

  1933. 

  1934. \ **Note:** This method is implemented only on macOS.
    1935. 

  1935. 

  1936. .. rst-class:: classref-item-separator
    1937. 

  1937. 

  1938. ----
    1939. 

  1939. 

  1940. .. _class_DisplayServer_method_global_menu_get_item_count:
    1941. 

  1941. 

  1942. .. rst-class:: classref-method
    1943. 

  1943. 

  1944. :ref:`int<class_int>` **global_menu_get_item_count** **(** :ref:`String<class_String>` menu_root **)** |const|
    1945. 

  1945. 

  1946. Returns number of items in the global menu with ID ``menu_root``.
    1947. 

  1947. 

  1948. \ **Note:** This method is implemented only on macOS.
    1949. 

  1949. 

  1950. .. rst-class:: classref-item-separator
    1951. 

  1951. 

  1952. ----
    1953. 

  1953. 

  1954. .. _class_DisplayServer_method_global_menu_get_item_icon:
    1955. 

  1955. 

  1956. .. rst-class:: classref-method
    1957. 

  1957. 

  1958. :ref:`Texture2D<class_Texture2D>` **global_menu_get_item_icon** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    1959. 

  1959. 

  1960. Returns the icon of the item at index ``idx``.
    1961. 

  1961. 

  1962. \ **Note:** This method is implemented only on macOS.
    1963. 

  1963. 

  1964. .. rst-class:: classref-item-separator
    1965. 

  1965. 

  1966. ----
    1967. 

  1967. 

  1968. .. _class_DisplayServer_method_global_menu_get_item_indentation_level:
    1969. 

  1969. 

  1970. .. rst-class:: classref-method
    1971. 

  1971. 

  1972. :ref:`int<class_int>` **global_menu_get_item_indentation_level** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    1973. 

  1973. 

  1974. Returns the horizontal offset of the item at the given ``idx``.
    1975. 

  1975. 

  1976. \ **Note:** This method is implemented only on macOS.
    1977. 

  1977. 

  1978. .. rst-class:: classref-item-separator
    1979. 

  1979. 

  1980. ----
    1981. 

  1981. 

  1982. .. _class_DisplayServer_method_global_menu_get_item_index_from_tag:
    1983. 

  1983. 

  1984. .. rst-class:: classref-method
    1985. 

  1985. 

  1986. :ref:`int<class_int>` **global_menu_get_item_index_from_tag** **(** :ref:`String<class_String>` menu_root, :ref:`Variant<class_Variant>` tag **)** |const|
    1987. 

  1987. 

  1988. Returns the index of the item with the specified ``tag``. Index is automatically assigned to each item by the engine. Index can not be set manually.
    1989. 

  1989. 

  1990. \ **Note:** This method is implemented only on macOS.
    1991. 

  1991. 

  1992. .. rst-class:: classref-item-separator
    1993. 

  1993. 

  1994. ----
    1995. 

  1995. 

  1996. .. _class_DisplayServer_method_global_menu_get_item_index_from_text:
    1997. 

  1997. 

  1998. .. rst-class:: classref-method
    1999. 

  1999. 

  2000. :ref:`int<class_int>` **global_menu_get_item_index_from_text** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` text **)** |const|
    2001. 

  2001. 

  2002. Returns the index of the item with the specified ``text``. Index is automatically assigned to each item by the engine. Index can not be set manually.
    2003. 

  2003. 

  2004. \ **Note:** This method is implemented only on macOS.
    2005. 

  2005. 

  2006. .. rst-class:: classref-item-separator
    2007. 

  2007. 

  2008. ----
    2009. 

  2009. 

  2010. .. _class_DisplayServer_method_global_menu_get_item_key_callback:
    2011. 

  2011. 

  2012. .. rst-class:: classref-method
    2013. 

  2013. 

  2014. :ref:`Callable<class_Callable>` **global_menu_get_item_key_callback** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2015. 

  2015. 

  2016. Returns the callback of the item accelerator at index ``idx``.
    2017. 

  2017. 

  2018. \ **Note:** This method is implemented only on macOS.
    2019. 

  2019. 

  2020. .. rst-class:: classref-item-separator
    2021. 

  2021. 

  2022. ----
    2023. 

  2023. 

  2024. .. _class_DisplayServer_method_global_menu_get_item_max_states:
    2025. 

  2025. 

  2026. .. rst-class:: classref-method
    2027. 

  2027. 

  2028. :ref:`int<class_int>` **global_menu_get_item_max_states** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2029. 

  2029. 

  2030. 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.
    2031. 

  2031. 

  2032. \ **Note:** This method is implemented only on macOS.
    2033. 

  2033. 

  2034. .. rst-class:: classref-item-separator
    2035. 

  2035. 

  2036. ----
    2037. 

  2037. 

  2038. .. _class_DisplayServer_method_global_menu_get_item_state:
    2039. 

  2039. 

  2040. .. rst-class:: classref-method
    2041. 

  2041. 

  2042. :ref:`int<class_int>` **global_menu_get_item_state** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2043. 

  2043. 

  2044. Returns the state of a multistate item. See :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
    2045. 

  2045. 

  2046. \ **Note:** This method is implemented only on macOS.
    2047. 

  2047. 

  2048. .. rst-class:: classref-item-separator
    2049. 

  2049. 

  2050. ----
    2051. 

  2051. 

  2052. .. _class_DisplayServer_method_global_menu_get_item_submenu:
    2053. 

  2053. 

  2054. .. rst-class:: classref-method
    2055. 

  2055. 

  2056. :ref:`String<class_String>` **global_menu_get_item_submenu** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2057. 

  2057. 

  2058. 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.
    2059. 

  2059. 

  2060. \ **Note:** This method is implemented only on macOS.
    2061. 

  2061. 

  2062. .. rst-class:: classref-item-separator
    2063. 

  2063. 

  2064. ----
    2065. 

  2065. 

  2066. .. _class_DisplayServer_method_global_menu_get_item_tag:
    2067. 

  2067. 

  2068. .. rst-class:: classref-method
    2069. 

  2069. 

  2070. :ref:`Variant<class_Variant>` **global_menu_get_item_tag** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2071. 

  2071. 

  2072. 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.
    2073. 

  2073. 

  2074. \ **Note:** This method is implemented only on macOS.
    2075. 

  2075. 

  2076. .. rst-class:: classref-item-separator
    2077. 

  2077. 

  2078. ----
    2079. 

  2079. 

  2080. .. _class_DisplayServer_method_global_menu_get_item_text:
    2081. 

  2081. 

  2082. .. rst-class:: classref-method
    2083. 

  2083. 

  2084. :ref:`String<class_String>` **global_menu_get_item_text** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2085. 

  2085. 

  2086. Returns the text of the item at index ``idx``.
    2087. 

  2087. 

  2088. \ **Note:** This method is implemented only on macOS.
    2089. 

  2089. 

  2090. .. rst-class:: classref-item-separator
    2091. 

  2091. 

  2092. ----
    2093. 

  2093. 

  2094. .. _class_DisplayServer_method_global_menu_get_item_tooltip:
    2095. 

  2095. 

  2096. .. rst-class:: classref-method
    2097. 

  2097. 

  2098. :ref:`String<class_String>` **global_menu_get_item_tooltip** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2099. 

  2099. 

  2100. Returns the tooltip associated with the specified index ``idx``.
    2101. 

  2101. 

  2102. \ **Note:** This method is implemented only on macOS.
    2103. 

  2103. 

  2104. .. rst-class:: classref-item-separator
    2105. 

  2105. 

  2106. ----
    2107. 

  2107. 

  2108. .. _class_DisplayServer_method_global_menu_is_item_checkable:
    2109. 

  2109. 

  2110. .. rst-class:: classref-method
    2111. 

  2111. 

  2112. :ref:`bool<class_bool>` **global_menu_is_item_checkable** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2113. 

  2113. 

  2114. Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if it has a checkbox or radio button.
    2115. 

  2115. 

  2116. \ **Note:** This method is implemented only on macOS.
    2117. 

  2117. 

  2118. .. rst-class:: classref-item-separator
    2119. 

  2119. 

  2120. ----
    2121. 

  2121. 

  2122. .. _class_DisplayServer_method_global_menu_is_item_checked:
    2123. 

  2123. 

  2124. .. rst-class:: classref-method
    2125. 

  2125. 

  2126. :ref:`bool<class_bool>` **global_menu_is_item_checked** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2127. 

  2127. 

  2128. Returns ``true`` if the item at index ``idx`` is checked.
    2129. 

  2129. 

  2130. \ **Note:** This method is implemented only on macOS.
    2131. 

  2131. 

  2132. .. rst-class:: classref-item-separator
    2133. 

  2133. 

  2134. ----
    2135. 

  2135. 

  2136. .. _class_DisplayServer_method_global_menu_is_item_disabled:
    2137. 

  2137. 

  2138. .. rst-class:: classref-method
    2139. 

  2139. 

  2140. :ref:`bool<class_bool>` **global_menu_is_item_disabled** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2141. 

  2141. 

  2142. Returns ``true`` if the item at index ``idx`` is disabled. When it is disabled it can't be selected, or its action invoked.
    2143. 

  2143. 

  2144. See :ref:`global_menu_set_item_disabled<class_DisplayServer_method_global_menu_set_item_disabled>` for more info on how to disable an item.
    2145. 

  2145. 

  2146. \ **Note:** This method is implemented only on macOS.
    2147. 

  2147. 

  2148. .. rst-class:: classref-item-separator
    2149. 

  2149. 

  2150. ----
    2151. 

  2151. 

  2152. .. _class_DisplayServer_method_global_menu_is_item_radio_checkable:
    2153. 

  2153. 

  2154. .. rst-class:: classref-method
    2155. 

  2155. 

  2156. :ref:`bool<class_bool>` **global_menu_is_item_radio_checkable** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2157. 

  2157. 

  2158. Returns ``true`` if the item at index ``idx`` has radio button-style checkability.
    2159. 

  2159. 

  2160. \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
    2161. 

  2161. 

  2162. \ **Note:** This method is implemented only on macOS.
    2163. 

  2163. 

  2164. .. rst-class:: classref-item-separator
    2165. 

  2165. 

  2166. ----
    2167. 

  2167. 

  2168. .. _class_DisplayServer_method_global_menu_remove_item:
    2169. 

  2169. 

  2170. .. rst-class:: classref-method
    2171. 

  2171. 

  2172. void **global_menu_remove_item** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)**
    2173. 

  2173. 

  2174. Removes the item at index ``idx`` from the global menu ``menu_root``.
    2175. 

  2175. 

  2176. \ **Note:** The indices of items after the removed item will be shifted by one.
    2177. 

  2177. 

  2178. \ **Note:** This method is implemented only on macOS.
    2179. 

  2179. 

  2180. .. rst-class:: classref-item-separator
    2181. 

  2181. 

  2182. ----
    2183. 

  2183. 

  2184. .. _class_DisplayServer_method_global_menu_set_item_accelerator:
    2185. 

  2185. 

  2186. .. rst-class:: classref-method
    2187. 

  2187. 

  2188. void **global_menu_set_item_accelerator** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Key<enum_@GlobalScope_Key>` keycode **)**
    2189. 

  2189. 

  2190. 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`).
    2191. 

  2191. 

  2192. \ **Note:** This method is implemented only on macOS.
    2193. 

  2193. 

  2194. .. rst-class:: classref-item-separator
    2195. 

  2195. 

  2196. ----
    2197. 

  2197. 

  2198. .. _class_DisplayServer_method_global_menu_set_item_callback:
    2199. 

  2199. 

  2200. .. rst-class:: classref-method
    2201. 

  2201. 

  2202. void **global_menu_set_item_callback** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Callable<class_Callable>` callback **)**
    2203. 

  2203. 

  2204. Sets the callback of the item at index ``idx``. Callback is emitted when an item is pressed.
    2205. 

  2205. 

  2206. \ **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.
    2207. 

  2207. 

  2208. \ **Note:** This method is implemented only on macOS.
    2209. 

  2209. 

  2210. .. rst-class:: classref-item-separator
    2211. 

  2211. 

  2212. ----
    2213. 

  2213. 

  2214. .. _class_DisplayServer_method_global_menu_set_item_checkable:
    2215. 

  2215. 

  2216. .. rst-class:: classref-method
    2217. 

  2217. 

  2218. void **global_menu_set_item_checkable** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checkable **)**
    2219. 

  2219. 

  2220. Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the type of the item to plain text.
    2221. 

  2221. 

  2222. \ **Note:** This method is implemented only on macOS.
    2223. 

  2223. 

  2224. .. rst-class:: classref-item-separator
    2225. 

  2225. 

  2226. ----
    2227. 

  2227. 

  2228. .. _class_DisplayServer_method_global_menu_set_item_checked:
    2229. 

  2229. 

  2230. .. rst-class:: classref-method
    2231. 

  2231. 

  2232. void **global_menu_set_item_checked** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checked **)**
    2233. 

  2233. 

  2234. Sets the checkstate status of the item at index ``idx``.
    2235. 

  2235. 

  2236. \ **Note:** This method is implemented only on macOS.
    2237. 

  2237. 

  2238. .. rst-class:: classref-item-separator
    2239. 

  2239. 

  2240. ----
    2241. 

  2241. 

  2242. .. _class_DisplayServer_method_global_menu_set_item_disabled:
    2243. 

  2243. 

  2244. .. rst-class:: classref-method
    2245. 

  2245. 

  2246. void **global_menu_set_item_disabled** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)**
    2247. 

  2247. 

  2248. Enables/disables the item at index ``idx``. When it is disabled, it can't be selected and its action can't be invoked.
    2249. 

  2249. 

  2250. \ **Note:** This method is implemented only on macOS.
    2251. 

  2251. 

  2252. .. rst-class:: classref-item-separator
    2253. 

  2253. 

  2254. ----
    2255. 

  2255. 

  2256. .. _class_DisplayServer_method_global_menu_set_item_icon:
    2257. 

  2257. 

  2258. .. rst-class:: classref-method
    2259. 

  2259. 

  2260. void **global_menu_set_item_icon** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Texture2D<class_Texture2D>` icon **)**
    2261. 

  2261. 

  2262. Replaces the :ref:`Texture2D<class_Texture2D>` icon of the specified ``idx``.
    2263. 

  2263. 

  2264. \ **Note:** This method is implemented only on macOS.
    2265. 

  2265. 

  2266. \ **Note:** This method is not supported by macOS "_dock" menu items.
    2267. 

  2267. 

  2268. .. rst-class:: classref-item-separator
    2269. 

  2269. 

  2270. ----
    2271. 

  2271. 

  2272. .. _class_DisplayServer_method_global_menu_set_item_indentation_level:
    2273. 

  2273. 

  2274. .. rst-class:: classref-method
    2275. 

  2275. 

  2276. void **global_menu_set_item_indentation_level** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` level **)**
    2277. 

  2277. 

  2278. Sets the horizontal offset of the item at the given ``idx``.
    2279. 

  2279. 

  2280. \ **Note:** This method is implemented only on macOS.
    2281. 

  2281. 

  2282. .. rst-class:: classref-item-separator
    2283. 

  2283. 

  2284. ----
    2285. 

  2285. 

  2286. .. _class_DisplayServer_method_global_menu_set_item_key_callback:
    2287. 

  2287. 

  2288. .. rst-class:: classref-method
    2289. 

  2289. 

  2290. void **global_menu_set_item_key_callback** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Callable<class_Callable>` key_callback **)**
    2291. 

  2291. 

  2292. Sets the callback of the item at index ``idx``. Callback is emitted when its accelerator is activated.
    2293. 

  2293. 

  2294. \ **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.
    2295. 

  2295. 

  2296. \ **Note:** This method is implemented only on macOS.
    2297. 

  2297. 

  2298. .. rst-class:: classref-item-separator
    2299. 

  2299. 

  2300. ----
    2301. 

  2301. 

  2302. .. _class_DisplayServer_method_global_menu_set_item_max_states:
    2303. 

  2303. 

  2304. .. rst-class:: classref-method
    2305. 

  2305. 

  2306. void **global_menu_set_item_max_states** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` max_states **)**
    2307. 

  2307. 

  2308. 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.
    2309. 

  2309. 

  2310. \ **Note:** This method is implemented only on macOS.
    2311. 

  2311. 

  2312. .. rst-class:: classref-item-separator
    2313. 

  2313. 

  2314. ----
    2315. 

  2315. 

  2316. .. _class_DisplayServer_method_global_menu_set_item_radio_checkable:
    2317. 

  2317. 

  2318. .. rst-class:: classref-method
    2319. 

  2319. 

  2320. void **global_menu_set_item_radio_checkable** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checkable **)**
    2321. 

  2321. 

  2322. 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.
    2323. 

  2323. 

  2324. \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
    2325. 

  2325. 

  2326. \ **Note:** This method is implemented only on macOS.
    2327. 

  2327. 

  2328. .. rst-class:: classref-item-separator
    2329. 

  2329. 

  2330. ----
    2331. 

  2331. 

  2332. .. _class_DisplayServer_method_global_menu_set_item_state:
    2333. 

  2333. 

  2334. .. rst-class:: classref-method
    2335. 

  2335. 

  2336. void **global_menu_set_item_state** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` state **)**
    2337. 

  2337. 

  2338. Sets the state of a multistate item. See :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
    2339. 

  2339. 

  2340. \ **Note:** This method is implemented only on macOS.
    2341. 

  2341. 

  2342. .. rst-class:: classref-item-separator
    2343. 

  2343. 

  2344. ----
    2345. 

  2345. 

  2346. .. _class_DisplayServer_method_global_menu_set_item_submenu:
    2347. 

  2347. 

  2348. .. rst-class:: classref-method
    2349. 

  2349. 

  2350. void **global_menu_set_item_submenu** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`String<class_String>` submenu **)**
    2351. 

  2351. 

  2352. 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.
    2353. 

  2353. 

  2354. \ **Note:** This method is implemented only on macOS.
    2355. 

  2355. 

  2356. .. rst-class:: classref-item-separator
    2357. 

  2357. 

  2358. ----
    2359. 

  2359. 

  2360. .. _class_DisplayServer_method_global_menu_set_item_tag:
    2361. 

  2361. 

  2362. .. rst-class:: classref-method
    2363. 

  2363. 

  2364. void **global_menu_set_item_tag** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` tag **)**
    2365. 

  2365. 

  2366. 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.
    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_set_item_text:
    2375. 

  2375. 

  2376. .. rst-class:: classref-method
    2377. 

  2377. 

  2378. void **global_menu_set_item_text** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`String<class_String>` text **)**
    2379. 

  2379. 

  2380. Sets the text of the item at index ``idx``.
    2381. 

  2381. 

  2382. \ **Note:** This method is implemented only on macOS.
    2383. 

  2383. 

  2384. .. rst-class:: classref-item-separator
    2385. 

  2385. 

  2386. ----
    2387. 

  2387. 

  2388. .. _class_DisplayServer_method_global_menu_set_item_tooltip:
    2389. 

  2389. 

  2390. .. rst-class:: classref-method
    2391. 

  2391. 

  2392. void **global_menu_set_item_tooltip** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`String<class_String>` tooltip **)**
    2393. 

  2393. 

  2394. Sets the :ref:`String<class_String>` tooltip of the item at the specified index ``idx``.
    2395. 

  2395. 

  2396. \ **Note:** This method is implemented only on macOS.
    2397. 

  2397. 

  2398. .. rst-class:: classref-item-separator
    2399. 

  2399. 

  2400. ----
    2401. 

  2401. 

  2402. .. _class_DisplayServer_method_has_feature:
    2403. 

  2403. 

  2404. .. rst-class:: classref-method
    2405. 

  2405. 

  2406. :ref:`bool<class_bool>` **has_feature** **(** :ref:`Feature<enum_DisplayServer_Feature>` feature **)** |const|
    2407. 

  2407. 

  2408. Returns ``true`` if the specified ``feature`` is supported by the current **DisplayServer**, ``false`` otherwise.
    2409. 

  2409. 

  2410. .. rst-class:: classref-item-separator
    2411. 

  2411. 

  2412. ----
    2413. 

  2413. 

  2414. .. _class_DisplayServer_method_ime_get_selection:
    2415. 

  2415. 

  2416. .. rst-class:: classref-method
    2417. 

  2417. 

  2418. :ref:`Vector2i<class_Vector2i>` **ime_get_selection** **(** **)** |const|
    2419. 

  2419. 

  2420. 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.
    2421. 

  2421. 

  2422. \ **Note:** This method is implemented only on macOS.
    2423. 

  2423. 

  2424. .. rst-class:: classref-item-separator
    2425. 

  2425. 

  2426. ----
    2427. 

  2427. 

  2428. .. _class_DisplayServer_method_ime_get_text:
    2429. 

  2429. 

  2430. .. rst-class:: classref-method
    2431. 

  2431. 

  2432. :ref:`String<class_String>` **ime_get_text** **(** **)** |const|
    2433. 

  2433. 

  2434. Returns the composition string contained within the `Input Method Editor <https://en.wikipedia.org/wiki/Input_method>`__ window.
    2435. 

  2435. 

  2436. \ **Note:** This method is implemented only on macOS.
    2437. 

  2437. 

  2438. .. rst-class:: classref-item-separator
    2439. 

  2439. 

  2440. ----
    2441. 

  2441. 

  2442. .. _class_DisplayServer_method_is_dark_mode:
    2443. 

  2443. 

  2444. .. rst-class:: classref-method
    2445. 

  2445. 

  2446. :ref:`bool<class_bool>` **is_dark_mode** **(** **)** |const|
    2447. 

  2447. 

  2448. Returns ``true`` if OS is using dark mode.
    2449. 

  2449. 

  2450. \ **Note:** This method is implemented on macOS, Windows and Linux (X11).
    2451. 

  2451. 

  2452. .. rst-class:: classref-item-separator
    2453. 

  2453. 

  2454. ----
    2455. 

  2455. 

  2456. .. _class_DisplayServer_method_is_dark_mode_supported:
    2457. 

  2457. 

  2458. .. rst-class:: classref-method
    2459. 

  2459. 

  2460. :ref:`bool<class_bool>` **is_dark_mode_supported** **(** **)** |const|
    2461. 

  2461. 

  2462. Returns ``true`` if OS supports dark mode.
    2463. 

  2463. 

  2464. \ **Note:** This method is implemented on macOS, Windows and Linux (X11).
    2465. 

  2465. 

  2466. .. rst-class:: classref-item-separator
    2467. 

  2467. 

  2468. ----
    2469. 

  2469. 

  2470. .. _class_DisplayServer_method_is_touchscreen_available:
    2471. 

  2471. 

  2472. .. rst-class:: classref-method
    2473. 

  2473. 

  2474. :ref:`bool<class_bool>` **is_touchscreen_available** **(** **)** |const|
    2475. 

  2475. 

  2476. Returns ``true`` if touch events are available (Android or iOS), the capability is detected on the Webplatform or if :ref:`ProjectSettings.input_devices/pointing/emulate_touch_from_mouse<class_ProjectSettings_property_input_devices/pointing/emulate_touch_from_mouse>` is ``true``.
    2477. 

  2477. 

  2478. .. rst-class:: classref-item-separator
    2479. 

  2479. 

  2480. ----
    2481. 

  2481. 

  2482. .. _class_DisplayServer_method_keyboard_get_current_layout:
    2483. 

  2483. 

  2484. .. rst-class:: classref-method
    2485. 

  2485. 

  2486. :ref:`int<class_int>` **keyboard_get_current_layout** **(** **)** |const|
    2487. 

  2487. 

  2488. Returns active keyboard layout index.
    2489. 

  2489. 

  2490. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    2491. 

  2491. 

  2492. .. rst-class:: classref-item-separator
    2493. 

  2493. 

  2494. ----
    2495. 

  2495. 

  2496. .. _class_DisplayServer_method_keyboard_get_keycode_from_physical:
    2497. 

  2497. 

  2498. .. rst-class:: classref-method
    2499. 

  2499. 

  2500. :ref:`Key<enum_@GlobalScope_Key>` **keyboard_get_keycode_from_physical** **(** :ref:`Key<enum_@GlobalScope_Key>` keycode **)** |const|
    2501. 

  2501. 

  2502. Converts a physical (US QWERTY) ``keycode`` to one in the active keyboard layout.
    2503. 

  2503. 

  2504. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    2505. 

  2505. 

  2506. .. rst-class:: classref-item-separator
    2507. 

  2507. 

  2508. ----
    2509. 

  2509. 

  2510. .. _class_DisplayServer_method_keyboard_get_layout_count:
    2511. 

  2511. 

  2512. .. rst-class:: classref-method
    2513. 

  2513. 

  2514. :ref:`int<class_int>` **keyboard_get_layout_count** **(** **)** |const|
    2515. 

  2515. 

  2516. Returns the number of keyboard layouts.
    2517. 

  2517. 

  2518. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    2519. 

  2519. 

  2520. .. rst-class:: classref-item-separator
    2521. 

  2521. 

  2522. ----
    2523. 

  2523. 

  2524. .. _class_DisplayServer_method_keyboard_get_layout_language:
    2525. 

  2525. 

  2526. .. rst-class:: classref-method
    2527. 

  2527. 

  2528. :ref:`String<class_String>` **keyboard_get_layout_language** **(** :ref:`int<class_int>` index **)** |const|
    2529. 

  2529. 

  2530. Returns the ISO-639/BCP-47 language code of the keyboard layout at position ``index``.
    2531. 

  2531. 

  2532. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    2533. 

  2533. 

  2534. .. rst-class:: classref-item-separator
    2535. 

  2535. 

  2536. ----
    2537. 

  2537. 

  2538. .. _class_DisplayServer_method_keyboard_get_layout_name:
    2539. 

  2539. 

  2540. .. rst-class:: classref-method
    2541. 

  2541. 

  2542. :ref:`String<class_String>` **keyboard_get_layout_name** **(** :ref:`int<class_int>` index **)** |const|
    2543. 

  2543. 

  2544. Returns the localized name of the keyboard layout at position ``index``.
    2545. 

  2545. 

  2546. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    2547. 

  2547. 

  2548. .. rst-class:: classref-item-separator
    2549. 

  2549. 

  2550. ----
    2551. 

  2551. 

  2552. .. _class_DisplayServer_method_keyboard_set_current_layout:
    2553. 

  2553. 

  2554. .. rst-class:: classref-method
    2555. 

  2555. 

  2556. void **keyboard_set_current_layout** **(** :ref:`int<class_int>` index **)**
    2557. 

  2557. 

  2558. Sets the active keyboard layout.
    2559. 

  2559. 

  2560. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    2561. 

  2561. 

  2562. .. rst-class:: classref-item-separator
    2563. 

  2563. 

  2564. ----
    2565. 

  2565. 

  2566. .. _class_DisplayServer_method_mouse_get_button_state:
    2567. 

  2567. 

  2568. .. rst-class:: classref-method
    2569. 

  2569. 

  2570. :ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>` **mouse_get_button_state** **(** **)** |const|
    2571. 

  2571. 

  2572. 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>`.
    2573. 

  2573. 

  2574. .. rst-class:: classref-item-separator
    2575. 

  2575. 

  2576. ----
    2577. 

  2577. 

  2578. .. _class_DisplayServer_method_mouse_get_mode:
    2579. 

  2579. 

  2580. .. rst-class:: classref-method
    2581. 

  2581. 

  2582. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **mouse_get_mode** **(** **)** |const|
    2583. 

  2583. 

  2584. Returns the current mouse mode. See also :ref:`mouse_set_mode<class_DisplayServer_method_mouse_set_mode>`.
    2585. 

  2585. 

  2586. .. rst-class:: classref-item-separator
    2587. 

  2587. 

  2588. ----
    2589. 

  2589. 

  2590. .. _class_DisplayServer_method_mouse_get_position:
    2591. 

  2591. 

  2592. .. rst-class:: classref-method
    2593. 

  2593. 

  2594. :ref:`Vector2i<class_Vector2i>` **mouse_get_position** **(** **)** |const|
    2595. 

  2595. 

  2596. Returns the mouse cursor's current position in screen coordinates.
    2597. 

  2597. 

  2598. .. rst-class:: classref-item-separator
    2599. 

  2599. 

  2600. ----
    2601. 

  2601. 

  2602. .. _class_DisplayServer_method_mouse_set_mode:
    2603. 

  2603. 

  2604. .. rst-class:: classref-method
    2605. 

  2605. 

  2606. void **mouse_set_mode** **(** :ref:`MouseMode<enum_DisplayServer_MouseMode>` mouse_mode **)**
    2607. 

  2607. 

  2608. Sets the current mouse mode. See also :ref:`mouse_get_mode<class_DisplayServer_method_mouse_get_mode>`.
    2609. 

  2609. 

  2610. .. rst-class:: classref-item-separator
    2611. 

  2611. 

  2612. ----
    2613. 

  2613. 

  2614. .. _class_DisplayServer_method_process_events:
    2615. 

  2615. 

  2616. .. rst-class:: classref-method
    2617. 

  2617. 

  2618. void **process_events** **(** **)**
    2619. 

  2619. 

  2620. 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>`.
    2621. 

  2621. 

  2622. .. rst-class:: classref-item-separator
    2623. 

  2623. 

  2624. ----
    2625. 

  2625. 

  2626. .. _class_DisplayServer_method_screen_get_dpi:
    2627. 

  2627. 

  2628. .. rst-class:: classref-method
    2629. 

  2629. 

  2630. :ref:`int<class_int>` **screen_get_dpi** **(** :ref:`int<class_int>` screen=-1 **)** |const|
    2631. 

  2631. 

  2632. 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.
    2633. 

  2633. 

  2634. \ **Note:** On macOS, returned value is inaccurate if fractional display scaling mode is used.
    2635. 

  2635. 

  2636. \ **Note:** On Android devices, the actual screen densities are grouped into six generalized densities:
    2637. 

  2637. 

  2638. ::
    2639. 

  2639. 

  2640.        ldpi - 120 dpi
    2641. 

  2641.        mdpi - 160 dpi
    2642. 

  2642.        hdpi - 240 dpi
    2643. 

  2643.       xhdpi - 320 dpi
    2644. 

  2644.      xxhdpi - 480 dpi
    2645. 

  2645.     xxxhdpi - 640 dpi
    2646. 

  2646. 

  2647. \ **Note:** This method is implemented on Android, Linux (X11), macOS and Windows. Returns ``72`` on unsupported platforms.
    2648. 

  2648. 

  2649. .. rst-class:: classref-item-separator
    2650. 

  2650. 

  2651. ----
    2652. 

  2652. 

  2653. .. _class_DisplayServer_method_screen_get_image:
    2654. 

  2654. 

  2655. .. rst-class:: classref-method
    2656. 

  2656. 

  2657. :ref:`Image<class_Image>` **screen_get_image** **(** :ref:`int<class_int>` screen=-1 **)** |const|
    2658. 

  2658. 

  2659. Returns screenshot of the ``screen``.
    2660. 

  2660. 

  2661. \ **Note:** This method is implemented on Linux (X11), macOS, and Windows.
    2662. 

  2662. 

  2663. \ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.
    2664. 

  2664. 

  2665. .. rst-class:: classref-item-separator
    2666. 

  2666. 

  2667. ----
    2668. 

  2668. 

  2669. .. _class_DisplayServer_method_screen_get_max_scale:
    2670. 

  2670. 

  2671. .. rst-class:: classref-method
    2672. 

  2672. 

  2673. :ref:`float<class_float>` **screen_get_max_scale** **(** **)** |const|
    2674. 

  2674. 

  2675. Returns the greatest scale factor of all screens.
    2676. 

  2676. 

  2677. \ **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.
    2678. 

  2678. 

  2679. \ **Note:** This method is implemented only on macOS.
    2680. 

  2680. 

  2681. .. rst-class:: classref-item-separator
    2682. 

  2682. 

  2683. ----
    2684. 

  2684. 

  2685. .. _class_DisplayServer_method_screen_get_orientation:
    2686. 

  2686. 

  2687. .. rst-class:: classref-method
    2688. 

  2688. 

  2689. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **screen_get_orientation** **(** :ref:`int<class_int>` screen=-1 **)** |const|
    2690. 

  2690. 

  2691. Returns the ``screen``'s current orientation. See also :ref:`screen_set_orientation<class_DisplayServer_method_screen_set_orientation>`.
    2692. 

  2692. 

  2693. \ **Note:** This method is implemented on Android and iOS.
    2694. 

  2694. 

  2695. .. rst-class:: classref-item-separator
    2696. 

  2696. 

  2697. ----
    2698. 

  2698. 

  2699. .. _class_DisplayServer_method_screen_get_pixel:
    2700. 

  2700. 

  2701. .. rst-class:: classref-method
    2702. 

  2702. 

  2703. :ref:`Color<class_Color>` **screen_get_pixel** **(** :ref:`Vector2i<class_Vector2i>` position **)** |const|
    2704. 

  2704. 

  2705. Returns color of the display pixel at the ``position``.
    2706. 

  2706. 

  2707. \ **Note:** This method is implemented on Linux (X11), macOS, and Windows.
    2708. 

  2708. 

  2709. \ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.
    2710. 

  2710. 

  2711. .. rst-class:: classref-item-separator
    2712. 

  2712. 

  2713. ----
    2714. 

  2714. 

  2715. .. _class_DisplayServer_method_screen_get_position:
    2716. 

  2716. 

  2717. .. rst-class:: classref-method
    2718. 

  2718. 

  2719. :ref:`Vector2i<class_Vector2i>` **screen_get_position** **(** :ref:`int<class_int>` screen=-1 **)** |const|
    2720. 

  2720. 

  2721. 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:
    2722. 

  2722. 

  2723. ::
    2724. 

  2724. 

  2725.     * (0, 0)        +-------+
    2726. 

  2726.                     |       |
    2727. 

  2727.     +-------------+ |       |
    2728. 

  2728.     |             | |       |
    2729. 

  2729.     |             | |       |
    2730. 

  2730.     +-------------+ +-------+
    2731. 

  2731. 

  2732. See also :ref:`screen_get_size<class_DisplayServer_method_screen_get_size>`.
    2733. 

  2733. 

  2734. .. rst-class:: classref-item-separator
    2735. 

  2735. 

  2736. ----
    2737. 

  2737. 

  2738. .. _class_DisplayServer_method_screen_get_refresh_rate:
    2739. 

  2739. 

  2740. .. rst-class:: classref-method
    2741. 

  2741. 

  2742. :ref:`float<class_float>` **screen_get_refresh_rate** **(** :ref:`int<class_int>` screen=-1 **)** |const|
    2743. 

  2743. 

  2744. 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.
    2745. 

  2745. 

  2746. \ **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.
    2747. 

  2747. 

  2748. To fallback to a default refresh rate if the method fails, try:
    2749. 

  2749. 

  2750. ::
    2751. 

  2751. 

  2752.     var refresh_rate = DisplayServer.screen_get_refresh_rate()
    2753. 

  2753.     if refresh_rate < 0:
    2754. 

  2754.         refresh_rate = 60.0
    2755. 

  2755. 

  2756. .. rst-class:: classref-item-separator
    2757. 

  2757. 

  2758. ----
    2759. 

  2759. 

  2760. .. _class_DisplayServer_method_screen_get_scale:
    2761. 

  2761. 

  2762. .. rst-class:: classref-method
    2763. 

  2763. 

  2764. :ref:`float<class_float>` **screen_get_scale** **(** :ref:`int<class_int>` screen=-1 **)** |const|
    2765. 

  2765. 

  2766. Returns the scale factor of the specified screen by index.
    2767. 

  2767. 

  2768. \ **Note:** On macOS returned value is ``2.0`` for hiDPI (Retina) screen, and ``1.0`` for all other cases.
    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_screen_get_size:
    2777. 

  2777. 

  2778. .. rst-class:: classref-method
    2779. 

  2779. 

  2780. :ref:`Vector2i<class_Vector2i>` **screen_get_size** **(** :ref:`int<class_int>` screen=-1 **)** |const|
    2781. 

  2781. 

  2782. 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>`.
    2783. 

  2783. 

  2784. .. rst-class:: classref-item-separator
    2785. 

  2785. 

  2786. ----
    2787. 

  2787. 

  2788. .. _class_DisplayServer_method_screen_get_usable_rect:
    2789. 

  2789. 

  2790. .. rst-class:: classref-method
    2791. 

  2791. 

  2792. :ref:`Rect2i<class_Rect2i>` **screen_get_usable_rect** **(** :ref:`int<class_int>` screen=-1 **)** |const|
    2793. 

  2793. 

  2794. 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>`.
    2795. 

  2795. 

  2796. .. rst-class:: classref-item-separator
    2797. 

  2797. 

  2798. ----
    2799. 

  2799. 

  2800. .. _class_DisplayServer_method_screen_is_kept_on:
    2801. 

  2801. 

  2802. .. rst-class:: classref-method
    2803. 

  2803. 

  2804. :ref:`bool<class_bool>` **screen_is_kept_on** **(** **)** |const|
    2805. 

  2805. 

  2806. 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>`.
    2807. 

  2807. 

  2808. .. rst-class:: classref-item-separator
    2809. 

  2809. 

  2810. ----
    2811. 

  2811. 

  2812. .. _class_DisplayServer_method_screen_set_keep_on:
    2813. 

  2813. 

  2814. .. rst-class:: classref-method
    2815. 

  2815. 

  2816. void **screen_set_keep_on** **(** :ref:`bool<class_bool>` enable **)**
    2817. 

  2817. 

  2818. 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>`.
    2819. 

  2819. 

  2820. .. rst-class:: classref-item-separator
    2821. 

  2821. 

  2822. ----
    2823. 

  2823. 

  2824. .. _class_DisplayServer_method_screen_set_orientation:
    2825. 

  2825. 

  2826. .. rst-class:: classref-method
    2827. 

  2827. 

  2828. void **screen_set_orientation** **(** :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` orientation, :ref:`int<class_int>` screen=-1 **)**
    2829. 

  2829. 

  2830. Sets the ``screen``'s ``orientation``. See also :ref:`screen_get_orientation<class_DisplayServer_method_screen_get_orientation>`.
    2831. 

  2831. 

  2832. .. rst-class:: classref-item-separator
    2833. 

  2833. 

  2834. ----
    2835. 

  2835. 

  2836. .. _class_DisplayServer_method_set_icon:
    2837. 

  2837. 

  2838. .. rst-class:: classref-method
    2839. 

  2839. 

  2840. void **set_icon** **(** :ref:`Image<class_Image>` image **)**
    2841. 

  2841. 

  2842. 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.
    2843. 

  2843. 

  2844. .. rst-class:: classref-item-separator
    2845. 

  2845. 

  2846. ----
    2847. 

  2847. 

  2848. .. _class_DisplayServer_method_set_native_icon:
    2849. 

  2849. 

  2850. .. rst-class:: classref-method
    2851. 

  2851. 

  2852. void **set_native_icon** **(** :ref:`String<class_String>` filename **)**
    2853. 

  2853. 

  2854. 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.
    2855. 

  2855. 

  2856. .. rst-class:: classref-item-separator
    2857. 

  2857. 

  2858. ----
    2859. 

  2859. 

  2860. .. _class_DisplayServer_method_tablet_get_current_driver:
    2861. 

  2861. 

  2862. .. rst-class:: classref-method
    2863. 

  2863. 

  2864. :ref:`String<class_String>` **tablet_get_current_driver** **(** **)** |const|
    2865. 

  2865. 

  2866. Returns current active tablet driver name.
    2867. 

  2867. 

  2868. \ **Note:** This method is implemented only on Windows.
    2869. 

  2869. 

  2870. .. rst-class:: classref-item-separator
    2871. 

  2871. 

  2872. ----
    2873. 

  2873. 

  2874. .. _class_DisplayServer_method_tablet_get_driver_count:
    2875. 

  2875. 

  2876. .. rst-class:: classref-method
    2877. 

  2877. 

  2878. :ref:`int<class_int>` **tablet_get_driver_count** **(** **)** |const|
    2879. 

  2879. 

  2880. Returns the total number of available tablet drivers.
    2881. 

  2881. 

  2882. \ **Note:** This method is implemented only on Windows.
    2883. 

  2883. 

  2884. .. rst-class:: classref-item-separator
    2885. 

  2885. 

  2886. ----
    2887. 

  2887. 

  2888. .. _class_DisplayServer_method_tablet_get_driver_name:
    2889. 

  2889. 

  2890. .. rst-class:: classref-method
    2891. 

  2891. 

  2892. :ref:`String<class_String>` **tablet_get_driver_name** **(** :ref:`int<class_int>` idx **)** |const|
    2893. 

  2893. 

  2894. Returns the tablet driver name for the given index.
    2895. 

  2895. 

  2896. \ **Note:** This method is implemented only on Windows.
    2897. 

  2897. 

  2898. .. rst-class:: classref-item-separator
    2899. 

  2899. 

  2900. ----
    2901. 

  2901. 

  2902. .. _class_DisplayServer_method_tablet_set_current_driver:
    2903. 

  2903. 

  2904. .. rst-class:: classref-method
    2905. 

  2905. 

  2906. void **tablet_set_current_driver** **(** :ref:`String<class_String>` name **)**
    2907. 

  2907. 

  2908. Set active tablet driver name.
    2909. 

  2909. 

  2910. \ **Note:** This method is implemented only on Windows.
    2911. 

  2911. 

  2912. .. rst-class:: classref-item-separator
    2913. 

  2913. 

  2914. ----
    2915. 

  2915. 

  2916. .. _class_DisplayServer_method_tts_get_voices:
    2917. 

  2917. 

  2918. .. rst-class:: classref-method
    2919. 

  2919. 

  2920. :ref:`Dictionary[]<class_Dictionary>` **tts_get_voices** **(** **)** |const|
    2921. 

  2921. 

  2922. Returns an :ref:`Array<class_Array>` of voice information dictionaries.
    2923. 

  2923. 

  2924. Each :ref:`Dictionary<class_Dictionary>` contains two :ref:`String<class_String>` entries:
    2925. 

  2925. 

  2926. - ``name`` is voice name.
    2927. 

  2927. 

  2928. - ``id`` is voice identifier.
    2929. 

  2929. 

  2930. - ``language`` is language code in ``lang_Variant`` format. ``lang`` part is a 2 or 3-letter code based on the ISO-639 standard, in lowercase. And ``Variant`` part is an engine dependent string describing country, region or/and dialect.
    2931. 

  2931. 

  2932. 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.
    2933. 

  2933. 

  2934. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    2935. 

  2935. 

  2936. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    2937. 

  2937. 

  2938. .. rst-class:: classref-item-separator
    2939. 

  2939. 

  2940. ----
    2941. 

  2941. 

  2942. .. _class_DisplayServer_method_tts_get_voices_for_language:
    2943. 

  2943. 

  2944. .. rst-class:: classref-method
    2945. 

  2945. 

  2946. :ref:`PackedStringArray<class_PackedStringArray>` **tts_get_voices_for_language** **(** :ref:`String<class_String>` language **)** |const|
    2947. 

  2947. 

  2948. Returns an :ref:`PackedStringArray<class_PackedStringArray>` of voice identifiers for the ``language``.
    2949. 

  2949. 

  2950. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    2951. 

  2951. 

  2952. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    2953. 

  2953. 

  2954. .. rst-class:: classref-item-separator
    2955. 

  2955. 

  2956. ----
    2957. 

  2957. 

  2958. .. _class_DisplayServer_method_tts_is_paused:
    2959. 

  2959. 

  2960. .. rst-class:: classref-method
    2961. 

  2961. 

  2962. :ref:`bool<class_bool>` **tts_is_paused** **(** **)** |const|
    2963. 

  2963. 

  2964. Returns ``true`` if the synthesizer is in a paused state.
    2965. 

  2965. 

  2966. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    2967. 

  2967. 

  2968. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    2969. 

  2969. 

  2970. .. rst-class:: classref-item-separator
    2971. 

  2971. 

  2972. ----
    2973. 

  2973. 

  2974. .. _class_DisplayServer_method_tts_is_speaking:
    2975. 

  2975. 

  2976. .. rst-class:: classref-method
    2977. 

  2977. 

  2978. :ref:`bool<class_bool>` **tts_is_speaking** **(** **)** |const|
    2979. 

  2979. 

  2980. Returns ``true`` if the synthesizer is generating speech, or have utterance waiting in the queue.
    2981. 

  2981. 

  2982. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    2983. 

  2983. 

  2984. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    2985. 

  2985. 

  2986. .. rst-class:: classref-item-separator
    2987. 

  2987. 

  2988. ----
    2989. 

  2989. 

  2990. .. _class_DisplayServer_method_tts_pause:
    2991. 

  2991. 

  2992. .. rst-class:: classref-method
    2993. 

  2993. 

  2994. void **tts_pause** **(** **)**
    2995. 

  2995. 

  2996. Puts the synthesizer into a paused state.
    2997. 

  2997. 

  2998. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    2999. 

  2999. 

  3000. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3001. 

  3001. 

  3002. .. rst-class:: classref-item-separator
    3003. 

  3003. 

  3004. ----
    3005. 

  3005. 

  3006. .. _class_DisplayServer_method_tts_resume:
    3007. 

  3007. 

  3008. .. rst-class:: classref-method
    3009. 

  3009. 

  3010. void **tts_resume** **(** **)**
    3011. 

  3011. 

  3012. Resumes the synthesizer if it was paused.
    3013. 

  3013. 

  3014. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    3015. 

  3015. 

  3016. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3017. 

  3017. 

  3018. .. rst-class:: classref-item-separator
    3019. 

  3019. 

  3020. ----
    3021. 

  3021. 

  3022. .. _class_DisplayServer_method_tts_set_utterance_callback:
    3023. 

  3023. 

  3024. .. rst-class:: classref-method
    3025. 

  3025. 

  3026. void **tts_set_utterance_callback** **(** :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` event, :ref:`Callable<class_Callable>` callable **)**
    3027. 

  3027. 

  3028. Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary.
    3029. 

  3029. 

  3030. - :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.
    3031. 

  3031. 

  3032. - :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.
    3033. 

  3033. 

  3034. \ **Note:** The granularity of the boundary callbacks is engine dependent.
    3035. 

  3035. 

  3036. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    3037. 

  3037. 

  3038. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3039. 

  3039. 

  3040. .. rst-class:: classref-item-separator
    3041. 

  3041. 

  3042. ----
    3043. 

  3043. 

  3044. .. _class_DisplayServer_method_tts_speak:
    3045. 

  3045. 

  3046. .. rst-class:: classref-method
    3047. 

  3047. 

  3048. void **tts_speak** **(** :ref:`String<class_String>` text, :ref:`String<class_String>` voice, :ref:`int<class_int>` volume=50, :ref:`float<class_float>` pitch=1.0, :ref:`float<class_float>` rate=1.0, :ref:`int<class_int>` utterance_id=0, :ref:`bool<class_bool>` interrupt=false **)**
    3049. 

  3049. 

  3050. Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is cleared first.
    3051. 

  3051. 

  3052. - ``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>`.
    3053. 

  3053. 

  3054. - ``volume`` ranges from ``0`` (lowest) to ``100`` (highest).
    3055. 

  3055. 

  3056. - ``pitch`` ranges from ``0.0`` (lowest) to ``2.0`` (highest), ``1.0`` is default pitch for the current voice.
    3057. 

  3057. 

  3058. - ``rate`` ranges from ``0.1`` (lowest) to ``10.0`` (highest), ``1.0`` is a normal speaking rate. Other values act as a percentage relative.
    3059. 

  3059. 

  3060. - ``utterance_id`` is passed as a parameter to the callback functions.
    3061. 

  3061. 

  3062. \ **Note:** On Windows and Linux (X11), 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>`.
    3063. 

  3063. 

  3064. \ **Note:** The granularity of pitch, rate, and volume is engine and voice dependent. Values may be truncated.
    3065. 

  3065. 

  3066. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    3067. 

  3067. 

  3068. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3069. 

  3069. 

  3070. .. rst-class:: classref-item-separator
    3071. 

  3071. 

  3072. ----
    3073. 

  3073. 

  3074. .. _class_DisplayServer_method_tts_stop:
    3075. 

  3075. 

  3076. .. rst-class:: classref-method
    3077. 

  3077. 

  3078. void **tts_stop** **(** **)**
    3079. 

  3079. 

  3080. Stops synthesis in progress and removes all utterances from the queue.
    3081. 

  3081. 

  3082. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    3083. 

  3083. 

  3084. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3085. 

  3085. 

  3086. .. rst-class:: classref-item-separator
    3087. 

  3087. 

  3088. ----
    3089. 

  3089. 

  3090. .. _class_DisplayServer_method_virtual_keyboard_get_height:
    3091. 

  3091. 

  3092. .. rst-class:: classref-method
    3093. 

  3093. 

  3094. :ref:`int<class_int>` **virtual_keyboard_get_height** **(** **)** |const|
    3095. 

  3095. 

  3096. Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.
    3097. 

  3097. 

  3098. .. rst-class:: classref-item-separator
    3099. 

  3099. 

  3100. ----
    3101. 

  3101. 

  3102. .. _class_DisplayServer_method_virtual_keyboard_hide:
    3103. 

  3103. 

  3104. .. rst-class:: classref-method
    3105. 

  3105. 

  3106. void **virtual_keyboard_hide** **(** **)**
    3107. 

  3107. 

  3108. Hides the virtual keyboard if it is shown, does nothing otherwise.
    3109. 

  3109. 

  3110. .. rst-class:: classref-item-separator
    3111. 

  3111. 

  3112. ----
    3113. 

  3113. 

  3114. .. _class_DisplayServer_method_virtual_keyboard_show:
    3115. 

  3115. 

  3116. .. rst-class:: classref-method
    3117. 

  3117. 

  3118. void **virtual_keyboard_show** **(** :ref:`String<class_String>` existing_text, :ref:`Rect2<class_Rect2>` position=Rect2(0, 0, 0, 0), :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` type=0, :ref:`int<class_int>` max_length=-1, :ref:`int<class_int>` cursor_start=-1, :ref:`int<class_int>` cursor_end=-1 **)**
    3119. 

  3119. 

  3120. Shows the virtual keyboard if the platform has one.
    3121. 

  3121. 

  3122. \ ``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).
    3123. 

  3123. 

  3124. \ ``position`` parameter is the screen space :ref:`Rect2<class_Rect2>` of the edited text.
    3125. 

  3125. 

  3126. \ ``type`` parameter allows configuring which type of virtual keyboard to show.
    3127. 

  3127. 

  3128. \ ``max_length`` limits the number of characters that can be entered if different from ``-1``.
    3129. 

  3129. 

  3130. \ ``cursor_start`` can optionally define the current text cursor position if ``cursor_end`` is not set.
    3131. 

  3131. 

  3132. \ ``cursor_start`` and ``cursor_end`` can optionally define the current text selection.
    3133. 

  3133. 

  3134. \ **Note:** This method is implemented on Android, iOS and Web.
    3135. 

  3135. 

  3136. .. rst-class:: classref-item-separator
    3137. 

  3137. 

  3138. ----
    3139. 

  3139. 

  3140. .. _class_DisplayServer_method_warp_mouse:
    3141. 

  3141. 

  3142. .. rst-class:: classref-method
    3143. 

  3143. 

  3144. void **warp_mouse** **(** :ref:`Vector2i<class_Vector2i>` position **)**
    3145. 

  3145. 

  3146. 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.
    3147. 

  3147. 

  3148. \ **Note:** :ref:`warp_mouse<class_DisplayServer_method_warp_mouse>` is only supported on Windows, macOS and Linux. It has no effect on Android, iOS and Web.
    3149. 

  3149. 

  3150. .. rst-class:: classref-item-separator
    3151. 

  3151. 

  3152. ----
    3153. 

  3153. 

  3154. .. _class_DisplayServer_method_window_can_draw:
    3155. 

  3155. 

  3156. .. rst-class:: classref-method
    3157. 

  3157. 

  3158. :ref:`bool<class_bool>` **window_can_draw** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3159. 

  3159. 

  3160. 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``.
    3161. 

  3161. 

  3162. .. rst-class:: classref-item-separator
    3163. 

  3163. 

  3164. ----
    3165. 

  3165. 

  3166. .. _class_DisplayServer_method_window_get_active_popup:
    3167. 

  3167. 

  3168. .. rst-class:: classref-method
    3169. 

  3169. 

  3170. :ref:`int<class_int>` **window_get_active_popup** **(** **)** |const|
    3171. 

  3171. 

  3172. Returns ID of the active popup window, or :ref:`INVALID_WINDOW_ID<class_DisplayServer_constant_INVALID_WINDOW_ID>` if there is none.
    3173. 

  3173. 

  3174. .. rst-class:: classref-item-separator
    3175. 

  3175. 

  3176. ----
    3177. 

  3177. 

  3178. .. _class_DisplayServer_method_window_get_attached_instance_id:
    3179. 

  3179. 

  3180. .. rst-class:: classref-method
    3181. 

  3181. 

  3182. :ref:`int<class_int>` **window_get_attached_instance_id** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3183. 

  3183. 

  3184. 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.
    3185. 

  3185. 

  3186. .. rst-class:: classref-item-separator
    3187. 

  3187. 

  3188. ----
    3189. 

  3189. 

  3190. .. _class_DisplayServer_method_window_get_current_screen:
    3191. 

  3191. 

  3192. .. rst-class:: classref-method
    3193. 

  3193. 

  3194. :ref:`int<class_int>` **window_get_current_screen** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3195. 

  3195. 

  3196. 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>`.
    3197. 

  3197. 

  3198. .. rst-class:: classref-item-separator
    3199. 

  3199. 

  3200. ----
    3201. 

  3201. 

  3202. .. _class_DisplayServer_method_window_get_flag:
    3203. 

  3203. 

  3204. .. rst-class:: classref-method
    3205. 

  3205. 

  3206. :ref:`bool<class_bool>` **window_get_flag** **(** :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` flag, :ref:`int<class_int>` window_id=0 **)** |const|
    3207. 

  3207. 

  3208. Returns the current value of the given window's ``flag``.
    3209. 

  3209. 

  3210. .. rst-class:: classref-item-separator
    3211. 

  3211. 

  3212. ----
    3213. 

  3213. 

  3214. .. _class_DisplayServer_method_window_get_max_size:
    3215. 

  3215. 

  3216. .. rst-class:: classref-method
    3217. 

  3217. 

  3218. :ref:`Vector2i<class_Vector2i>` **window_get_max_size** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3219. 

  3219. 

  3220. Returns the window's maximum size (in pixels). See also :ref:`window_set_max_size<class_DisplayServer_method_window_set_max_size>`.
    3221. 

  3221. 

  3222. .. rst-class:: classref-item-separator
    3223. 

  3223. 

  3224. ----
    3225. 

  3225. 

  3226. .. _class_DisplayServer_method_window_get_min_size:
    3227. 

  3227. 

  3228. .. rst-class:: classref-method
    3229. 

  3229. 

  3230. :ref:`Vector2i<class_Vector2i>` **window_get_min_size** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3231. 

  3231. 

  3232. Returns the window's minimum size (in pixels). See also :ref:`window_set_min_size<class_DisplayServer_method_window_set_min_size>`.
    3233. 

  3233. 

  3234. .. rst-class:: classref-item-separator
    3235. 

  3235. 

  3236. ----
    3237. 

  3237. 

  3238. .. _class_DisplayServer_method_window_get_mode:
    3239. 

  3239. 

  3240. .. rst-class:: classref-method
    3241. 

  3241. 

  3242. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **window_get_mode** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3243. 

  3243. 

  3244. Returns the mode of the given window.
    3245. 

  3245. 

  3246. .. rst-class:: classref-item-separator
    3247. 

  3247. 

  3248. ----
    3249. 

  3249. 

  3250. .. _class_DisplayServer_method_window_get_native_handle:
    3251. 

  3251. 

  3252. .. rst-class:: classref-method
    3253. 

  3253. 

  3254. :ref:`int<class_int>` **window_get_native_handle** **(** :ref:`HandleType<enum_DisplayServer_HandleType>` handle_type, :ref:`int<class_int>` window_id=0 **)** |const|
    3255. 

  3255. 

  3256. Returns internal structure pointers for use in plugins.
    3257. 

  3257. 

  3258. \ **Note:** This method is implemented on Android, Linux (X11), macOS and Windows.
    3259. 

  3259. 

  3260. .. rst-class:: classref-item-separator
    3261. 

  3261. 

  3262. ----
    3263. 

  3263. 

  3264. .. _class_DisplayServer_method_window_get_popup_safe_rect:
    3265. 

  3265. 

  3266. .. rst-class:: classref-method
    3267. 

  3267. 

  3268. :ref:`Rect2i<class_Rect2i>` **window_get_popup_safe_rect** **(** :ref:`int<class_int>` window **)** |const|
    3269. 

  3269. 

  3270. Returns the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system.
    3271. 

  3271. 

  3272. .. rst-class:: classref-item-separator
    3273. 

  3273. 

  3274. ----
    3275. 

  3275. 

  3276. .. _class_DisplayServer_method_window_get_position:
    3277. 

  3277. 

  3278. .. rst-class:: classref-method
    3279. 

  3279. 

  3280. :ref:`Vector2i<class_Vector2i>` **window_get_position** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3281. 

  3281. 

  3282. Returns the position of the client area of the given window on the screen.
    3283. 

  3283. 

  3284. .. rst-class:: classref-item-separator
    3285. 

  3285. 

  3286. ----
    3287. 

  3287. 

  3288. .. _class_DisplayServer_method_window_get_position_with_decorations:
    3289. 

  3289. 

  3290. .. rst-class:: classref-method
    3291. 

  3291. 

  3292. :ref:`Vector2i<class_Vector2i>` **window_get_position_with_decorations** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3293. 

  3293. 

  3294. 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>`.
    3295. 

  3295. 

  3296. .. rst-class:: classref-item-separator
    3297. 

  3297. 

  3298. ----
    3299. 

  3299. 

  3300. .. _class_DisplayServer_method_window_get_safe_title_margins:
    3301. 

  3301. 

  3302. .. rst-class:: classref-method
    3303. 

  3303. 

  3304. :ref:`Vector3i<class_Vector3i>` **window_get_safe_title_margins** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3305. 

  3305. 

  3306. 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.
    3307. 

  3307. 

  3308. .. rst-class:: classref-item-separator
    3309. 

  3309. 

  3310. ----
    3311. 

  3311. 

  3312. .. _class_DisplayServer_method_window_get_size:
    3313. 

  3313. 

  3314. .. rst-class:: classref-method
    3315. 

  3315. 

  3316. :ref:`Vector2i<class_Vector2i>` **window_get_size** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3317. 

  3317. 

  3318. 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>`.
    3319. 

  3319. 

  3320. .. rst-class:: classref-item-separator
    3321. 

  3321. 

  3322. ----
    3323. 

  3323. 

  3324. .. _class_DisplayServer_method_window_get_size_with_decorations:
    3325. 

  3325. 

  3326. .. rst-class:: classref-method
    3327. 

  3327. 

  3328. :ref:`Vector2i<class_Vector2i>` **window_get_size_with_decorations** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3329. 

  3329. 

  3330. 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>`.
    3331. 

  3331. 

  3332. .. rst-class:: classref-item-separator
    3333. 

  3333. 

  3334. ----
    3335. 

  3335. 

  3336. .. _class_DisplayServer_method_window_get_vsync_mode:
    3337. 

  3337. 

  3338. .. rst-class:: classref-method
    3339. 

  3339. 

  3340. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **window_get_vsync_mode** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3341. 

  3341. 

  3342. Returns the V-Sync mode of the given window.
    3343. 

  3343. 

  3344. .. rst-class:: classref-item-separator
    3345. 

  3345. 

  3346. ----
    3347. 

  3347. 

  3348. .. _class_DisplayServer_method_window_is_maximize_allowed:
    3349. 

  3349. 

  3350. .. rst-class:: classref-method
    3351. 

  3351. 

  3352. :ref:`bool<class_bool>` **window_is_maximize_allowed** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3353. 

  3353. 

  3354. Returns ``true`` if the given window can be maximized (the maximize button is enabled).
    3355. 

  3355. 

  3356. .. rst-class:: classref-item-separator
    3357. 

  3357. 

  3358. ----
    3359. 

  3359. 

  3360. .. _class_DisplayServer_method_window_maximize_on_title_dbl_click:
    3361. 

  3361. 

  3362. .. rst-class:: classref-method
    3363. 

  3363. 

  3364. :ref:`bool<class_bool>` **window_maximize_on_title_dbl_click** **(** **)** |const|
    3365. 

  3365. 

  3366. Returns ``true``, if double-click on a window title should maximize it.
    3367. 

  3367. 

  3368. \ **Note:** This method is implemented only on macOS.
    3369. 

  3369. 

  3370. .. rst-class:: classref-item-separator
    3371. 

  3371. 

  3372. ----
    3373. 

  3373. 

  3374. .. _class_DisplayServer_method_window_minimize_on_title_dbl_click:
    3375. 

  3375. 

  3376. .. rst-class:: classref-method
    3377. 

  3377. 

  3378. :ref:`bool<class_bool>` **window_minimize_on_title_dbl_click** **(** **)** |const|
    3379. 

  3379. 

  3380. Returns ``true``, if double-click on a window title should minimize it.
    3381. 

  3381. 

  3382. \ **Note:** This method is implemented only on macOS.
    3383. 

  3383. 

  3384. .. rst-class:: classref-item-separator
    3385. 

  3385. 

  3386. ----
    3387. 

  3387. 

  3388. .. _class_DisplayServer_method_window_move_to_foreground:
    3389. 

  3389. 

  3390. .. rst-class:: classref-method
    3391. 

  3391. 

  3392. void **window_move_to_foreground** **(** :ref:`int<class_int>` window_id=0 **)**
    3393. 

  3393. 

  3394. Moves the window specified by ``window_id`` to the foreground, so that it is visible over other windows.
    3395. 

  3395. 

  3396. .. rst-class:: classref-item-separator
    3397. 

  3397. 

  3398. ----
    3399. 

  3399. 

  3400. .. _class_DisplayServer_method_window_request_attention:
    3401. 

  3401. 

  3402. .. rst-class:: classref-method
    3403. 

  3403. 

  3404. void **window_request_attention** **(** :ref:`int<class_int>` window_id=0 **)**
    3405. 

  3405. 

  3406. 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.
    3407. 

  3407. 

  3408. .. rst-class:: classref-item-separator
    3409. 

  3409. 

  3410. ----
    3411. 

  3411. 

  3412. .. _class_DisplayServer_method_window_set_current_screen:
    3413. 

  3413. 

  3414. .. rst-class:: classref-method
    3415. 

  3415. 

  3416. void **window_set_current_screen** **(** :ref:`int<class_int>` screen, :ref:`int<class_int>` window_id=0 **)**
    3417. 

  3417. 

  3418. 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>`.
    3419. 

  3419. 

  3420. .. rst-class:: classref-item-separator
    3421. 

  3421. 

  3422. ----
    3423. 

  3423. 

  3424. .. _class_DisplayServer_method_window_set_drop_files_callback:
    3425. 

  3425. 

  3426. .. rst-class:: classref-method
    3427. 

  3427. 

  3428. void **window_set_drop_files_callback** **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**
    3429. 

  3429. 

  3430. 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``.
    3431. 

  3431. 

  3432. \ **Note:** This method is implemented on Windows, macOS, Linux (X11) and Web.
    3433. 

  3433. 

  3434. .. rst-class:: classref-item-separator
    3435. 

  3435. 

  3436. ----
    3437. 

  3437. 

  3438. .. _class_DisplayServer_method_window_set_exclusive:
    3439. 

  3439. 

  3440. .. rst-class:: classref-method
    3441. 

  3441. 

  3442. void **window_set_exclusive** **(** :ref:`int<class_int>` window_id, :ref:`bool<class_bool>` exclusive **)**
    3443. 

  3443. 

  3444. 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.
    3445. 

  3445. 

  3446. \ **Note:** On macOS, exclusive windows are confined to the same space (virtual desktop or screen) as the parent window.
    3447. 

  3447. 

  3448. \ **Note:** This method is implemented on macOS and Windows.
    3449. 

  3449. 

  3450. .. rst-class:: classref-item-separator
    3451. 

  3451. 

  3452. ----
    3453. 

  3453. 

  3454. .. _class_DisplayServer_method_window_set_flag:
    3455. 

  3455. 

  3456. .. rst-class:: classref-method
    3457. 

  3457. 

  3458. void **window_set_flag** **(** :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` flag, :ref:`bool<class_bool>` enabled, :ref:`int<class_int>` window_id=0 **)**
    3459. 

  3459. 

  3460. Enables or disables the given window's given ``flag``. See :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` for possible values and their behavior.
    3461. 

  3461. 

  3462. .. rst-class:: classref-item-separator
    3463. 

  3463. 

  3464. ----
    3465. 

  3465. 

  3466. .. _class_DisplayServer_method_window_set_ime_active:
    3467. 

  3467. 

  3468. .. rst-class:: classref-method
    3469. 

  3469. 

  3470. void **window_set_ime_active** **(** :ref:`bool<class_bool>` active, :ref:`int<class_int>` window_id=0 **)**
    3471. 

  3471. 

  3472. 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>`.
    3473. 

  3473. 

  3474. .. rst-class:: classref-item-separator
    3475. 

  3475. 

  3476. ----
    3477. 

  3477. 

  3478. .. _class_DisplayServer_method_window_set_ime_position:
    3479. 

  3479. 

  3480. .. rst-class:: classref-method
    3481. 

  3481. 

  3482. void **window_set_ime_position** **(** :ref:`Vector2i<class_Vector2i>` position, :ref:`int<class_int>` window_id=0 **)**
    3483. 

  3483. 

  3484. 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``.
    3485. 

  3485. 

  3486. .. rst-class:: classref-item-separator
    3487. 

  3487. 

  3488. ----
    3489. 

  3489. 

  3490. .. _class_DisplayServer_method_window_set_input_event_callback:
    3491. 

  3491. 

  3492. .. rst-class:: classref-method
    3493. 

  3493. 

  3494. void **window_set_input_event_callback** **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**
    3495. 

  3495. 

  3496. Sets the ``callback`` that should be called when any :ref:`InputEvent<class_InputEvent>` is sent to the window specified by ``window_id``.
    3497. 

  3497. 

  3498. .. rst-class:: classref-item-separator
    3499. 

  3499. 

  3500. ----
    3501. 

  3501. 

  3502. .. _class_DisplayServer_method_window_set_input_text_callback:
    3503. 

  3503. 

  3504. .. rst-class:: classref-method
    3505. 

  3505. 

  3506. void **window_set_input_text_callback** **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**
    3507. 

  3507. 

  3508. Sets the ``callback`` that should be called when text is entered using the virtual keyboard to the window specified by ``window_id``.
    3509. 

  3509. 

  3510. .. rst-class:: classref-item-separator
    3511. 

  3511. 

  3512. ----
    3513. 

  3513. 

  3514. .. _class_DisplayServer_method_window_set_max_size:
    3515. 

  3515. 

  3516. .. rst-class:: classref-method
    3517. 

  3517. 

  3518. void **window_set_max_size** **(** :ref:`Vector2i<class_Vector2i>` max_size, :ref:`int<class_int>` window_id=0 **)**
    3519. 

  3519. 

  3520. 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>`.
    3521. 

  3521. 

  3522. \ **Note:** It's recommended to change this value using :ref:`Window.max_size<class_Window_property_max_size>` instead.
    3523. 

  3523. 

  3524. \ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.
    3525. 

  3525. 

  3526. .. rst-class:: classref-item-separator
    3527. 

  3527. 

  3528. ----
    3529. 

  3529. 

  3530. .. _class_DisplayServer_method_window_set_min_size:
    3531. 

  3531. 

  3532. .. rst-class:: classref-method
    3533. 

  3533. 

  3534. void **window_set_min_size** **(** :ref:`Vector2i<class_Vector2i>` min_size, :ref:`int<class_int>` window_id=0 **)**
    3535. 

  3535. 

  3536. 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>`.
    3537. 

  3537. 

  3538. \ **Note:** It's recommended to change this value using :ref:`Window.min_size<class_Window_property_min_size>` instead.
    3539. 

  3539. 

  3540. \ **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.
    3541. 

  3541. 

  3542. \ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.
    3543. 

  3543. 

  3544. .. rst-class:: classref-item-separator
    3545. 

  3545. 

  3546. ----
    3547. 

  3547. 

  3548. .. _class_DisplayServer_method_window_set_mode:
    3549. 

  3549. 

  3550. .. rst-class:: classref-method
    3551. 

  3551. 

  3552. void **window_set_mode** **(** :ref:`WindowMode<enum_DisplayServer_WindowMode>` mode, :ref:`int<class_int>` window_id=0 **)**
    3553. 

  3553. 

  3554. Sets window mode for the given window to ``mode``. See :ref:`WindowMode<enum_DisplayServer_WindowMode>` for possible values and how each mode behaves.
    3555. 

  3555. 

  3556. \ **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.
    3557. 

  3557. 

  3558. .. rst-class:: classref-item-separator
    3559. 

  3559. 

  3560. ----
    3561. 

  3561. 

  3562. .. _class_DisplayServer_method_window_set_mouse_passthrough:
    3563. 

  3563. 

  3564. .. rst-class:: classref-method
    3565. 

  3565. 

  3566. void **window_set_mouse_passthrough** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` region, :ref:`int<class_int>` window_id=0 **)**
    3567. 

  3567. 

  3568. Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through.
    3569. 

  3569. 

  3570. Passing an empty array will disable passthrough support (all mouse events will be intercepted by the window, which is the default behavior).
    3571. 

  3571. 

  3572. 

  3573. .. tabs::
    3574. 

  3574. 

  3575.  .. code-tab:: gdscript
    3576. 

  3576. 

  3577.     # Set region, using Path2D node.
    3578. 

  3578.     DisplayServer.window_set_mouse_passthrough($Path2D.curve.get_baked_points())
    3579. 

  3579.     
    3580. 

  3580.     # Set region, using Polygon2D node.
    3581. 

  3581.     DisplayServer.window_set_mouse_passthrough($Polygon2D.polygon)
    3582. 

  3582.     
    3583. 

  3583.     # Reset region to default.
    3584. 

  3584.     DisplayServer.window_set_mouse_passthrough([])
    3585. 

  3585. 

  3586.  .. code-tab:: csharp
    3587. 

  3587. 

  3588.     // Set region, using Path2D node.
    3589. 

  3589.     DisplayServer.WindowSetMousePassthrough(GetNode<Path2D>("Path2D").Curve.GetBakedPoints());
    3590. 

  3590.     
    3591. 

  3591.     // Set region, using Polygon2D node.
    3592. 

  3592.     DisplayServer.WindowSetMousePassthrough(GetNode<Polygon2D>("Polygon2D").Polygon);
    3593. 

  3593.     
    3594. 

  3594.     // Reset region to default.
    3595. 

  3595.     DisplayServer.WindowSetMousePassthrough(new Vector2[] {});
    3596. 

  3596. 

  3597. 

  3598. 

  3599. \ **Note:** On Windows, the portion of a window that lies outside the region is not drawn, while on Linux (X11) and macOS it is.
    3600. 

  3600. 

  3601. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    3602. 

  3602. 

  3603. .. rst-class:: classref-item-separator
    3604. 

  3604. 

  3605. ----
    3606. 

  3606. 

  3607. .. _class_DisplayServer_method_window_set_popup_safe_rect:
    3608. 

  3608. 

  3609. .. rst-class:: classref-method
    3610. 

  3610. 

  3611. void **window_set_popup_safe_rect** **(** :ref:`int<class_int>` window, :ref:`Rect2i<class_Rect2i>` rect **)**
    3612. 

  3612. 

  3613. 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.
    3614. 

  3614. 

  3615. .. rst-class:: classref-item-separator
    3616. 

  3616. 

  3617. ----
    3618. 

  3618. 

  3619. .. _class_DisplayServer_method_window_set_position:
    3620. 

  3620. 

  3621. .. rst-class:: classref-method
    3622. 

  3622. 

  3623. void **window_set_position** **(** :ref:`Vector2i<class_Vector2i>` position, :ref:`int<class_int>` window_id=0 **)**
    3624. 

  3624. 

  3625. 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:
    3626. 

  3626. 

  3627. ::
    3628. 

  3628. 

  3629.     * (0, 0)        +-------+
    3630. 

  3630.                     |       |
    3631. 

  3631.     +-------------+ |       |
    3632. 

  3632.     |             | |       |
    3633. 

  3633.     |             | |       |
    3634. 

  3634.     +-------------+ +-------+
    3635. 

  3635. 

  3636. See also :ref:`window_get_position<class_DisplayServer_method_window_get_position>` and :ref:`window_set_size<class_DisplayServer_method_window_set_size>`.
    3637. 

  3637. 

  3638. \ **Note:** It's recommended to change this value using :ref:`Window.position<class_Window_property_position>` instead.
    3639. 

  3639. 

  3640. .. rst-class:: classref-item-separator
    3641. 

  3641. 

  3642. ----
    3643. 

  3643. 

  3644. .. _class_DisplayServer_method_window_set_rect_changed_callback:
    3645. 

  3645. 

  3646. .. rst-class:: classref-method
    3647. 

  3647. 

  3648. void **window_set_rect_changed_callback** **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**
    3649. 

  3649. 

  3650. Sets the ``callback`` that will be called when the window specified by ``window_id`` is moved or resized.
    3651. 

  3651. 

  3652. .. rst-class:: classref-item-separator
    3653. 

  3653. 

  3654. ----
    3655. 

  3655. 

  3656. .. _class_DisplayServer_method_window_set_size:
    3657. 

  3657. 

  3658. .. rst-class:: classref-method
    3659. 

  3659. 

  3660. void **window_set_size** **(** :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` window_id=0 **)**
    3661. 

  3661. 

  3662. 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>`.
    3663. 

  3663. 

  3664. \ **Note:** It's recommended to change this value using :ref:`Window.size<class_Window_property_size>` instead.
    3665. 

  3665. 

  3666. .. rst-class:: classref-item-separator
    3667. 

  3667. 

  3668. ----
    3669. 

  3669. 

  3670. .. _class_DisplayServer_method_window_set_title:
    3671. 

  3671. 

  3672. .. rst-class:: classref-method
    3673. 

  3673. 

  3674. void **window_set_title** **(** :ref:`String<class_String>` title, :ref:`int<class_int>` window_id=0 **)**
    3675. 

  3675. 

  3676. Sets the title of the given window to ``title``.
    3677. 

  3677. 

  3678. \ **Note:** It's recommended to change this value using :ref:`Window.title<class_Window_property_title>` instead.
    3679. 

  3679. 

  3680. \ **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.
    3681. 

  3681. 

  3682. .. rst-class:: classref-item-separator
    3683. 

  3683. 

  3684. ----
    3685. 

  3685. 

  3686. .. _class_DisplayServer_method_window_set_transient:
    3687. 

  3687. 

  3688. .. rst-class:: classref-method
    3689. 

  3689. 

  3690. void **window_set_transient** **(** :ref:`int<class_int>` window_id, :ref:`int<class_int>` parent_window_id **)**
    3691. 

  3691. 

  3692. 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.
    3693. 

  3693. 

  3694. \ **Note:** It's recommended to change this value using :ref:`Window.transient<class_Window_property_transient>` instead.
    3695. 

  3695. 

  3696. \ **Note:** The behavior might be different depending on the platform.
    3697. 

  3697. 

  3698. .. rst-class:: classref-item-separator
    3699. 

  3699. 

  3700. ----
    3701. 

  3701. 

  3702. .. _class_DisplayServer_method_window_set_vsync_mode:
    3703. 

  3703. 

  3704. .. rst-class:: classref-method
    3705. 

  3705. 

  3706. void **window_set_vsync_mode** **(** :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` vsync_mode, :ref:`int<class_int>` window_id=0 **)**
    3707. 

  3707. 

  3708. 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>`.
    3709. 

  3709. 

  3710. See :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` for possible values and how they affect the behavior of your application.
    3711. 

  3711. 

  3712. 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.
    3713. 

  3713. 

  3714. \ **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.
    3715. 

  3715. 

  3716. .. rst-class:: classref-item-separator
    3717. 

  3717. 

  3718. ----
    3719. 

  3719. 

  3720. .. _class_DisplayServer_method_window_set_window_buttons_offset:
    3721. 

  3721. 

  3722. .. rst-class:: classref-method
    3723. 

  3723. 

  3724. void **window_set_window_buttons_offset** **(** :ref:`Vector2i<class_Vector2i>` offset, :ref:`int<class_int>` window_id=0 **)**
    3725. 

  3725. 

  3726. 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.
    3727. 

  3727. 

  3728. \ **Note:** This flag is implemented only on macOS.
    3729. 

  3729. 

  3730. .. rst-class:: classref-item-separator
    3731. 

  3731. 

  3732. ----
    3733. 

  3733. 

  3734. .. _class_DisplayServer_method_window_set_window_event_callback:
    3735. 

  3735. 

  3736. .. rst-class:: classref-method
    3737. 

  3737. 

  3738. void **window_set_window_event_callback** **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**
    3739. 

  3739. 

  3740. Sets the ``callback`` that will be called when an event occurs in the window specified by ``window_id``.
    3741. 

  3741. 

  3742. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    3743. 

  3743. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    3744. 

  3744. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    3745. 

  3745. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    3746. 

  3746. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    3747. 

  3747. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    3748.