class_displayserver.rst 402 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DisplayServer.xml.
  6. .. _class_DisplayServer:
  7. DisplayServer
  8. =============
  9. **Inherits:** :ref:`Object<class_Object>`
  10. A server interface for low-level window management.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. **DisplayServer** handles everything related to window management. It is separated from :ref:`OS<class_OS>` as a single operating system may support multiple display servers.
  15. \ **Headless mode:** Starting the engine with the ``--headless`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>` disables all rendering and window management functions. Most functions from **DisplayServer** will return dummy values in this case.
  16. .. rst-class:: classref-reftable-group
  17. Methods
  18. -------
  19. .. table::
  20. :widths: auto
  21. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | |void| | :ref:`beep<class_DisplayServer_method_beep>`\ (\ ) |const| |
  23. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`String<class_String>` | :ref:`clipboard_get<class_DisplayServer_method_clipboard_get>`\ (\ ) |const| |
  25. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`Image<class_Image>` | :ref:`clipboard_get_image<class_DisplayServer_method_clipboard_get_image>`\ (\ ) |const| |
  27. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`String<class_String>` | :ref:`clipboard_get_primary<class_DisplayServer_method_clipboard_get_primary>`\ (\ ) |const| |
  29. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`bool<class_bool>` | :ref:`clipboard_has<class_DisplayServer_method_clipboard_has>`\ (\ ) |const| |
  31. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`bool<class_bool>` | :ref:`clipboard_has_image<class_DisplayServer_method_clipboard_has_image>`\ (\ ) |const| |
  33. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | |void| | :ref:`clipboard_set<class_DisplayServer_method_clipboard_set>`\ (\ clipboard\: :ref:`String<class_String>`\ ) |
  35. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | |void| | :ref:`clipboard_set_primary<class_DisplayServer_method_clipboard_set_primary>`\ (\ clipboard_primary\: :ref:`String<class_String>`\ ) |
  37. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | :ref:`int<class_int>` | :ref:`create_status_indicator<class_DisplayServer_method_create_status_indicator>`\ (\ icon\: :ref:`Texture2D<class_Texture2D>`, tooltip\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  39. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`CursorShape<enum_DisplayServer_CursorShape>` | :ref:`cursor_get_shape<class_DisplayServer_method_cursor_get_shape>`\ (\ ) |const| |
  41. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | |void| | :ref:`cursor_set_custom_image<class_DisplayServer_method_cursor_set_custom_image>`\ (\ cursor\: :ref:`Resource<class_Resource>`, shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>` = 0, hotspot\: :ref:`Vector2<class_Vector2>` = Vector2(0, 0)\ ) |
  43. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | |void| | :ref:`cursor_set_shape<class_DisplayServer_method_cursor_set_shape>`\ (\ shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>`\ ) |
  45. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | |void| | :ref:`delete_status_indicator<class_DisplayServer_method_delete_status_indicator>`\ (\ id\: :ref:`int<class_int>`\ ) |
  47. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`dialog_input_text<class_DisplayServer_method_dialog_input_text>`\ (\ title\: :ref:`String<class_String>`, description\: :ref:`String<class_String>`, existing_text\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  49. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`dialog_show<class_DisplayServer_method_dialog_show>`\ (\ title\: :ref:`String<class_String>`, description\: :ref:`String<class_String>`, buttons\: :ref:`PackedStringArray<class_PackedStringArray>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  51. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | |void| | :ref:`enable_for_stealing_focus<class_DisplayServer_method_enable_for_stealing_focus>`\ (\ process_id\: :ref:`int<class_int>`\ ) |
  53. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`file_dialog_show<class_DisplayServer_method_file_dialog_show>`\ (\ title\: :ref:`String<class_String>`, current_directory\: :ref:`String<class_String>`, filename\: :ref:`String<class_String>`, show_hidden\: :ref:`bool<class_bool>`, mode\: :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>`, filters\: :ref:`PackedStringArray<class_PackedStringArray>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  55. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`file_dialog_with_options_show<class_DisplayServer_method_file_dialog_with_options_show>`\ (\ title\: :ref:`String<class_String>`, current_directory\: :ref:`String<class_String>`, root\: :ref:`String<class_String>`, filename\: :ref:`String<class_String>`, show_hidden\: :ref:`bool<class_bool>`, mode\: :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>`, filters\: :ref:`PackedStringArray<class_PackedStringArray>`, options\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\], callback\: :ref:`Callable<class_Callable>`\ ) |
  57. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | |void| | :ref:`force_process_and_drop_events<class_DisplayServer_method_force_process_and_drop_events>`\ (\ ) |
  59. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | :ref:`Color<class_Color>` | :ref:`get_accent_color<class_DisplayServer_method_get_accent_color>`\ (\ ) |const| |
  61. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`Color<class_Color>` | :ref:`get_base_color<class_DisplayServer_method_get_base_color>`\ (\ ) |const| |
  63. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`Array<class_Array>`\[:ref:`Rect2<class_Rect2>`\] | :ref:`get_display_cutouts<class_DisplayServer_method_get_display_cutouts>`\ (\ ) |const| |
  65. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`Rect2i<class_Rect2i>` | :ref:`get_display_safe_area<class_DisplayServer_method_get_display_safe_area>`\ (\ ) |const| |
  67. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`int<class_int>` | :ref:`get_keyboard_focus_screen<class_DisplayServer_method_get_keyboard_focus_screen>`\ (\ ) |const| |
  69. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :ref:`String<class_String>` | :ref:`get_name<class_DisplayServer_method_get_name>`\ (\ ) |const| |
  71. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :ref:`int<class_int>` | :ref:`get_primary_screen<class_DisplayServer_method_get_primary_screen>`\ (\ ) |const| |
  73. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :ref:`int<class_int>` | :ref:`get_screen_count<class_DisplayServer_method_get_screen_count>`\ (\ ) |const| |
  75. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | :ref:`int<class_int>` | :ref:`get_screen_from_rect<class_DisplayServer_method_get_screen_from_rect>`\ (\ rect\: :ref:`Rect2<class_Rect2>`\ ) |const| |
  77. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :ref:`bool<class_bool>` | :ref:`get_swap_cancel_ok<class_DisplayServer_method_get_swap_cancel_ok>`\ (\ ) |
  79. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | :ref:`int<class_int>` | :ref:`get_window_at_screen_position<class_DisplayServer_method_get_window_at_screen_position>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
  81. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_window_list<class_DisplayServer_method_get_window_list>`\ (\ ) |const| |
  83. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | :ref:`int<class_int>` | :ref:`global_menu_add_check_item<class_DisplayServer_method_global_menu_add_check_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
  85. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | :ref:`int<class_int>` | :ref:`global_menu_add_icon_check_item<class_DisplayServer_method_global_menu_add_icon_check_item>`\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
  87. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | :ref:`int<class_int>` | :ref:`global_menu_add_icon_item<class_DisplayServer_method_global_menu_add_icon_item>`\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
  89. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :ref:`int<class_int>` | :ref:`global_menu_add_icon_radio_check_item<class_DisplayServer_method_global_menu_add_icon_radio_check_item>`\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
  91. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | :ref:`int<class_int>` | :ref:`global_menu_add_item<class_DisplayServer_method_global_menu_add_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
  93. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`int<class_int>` | :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, max_states\: :ref:`int<class_int>`, default_state\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
  95. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | :ref:`int<class_int>` | :ref:`global_menu_add_radio_check_item<class_DisplayServer_method_global_menu_add_radio_check_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) |
  97. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | :ref:`int<class_int>` | :ref:`global_menu_add_separator<class_DisplayServer_method_global_menu_add_separator>`\ (\ menu_root\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ ) |
  99. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | :ref:`int<class_int>` | :ref:`global_menu_add_submenu_item<class_DisplayServer_method_global_menu_add_submenu_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, submenu\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ ) |
  101. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | |void| | :ref:`global_menu_clear<class_DisplayServer_method_global_menu_clear>`\ (\ menu_root\: :ref:`String<class_String>`\ ) |
  103. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | :ref:`Key<enum_@GlobalScope_Key>` | :ref:`global_menu_get_item_accelerator<class_DisplayServer_method_global_menu_get_item_accelerator>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  105. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | :ref:`Callable<class_Callable>` | :ref:`global_menu_get_item_callback<class_DisplayServer_method_global_menu_get_item_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  107. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | :ref:`int<class_int>` | :ref:`global_menu_get_item_count<class_DisplayServer_method_global_menu_get_item_count>`\ (\ menu_root\: :ref:`String<class_String>`\ ) |const| |
  109. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | :ref:`Texture2D<class_Texture2D>` | :ref:`global_menu_get_item_icon<class_DisplayServer_method_global_menu_get_item_icon>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  111. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | :ref:`int<class_int>` | :ref:`global_menu_get_item_indentation_level<class_DisplayServer_method_global_menu_get_item_indentation_level>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  113. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | :ref:`int<class_int>` | :ref:`global_menu_get_item_index_from_tag<class_DisplayServer_method_global_menu_get_item_index_from_tag>`\ (\ menu_root\: :ref:`String<class_String>`, tag\: :ref:`Variant<class_Variant>`\ ) |const| |
  115. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | :ref:`int<class_int>` | :ref:`global_menu_get_item_index_from_text<class_DisplayServer_method_global_menu_get_item_index_from_text>`\ (\ menu_root\: :ref:`String<class_String>`, text\: :ref:`String<class_String>`\ ) |const| |
  117. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | :ref:`Callable<class_Callable>` | :ref:`global_menu_get_item_key_callback<class_DisplayServer_method_global_menu_get_item_key_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  119. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | :ref:`int<class_int>` | :ref:`global_menu_get_item_max_states<class_DisplayServer_method_global_menu_get_item_max_states>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  121. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | :ref:`int<class_int>` | :ref:`global_menu_get_item_state<class_DisplayServer_method_global_menu_get_item_state>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  123. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | :ref:`String<class_String>` | :ref:`global_menu_get_item_submenu<class_DisplayServer_method_global_menu_get_item_submenu>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  125. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | :ref:`Variant<class_Variant>` | :ref:`global_menu_get_item_tag<class_DisplayServer_method_global_menu_get_item_tag>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  127. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | :ref:`String<class_String>` | :ref:`global_menu_get_item_text<class_DisplayServer_method_global_menu_get_item_text>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  129. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | :ref:`String<class_String>` | :ref:`global_menu_get_item_tooltip<class_DisplayServer_method_global_menu_get_item_tooltip>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  131. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | :ref:`Dictionary<class_Dictionary>` | :ref:`global_menu_get_system_menu_roots<class_DisplayServer_method_global_menu_get_system_menu_roots>`\ (\ ) |const| |
  133. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | :ref:`bool<class_bool>` | :ref:`global_menu_is_item_checkable<class_DisplayServer_method_global_menu_is_item_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  135. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. | :ref:`bool<class_bool>` | :ref:`global_menu_is_item_checked<class_DisplayServer_method_global_menu_is_item_checked>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  137. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  138. | :ref:`bool<class_bool>` | :ref:`global_menu_is_item_disabled<class_DisplayServer_method_global_menu_is_item_disabled>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  139. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  140. | :ref:`bool<class_bool>` | :ref:`global_menu_is_item_hidden<class_DisplayServer_method_global_menu_is_item_hidden>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  141. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  142. | :ref:`bool<class_bool>` | :ref:`global_menu_is_item_radio_checkable<class_DisplayServer_method_global_menu_is_item_radio_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| |
  143. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  144. | |void| | :ref:`global_menu_remove_item<class_DisplayServer_method_global_menu_remove_item>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |
  145. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  146. | |void| | :ref:`global_menu_set_item_accelerator<class_DisplayServer_method_global_menu_set_item_accelerator>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |
  147. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  148. | |void| | :ref:`global_menu_set_item_callback<class_DisplayServer_method_global_menu_set_item_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  149. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  150. | |void| | :ref:`global_menu_set_item_checkable<class_DisplayServer_method_global_menu_set_item_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ ) |
  151. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  152. | |void| | :ref:`global_menu_set_item_checked<class_DisplayServer_method_global_menu_set_item_checked>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checked\: :ref:`bool<class_bool>`\ ) |
  153. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  154. | |void| | :ref:`global_menu_set_item_disabled<class_DisplayServer_method_global_menu_set_item_disabled>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) |
  155. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  156. | |void| | :ref:`global_menu_set_item_hidden<class_DisplayServer_method_global_menu_set_item_hidden>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, hidden\: :ref:`bool<class_bool>`\ ) |
  157. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  158. | |void| | :ref:`global_menu_set_item_hover_callbacks<class_DisplayServer_method_global_menu_set_item_hover_callbacks>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  159. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  160. | |void| | :ref:`global_menu_set_item_icon<class_DisplayServer_method_global_menu_set_item_icon>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) |
  161. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  162. | |void| | :ref:`global_menu_set_item_indentation_level<class_DisplayServer_method_global_menu_set_item_indentation_level>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, level\: :ref:`int<class_int>`\ ) |
  163. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  164. | |void| | :ref:`global_menu_set_item_key_callback<class_DisplayServer_method_global_menu_set_item_key_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, key_callback\: :ref:`Callable<class_Callable>`\ ) |
  165. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  166. | |void| | :ref:`global_menu_set_item_max_states<class_DisplayServer_method_global_menu_set_item_max_states>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, max_states\: :ref:`int<class_int>`\ ) |
  167. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  168. | |void| | :ref:`global_menu_set_item_radio_checkable<class_DisplayServer_method_global_menu_set_item_radio_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ ) |
  169. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  170. | |void| | :ref:`global_menu_set_item_state<class_DisplayServer_method_global_menu_set_item_state>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, state\: :ref:`int<class_int>`\ ) |
  171. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  172. | |void| | :ref:`global_menu_set_item_submenu<class_DisplayServer_method_global_menu_set_item_submenu>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, submenu\: :ref:`String<class_String>`\ ) |
  173. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  174. | |void| | :ref:`global_menu_set_item_tag<class_DisplayServer_method_global_menu_set_item_tag>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tag\: :ref:`Variant<class_Variant>`\ ) |
  175. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  176. | |void| | :ref:`global_menu_set_item_text<class_DisplayServer_method_global_menu_set_item_text>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, text\: :ref:`String<class_String>`\ ) |
  177. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  178. | |void| | :ref:`global_menu_set_item_tooltip<class_DisplayServer_method_global_menu_set_item_tooltip>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) |
  179. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  180. | |void| | :ref:`global_menu_set_popup_callbacks<class_DisplayServer_method_global_menu_set_popup_callbacks>`\ (\ menu_root\: :ref:`String<class_String>`, open_callback\: :ref:`Callable<class_Callable>`, close_callback\: :ref:`Callable<class_Callable>`\ ) |
  181. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  182. | :ref:`bool<class_bool>` | :ref:`has_additional_outputs<class_DisplayServer_method_has_additional_outputs>`\ (\ ) |const| |
  183. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  184. | :ref:`bool<class_bool>` | :ref:`has_feature<class_DisplayServer_method_has_feature>`\ (\ feature\: :ref:`Feature<enum_DisplayServer_Feature>`\ ) |const| |
  185. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  186. | :ref:`bool<class_bool>` | :ref:`has_hardware_keyboard<class_DisplayServer_method_has_hardware_keyboard>`\ (\ ) |const| |
  187. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  188. | |void| | :ref:`help_set_search_callbacks<class_DisplayServer_method_help_set_search_callbacks>`\ (\ search_callback\: :ref:`Callable<class_Callable>`, action_callback\: :ref:`Callable<class_Callable>`\ ) |
  189. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  190. | :ref:`Vector2i<class_Vector2i>` | :ref:`ime_get_selection<class_DisplayServer_method_ime_get_selection>`\ (\ ) |const| |
  191. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  192. | :ref:`String<class_String>` | :ref:`ime_get_text<class_DisplayServer_method_ime_get_text>`\ (\ ) |const| |
  193. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  194. | :ref:`bool<class_bool>` | :ref:`is_dark_mode<class_DisplayServer_method_is_dark_mode>`\ (\ ) |const| |
  195. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  196. | :ref:`bool<class_bool>` | :ref:`is_dark_mode_supported<class_DisplayServer_method_is_dark_mode_supported>`\ (\ ) |const| |
  197. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  198. | :ref:`bool<class_bool>` | :ref:`is_touchscreen_available<class_DisplayServer_method_is_touchscreen_available>`\ (\ ) |const| |
  199. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  200. | :ref:`bool<class_bool>` | :ref:`is_window_transparency_available<class_DisplayServer_method_is_window_transparency_available>`\ (\ ) |const| |
  201. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  202. | :ref:`int<class_int>` | :ref:`keyboard_get_current_layout<class_DisplayServer_method_keyboard_get_current_layout>`\ (\ ) |const| |
  203. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  204. | :ref:`Key<enum_@GlobalScope_Key>` | :ref:`keyboard_get_keycode_from_physical<class_DisplayServer_method_keyboard_get_keycode_from_physical>`\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const| |
  205. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  206. | :ref:`Key<enum_@GlobalScope_Key>` | :ref:`keyboard_get_label_from_physical<class_DisplayServer_method_keyboard_get_label_from_physical>`\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const| |
  207. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  208. | :ref:`int<class_int>` | :ref:`keyboard_get_layout_count<class_DisplayServer_method_keyboard_get_layout_count>`\ (\ ) |const| |
  209. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  210. | :ref:`String<class_String>` | :ref:`keyboard_get_layout_language<class_DisplayServer_method_keyboard_get_layout_language>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
  211. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  212. | :ref:`String<class_String>` | :ref:`keyboard_get_layout_name<class_DisplayServer_method_keyboard_get_layout_name>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
  213. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  214. | |void| | :ref:`keyboard_set_current_layout<class_DisplayServer_method_keyboard_set_current_layout>`\ (\ index\: :ref:`int<class_int>`\ ) |
  215. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  216. | |bitfield|\[:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>`\] | :ref:`mouse_get_button_state<class_DisplayServer_method_mouse_get_button_state>`\ (\ ) |const| |
  217. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  218. | :ref:`MouseMode<enum_DisplayServer_MouseMode>` | :ref:`mouse_get_mode<class_DisplayServer_method_mouse_get_mode>`\ (\ ) |const| |
  219. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  220. | :ref:`Vector2i<class_Vector2i>` | :ref:`mouse_get_position<class_DisplayServer_method_mouse_get_position>`\ (\ ) |const| |
  221. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  222. | |void| | :ref:`mouse_set_mode<class_DisplayServer_method_mouse_set_mode>`\ (\ mouse_mode\: :ref:`MouseMode<enum_DisplayServer_MouseMode>`\ ) |
  223. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  224. | |void| | :ref:`process_events<class_DisplayServer_method_process_events>`\ (\ ) |
  225. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  226. | |void| | :ref:`register_additional_output<class_DisplayServer_method_register_additional_output>`\ (\ object\: :ref:`Object<class_Object>`\ ) |
  227. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  228. | :ref:`int<class_int>` | :ref:`screen_get_dpi<class_DisplayServer_method_screen_get_dpi>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  229. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  230. | :ref:`Image<class_Image>` | :ref:`screen_get_image<class_DisplayServer_method_screen_get_image>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  231. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  232. | :ref:`Image<class_Image>` | :ref:`screen_get_image_rect<class_DisplayServer_method_screen_get_image_rect>`\ (\ rect\: :ref:`Rect2i<class_Rect2i>`\ ) |const| |
  233. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  234. | :ref:`float<class_float>` | :ref:`screen_get_max_scale<class_DisplayServer_method_screen_get_max_scale>`\ (\ ) |const| |
  235. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  236. | :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` | :ref:`screen_get_orientation<class_DisplayServer_method_screen_get_orientation>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  237. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  238. | :ref:`Color<class_Color>` | :ref:`screen_get_pixel<class_DisplayServer_method_screen_get_pixel>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
  239. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  240. | :ref:`Vector2i<class_Vector2i>` | :ref:`screen_get_position<class_DisplayServer_method_screen_get_position>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  241. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  242. | :ref:`float<class_float>` | :ref:`screen_get_refresh_rate<class_DisplayServer_method_screen_get_refresh_rate>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  243. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  244. | :ref:`float<class_float>` | :ref:`screen_get_scale<class_DisplayServer_method_screen_get_scale>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  245. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  246. | :ref:`Vector2i<class_Vector2i>` | :ref:`screen_get_size<class_DisplayServer_method_screen_get_size>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  247. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  248. | :ref:`Rect2i<class_Rect2i>` | :ref:`screen_get_usable_rect<class_DisplayServer_method_screen_get_usable_rect>`\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| |
  249. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  250. | :ref:`bool<class_bool>` | :ref:`screen_is_kept_on<class_DisplayServer_method_screen_is_kept_on>`\ (\ ) |const| |
  251. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  252. | |void| | :ref:`screen_set_keep_on<class_DisplayServer_method_screen_set_keep_on>`\ (\ enable\: :ref:`bool<class_bool>`\ ) |
  253. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  254. | |void| | :ref:`screen_set_orientation<class_DisplayServer_method_screen_set_orientation>`\ (\ orientation\: :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>`, screen\: :ref:`int<class_int>` = -1\ ) |
  255. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  256. | |void| | :ref:`set_icon<class_DisplayServer_method_set_icon>`\ (\ image\: :ref:`Image<class_Image>`\ ) |
  257. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  258. | |void| | :ref:`set_native_icon<class_DisplayServer_method_set_native_icon>`\ (\ filename\: :ref:`String<class_String>`\ ) |
  259. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  260. | |void| | :ref:`set_system_theme_change_callback<class_DisplayServer_method_set_system_theme_change_callback>`\ (\ callable\: :ref:`Callable<class_Callable>`\ ) |
  261. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  262. | :ref:`Rect2<class_Rect2>` | :ref:`status_indicator_get_rect<class_DisplayServer_method_status_indicator_get_rect>`\ (\ id\: :ref:`int<class_int>`\ ) |const| |
  263. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  264. | |void| | :ref:`status_indicator_set_callback<class_DisplayServer_method_status_indicator_set_callback>`\ (\ id\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  265. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  266. | |void| | :ref:`status_indicator_set_icon<class_DisplayServer_method_status_indicator_set_icon>`\ (\ id\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) |
  267. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  268. | |void| | :ref:`status_indicator_set_menu<class_DisplayServer_method_status_indicator_set_menu>`\ (\ id\: :ref:`int<class_int>`, menu_rid\: :ref:`RID<class_RID>`\ ) |
  269. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  270. | |void| | :ref:`status_indicator_set_tooltip<class_DisplayServer_method_status_indicator_set_tooltip>`\ (\ id\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) |
  271. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  272. | :ref:`String<class_String>` | :ref:`tablet_get_current_driver<class_DisplayServer_method_tablet_get_current_driver>`\ (\ ) |const| |
  273. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  274. | :ref:`int<class_int>` | :ref:`tablet_get_driver_count<class_DisplayServer_method_tablet_get_driver_count>`\ (\ ) |const| |
  275. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  276. | :ref:`String<class_String>` | :ref:`tablet_get_driver_name<class_DisplayServer_method_tablet_get_driver_name>`\ (\ idx\: :ref:`int<class_int>`\ ) |const| |
  277. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  278. | |void| | :ref:`tablet_set_current_driver<class_DisplayServer_method_tablet_set_current_driver>`\ (\ name\: :ref:`String<class_String>`\ ) |
  279. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  280. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`tts_get_voices<class_DisplayServer_method_tts_get_voices>`\ (\ ) |const| |
  281. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  282. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`tts_get_voices_for_language<class_DisplayServer_method_tts_get_voices_for_language>`\ (\ language\: :ref:`String<class_String>`\ ) |const| |
  283. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  284. | :ref:`bool<class_bool>` | :ref:`tts_is_paused<class_DisplayServer_method_tts_is_paused>`\ (\ ) |const| |
  285. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  286. | :ref:`bool<class_bool>` | :ref:`tts_is_speaking<class_DisplayServer_method_tts_is_speaking>`\ (\ ) |const| |
  287. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  288. | |void| | :ref:`tts_pause<class_DisplayServer_method_tts_pause>`\ (\ ) |
  289. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  290. | |void| | :ref:`tts_resume<class_DisplayServer_method_tts_resume>`\ (\ ) |
  291. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  292. | |void| | :ref:`tts_set_utterance_callback<class_DisplayServer_method_tts_set_utterance_callback>`\ (\ event\: :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>`, callable\: :ref:`Callable<class_Callable>`\ ) |
  293. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  294. | |void| | :ref:`tts_speak<class_DisplayServer_method_tts_speak>`\ (\ text\: :ref:`String<class_String>`, voice\: :ref:`String<class_String>`, volume\: :ref:`int<class_int>` = 50, pitch\: :ref:`float<class_float>` = 1.0, rate\: :ref:`float<class_float>` = 1.0, utterance_id\: :ref:`int<class_int>` = 0, interrupt\: :ref:`bool<class_bool>` = false\ ) |
  295. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  296. | |void| | :ref:`tts_stop<class_DisplayServer_method_tts_stop>`\ (\ ) |
  297. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  298. | |void| | :ref:`unregister_additional_output<class_DisplayServer_method_unregister_additional_output>`\ (\ object\: :ref:`Object<class_Object>`\ ) |
  299. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  300. | :ref:`int<class_int>` | :ref:`virtual_keyboard_get_height<class_DisplayServer_method_virtual_keyboard_get_height>`\ (\ ) |const| |
  301. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  302. | |void| | :ref:`virtual_keyboard_hide<class_DisplayServer_method_virtual_keyboard_hide>`\ (\ ) |
  303. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  304. | |void| | :ref:`virtual_keyboard_show<class_DisplayServer_method_virtual_keyboard_show>`\ (\ existing_text\: :ref:`String<class_String>`, position\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0), type\: :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` = 0, max_length\: :ref:`int<class_int>` = -1, cursor_start\: :ref:`int<class_int>` = -1, cursor_end\: :ref:`int<class_int>` = -1\ ) |
  305. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  306. | |void| | :ref:`warp_mouse<class_DisplayServer_method_warp_mouse>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |
  307. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  308. | :ref:`bool<class_bool>` | :ref:`window_can_draw<class_DisplayServer_method_window_can_draw>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  309. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  310. | :ref:`int<class_int>` | :ref:`window_get_active_popup<class_DisplayServer_method_window_get_active_popup>`\ (\ ) |const| |
  311. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  312. | :ref:`int<class_int>` | :ref:`window_get_attached_instance_id<class_DisplayServer_method_window_get_attached_instance_id>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  313. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  314. | :ref:`int<class_int>` | :ref:`window_get_current_screen<class_DisplayServer_method_window_get_current_screen>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  315. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  316. | :ref:`bool<class_bool>` | :ref:`window_get_flag<class_DisplayServer_method_window_get_flag>`\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  317. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  318. | :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_max_size<class_DisplayServer_method_window_get_max_size>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  319. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  320. | :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_min_size<class_DisplayServer_method_window_get_min_size>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  321. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  322. | :ref:`WindowMode<enum_DisplayServer_WindowMode>` | :ref:`window_get_mode<class_DisplayServer_method_window_get_mode>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  323. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  324. | :ref:`int<class_int>` | :ref:`window_get_native_handle<class_DisplayServer_method_window_get_native_handle>`\ (\ handle_type\: :ref:`HandleType<enum_DisplayServer_HandleType>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  325. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  326. | :ref:`Rect2i<class_Rect2i>` | :ref:`window_get_popup_safe_rect<class_DisplayServer_method_window_get_popup_safe_rect>`\ (\ window\: :ref:`int<class_int>`\ ) |const| |
  327. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  328. | :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_position<class_DisplayServer_method_window_get_position>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  329. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  330. | :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_position_with_decorations<class_DisplayServer_method_window_get_position_with_decorations>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  331. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  332. | :ref:`Vector3i<class_Vector3i>` | :ref:`window_get_safe_title_margins<class_DisplayServer_method_window_get_safe_title_margins>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  333. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  334. | :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_size<class_DisplayServer_method_window_get_size>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  335. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  336. | :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_size_with_decorations<class_DisplayServer_method_window_get_size_with_decorations>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  337. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  338. | :ref:`Vector2i<class_Vector2i>` | :ref:`window_get_title_size<class_DisplayServer_method_window_get_title_size>`\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  339. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  340. | :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` | :ref:`window_get_vsync_mode<class_DisplayServer_method_window_get_vsync_mode>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  341. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  342. | :ref:`bool<class_bool>` | :ref:`window_is_focused<class_DisplayServer_method_window_is_focused>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  343. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  344. | :ref:`bool<class_bool>` | :ref:`window_is_maximize_allowed<class_DisplayServer_method_window_is_maximize_allowed>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| |
  345. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  346. | :ref:`bool<class_bool>` | :ref:`window_maximize_on_title_dbl_click<class_DisplayServer_method_window_maximize_on_title_dbl_click>`\ (\ ) |const| |
  347. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  348. | :ref:`bool<class_bool>` | :ref:`window_minimize_on_title_dbl_click<class_DisplayServer_method_window_minimize_on_title_dbl_click>`\ (\ ) |const| |
  349. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  350. | |void| | :ref:`window_move_to_foreground<class_DisplayServer_method_window_move_to_foreground>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |
  351. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  352. | |void| | :ref:`window_request_attention<class_DisplayServer_method_window_request_attention>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |
  353. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  354. | |void| | :ref:`window_set_current_screen<class_DisplayServer_method_window_set_current_screen>`\ (\ screen\: :ref:`int<class_int>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  355. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  356. | |void| | :ref:`window_set_drop_files_callback<class_DisplayServer_method_window_set_drop_files_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  357. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  358. | |void| | :ref:`window_set_exclusive<class_DisplayServer_method_window_set_exclusive>`\ (\ window_id\: :ref:`int<class_int>`, exclusive\: :ref:`bool<class_bool>`\ ) |
  359. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  360. | |void| | :ref:`window_set_flag<class_DisplayServer_method_window_set_flag>`\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, enabled\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  361. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  362. | |void| | :ref:`window_set_ime_active<class_DisplayServer_method_window_set_ime_active>`\ (\ active\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  363. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  364. | |void| | :ref:`window_set_ime_position<class_DisplayServer_method_window_set_ime_position>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  365. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  366. | |void| | :ref:`window_set_input_event_callback<class_DisplayServer_method_window_set_input_event_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  367. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  368. | |void| | :ref:`window_set_input_text_callback<class_DisplayServer_method_window_set_input_text_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  369. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  370. | |void| | :ref:`window_set_max_size<class_DisplayServer_method_window_set_max_size>`\ (\ max_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  371. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  372. | |void| | :ref:`window_set_min_size<class_DisplayServer_method_window_set_min_size>`\ (\ min_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  373. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  374. | |void| | :ref:`window_set_mode<class_DisplayServer_method_window_set_mode>`\ (\ mode\: :ref:`WindowMode<enum_DisplayServer_WindowMode>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  375. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  376. | |void| | :ref:`window_set_mouse_passthrough<class_DisplayServer_method_window_set_mouse_passthrough>`\ (\ region\: :ref:`PackedVector2Array<class_PackedVector2Array>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  377. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  378. | |void| | :ref:`window_set_popup_safe_rect<class_DisplayServer_method_window_set_popup_safe_rect>`\ (\ window\: :ref:`int<class_int>`, rect\: :ref:`Rect2i<class_Rect2i>`\ ) |
  379. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  380. | |void| | :ref:`window_set_position<class_DisplayServer_method_window_set_position>`\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  381. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  382. | |void| | :ref:`window_set_rect_changed_callback<class_DisplayServer_method_window_set_rect_changed_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  383. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  384. | |void| | :ref:`window_set_size<class_DisplayServer_method_window_set_size>`\ (\ size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  385. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  386. | |void| | :ref:`window_set_title<class_DisplayServer_method_window_set_title>`\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  387. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  388. | |void| | :ref:`window_set_transient<class_DisplayServer_method_window_set_transient>`\ (\ window_id\: :ref:`int<class_int>`, parent_window_id\: :ref:`int<class_int>`\ ) |
  389. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  390. | |void| | :ref:`window_set_vsync_mode<class_DisplayServer_method_window_set_vsync_mode>`\ (\ vsync_mode\: :ref:`VSyncMode<enum_DisplayServer_VSyncMode>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  391. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  392. | |void| | :ref:`window_set_window_buttons_offset<class_DisplayServer_method_window_set_window_buttons_offset>`\ (\ offset\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  393. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  394. | |void| | :ref:`window_set_window_event_callback<class_DisplayServer_method_window_set_window_event_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) |
  395. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  396. | |void| | :ref:`window_start_drag<class_DisplayServer_method_window_start_drag>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |
  397. +-------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  398. .. rst-class:: classref-section-separator
  399. ----
  400. .. rst-class:: classref-descriptions-group
  401. Enumerations
  402. ------------
  403. .. _enum_DisplayServer_Feature:
  404. .. rst-class:: classref-enumeration
  405. enum **Feature**: :ref:`๐Ÿ”—<enum_DisplayServer_Feature>`
  406. .. _class_DisplayServer_constant_FEATURE_GLOBAL_MENU:
  407. .. rst-class:: classref-enumeration-constant
  408. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_GLOBAL_MENU** = ``0``
  409. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  410. Display server supports global menu. This allows the application to display its menu items in the operating system's top bar. **macOS**
  411. .. _class_DisplayServer_constant_FEATURE_SUBWINDOWS:
  412. .. rst-class:: classref-enumeration-constant
  413. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SUBWINDOWS** = ``1``
  414. Display server supports multiple windows that can be moved outside of the main window. **Windows, macOS, Linux (X11)**
  415. .. _class_DisplayServer_constant_FEATURE_TOUCHSCREEN:
  416. .. rst-class:: classref-enumeration-constant
  417. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TOUCHSCREEN** = ``2``
  418. Display server supports touchscreen input. **Windows, Linux (X11), Android, iOS, Web**
  419. .. _class_DisplayServer_constant_FEATURE_MOUSE:
  420. .. rst-class:: classref-enumeration-constant
  421. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE** = ``3``
  422. Display server supports mouse input. **Windows, macOS, Linux (X11/Wayland), Android, Web**
  423. .. _class_DisplayServer_constant_FEATURE_MOUSE_WARP:
  424. .. rst-class:: classref-enumeration-constant
  425. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE_WARP** = ``4``
  426. Display server supports warping mouse coordinates to keep the mouse cursor constrained within an area, but looping when one of the edges is reached. **Windows, macOS, Linux (X11/Wayland)**
  427. .. _class_DisplayServer_constant_FEATURE_CLIPBOARD:
  428. .. rst-class:: classref-enumeration-constant
  429. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD** = ``5``
  430. Display server supports setting and getting clipboard data. See also :ref:`FEATURE_CLIPBOARD_PRIMARY<class_DisplayServer_constant_FEATURE_CLIPBOARD_PRIMARY>`. **Windows, macOS, Linux (X11/Wayland), Android, iOS, Web**
  431. .. _class_DisplayServer_constant_FEATURE_VIRTUAL_KEYBOARD:
  432. .. rst-class:: classref-enumeration-constant
  433. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_VIRTUAL_KEYBOARD** = ``6``
  434. Display server supports popping up a virtual keyboard when requested to input text without a physical keyboard. **Android, iOS, Web**
  435. .. _class_DisplayServer_constant_FEATURE_CURSOR_SHAPE:
  436. .. rst-class:: classref-enumeration-constant
  437. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CURSOR_SHAPE** = ``7``
  438. Display server supports setting the mouse cursor shape to be different from the default. **Windows, macOS, Linux (X11/Wayland), Android, Web**
  439. .. _class_DisplayServer_constant_FEATURE_CUSTOM_CURSOR_SHAPE:
  440. .. rst-class:: classref-enumeration-constant
  441. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CUSTOM_CURSOR_SHAPE** = ``8``
  442. Display server supports setting the mouse cursor shape to a custom image. **Windows, macOS, Linux (X11/Wayland), Web**
  443. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG:
  444. .. rst-class:: classref-enumeration-constant
  445. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG** = ``9``
  446. Display server supports spawning text dialogs using the operating system's native look-and-feel. See :ref:`dialog_show<class_DisplayServer_method_dialog_show>`. **Windows, macOS**
  447. .. _class_DisplayServer_constant_FEATURE_IME:
  448. .. rst-class:: classref-enumeration-constant
  449. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_IME** = ``10``
  450. 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)**
  451. .. _class_DisplayServer_constant_FEATURE_WINDOW_TRANSPARENCY:
  452. .. rst-class:: classref-enumeration-constant
  453. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_TRANSPARENCY** = ``11``
  454. Display server supports windows can use per-pixel transparency to make windows behind them partially or fully visible. **Windows, macOS, Linux (X11/Wayland)**
  455. .. _class_DisplayServer_constant_FEATURE_HIDPI:
  456. .. rst-class:: classref-enumeration-constant
  457. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_HIDPI** = ``12``
  458. Display server supports querying the operating system's display scale factor. This allows for *reliable* automatic hiDPI display detection, as opposed to guessing based on the screen resolution and reported display DPI (which can be unreliable due to broken monitor EDID). **Windows, Linux (Wayland), macOS**
  459. .. _class_DisplayServer_constant_FEATURE_ICON:
  460. .. rst-class:: classref-enumeration-constant
  461. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ICON** = ``13``
  462. Display server supports changing the window icon (usually displayed in the top-left corner). **Windows, macOS, Linux (X11)**
  463. .. _class_DisplayServer_constant_FEATURE_NATIVE_ICON:
  464. .. rst-class:: classref-enumeration-constant
  465. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_ICON** = ``14``
  466. Display server supports changing the window icon (usually displayed in the top-left corner). **Windows, macOS**
  467. .. _class_DisplayServer_constant_FEATURE_ORIENTATION:
  468. .. rst-class:: classref-enumeration-constant
  469. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ORIENTATION** = ``15``
  470. Display server supports changing the screen orientation. **Android, iOS**
  471. .. _class_DisplayServer_constant_FEATURE_SWAP_BUFFERS:
  472. .. rst-class:: classref-enumeration-constant
  473. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SWAP_BUFFERS** = ``16``
  474. Display server supports V-Sync status can be changed from the default (which is forced to be enabled platforms not supporting this feature). **Windows, macOS, Linux (X11/Wayland)**
  475. .. _class_DisplayServer_constant_FEATURE_CLIPBOARD_PRIMARY:
  476. .. rst-class:: classref-enumeration-constant
  477. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD_PRIMARY** = ``18``
  478. Display server supports Primary clipboard can be used. This is a different clipboard from :ref:`FEATURE_CLIPBOARD<class_DisplayServer_constant_FEATURE_CLIPBOARD>`. **Linux (X11/Wayland)**
  479. .. _class_DisplayServer_constant_FEATURE_TEXT_TO_SPEECH:
  480. .. rst-class:: classref-enumeration-constant
  481. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TEXT_TO_SPEECH** = ``19``
  482. Display server supports text-to-speech. See ``tts_*`` methods. **Windows, macOS, Linux (X11/Wayland), Android, iOS, Web**
  483. .. _class_DisplayServer_constant_FEATURE_EXTEND_TO_TITLE:
  484. .. rst-class:: classref-enumeration-constant
  485. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_EXTEND_TO_TITLE** = ``20``
  486. 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**
  487. .. _class_DisplayServer_constant_FEATURE_SCREEN_CAPTURE:
  488. .. rst-class:: classref-enumeration-constant
  489. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SCREEN_CAPTURE** = ``21``
  490. Display server supports reading screen pixels. See :ref:`screen_get_pixel<class_DisplayServer_method_screen_get_pixel>`.
  491. .. _class_DisplayServer_constant_FEATURE_STATUS_INDICATOR:
  492. .. rst-class:: classref-enumeration-constant
  493. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_STATUS_INDICATOR** = ``22``
  494. Display server supports application status indicators.
  495. .. _class_DisplayServer_constant_FEATURE_NATIVE_HELP:
  496. .. rst-class:: classref-enumeration-constant
  497. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_HELP** = ``23``
  498. Display server supports native help system search callbacks. See :ref:`help_set_search_callbacks<class_DisplayServer_method_help_set_search_callbacks>`.
  499. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_INPUT:
  500. .. rst-class:: classref-enumeration-constant
  501. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_INPUT** = ``24``
  502. Display server supports spawning text input dialogs using the operating system's native look-and-feel. See :ref:`dialog_input_text<class_DisplayServer_method_dialog_input_text>`. **Windows, macOS**
  503. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE:
  504. .. rst-class:: classref-enumeration-constant
  505. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE** = ``25``
  506. Display server supports spawning dialogs for selecting files or directories using the operating system's native look-and-feel. See :ref:`file_dialog_show<class_DisplayServer_method_file_dialog_show>`. **Windows, macOS, Linux (X11/Wayland), Android**
  507. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE_EXTRA:
  508. .. rst-class:: classref-enumeration-constant
  509. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE_EXTRA** = ``26``
  510. The display server supports all features of :ref:`FEATURE_NATIVE_DIALOG_FILE<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE>`, with the added functionality of Options and native dialog file access to ``res://`` and ``user://`` paths. See :ref:`file_dialog_show<class_DisplayServer_method_file_dialog_show>` and :ref:`file_dialog_with_options_show<class_DisplayServer_method_file_dialog_with_options_show>`. **Windows, macOS, Linux (X11/Wayland)**
  511. .. _class_DisplayServer_constant_FEATURE_WINDOW_DRAG:
  512. .. rst-class:: classref-enumeration-constant
  513. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_DRAG** = ``27``
  514. The display server supports initiating window drag operation on demand. See :ref:`window_start_drag<class_DisplayServer_method_window_start_drag>`.
  515. .. _class_DisplayServer_constant_FEATURE_SCREEN_EXCLUDE_FROM_CAPTURE:
  516. .. rst-class:: classref-enumeration-constant
  517. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SCREEN_EXCLUDE_FROM_CAPTURE** = ``28``
  518. Display server supports :ref:`WINDOW_FLAG_EXCLUDE_FROM_CAPTURE<class_DisplayServer_constant_WINDOW_FLAG_EXCLUDE_FROM_CAPTURE>` window flag.
  519. .. _class_DisplayServer_constant_FEATURE_WINDOW_EMBEDDING:
  520. .. rst-class:: classref-enumeration-constant
  521. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_EMBEDDING** = ``29``
  522. Display server supports embedding a window from another process. **Windows, Linux (X11)**
  523. .. rst-class:: classref-item-separator
  524. ----
  525. .. _enum_DisplayServer_MouseMode:
  526. .. rst-class:: classref-enumeration
  527. enum **MouseMode**: :ref:`๐Ÿ”—<enum_DisplayServer_MouseMode>`
  528. .. _class_DisplayServer_constant_MOUSE_MODE_VISIBLE:
  529. .. rst-class:: classref-enumeration-constant
  530. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_VISIBLE** = ``0``
  531. Makes the mouse cursor visible if it is hidden.
  532. .. _class_DisplayServer_constant_MOUSE_MODE_HIDDEN:
  533. .. rst-class:: classref-enumeration-constant
  534. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_HIDDEN** = ``1``
  535. Makes the mouse cursor hidden if it is visible.
  536. .. _class_DisplayServer_constant_MOUSE_MODE_CAPTURED:
  537. .. rst-class:: classref-enumeration-constant
  538. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CAPTURED** = ``2``
  539. Captures the mouse. The mouse will be hidden and its position locked at the center of the window manager's window.
  540. \ **Note:** If you want to process the mouse's movement in this mode, you need to use :ref:`InputEventMouseMotion.relative<class_InputEventMouseMotion_property_relative>`.
  541. .. _class_DisplayServer_constant_MOUSE_MODE_CONFINED:
  542. .. rst-class:: classref-enumeration-constant
  543. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED** = ``3``
  544. Confines the mouse cursor to the game window, and make it visible.
  545. .. _class_DisplayServer_constant_MOUSE_MODE_CONFINED_HIDDEN:
  546. .. rst-class:: classref-enumeration-constant
  547. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED_HIDDEN** = ``4``
  548. Confines the mouse cursor to the game window, and make it hidden.
  549. .. rst-class:: classref-item-separator
  550. ----
  551. .. _enum_DisplayServer_ScreenOrientation:
  552. .. rst-class:: classref-enumeration
  553. enum **ScreenOrientation**: :ref:`๐Ÿ”—<enum_DisplayServer_ScreenOrientation>`
  554. .. _class_DisplayServer_constant_SCREEN_LANDSCAPE:
  555. .. rst-class:: classref-enumeration-constant
  556. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_LANDSCAPE** = ``0``
  557. Default landscape orientation.
  558. .. _class_DisplayServer_constant_SCREEN_PORTRAIT:
  559. .. rst-class:: classref-enumeration-constant
  560. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_PORTRAIT** = ``1``
  561. Default portrait orientation.
  562. .. _class_DisplayServer_constant_SCREEN_REVERSE_LANDSCAPE:
  563. .. rst-class:: classref-enumeration-constant
  564. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_LANDSCAPE** = ``2``
  565. Reverse landscape orientation (upside down).
  566. .. _class_DisplayServer_constant_SCREEN_REVERSE_PORTRAIT:
  567. .. rst-class:: classref-enumeration-constant
  568. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_PORTRAIT** = ``3``
  569. Reverse portrait orientation (upside down).
  570. .. _class_DisplayServer_constant_SCREEN_SENSOR_LANDSCAPE:
  571. .. rst-class:: classref-enumeration-constant
  572. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_LANDSCAPE** = ``4``
  573. Automatic landscape orientation (default or reverse depending on sensor).
  574. .. _class_DisplayServer_constant_SCREEN_SENSOR_PORTRAIT:
  575. .. rst-class:: classref-enumeration-constant
  576. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_PORTRAIT** = ``5``
  577. Automatic portrait orientation (default or reverse depending on sensor).
  578. .. _class_DisplayServer_constant_SCREEN_SENSOR:
  579. .. rst-class:: classref-enumeration-constant
  580. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR** = ``6``
  581. Automatic landscape or portrait orientation (default or reverse depending on sensor).
  582. .. rst-class:: classref-item-separator
  583. ----
  584. .. _enum_DisplayServer_VirtualKeyboardType:
  585. .. rst-class:: classref-enumeration
  586. enum **VirtualKeyboardType**: :ref:`๐Ÿ”—<enum_DisplayServer_VirtualKeyboardType>`
  587. .. _class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT:
  588. .. rst-class:: classref-enumeration-constant
  589. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_DEFAULT** = ``0``
  590. Default text virtual keyboard.
  591. .. _class_DisplayServer_constant_KEYBOARD_TYPE_MULTILINE:
  592. .. rst-class:: classref-enumeration-constant
  593. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_MULTILINE** = ``1``
  594. Multiline virtual keyboard.
  595. .. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER:
  596. .. rst-class:: classref-enumeration-constant
  597. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER** = ``2``
  598. Virtual number keypad, useful for PIN entry.
  599. .. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER_DECIMAL:
  600. .. rst-class:: classref-enumeration-constant
  601. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER_DECIMAL** = ``3``
  602. Virtual number keypad, useful for entering fractional numbers.
  603. .. _class_DisplayServer_constant_KEYBOARD_TYPE_PHONE:
  604. .. rst-class:: classref-enumeration-constant
  605. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PHONE** = ``4``
  606. Virtual phone number keypad.
  607. .. _class_DisplayServer_constant_KEYBOARD_TYPE_EMAIL_ADDRESS:
  608. .. rst-class:: classref-enumeration-constant
  609. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_EMAIL_ADDRESS** = ``5``
  610. Virtual keyboard with additional keys to assist with typing email addresses.
  611. .. _class_DisplayServer_constant_KEYBOARD_TYPE_PASSWORD:
  612. .. rst-class:: classref-enumeration-constant
  613. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PASSWORD** = ``6``
  614. Virtual keyboard for entering a password. On most platforms, this should disable autocomplete and autocapitalization.
  615. \ **Note:** This is not supported on Web. Instead, this behaves identically to :ref:`KEYBOARD_TYPE_DEFAULT<class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT>`.
  616. .. _class_DisplayServer_constant_KEYBOARD_TYPE_URL:
  617. .. rst-class:: classref-enumeration-constant
  618. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_URL** = ``7``
  619. Virtual keyboard with additional keys to assist with typing URLs.
  620. .. rst-class:: classref-item-separator
  621. ----
  622. .. _enum_DisplayServer_CursorShape:
  623. .. rst-class:: classref-enumeration
  624. enum **CursorShape**: :ref:`๐Ÿ”—<enum_DisplayServer_CursorShape>`
  625. .. _class_DisplayServer_constant_CURSOR_ARROW:
  626. .. rst-class:: classref-enumeration-constant
  627. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_ARROW** = ``0``
  628. 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>`.
  629. .. _class_DisplayServer_constant_CURSOR_IBEAM:
  630. .. rst-class:: classref-enumeration-constant
  631. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_IBEAM** = ``1``
  632. 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>`.
  633. .. _class_DisplayServer_constant_CURSOR_POINTING_HAND:
  634. .. rst-class:: classref-enumeration-constant
  635. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_POINTING_HAND** = ``2``
  636. 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>`.
  637. .. _class_DisplayServer_constant_CURSOR_CROSS:
  638. .. rst-class:: classref-enumeration-constant
  639. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CROSS** = ``3``
  640. 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.
  641. .. _class_DisplayServer_constant_CURSOR_WAIT:
  642. .. rst-class:: classref-enumeration-constant
  643. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_WAIT** = ``4``
  644. 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>`.
  645. .. _class_DisplayServer_constant_CURSOR_BUSY:
  646. .. rst-class:: classref-enumeration-constant
  647. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BUSY** = ``5``
  648. 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>`.
  649. .. _class_DisplayServer_constant_CURSOR_DRAG:
  650. .. rst-class:: classref-enumeration-constant
  651. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_DRAG** = ``6``
  652. Dragging hand cursor. This is displayed during drag-and-drop operations. See also :ref:`CURSOR_CAN_DROP<class_DisplayServer_constant_CURSOR_CAN_DROP>`.
  653. .. _class_DisplayServer_constant_CURSOR_CAN_DROP:
  654. .. rst-class:: classref-enumeration-constant
  655. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CAN_DROP** = ``7``
  656. "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>`.
  657. .. _class_DisplayServer_constant_CURSOR_FORBIDDEN:
  658. .. rst-class:: classref-enumeration-constant
  659. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FORBIDDEN** = ``8``
  660. 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.
  661. .. _class_DisplayServer_constant_CURSOR_VSIZE:
  662. .. rst-class:: classref-enumeration-constant
  663. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSIZE** = ``9``
  664. 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>`.
  665. .. _class_DisplayServer_constant_CURSOR_HSIZE:
  666. .. rst-class:: classref-enumeration-constant
  667. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSIZE** = ``10``
  668. 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>`.
  669. .. _class_DisplayServer_constant_CURSOR_BDIAGSIZE:
  670. .. rst-class:: classref-enumeration-constant
  671. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BDIAGSIZE** = ``11``
  672. 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.
  673. .. _class_DisplayServer_constant_CURSOR_FDIAGSIZE:
  674. .. rst-class:: classref-enumeration-constant
  675. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FDIAGSIZE** = ``12``
  676. 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.
  677. .. _class_DisplayServer_constant_CURSOR_MOVE:
  678. .. rst-class:: classref-enumeration-constant
  679. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MOVE** = ``13``
  680. Move cursor. Intended to be displayed when the hovered :ref:`Control<class_Control>` can be moved using the mouse.
  681. .. _class_DisplayServer_constant_CURSOR_VSPLIT:
  682. .. rst-class:: classref-enumeration-constant
  683. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSPLIT** = ``14``
  684. 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>`.
  685. .. _class_DisplayServer_constant_CURSOR_HSPLIT:
  686. .. rst-class:: classref-enumeration-constant
  687. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSPLIT** = ``15``
  688. 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>`.
  689. .. _class_DisplayServer_constant_CURSOR_HELP:
  690. .. rst-class:: classref-enumeration-constant
  691. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HELP** = ``16``
  692. 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.
  693. .. _class_DisplayServer_constant_CURSOR_MAX:
  694. .. rst-class:: classref-enumeration-constant
  695. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MAX** = ``17``
  696. Represents the size of the :ref:`CursorShape<enum_DisplayServer_CursorShape>` enum.
  697. .. rst-class:: classref-item-separator
  698. ----
  699. .. _enum_DisplayServer_FileDialogMode:
  700. .. rst-class:: classref-enumeration
  701. enum **FileDialogMode**: :ref:`๐Ÿ”—<enum_DisplayServer_FileDialogMode>`
  702. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILE:
  703. .. rst-class:: classref-enumeration-constant
  704. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILE** = ``0``
  705. The native file dialog allows selecting one, and only one file.
  706. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILES:
  707. .. rst-class:: classref-enumeration-constant
  708. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILES** = ``1``
  709. The native file dialog allows selecting multiple files.
  710. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_DIR:
  711. .. rst-class:: classref-enumeration-constant
  712. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_DIR** = ``2``
  713. The native file dialog only allows selecting a directory, disallowing the selection of any file.
  714. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_ANY:
  715. .. rst-class:: classref-enumeration-constant
  716. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_ANY** = ``3``
  717. The native file dialog allows selecting one file or directory.
  718. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_SAVE_FILE:
  719. .. rst-class:: classref-enumeration-constant
  720. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_SAVE_FILE** = ``4``
  721. The native file dialog will warn when a file exists.
  722. .. rst-class:: classref-item-separator
  723. ----
  724. .. _enum_DisplayServer_WindowMode:
  725. .. rst-class:: classref-enumeration
  726. enum **WindowMode**: :ref:`๐Ÿ”—<enum_DisplayServer_WindowMode>`
  727. .. _class_DisplayServer_constant_WINDOW_MODE_WINDOWED:
  728. .. rst-class:: classref-enumeration-constant
  729. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_WINDOWED** = ``0``
  730. Windowed mode, i.e. :ref:`Window<class_Window>` doesn't occupy the whole screen (unless set to the size of the screen).
  731. .. _class_DisplayServer_constant_WINDOW_MODE_MINIMIZED:
  732. .. rst-class:: classref-enumeration-constant
  733. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MINIMIZED** = ``1``
  734. 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.
  735. .. _class_DisplayServer_constant_WINDOW_MODE_MAXIMIZED:
  736. .. rst-class:: classref-enumeration-constant
  737. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MAXIMIZED** = ``2``
  738. 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.
  739. .. _class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN:
  740. .. rst-class:: classref-enumeration-constant
  741. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_FULLSCREEN** = ``3``
  742. Full screen mode with full multi-window support.
  743. Full screen window covers the entire display area of a screen and has no decorations. The display's video mode is not changed.
  744. \ **On Android:** This enables immersive mode.
  745. \ **On Windows:** Multi-window full-screen mode has a 1px border of the :ref:`ProjectSettings.rendering/environment/defaults/default_clear_color<class_ProjectSettings_property_rendering/environment/defaults/default_clear_color>` color.
  746. \ **On macOS:** A new desktop is used to display the running project.
  747. \ **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.
  748. .. _class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN:
  749. .. rst-class:: classref-enumeration-constant
  750. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_EXCLUSIVE_FULLSCREEN** = ``4``
  751. 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).
  752. Full screen window covers the entire display area of a screen and has no border or decorations. The display's video mode is not changed.
  753. \ **On Android:** This enables immersive mode.
  754. \ **On Windows:** Depending on video driver, full screen transition might cause screens to go black for a moment.
  755. \ **On macOS:** A new desktop is used to display the running project. Exclusive full screen mode prevents Dock and Menu from showing up when the mouse pointer is hovering the edge of the screen.
  756. \ **On Linux (X11):** Exclusive full screen mode bypasses compositor.
  757. \ **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.
  758. .. rst-class:: classref-item-separator
  759. ----
  760. .. _enum_DisplayServer_WindowFlags:
  761. .. rst-class:: classref-enumeration
  762. enum **WindowFlags**: :ref:`๐Ÿ”—<enum_DisplayServer_WindowFlags>`
  763. .. _class_DisplayServer_constant_WINDOW_FLAG_RESIZE_DISABLED:
  764. .. rst-class:: classref-enumeration-constant
  765. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_RESIZE_DISABLED** = ``0``
  766. 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.
  767. .. _class_DisplayServer_constant_WINDOW_FLAG_BORDERLESS:
  768. .. rst-class:: classref-enumeration-constant
  769. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_BORDERLESS** = ``1``
  770. The window do not have native title bar and other decorations. This flag is ignored for full-screen windows.
  771. .. _class_DisplayServer_constant_WINDOW_FLAG_ALWAYS_ON_TOP:
  772. .. rst-class:: classref-enumeration-constant
  773. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_ALWAYS_ON_TOP** = ``2``
  774. The window is floating on top of all other windows. This flag is ignored for full-screen windows.
  775. .. _class_DisplayServer_constant_WINDOW_FLAG_TRANSPARENT:
  776. .. rst-class:: classref-enumeration-constant
  777. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_TRANSPARENT** = ``3``
  778. The window background can be transparent.
  779. \ **Note:** This flag has no effect if :ref:`is_window_transparency_available<class_DisplayServer_method_is_window_transparency_available>` returns ``false``.
  780. \ **Note:** Transparency support is implemented on Linux (X11/Wayland), macOS, and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities.
  781. .. _class_DisplayServer_constant_WINDOW_FLAG_NO_FOCUS:
  782. .. rst-class:: classref-enumeration-constant
  783. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_NO_FOCUS** = ``4``
  784. The window can't be focused. No-focus window will ignore all input, except mouse clicks.
  785. .. _class_DisplayServer_constant_WINDOW_FLAG_POPUP:
  786. .. rst-class:: classref-enumeration-constant
  787. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_POPUP** = ``5``
  788. 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>`).
  789. .. _class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE:
  790. .. rst-class:: classref-enumeration-constant
  791. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_EXTEND_TO_TITLE** = ``6``
  792. 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.
  793. Use :ref:`window_set_window_buttons_offset<class_DisplayServer_method_window_set_window_buttons_offset>` to adjust minimize/maximize/close buttons offset.
  794. 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.
  795. \ **Note:** This flag is implemented only on macOS.
  796. .. _class_DisplayServer_constant_WINDOW_FLAG_MOUSE_PASSTHROUGH:
  797. .. rst-class:: classref-enumeration-constant
  798. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MOUSE_PASSTHROUGH** = ``7``
  799. All mouse events are passed to the underlying window of the same application.
  800. .. _class_DisplayServer_constant_WINDOW_FLAG_SHARP_CORNERS:
  801. .. rst-class:: classref-enumeration-constant
  802. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_SHARP_CORNERS** = ``8``
  803. Window style is overridden, forcing sharp corners.
  804. \ **Note:** This flag is implemented only on Windows (11).
  805. .. _class_DisplayServer_constant_WINDOW_FLAG_EXCLUDE_FROM_CAPTURE:
  806. .. rst-class:: classref-enumeration-constant
  807. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_EXCLUDE_FROM_CAPTURE** = ``9``
  808. Windows is excluded from screenshots taken by :ref:`screen_get_image<class_DisplayServer_method_screen_get_image>`, :ref:`screen_get_image_rect<class_DisplayServer_method_screen_get_image_rect>`, and :ref:`screen_get_pixel<class_DisplayServer_method_screen_get_pixel>`.
  809. \ **Note:** This flag is implemented on macOS and Windows.
  810. \ **Note:** Setting this flag will **NOT** prevent other apps from capturing an image, it should not be used as a security measure.
  811. .. _class_DisplayServer_constant_WINDOW_FLAG_MAX:
  812. .. rst-class:: classref-enumeration-constant
  813. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MAX** = ``10``
  814. Max value of the :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`.
  815. .. rst-class:: classref-item-separator
  816. ----
  817. .. _enum_DisplayServer_WindowEvent:
  818. .. rst-class:: classref-enumeration
  819. enum **WindowEvent**: :ref:`๐Ÿ”—<enum_DisplayServer_WindowEvent>`
  820. .. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_ENTER:
  821. .. rst-class:: classref-enumeration-constant
  822. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_ENTER** = ``0``
  823. Sent when the mouse pointer enters the window.
  824. .. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_EXIT:
  825. .. rst-class:: classref-enumeration-constant
  826. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_EXIT** = ``1``
  827. Sent when the mouse pointer exits the window.
  828. .. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_IN:
  829. .. rst-class:: classref-enumeration-constant
  830. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_IN** = ``2``
  831. Sent when the window grabs focus.
  832. .. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_OUT:
  833. .. rst-class:: classref-enumeration-constant
  834. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_OUT** = ``3``
  835. Sent when the window loses focus.
  836. .. _class_DisplayServer_constant_WINDOW_EVENT_CLOSE_REQUEST:
  837. .. rst-class:: classref-enumeration-constant
  838. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_CLOSE_REQUEST** = ``4``
  839. Sent when the user has attempted to close the window (e.g. close button is pressed).
  840. .. _class_DisplayServer_constant_WINDOW_EVENT_GO_BACK_REQUEST:
  841. .. rst-class:: classref-enumeration-constant
  842. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_GO_BACK_REQUEST** = ``5``
  843. Sent when the device "Back" button is pressed.
  844. \ **Note:** This event is implemented only on Android.
  845. .. _class_DisplayServer_constant_WINDOW_EVENT_DPI_CHANGE:
  846. .. rst-class:: classref-enumeration-constant
  847. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_DPI_CHANGE** = ``6``
  848. Sent when the window is moved to the display with different DPI, or display DPI is changed.
  849. \ **Note:** This flag is implemented only on macOS.
  850. .. _class_DisplayServer_constant_WINDOW_EVENT_TITLEBAR_CHANGE:
  851. .. rst-class:: classref-enumeration-constant
  852. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_TITLEBAR_CHANGE** = ``7``
  853. 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).
  854. \ **Note:** This flag is implemented only on macOS.
  855. .. rst-class:: classref-item-separator
  856. ----
  857. .. _enum_DisplayServer_VSyncMode:
  858. .. rst-class:: classref-enumeration
  859. enum **VSyncMode**: :ref:`๐Ÿ”—<enum_DisplayServer_VSyncMode>`
  860. .. _class_DisplayServer_constant_VSYNC_DISABLED:
  861. .. rst-class:: classref-enumeration-constant
  862. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_DISABLED** = ``0``
  863. No vertical synchronization, which means the engine will display frames as fast as possible (tearing may be visible). Framerate is unlimited (regardless of :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
  864. .. _class_DisplayServer_constant_VSYNC_ENABLED:
  865. .. rst-class:: classref-enumeration-constant
  866. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ENABLED** = ``1``
  867. Default vertical synchronization mode, the image is displayed only on vertical blanking intervals (no tearing is visible). Framerate is limited by the monitor refresh rate (regardless of :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
  868. .. _class_DisplayServer_constant_VSYNC_ADAPTIVE:
  869. .. rst-class:: classref-enumeration-constant
  870. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ADAPTIVE** = ``2``
  871. Behaves like :ref:`VSYNC_DISABLED<class_DisplayServer_constant_VSYNC_DISABLED>` when the framerate drops below the screen's refresh rate to reduce stuttering (tearing may be visible). Otherwise, vertical synchronization is enabled to avoid tearing. Framerate is limited by the monitor refresh rate (regardless of :ref:`Engine.max_fps<class_Engine_property_max_fps>`). Behaves like :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>` when using the Compatibility rendering method.
  872. .. _class_DisplayServer_constant_VSYNC_MAILBOX:
  873. .. rst-class:: classref-enumeration-constant
  874. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_MAILBOX** = ``3``
  875. Displays the most recent image in the queue on vertical blanking intervals, while rendering to the other images (no tearing is visible). Framerate is unlimited (regardless of :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
  876. 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.
  877. .. rst-class:: classref-item-separator
  878. ----
  879. .. _enum_DisplayServer_HandleType:
  880. .. rst-class:: classref-enumeration
  881. enum **HandleType**: :ref:`๐Ÿ”—<enum_DisplayServer_HandleType>`
  882. .. _class_DisplayServer_constant_DISPLAY_HANDLE:
  883. .. rst-class:: classref-enumeration-constant
  884. :ref:`HandleType<enum_DisplayServer_HandleType>` **DISPLAY_HANDLE** = ``0``
  885. Display handle:
  886. - Linux (X11): ``X11::Display*`` for the display.
  887. - Linux (Wayland): ``wl_display`` for the display.
  888. - Android: ``EGLDisplay`` for the display.
  889. .. _class_DisplayServer_constant_WINDOW_HANDLE:
  890. .. rst-class:: classref-enumeration-constant
  891. :ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_HANDLE** = ``1``
  892. Window handle:
  893. - Windows: ``HWND`` for the window.
  894. - Linux (X11): ``X11::Window*`` for the window.
  895. - Linux (Wayland): ``wl_surface`` for the window.
  896. - macOS: ``NSWindow*`` for the window.
  897. - iOS: ``UIViewController*`` for the view controller.
  898. - Android: ``jObject`` for the activity.
  899. .. _class_DisplayServer_constant_WINDOW_VIEW:
  900. .. rst-class:: classref-enumeration-constant
  901. :ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_VIEW** = ``2``
  902. Window view:
  903. - Windows: ``HDC`` for the window (only with the Compatibility renderer).
  904. - macOS: ``NSView*`` for the window main view.
  905. - iOS: ``UIView*`` for the window main view.
  906. .. _class_DisplayServer_constant_OPENGL_CONTEXT:
  907. .. rst-class:: classref-enumeration-constant
  908. :ref:`HandleType<enum_DisplayServer_HandleType>` **OPENGL_CONTEXT** = ``3``
  909. OpenGL context (only with the Compatibility renderer):
  910. - Windows: ``HGLRC`` for the window (native GL), or ``EGLContext`` for the window (ANGLE).
  911. - Linux (X11): ``GLXContext*`` for the window.
  912. - Linux (Wayland): ``EGLContext`` for the window.
  913. - macOS: ``NSOpenGLContext*`` for the window (native GL), or ``EGLContext`` for the window (ANGLE).
  914. - Android: ``EGLContext`` for the window.
  915. .. _class_DisplayServer_constant_EGL_DISPLAY:
  916. .. rst-class:: classref-enumeration-constant
  917. :ref:`HandleType<enum_DisplayServer_HandleType>` **EGL_DISPLAY** = ``4``
  918. - Windows: ``EGLDisplay`` for the window (ANGLE).
  919. - macOS: ``EGLDisplay`` for the window (ANGLE).
  920. - Linux (Wayland): ``EGLDisplay`` for the window.
  921. .. _class_DisplayServer_constant_EGL_CONFIG:
  922. .. rst-class:: classref-enumeration-constant
  923. :ref:`HandleType<enum_DisplayServer_HandleType>` **EGL_CONFIG** = ``5``
  924. - Windows: ``EGLConfig`` for the window (ANGLE).
  925. - macOS: ``EGLConfig`` for the window (ANGLE).
  926. - Linux (Wayland): ``EGLConfig`` for the window.
  927. .. rst-class:: classref-item-separator
  928. ----
  929. .. _enum_DisplayServer_TTSUtteranceEvent:
  930. .. rst-class:: classref-enumeration
  931. enum **TTSUtteranceEvent**: :ref:`๐Ÿ”—<enum_DisplayServer_TTSUtteranceEvent>`
  932. .. _class_DisplayServer_constant_TTS_UTTERANCE_STARTED:
  933. .. rst-class:: classref-enumeration-constant
  934. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_STARTED** = ``0``
  935. Utterance has begun to be spoken.
  936. .. _class_DisplayServer_constant_TTS_UTTERANCE_ENDED:
  937. .. rst-class:: classref-enumeration-constant
  938. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_ENDED** = ``1``
  939. Utterance was successfully finished.
  940. .. _class_DisplayServer_constant_TTS_UTTERANCE_CANCELED:
  941. .. rst-class:: classref-enumeration-constant
  942. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_CANCELED** = ``2``
  943. Utterance was canceled, or TTS service was unable to process it.
  944. .. _class_DisplayServer_constant_TTS_UTTERANCE_BOUNDARY:
  945. .. rst-class:: classref-enumeration-constant
  946. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_BOUNDARY** = ``3``
  947. Utterance reached a word or sentence boundary.
  948. .. rst-class:: classref-section-separator
  949. ----
  950. .. rst-class:: classref-descriptions-group
  951. Constants
  952. ---------
  953. .. _class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS:
  954. .. rst-class:: classref-constant
  955. **SCREEN_WITH_MOUSE_FOCUS** = ``-4`` :ref:`๐Ÿ”—<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`
  956. Represents the screen containing the mouse pointer.
  957. \ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``.
  958. .. _class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS:
  959. .. rst-class:: classref-constant
  960. **SCREEN_WITH_KEYBOARD_FOCUS** = ``-3`` :ref:`๐Ÿ”—<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`
  961. Represents the screen containing the window with the keyboard focus.
  962. \ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``.
  963. .. _class_DisplayServer_constant_SCREEN_PRIMARY:
  964. .. rst-class:: classref-constant
  965. **SCREEN_PRIMARY** = ``-2`` :ref:`๐Ÿ”—<class_DisplayServer_constant_SCREEN_PRIMARY>`
  966. Represents the primary screen.
  967. \ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``.
  968. .. _class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW:
  969. .. rst-class:: classref-constant
  970. **SCREEN_OF_MAIN_WINDOW** = ``-1`` :ref:`๐Ÿ”—<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`
  971. Represents the screen where the main window is located. This is usually the default value in functions that allow specifying one of several screens.
  972. \ **Note:** On Linux (Wayland), this constant always represents the screen at index ``0``.
  973. .. _class_DisplayServer_constant_MAIN_WINDOW_ID:
  974. .. rst-class:: classref-constant
  975. **MAIN_WINDOW_ID** = ``0`` :ref:`๐Ÿ”—<class_DisplayServer_constant_MAIN_WINDOW_ID>`
  976. The ID of the main window spawned by the engine, which can be passed to methods expecting a ``window_id``.
  977. .. _class_DisplayServer_constant_INVALID_WINDOW_ID:
  978. .. rst-class:: classref-constant
  979. **INVALID_WINDOW_ID** = ``-1`` :ref:`๐Ÿ”—<class_DisplayServer_constant_INVALID_WINDOW_ID>`
  980. The ID that refers to a nonexistent window. This is returned by some **DisplayServer** methods if no window matches the requested result.
  981. .. _class_DisplayServer_constant_INVALID_INDICATOR_ID:
  982. .. rst-class:: classref-constant
  983. **INVALID_INDICATOR_ID** = ``-1`` :ref:`๐Ÿ”—<class_DisplayServer_constant_INVALID_INDICATOR_ID>`
  984. The ID that refers to a nonexistent application status indicator.
  985. .. rst-class:: classref-section-separator
  986. ----
  987. .. rst-class:: classref-descriptions-group
  988. Method Descriptions
  989. -------------------
  990. .. _class_DisplayServer_method_beep:
  991. .. rst-class:: classref-method
  992. |void| **beep**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_beep>`
  993. Plays the beep sound from the operative system, if possible. Because it comes from the OS, the beep sound will be audible even if the application is muted. It may also be disabled for the entire OS by the user.
  994. \ **Note:** This method is implemented on macOS, Linux (X11/Wayland), and Windows.
  995. .. rst-class:: classref-item-separator
  996. ----
  997. .. _class_DisplayServer_method_clipboard_get:
  998. .. rst-class:: classref-method
  999. :ref:`String<class_String>` **clipboard_get**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_get>`
  1000. Returns the user's clipboard as a string if possible.
  1001. .. rst-class:: classref-item-separator
  1002. ----
  1003. .. _class_DisplayServer_method_clipboard_get_image:
  1004. .. rst-class:: classref-method
  1005. :ref:`Image<class_Image>` **clipboard_get_image**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_get_image>`
  1006. Returns the user's clipboard as an image if possible.
  1007. \ **Note:** This method uses the copied pixel data, e.g. from a image editing software or a web browser, not an image file copied from file explorer.
  1008. .. rst-class:: classref-item-separator
  1009. ----
  1010. .. _class_DisplayServer_method_clipboard_get_primary:
  1011. .. rst-class:: classref-method
  1012. :ref:`String<class_String>` **clipboard_get_primary**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_get_primary>`
  1013. 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.
  1014. \ **Note:** This method is only implemented on Linux (X11/Wayland).
  1015. .. rst-class:: classref-item-separator
  1016. ----
  1017. .. _class_DisplayServer_method_clipboard_has:
  1018. .. rst-class:: classref-method
  1019. :ref:`bool<class_bool>` **clipboard_has**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_has>`
  1020. Returns ``true`` if there is a text content on the user's clipboard.
  1021. .. rst-class:: classref-item-separator
  1022. ----
  1023. .. _class_DisplayServer_method_clipboard_has_image:
  1024. .. rst-class:: classref-method
  1025. :ref:`bool<class_bool>` **clipboard_has_image**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_has_image>`
  1026. Returns ``true`` if there is an image content on the user's clipboard.
  1027. .. rst-class:: classref-item-separator
  1028. ----
  1029. .. _class_DisplayServer_method_clipboard_set:
  1030. .. rst-class:: classref-method
  1031. |void| **clipboard_set**\ (\ clipboard\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_set>`
  1032. Sets the user's clipboard content to the given string.
  1033. .. rst-class:: classref-item-separator
  1034. ----
  1035. .. _class_DisplayServer_method_clipboard_set_primary:
  1036. .. rst-class:: classref-method
  1037. |void| **clipboard_set_primary**\ (\ clipboard_primary\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_set_primary>`
  1038. 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.
  1039. \ **Note:** This method is only implemented on Linux (X11/Wayland).
  1040. .. rst-class:: classref-item-separator
  1041. ----
  1042. .. _class_DisplayServer_method_create_status_indicator:
  1043. .. rst-class:: classref-method
  1044. :ref:`int<class_int>` **create_status_indicator**\ (\ icon\: :ref:`Texture2D<class_Texture2D>`, tooltip\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_create_status_indicator>`
  1045. Creates a new application status indicator with the specified icon, tooltip, and activation callback.
  1046. \ ``callback`` should take two arguments: the pressed mouse button (one of the :ref:`MouseButton<enum_@GlobalScope_MouseButton>` constants) and the click position in screen coordinates (a :ref:`Vector2i<class_Vector2i>`).
  1047. .. rst-class:: classref-item-separator
  1048. ----
  1049. .. _class_DisplayServer_method_cursor_get_shape:
  1050. .. rst-class:: classref-method
  1051. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **cursor_get_shape**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_cursor_get_shape>`
  1052. Returns the default mouse cursor shape set by :ref:`cursor_set_shape<class_DisplayServer_method_cursor_set_shape>`.
  1053. .. rst-class:: classref-item-separator
  1054. ----
  1055. .. _class_DisplayServer_method_cursor_set_custom_image:
  1056. .. rst-class:: classref-method
  1057. |void| **cursor_set_custom_image**\ (\ cursor\: :ref:`Resource<class_Resource>`, shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>` = 0, hotspot\: :ref:`Vector2<class_Vector2>` = Vector2(0, 0)\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_cursor_set_custom_image>`
  1058. Sets a custom mouse cursor image for the given ``shape``. This means the user's operating system and mouse cursor theme will no longer influence the mouse cursor's appearance.
  1059. \ ``cursor`` can be either a :ref:`Texture2D<class_Texture2D>` or an :ref:`Image<class_Image>`, and it should not be larger than 256ร—256 to display correctly. Optionally, ``hotspot`` can be set to offset the image's position relative to the click point. By default, ``hotspot`` is set to the top-left corner of the image. See also :ref:`cursor_set_shape<class_DisplayServer_method_cursor_set_shape>`.
  1060. .. rst-class:: classref-item-separator
  1061. ----
  1062. .. _class_DisplayServer_method_cursor_set_shape:
  1063. .. rst-class:: classref-method
  1064. |void| **cursor_set_shape**\ (\ shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_cursor_set_shape>`
  1065. 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>`.
  1066. .. rst-class:: classref-item-separator
  1067. ----
  1068. .. _class_DisplayServer_method_delete_status_indicator:
  1069. .. rst-class:: classref-method
  1070. |void| **delete_status_indicator**\ (\ id\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_delete_status_indicator>`
  1071. Removes the application status indicator.
  1072. .. rst-class:: classref-item-separator
  1073. ----
  1074. .. _class_DisplayServer_method_dialog_input_text:
  1075. .. rst-class:: classref-method
  1076. :ref:`Error<enum_@GlobalScope_Error>` **dialog_input_text**\ (\ title\: :ref:`String<class_String>`, description\: :ref:`String<class_String>`, existing_text\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_dialog_input_text>`
  1077. Shows a text input dialog which uses the operating system's native look-and-feel. ``callback`` should accept a single :ref:`String<class_String>` parameter which contains the text field's contents.
  1078. \ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_INPUT<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_INPUT>` feature. Supported platforms include macOS, Windows, and Android.
  1079. .. rst-class:: classref-item-separator
  1080. ----
  1081. .. _class_DisplayServer_method_dialog_show:
  1082. .. rst-class:: classref-method
  1083. :ref:`Error<enum_@GlobalScope_Error>` **dialog_show**\ (\ title\: :ref:`String<class_String>`, description\: :ref:`String<class_String>`, buttons\: :ref:`PackedStringArray<class_PackedStringArray>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_dialog_show>`
  1084. Shows a text dialog which uses the operating system's native look-and-feel. ``callback`` should accept a single :ref:`int<class_int>` parameter which corresponds to the index of the pressed button.
  1085. \ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG>` feature. Supported platforms include macOS and Windows.
  1086. .. rst-class:: classref-item-separator
  1087. ----
  1088. .. _class_DisplayServer_method_enable_for_stealing_focus:
  1089. .. rst-class:: classref-method
  1090. |void| **enable_for_stealing_focus**\ (\ process_id\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_enable_for_stealing_focus>`
  1091. 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.
  1092. \ **Note:** This method is implemented only on Windows.
  1093. .. rst-class:: classref-item-separator
  1094. ----
  1095. .. _class_DisplayServer_method_file_dialog_show:
  1096. .. rst-class:: classref-method
  1097. :ref:`Error<enum_@GlobalScope_Error>` **file_dialog_show**\ (\ title\: :ref:`String<class_String>`, current_directory\: :ref:`String<class_String>`, filename\: :ref:`String<class_String>`, show_hidden\: :ref:`bool<class_bool>`, mode\: :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>`, filters\: :ref:`PackedStringArray<class_PackedStringArray>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_file_dialog_show>`
  1098. Displays OS native dialog for selecting files or directories in the file system.
  1099. Each filter string in the ``filters`` array should be formatted like this: ``*.txt,*.doc;Text Files``. The description text of the filter is optional and can be omitted. See also :ref:`FileDialog.filters<class_FileDialog_property_filters>`.
  1100. Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int``. **On Android,** callback argument ``selected_filter_index`` is always zero.
  1101. \ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_FILE<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE>` feature. Supported platforms include Linux (X11/Wayland), Windows, macOS, and Android.
  1102. \ **Note:** ``current_directory`` might be ignored.
  1103. \ **Note:** On Android, the filter strings in the ``filters`` array should be specified using MIME types, for example:``image/png, image/jpeg"``. Additionally, the ``mode`` :ref:`FILE_DIALOG_MODE_OPEN_ANY<class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_ANY>` is not supported on Android.
  1104. \ **Note:** On Android and Linux, ``show_hidden`` is ignored.
  1105. \ **Note:** On Android and macOS, native file dialogs have no title.
  1106. \ **Note:** On macOS, sandboxed apps will save security-scoped bookmarks to retain access to the opened folders across multiple sessions. Use :ref:`OS.get_granted_permissions<class_OS_method_get_granted_permissions>` to get a list of saved bookmarks.
  1107. .. rst-class:: classref-item-separator
  1108. ----
  1109. .. _class_DisplayServer_method_file_dialog_with_options_show:
  1110. .. rst-class:: classref-method
  1111. :ref:`Error<enum_@GlobalScope_Error>` **file_dialog_with_options_show**\ (\ title\: :ref:`String<class_String>`, current_directory\: :ref:`String<class_String>`, root\: :ref:`String<class_String>`, filename\: :ref:`String<class_String>`, show_hidden\: :ref:`bool<class_bool>`, mode\: :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>`, filters\: :ref:`PackedStringArray<class_PackedStringArray>`, options\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\], callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_file_dialog_with_options_show>`
  1112. Displays OS native dialog for selecting files or directories in the file system with additional user selectable options.
  1113. Each filter string in the ``filters`` array should be formatted like this: ``*.txt,*.doc;Text Files``. The description text of the filter is optional and can be omitted. See also :ref:`FileDialog.filters<class_FileDialog_property_filters>`.
  1114. \ ``options`` is array of :ref:`Dictionary<class_Dictionary>`\ s with the following keys:
  1115. - ``"name"`` - option's name :ref:`String<class_String>`.
  1116. - ``"values"`` - :ref:`PackedStringArray<class_PackedStringArray>` of values. If empty, boolean option (check box) is used.
  1117. - ``"default"`` - default selected option index (:ref:`int<class_int>`) or default boolean value (:ref:`bool<class_bool>`).
  1118. Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int, selected_option: Dictionary``.
  1119. \ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_FILE_EXTRA<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE_EXTRA>` feature. Supported platforms include Linux (X11/Wayland), Windows, and macOS.
  1120. \ **Note:** ``current_directory`` might be ignored.
  1121. \ **Note:** On Linux (X11), ``show_hidden`` is ignored.
  1122. \ **Note:** On macOS, native file dialogs have no title.
  1123. \ **Note:** On macOS, sandboxed apps will save security-scoped bookmarks to retain access to the opened folders across multiple sessions. Use :ref:`OS.get_granted_permissions<class_OS_method_get_granted_permissions>` to get a list of saved bookmarks.
  1124. .. rst-class:: classref-item-separator
  1125. ----
  1126. .. _class_DisplayServer_method_force_process_and_drop_events:
  1127. .. rst-class:: classref-method
  1128. |void| **force_process_and_drop_events**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_force_process_and_drop_events>`
  1129. Forces window manager processing while ignoring all :ref:`InputEvent<class_InputEvent>`\ s. See also :ref:`process_events<class_DisplayServer_method_process_events>`.
  1130. \ **Note:** This method is implemented on Windows and macOS.
  1131. .. rst-class:: classref-item-separator
  1132. ----
  1133. .. _class_DisplayServer_method_get_accent_color:
  1134. .. rst-class:: classref-method
  1135. :ref:`Color<class_Color>` **get_accent_color**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_accent_color>`
  1136. Returns OS theme accent color. Returns ``Color(0, 0, 0, 0)``, if accent color is unknown.
  1137. \ **Note:** This method is implemented on macOS, Windows, and Android.
  1138. .. rst-class:: classref-item-separator
  1139. ----
  1140. .. _class_DisplayServer_method_get_base_color:
  1141. .. rst-class:: classref-method
  1142. :ref:`Color<class_Color>` **get_base_color**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_base_color>`
  1143. Returns the OS theme base color (default control background). Returns ``Color(0, 0, 0, 0)`` if the base color is unknown.
  1144. \ **Note:** This method is implemented on macOS, Windows, and Android.
  1145. .. rst-class:: classref-item-separator
  1146. ----
  1147. .. _class_DisplayServer_method_get_display_cutouts:
  1148. .. rst-class:: classref-method
  1149. :ref:`Array<class_Array>`\[:ref:`Rect2<class_Rect2>`\] **get_display_cutouts**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_display_cutouts>`
  1150. 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>`.
  1151. \ **Note:** Currently only implemented on Android. Other platforms will return an empty array even if they do have display cutouts or notches.
  1152. .. rst-class:: classref-item-separator
  1153. ----
  1154. .. _class_DisplayServer_method_get_display_safe_area:
  1155. .. rst-class:: classref-method
  1156. :ref:`Rect2i<class_Rect2i>` **get_display_safe_area**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_display_safe_area>`
  1157. 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>`.
  1158. .. rst-class:: classref-item-separator
  1159. ----
  1160. .. _class_DisplayServer_method_get_keyboard_focus_screen:
  1161. .. rst-class:: classref-method
  1162. :ref:`int<class_int>` **get_keyboard_focus_screen**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_keyboard_focus_screen>`
  1163. Returns the index of the screen containing the window with the keyboard focus, or the primary screen if there's no focused window.
  1164. .. rst-class:: classref-item-separator
  1165. ----
  1166. .. _class_DisplayServer_method_get_name:
  1167. .. rst-class:: classref-method
  1168. :ref:`String<class_String>` **get_name**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_name>`
  1169. Returns the name of the **DisplayServer** currently in use. Most operating systems only have a single **DisplayServer**, but Linux has access to more than one **DisplayServer** (currently X11 and Wayland).
  1170. The names of built-in display servers are ``Windows``, ``macOS``, ``X11`` (Linux), ``Wayland`` (Linux), ``Android``, ``iOS``, ``web`` (HTML5), and ``headless`` (when started with the ``--headless`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>`).
  1171. .. rst-class:: classref-item-separator
  1172. ----
  1173. .. _class_DisplayServer_method_get_primary_screen:
  1174. .. rst-class:: classref-method
  1175. :ref:`int<class_int>` **get_primary_screen**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_primary_screen>`
  1176. Returns index of the primary screen.
  1177. .. rst-class:: classref-item-separator
  1178. ----
  1179. .. _class_DisplayServer_method_get_screen_count:
  1180. .. rst-class:: classref-method
  1181. :ref:`int<class_int>` **get_screen_count**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_screen_count>`
  1182. Returns the number of displays available.
  1183. .. rst-class:: classref-item-separator
  1184. ----
  1185. .. _class_DisplayServer_method_get_screen_from_rect:
  1186. .. rst-class:: classref-method
  1187. :ref:`int<class_int>` **get_screen_from_rect**\ (\ rect\: :ref:`Rect2<class_Rect2>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_screen_from_rect>`
  1188. Returns the index of the screen that overlaps the most with the given rectangle. Returns ``-1`` if the rectangle doesn't overlap with any screen or has no area.
  1189. .. rst-class:: classref-item-separator
  1190. ----
  1191. .. _class_DisplayServer_method_get_swap_cancel_ok:
  1192. .. rst-class:: classref-method
  1193. :ref:`bool<class_bool>` **get_swap_cancel_ok**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_get_swap_cancel_ok>`
  1194. Returns ``true`` if positions of **OK** and **Cancel** buttons are swapped in dialogs. This is enabled by default on Windows to follow interface conventions, and be toggled by changing :ref:`ProjectSettings.gui/common/swap_cancel_ok<class_ProjectSettings_property_gui/common/swap_cancel_ok>`.
  1195. \ **Note:** This doesn't affect native dialogs such as the ones spawned by :ref:`dialog_show<class_DisplayServer_method_dialog_show>`.
  1196. .. rst-class:: classref-item-separator
  1197. ----
  1198. .. _class_DisplayServer_method_get_window_at_screen_position:
  1199. .. rst-class:: classref-method
  1200. :ref:`int<class_int>` **get_window_at_screen_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_window_at_screen_position>`
  1201. 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:
  1202. .. code:: text
  1203. * (0, 0) +-------+
  1204. | |
  1205. +-------------+ | |
  1206. | | | |
  1207. | | | |
  1208. +-------------+ +-------+
  1209. .. rst-class:: classref-item-separator
  1210. ----
  1211. .. _class_DisplayServer_method_get_window_list:
  1212. .. rst-class:: classref-method
  1213. :ref:`PackedInt32Array<class_PackedInt32Array>` **get_window_list**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_window_list>`
  1214. Returns the list of Godot window IDs belonging to this process.
  1215. \ **Note:** Native dialogs are not included in this list.
  1216. .. rst-class:: classref-item-separator
  1217. ----
  1218. .. _class_DisplayServer_method_global_menu_add_check_item:
  1219. .. rst-class:: classref-method
  1220. :ref:`int<class_int>` **global_menu_add_check_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_check_item>`
  1221. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1222. Adds a new checkable item with text ``label`` to the global menu with ID ``menu_root``.
  1223. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  1224. 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`).
  1225. \ **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``.
  1226. \ **Note:** This method is implemented only on macOS.
  1227. \ **Supported system menu IDs:**\
  1228. .. code:: text
  1229. "_main" - Main menu (macOS).
  1230. "_dock" - Dock popup menu (macOS).
  1231. "_apple" - Apple menu (macOS, custom items added before "Services").
  1232. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  1233. "_help" - Help menu (macOS).
  1234. .. rst-class:: classref-item-separator
  1235. ----
  1236. .. _class_DisplayServer_method_global_menu_add_icon_check_item:
  1237. .. rst-class:: classref-method
  1238. :ref:`int<class_int>` **global_menu_add_icon_check_item**\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_icon_check_item>`
  1239. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1240. Adds a new checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
  1241. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  1242. 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`).
  1243. \ **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``.
  1244. \ **Note:** This method is implemented only on macOS.
  1245. \ **Supported system menu IDs:**\
  1246. .. code:: text
  1247. "_main" - Main menu (macOS).
  1248. "_dock" - Dock popup menu (macOS).
  1249. "_apple" - Apple menu (macOS, custom items added before "Services").
  1250. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  1251. "_help" - Help menu (macOS).
  1252. .. rst-class:: classref-item-separator
  1253. ----
  1254. .. _class_DisplayServer_method_global_menu_add_icon_item:
  1255. .. rst-class:: classref-method
  1256. :ref:`int<class_int>` **global_menu_add_icon_item**\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_icon_item>`
  1257. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1258. Adds a new item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
  1259. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  1260. 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`).
  1261. \ **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``.
  1262. \ **Note:** This method is implemented only on macOS.
  1263. \ **Supported system menu IDs:**\
  1264. .. code:: text
  1265. "_main" - Main menu (macOS).
  1266. "_dock" - Dock popup menu (macOS).
  1267. "_apple" - Apple menu (macOS, custom items added before "Services").
  1268. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  1269. "_help" - Help menu (macOS).
  1270. .. rst-class:: classref-item-separator
  1271. ----
  1272. .. _class_DisplayServer_method_global_menu_add_icon_radio_check_item:
  1273. .. rst-class:: classref-method
  1274. :ref:`int<class_int>` **global_menu_add_icon_radio_check_item**\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_icon_radio_check_item>`
  1275. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1276. Adds a new radio-checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
  1277. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  1278. 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`).
  1279. \ **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.
  1280. \ **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``.
  1281. \ **Note:** This method is implemented only on macOS.
  1282. \ **Supported system menu IDs:**\
  1283. .. code:: text
  1284. "_main" - Main menu (macOS).
  1285. "_dock" - Dock popup menu (macOS).
  1286. "_apple" - Apple menu (macOS, custom items added before "Services").
  1287. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  1288. "_help" - Help menu (macOS).
  1289. .. rst-class:: classref-item-separator
  1290. ----
  1291. .. _class_DisplayServer_method_global_menu_add_item:
  1292. .. rst-class:: classref-method
  1293. :ref:`int<class_int>` **global_menu_add_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_item>`
  1294. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1295. Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
  1296. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  1297. 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`).
  1298. \ **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``.
  1299. \ **Note:** This method is implemented only on macOS.
  1300. \ **Supported system menu IDs:**\
  1301. .. code:: text
  1302. "_main" - Main menu (macOS).
  1303. "_dock" - Dock popup menu (macOS).
  1304. "_apple" - Apple menu (macOS, custom items added before "Services").
  1305. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  1306. "_help" - Help menu (macOS).
  1307. .. rst-class:: classref-item-separator
  1308. ----
  1309. .. _class_DisplayServer_method_global_menu_add_multistate_item:
  1310. .. rst-class:: classref-method
  1311. :ref:`int<class_int>` **global_menu_add_multistate_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, max_states\: :ref:`int<class_int>`, default_state\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_multistate_item>`
  1312. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1313. Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
  1314. 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``.
  1315. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  1316. 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`).
  1317. \ **Note:** By default, there's no indication of the current item state, it should be changed manually.
  1318. \ **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``.
  1319. \ **Note:** This method is implemented only on macOS.
  1320. \ **Supported system menu IDs:**\
  1321. .. code:: text
  1322. "_main" - Main menu (macOS).
  1323. "_dock" - Dock popup menu (macOS).
  1324. "_apple" - Apple menu (macOS, custom items added before "Services").
  1325. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  1326. "_help" - Help menu (macOS).
  1327. .. rst-class:: classref-item-separator
  1328. ----
  1329. .. _class_DisplayServer_method_global_menu_add_radio_check_item:
  1330. .. rst-class:: classref-method
  1331. :ref:`int<class_int>` **global_menu_add_radio_check_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_radio_check_item>`
  1332. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1333. Adds a new radio-checkable item with text ``label`` to the global menu with ID ``menu_root``.
  1334. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  1335. 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`).
  1336. \ **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.
  1337. \ **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``.
  1338. \ **Note:** This method is implemented only on macOS.
  1339. \ **Supported system menu IDs:**\
  1340. .. code:: text
  1341. "_main" - Main menu (macOS).
  1342. "_dock" - Dock popup menu (macOS).
  1343. "_apple" - Apple menu (macOS, custom items added before "Services").
  1344. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  1345. "_help" - Help menu (macOS).
  1346. .. rst-class:: classref-item-separator
  1347. ----
  1348. .. _class_DisplayServer_method_global_menu_add_separator:
  1349. .. rst-class:: classref-method
  1350. :ref:`int<class_int>` **global_menu_add_separator**\ (\ menu_root\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_separator>`
  1351. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1352. Adds a separator between items to the global menu with ID ``menu_root``. Separators also occupy an index.
  1353. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  1354. \ **Note:** This method is implemented only on macOS.
  1355. \ **Supported system menu IDs:**\
  1356. .. code:: text
  1357. "_main" - Main menu (macOS).
  1358. "_dock" - Dock popup menu (macOS).
  1359. "_apple" - Apple menu (macOS, custom items added before "Services").
  1360. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  1361. "_help" - Help menu (macOS).
  1362. .. rst-class:: classref-item-separator
  1363. ----
  1364. .. _class_DisplayServer_method_global_menu_add_submenu_item:
  1365. .. rst-class:: classref-method
  1366. :ref:`int<class_int>` **global_menu_add_submenu_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, submenu\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_submenu_item>`
  1367. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1368. 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.
  1369. Returns index of the inserted item, it's not guaranteed to be the same as ``index`` value.
  1370. \ **Note:** This method is implemented only on macOS.
  1371. \ **Supported system menu IDs:**\
  1372. .. code:: text
  1373. "_main" - Main menu (macOS).
  1374. "_dock" - Dock popup menu (macOS).
  1375. "_apple" - Apple menu (macOS, custom items added before "Services").
  1376. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  1377. "_help" - Help menu (macOS).
  1378. .. rst-class:: classref-item-separator
  1379. ----
  1380. .. _class_DisplayServer_method_global_menu_clear:
  1381. .. rst-class:: classref-method
  1382. |void| **global_menu_clear**\ (\ menu_root\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_clear>`
  1383. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1384. Removes all items from the global menu with ID ``menu_root``.
  1385. \ **Note:** This method is implemented only on macOS.
  1386. \ **Supported system menu IDs:**\
  1387. .. code:: text
  1388. "_main" - Main menu (macOS).
  1389. "_dock" - Dock popup menu (macOS).
  1390. "_apple" - Apple menu (macOS, custom items added before "Services").
  1391. "_window" - Window menu (macOS, custom items added after "Bring All to Front").
  1392. "_help" - Help menu (macOS).
  1393. .. rst-class:: classref-item-separator
  1394. ----
  1395. .. _class_DisplayServer_method_global_menu_get_item_accelerator:
  1396. .. rst-class:: classref-method
  1397. :ref:`Key<enum_@GlobalScope_Key>` **global_menu_get_item_accelerator**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_accelerator>`
  1398. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1399. 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.
  1400. \ **Note:** This method is implemented only on macOS.
  1401. .. rst-class:: classref-item-separator
  1402. ----
  1403. .. _class_DisplayServer_method_global_menu_get_item_callback:
  1404. .. rst-class:: classref-method
  1405. :ref:`Callable<class_Callable>` **global_menu_get_item_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_callback>`
  1406. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1407. Returns the callback of the item at index ``idx``.
  1408. \ **Note:** This method is implemented only on macOS.
  1409. .. rst-class:: classref-item-separator
  1410. ----
  1411. .. _class_DisplayServer_method_global_menu_get_item_count:
  1412. .. rst-class:: classref-method
  1413. :ref:`int<class_int>` **global_menu_get_item_count**\ (\ menu_root\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_count>`
  1414. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1415. Returns number of items in the global menu with ID ``menu_root``.
  1416. \ **Note:** This method is implemented only on macOS.
  1417. .. rst-class:: classref-item-separator
  1418. ----
  1419. .. _class_DisplayServer_method_global_menu_get_item_icon:
  1420. .. rst-class:: classref-method
  1421. :ref:`Texture2D<class_Texture2D>` **global_menu_get_item_icon**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_icon>`
  1422. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1423. Returns the icon of the item at index ``idx``.
  1424. \ **Note:** This method is implemented only on macOS.
  1425. .. rst-class:: classref-item-separator
  1426. ----
  1427. .. _class_DisplayServer_method_global_menu_get_item_indentation_level:
  1428. .. rst-class:: classref-method
  1429. :ref:`int<class_int>` **global_menu_get_item_indentation_level**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_indentation_level>`
  1430. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1431. Returns the horizontal offset of the item at the given ``idx``.
  1432. \ **Note:** This method is implemented only on macOS.
  1433. .. rst-class:: classref-item-separator
  1434. ----
  1435. .. _class_DisplayServer_method_global_menu_get_item_index_from_tag:
  1436. .. rst-class:: classref-method
  1437. :ref:`int<class_int>` **global_menu_get_item_index_from_tag**\ (\ menu_root\: :ref:`String<class_String>`, tag\: :ref:`Variant<class_Variant>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_index_from_tag>`
  1438. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1439. Returns the index of the item with the specified ``tag``. Indices are automatically assigned to each item by the engine, and cannot be set manually.
  1440. \ **Note:** This method is implemented only on macOS.
  1441. .. rst-class:: classref-item-separator
  1442. ----
  1443. .. _class_DisplayServer_method_global_menu_get_item_index_from_text:
  1444. .. rst-class:: classref-method
  1445. :ref:`int<class_int>` **global_menu_get_item_index_from_text**\ (\ menu_root\: :ref:`String<class_String>`, text\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_index_from_text>`
  1446. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1447. Returns the index of the item with the specified ``text``. Indices are automatically assigned to each item by the engine, and cannot be set manually.
  1448. \ **Note:** This method is implemented only on macOS.
  1449. .. rst-class:: classref-item-separator
  1450. ----
  1451. .. _class_DisplayServer_method_global_menu_get_item_key_callback:
  1452. .. rst-class:: classref-method
  1453. :ref:`Callable<class_Callable>` **global_menu_get_item_key_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_key_callback>`
  1454. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1455. Returns the callback of the item accelerator at index ``idx``.
  1456. \ **Note:** This method is implemented only on macOS.
  1457. .. rst-class:: classref-item-separator
  1458. ----
  1459. .. _class_DisplayServer_method_global_menu_get_item_max_states:
  1460. .. rst-class:: classref-method
  1461. :ref:`int<class_int>` **global_menu_get_item_max_states**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_max_states>`
  1462. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1463. 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.
  1464. \ **Note:** This method is implemented only on macOS.
  1465. .. rst-class:: classref-item-separator
  1466. ----
  1467. .. _class_DisplayServer_method_global_menu_get_item_state:
  1468. .. rst-class:: classref-method
  1469. :ref:`int<class_int>` **global_menu_get_item_state**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_state>`
  1470. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1471. Returns the state of a multistate item. See :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
  1472. \ **Note:** This method is implemented only on macOS.
  1473. .. rst-class:: classref-item-separator
  1474. ----
  1475. .. _class_DisplayServer_method_global_menu_get_item_submenu:
  1476. .. rst-class:: classref-method
  1477. :ref:`String<class_String>` **global_menu_get_item_submenu**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_submenu>`
  1478. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1479. 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.
  1480. \ **Note:** This method is implemented only on macOS.
  1481. .. rst-class:: classref-item-separator
  1482. ----
  1483. .. _class_DisplayServer_method_global_menu_get_item_tag:
  1484. .. rst-class:: classref-method
  1485. :ref:`Variant<class_Variant>` **global_menu_get_item_tag**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_tag>`
  1486. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1487. 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.
  1488. \ **Note:** This method is implemented only on macOS.
  1489. .. rst-class:: classref-item-separator
  1490. ----
  1491. .. _class_DisplayServer_method_global_menu_get_item_text:
  1492. .. rst-class:: classref-method
  1493. :ref:`String<class_String>` **global_menu_get_item_text**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_text>`
  1494. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1495. Returns the text of the item at index ``idx``.
  1496. \ **Note:** This method is implemented only on macOS.
  1497. .. rst-class:: classref-item-separator
  1498. ----
  1499. .. _class_DisplayServer_method_global_menu_get_item_tooltip:
  1500. .. rst-class:: classref-method
  1501. :ref:`String<class_String>` **global_menu_get_item_tooltip**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_tooltip>`
  1502. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1503. Returns the tooltip associated with the specified index ``idx``.
  1504. \ **Note:** This method is implemented only on macOS.
  1505. .. rst-class:: classref-item-separator
  1506. ----
  1507. .. _class_DisplayServer_method_global_menu_get_system_menu_roots:
  1508. .. rst-class:: classref-method
  1509. :ref:`Dictionary<class_Dictionary>` **global_menu_get_system_menu_roots**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_system_menu_roots>`
  1510. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1511. Returns Dictionary of supported system menu IDs and names.
  1512. \ **Note:** This method is implemented only on macOS.
  1513. .. rst-class:: classref-item-separator
  1514. ----
  1515. .. _class_DisplayServer_method_global_menu_is_item_checkable:
  1516. .. rst-class:: classref-method
  1517. :ref:`bool<class_bool>` **global_menu_is_item_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_is_item_checkable>`
  1518. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1519. Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if it has a checkbox or radio button.
  1520. \ **Note:** This method is implemented only on macOS.
  1521. .. rst-class:: classref-item-separator
  1522. ----
  1523. .. _class_DisplayServer_method_global_menu_is_item_checked:
  1524. .. rst-class:: classref-method
  1525. :ref:`bool<class_bool>` **global_menu_is_item_checked**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_is_item_checked>`
  1526. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1527. Returns ``true`` if the item at index ``idx`` is checked.
  1528. \ **Note:** This method is implemented only on macOS.
  1529. .. rst-class:: classref-item-separator
  1530. ----
  1531. .. _class_DisplayServer_method_global_menu_is_item_disabled:
  1532. .. rst-class:: classref-method
  1533. :ref:`bool<class_bool>` **global_menu_is_item_disabled**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_is_item_disabled>`
  1534. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1535. Returns ``true`` if the item at index ``idx`` is disabled. When it is disabled it can't be selected, or its action invoked.
  1536. See :ref:`global_menu_set_item_disabled<class_DisplayServer_method_global_menu_set_item_disabled>` for more info on how to disable an item.
  1537. \ **Note:** This method is implemented only on macOS.
  1538. .. rst-class:: classref-item-separator
  1539. ----
  1540. .. _class_DisplayServer_method_global_menu_is_item_hidden:
  1541. .. rst-class:: classref-method
  1542. :ref:`bool<class_bool>` **global_menu_is_item_hidden**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_is_item_hidden>`
  1543. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1544. Returns ``true`` if the item at index ``idx`` is hidden.
  1545. See :ref:`global_menu_set_item_hidden<class_DisplayServer_method_global_menu_set_item_hidden>` for more info on how to hide an item.
  1546. \ **Note:** This method is implemented only on macOS.
  1547. .. rst-class:: classref-item-separator
  1548. ----
  1549. .. _class_DisplayServer_method_global_menu_is_item_radio_checkable:
  1550. .. rst-class:: classref-method
  1551. :ref:`bool<class_bool>` **global_menu_is_item_radio_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_is_item_radio_checkable>`
  1552. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1553. Returns ``true`` if the item at index ``idx`` has radio button-style checkability.
  1554. \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
  1555. \ **Note:** This method is implemented only on macOS.
  1556. .. rst-class:: classref-item-separator
  1557. ----
  1558. .. _class_DisplayServer_method_global_menu_remove_item:
  1559. .. rst-class:: classref-method
  1560. |void| **global_menu_remove_item**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_remove_item>`
  1561. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1562. Removes the item at index ``idx`` from the global menu ``menu_root``.
  1563. \ **Note:** The indices of items after the removed item will be shifted by one.
  1564. \ **Note:** This method is implemented only on macOS.
  1565. .. rst-class:: classref-item-separator
  1566. ----
  1567. .. _class_DisplayServer_method_global_menu_set_item_accelerator:
  1568. .. rst-class:: classref-method
  1569. |void| **global_menu_set_item_accelerator**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_accelerator>`
  1570. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1571. 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`).
  1572. \ **Note:** This method is implemented only on macOS.
  1573. .. rst-class:: classref-item-separator
  1574. ----
  1575. .. _class_DisplayServer_method_global_menu_set_item_callback:
  1576. .. rst-class:: classref-method
  1577. |void| **global_menu_set_item_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_callback>`
  1578. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1579. Sets the callback of the item at index ``idx``. Callback is emitted when an item is pressed.
  1580. \ **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.
  1581. \ **Note:** This method is implemented only on macOS.
  1582. .. rst-class:: classref-item-separator
  1583. ----
  1584. .. _class_DisplayServer_method_global_menu_set_item_checkable:
  1585. .. rst-class:: classref-method
  1586. |void| **global_menu_set_item_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_checkable>`
  1587. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1588. Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the type of the item to plain text.
  1589. \ **Note:** This method is implemented only on macOS.
  1590. .. rst-class:: classref-item-separator
  1591. ----
  1592. .. _class_DisplayServer_method_global_menu_set_item_checked:
  1593. .. rst-class:: classref-method
  1594. |void| **global_menu_set_item_checked**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checked\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_checked>`
  1595. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1596. Sets the checkstate status of the item at index ``idx``.
  1597. \ **Note:** This method is implemented only on macOS.
  1598. .. rst-class:: classref-item-separator
  1599. ----
  1600. .. _class_DisplayServer_method_global_menu_set_item_disabled:
  1601. .. rst-class:: classref-method
  1602. |void| **global_menu_set_item_disabled**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_disabled>`
  1603. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1604. Enables/disables the item at index ``idx``. When it is disabled, it can't be selected and its action can't be invoked.
  1605. \ **Note:** This method is implemented only on macOS.
  1606. .. rst-class:: classref-item-separator
  1607. ----
  1608. .. _class_DisplayServer_method_global_menu_set_item_hidden:
  1609. .. rst-class:: classref-method
  1610. |void| **global_menu_set_item_hidden**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, hidden\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_hidden>`
  1611. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1612. Hides/shows the item at index ``idx``. When it is hidden, an item does not appear in a menu and its action cannot be invoked.
  1613. \ **Note:** This method is implemented only on macOS.
  1614. .. rst-class:: classref-item-separator
  1615. ----
  1616. .. _class_DisplayServer_method_global_menu_set_item_hover_callbacks:
  1617. .. rst-class:: classref-method
  1618. |void| **global_menu_set_item_hover_callbacks**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_hover_callbacks>`
  1619. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1620. Sets the callback of the item at index ``idx``. The callback is emitted when an item is hovered.
  1621. \ **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.
  1622. \ **Note:** This method is implemented only on macOS.
  1623. .. rst-class:: classref-item-separator
  1624. ----
  1625. .. _class_DisplayServer_method_global_menu_set_item_icon:
  1626. .. rst-class:: classref-method
  1627. |void| **global_menu_set_item_icon**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_icon>`
  1628. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1629. Replaces the :ref:`Texture2D<class_Texture2D>` icon of the specified ``idx``.
  1630. \ **Note:** This method is implemented only on macOS.
  1631. \ **Note:** This method is not supported by macOS "_dock" menu items.
  1632. .. rst-class:: classref-item-separator
  1633. ----
  1634. .. _class_DisplayServer_method_global_menu_set_item_indentation_level:
  1635. .. rst-class:: classref-method
  1636. |void| **global_menu_set_item_indentation_level**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, level\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_indentation_level>`
  1637. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1638. Sets the horizontal offset of the item at the given ``idx``.
  1639. \ **Note:** This method is implemented only on macOS.
  1640. .. rst-class:: classref-item-separator
  1641. ----
  1642. .. _class_DisplayServer_method_global_menu_set_item_key_callback:
  1643. .. rst-class:: classref-method
  1644. |void| **global_menu_set_item_key_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, key_callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_key_callback>`
  1645. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1646. Sets the callback of the item at index ``idx``. Callback is emitted when its accelerator is activated.
  1647. \ **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.
  1648. \ **Note:** This method is implemented only on macOS.
  1649. .. rst-class:: classref-item-separator
  1650. ----
  1651. .. _class_DisplayServer_method_global_menu_set_item_max_states:
  1652. .. rst-class:: classref-method
  1653. |void| **global_menu_set_item_max_states**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, max_states\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_max_states>`
  1654. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1655. 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.
  1656. \ **Note:** This method is implemented only on macOS.
  1657. .. rst-class:: classref-item-separator
  1658. ----
  1659. .. _class_DisplayServer_method_global_menu_set_item_radio_checkable:
  1660. .. rst-class:: classref-method
  1661. |void| **global_menu_set_item_radio_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_radio_checkable>`
  1662. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1663. 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.
  1664. \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
  1665. \ **Note:** This method is implemented only on macOS.
  1666. .. rst-class:: classref-item-separator
  1667. ----
  1668. .. _class_DisplayServer_method_global_menu_set_item_state:
  1669. .. rst-class:: classref-method
  1670. |void| **global_menu_set_item_state**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, state\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_state>`
  1671. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1672. Sets the state of a multistate item. See :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
  1673. \ **Note:** This method is implemented only on macOS.
  1674. .. rst-class:: classref-item-separator
  1675. ----
  1676. .. _class_DisplayServer_method_global_menu_set_item_submenu:
  1677. .. rst-class:: classref-method
  1678. |void| **global_menu_set_item_submenu**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, submenu\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_submenu>`
  1679. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1680. 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.
  1681. \ **Note:** This method is implemented only on macOS.
  1682. .. rst-class:: classref-item-separator
  1683. ----
  1684. .. _class_DisplayServer_method_global_menu_set_item_tag:
  1685. .. rst-class:: classref-method
  1686. |void| **global_menu_set_item_tag**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tag\: :ref:`Variant<class_Variant>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_tag>`
  1687. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1688. 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.
  1689. \ **Note:** This method is implemented only on macOS.
  1690. .. rst-class:: classref-item-separator
  1691. ----
  1692. .. _class_DisplayServer_method_global_menu_set_item_text:
  1693. .. rst-class:: classref-method
  1694. |void| **global_menu_set_item_text**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, text\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_text>`
  1695. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1696. Sets the text of the item at index ``idx``.
  1697. \ **Note:** This method is implemented only on macOS.
  1698. .. rst-class:: classref-item-separator
  1699. ----
  1700. .. _class_DisplayServer_method_global_menu_set_item_tooltip:
  1701. .. rst-class:: classref-method
  1702. |void| **global_menu_set_item_tooltip**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_tooltip>`
  1703. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1704. Sets the :ref:`String<class_String>` tooltip of the item at the specified index ``idx``.
  1705. \ **Note:** This method is implemented only on macOS.
  1706. .. rst-class:: classref-item-separator
  1707. ----
  1708. .. _class_DisplayServer_method_global_menu_set_popup_callbacks:
  1709. .. rst-class:: classref-method
  1710. |void| **global_menu_set_popup_callbacks**\ (\ menu_root\: :ref:`String<class_String>`, open_callback\: :ref:`Callable<class_Callable>`, close_callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_popup_callbacks>`
  1711. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
  1712. Registers callables to emit when the menu is respectively about to show or closed. Callback methods should have zero arguments.
  1713. .. rst-class:: classref-item-separator
  1714. ----
  1715. .. _class_DisplayServer_method_has_additional_outputs:
  1716. .. rst-class:: classref-method
  1717. :ref:`bool<class_bool>` **has_additional_outputs**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_has_additional_outputs>`
  1718. Returns ``true`` if any additional outputs have been registered via :ref:`register_additional_output<class_DisplayServer_method_register_additional_output>`.
  1719. .. rst-class:: classref-item-separator
  1720. ----
  1721. .. _class_DisplayServer_method_has_feature:
  1722. .. rst-class:: classref-method
  1723. :ref:`bool<class_bool>` **has_feature**\ (\ feature\: :ref:`Feature<enum_DisplayServer_Feature>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_has_feature>`
  1724. Returns ``true`` if the specified ``feature`` is supported by the current **DisplayServer**, ``false`` otherwise.
  1725. .. rst-class:: classref-item-separator
  1726. ----
  1727. .. _class_DisplayServer_method_has_hardware_keyboard:
  1728. .. rst-class:: classref-method
  1729. :ref:`bool<class_bool>` **has_hardware_keyboard**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_has_hardware_keyboard>`
  1730. Returns ``true`` if hardware keyboard is connected.
  1731. \ **Note:** This method is implemented on Android and iOS, on other platforms this method always returns ``true``.
  1732. .. rst-class:: classref-item-separator
  1733. ----
  1734. .. _class_DisplayServer_method_help_set_search_callbacks:
  1735. .. rst-class:: classref-method
  1736. |void| **help_set_search_callbacks**\ (\ search_callback\: :ref:`Callable<class_Callable>`, action_callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_help_set_search_callbacks>`
  1737. Sets native help system search callbacks.
  1738. \ ``search_callback`` has the following arguments: ``String search_string, int result_limit`` and return a :ref:`Dictionary<class_Dictionary>` with "key, display name" pairs for the search results. Called when the user enters search terms in the ``Help`` menu.
  1739. \ ``action_callback`` has the following arguments: ``String key``. Called when the user selects a search result in the ``Help`` menu.
  1740. \ **Note:** This method is implemented only on macOS.
  1741. .. rst-class:: classref-item-separator
  1742. ----
  1743. .. _class_DisplayServer_method_ime_get_selection:
  1744. .. rst-class:: classref-method
  1745. :ref:`Vector2i<class_Vector2i>` **ime_get_selection**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_ime_get_selection>`
  1746. 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.
  1747. \ **Note:** This method is implemented only on macOS.
  1748. .. rst-class:: classref-item-separator
  1749. ----
  1750. .. _class_DisplayServer_method_ime_get_text:
  1751. .. rst-class:: classref-method
  1752. :ref:`String<class_String>` **ime_get_text**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_ime_get_text>`
  1753. Returns the composition string contained within the `Input Method Editor <https://en.wikipedia.org/wiki/Input_method>`__ window.
  1754. \ **Note:** This method is implemented only on macOS.
  1755. .. rst-class:: classref-item-separator
  1756. ----
  1757. .. _class_DisplayServer_method_is_dark_mode:
  1758. .. rst-class:: classref-method
  1759. :ref:`bool<class_bool>` **is_dark_mode**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_is_dark_mode>`
  1760. Returns ``true`` if OS is using dark mode.
  1761. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
  1762. .. rst-class:: classref-item-separator
  1763. ----
  1764. .. _class_DisplayServer_method_is_dark_mode_supported:
  1765. .. rst-class:: classref-method
  1766. :ref:`bool<class_bool>` **is_dark_mode_supported**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_is_dark_mode_supported>`
  1767. Returns ``true`` if OS supports dark mode.
  1768. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
  1769. .. rst-class:: classref-item-separator
  1770. ----
  1771. .. _class_DisplayServer_method_is_touchscreen_available:
  1772. .. rst-class:: classref-method
  1773. :ref:`bool<class_bool>` **is_touchscreen_available**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_is_touchscreen_available>`
  1774. Returns ``true`` if touch events are available (Android or iOS), the capability is detected on the Web platform or if :ref:`ProjectSettings.input_devices/pointing/emulate_touch_from_mouse<class_ProjectSettings_property_input_devices/pointing/emulate_touch_from_mouse>` is ``true``.
  1775. .. rst-class:: classref-item-separator
  1776. ----
  1777. .. _class_DisplayServer_method_is_window_transparency_available:
  1778. .. rst-class:: classref-method
  1779. :ref:`bool<class_bool>` **is_window_transparency_available**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_is_window_transparency_available>`
  1780. Returns ``true`` if the window background can be made transparent. This method returns ``false`` if :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>` is set to ``false``, or if transparency is not supported by the renderer or OS compositor.
  1781. .. rst-class:: classref-item-separator
  1782. ----
  1783. .. _class_DisplayServer_method_keyboard_get_current_layout:
  1784. .. rst-class:: classref-method
  1785. :ref:`int<class_int>` **keyboard_get_current_layout**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_current_layout>`
  1786. Returns active keyboard layout index.
  1787. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS, and Windows.
  1788. .. rst-class:: classref-item-separator
  1789. ----
  1790. .. _class_DisplayServer_method_keyboard_get_keycode_from_physical:
  1791. .. rst-class:: classref-method
  1792. :ref:`Key<enum_@GlobalScope_Key>` **keyboard_get_keycode_from_physical**\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_keycode_from_physical>`
  1793. Converts a physical (US QWERTY) ``keycode`` to one in the active keyboard layout.
  1794. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
  1795. .. rst-class:: classref-item-separator
  1796. ----
  1797. .. _class_DisplayServer_method_keyboard_get_label_from_physical:
  1798. .. rst-class:: classref-method
  1799. :ref:`Key<enum_@GlobalScope_Key>` **keyboard_get_label_from_physical**\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_label_from_physical>`
  1800. Converts a physical (US QWERTY) ``keycode`` to localized label printed on the key in the active keyboard layout.
  1801. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
  1802. .. rst-class:: classref-item-separator
  1803. ----
  1804. .. _class_DisplayServer_method_keyboard_get_layout_count:
  1805. .. rst-class:: classref-method
  1806. :ref:`int<class_int>` **keyboard_get_layout_count**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_layout_count>`
  1807. Returns the number of keyboard layouts.
  1808. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
  1809. .. rst-class:: classref-item-separator
  1810. ----
  1811. .. _class_DisplayServer_method_keyboard_get_layout_language:
  1812. .. rst-class:: classref-method
  1813. :ref:`String<class_String>` **keyboard_get_layout_language**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_layout_language>`
  1814. Returns the ISO-639/BCP-47 language code of the keyboard layout at position ``index``.
  1815. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
  1816. .. rst-class:: classref-item-separator
  1817. ----
  1818. .. _class_DisplayServer_method_keyboard_get_layout_name:
  1819. .. rst-class:: classref-method
  1820. :ref:`String<class_String>` **keyboard_get_layout_name**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_layout_name>`
  1821. Returns the localized name of the keyboard layout at position ``index``.
  1822. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
  1823. .. rst-class:: classref-item-separator
  1824. ----
  1825. .. _class_DisplayServer_method_keyboard_set_current_layout:
  1826. .. rst-class:: classref-method
  1827. |void| **keyboard_set_current_layout**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_set_current_layout>`
  1828. Sets the active keyboard layout.
  1829. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
  1830. .. rst-class:: classref-item-separator
  1831. ----
  1832. .. _class_DisplayServer_method_mouse_get_button_state:
  1833. .. rst-class:: classref-method
  1834. |bitfield|\[:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>`\] **mouse_get_button_state**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_mouse_get_button_state>`
  1835. 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>`.
  1836. .. rst-class:: classref-item-separator
  1837. ----
  1838. .. _class_DisplayServer_method_mouse_get_mode:
  1839. .. rst-class:: classref-method
  1840. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **mouse_get_mode**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_mouse_get_mode>`
  1841. Returns the current mouse mode. See also :ref:`mouse_set_mode<class_DisplayServer_method_mouse_set_mode>`.
  1842. .. rst-class:: classref-item-separator
  1843. ----
  1844. .. _class_DisplayServer_method_mouse_get_position:
  1845. .. rst-class:: classref-method
  1846. :ref:`Vector2i<class_Vector2i>` **mouse_get_position**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_mouse_get_position>`
  1847. Returns the mouse cursor's current position in screen coordinates.
  1848. .. rst-class:: classref-item-separator
  1849. ----
  1850. .. _class_DisplayServer_method_mouse_set_mode:
  1851. .. rst-class:: classref-method
  1852. |void| **mouse_set_mode**\ (\ mouse_mode\: :ref:`MouseMode<enum_DisplayServer_MouseMode>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_mouse_set_mode>`
  1853. Sets the current mouse mode. See also :ref:`mouse_get_mode<class_DisplayServer_method_mouse_get_mode>`.
  1854. .. rst-class:: classref-item-separator
  1855. ----
  1856. .. _class_DisplayServer_method_process_events:
  1857. .. rst-class:: classref-method
  1858. |void| **process_events**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_process_events>`
  1859. 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>`.
  1860. .. rst-class:: classref-item-separator
  1861. ----
  1862. .. _class_DisplayServer_method_register_additional_output:
  1863. .. rst-class:: classref-method
  1864. |void| **register_additional_output**\ (\ object\: :ref:`Object<class_Object>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_register_additional_output>`
  1865. Registers an :ref:`Object<class_Object>` which represents an additional output that will be rendered too, beyond normal windows. The :ref:`Object<class_Object>` is only used as an identifier, which can be later passed to :ref:`unregister_additional_output<class_DisplayServer_method_unregister_additional_output>`.
  1866. This can be used to prevent Godot from skipping rendering when no normal windows are visible.
  1867. .. rst-class:: classref-item-separator
  1868. ----
  1869. .. _class_DisplayServer_method_screen_get_dpi:
  1870. .. rst-class:: classref-method
  1871. :ref:`int<class_int>` **screen_get_dpi**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_dpi>`
  1872. 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.
  1873. \ **Note:** On macOS, returned value is inaccurate if fractional display scaling mode is used.
  1874. \ **Note:** On Android devices, the actual screen densities are grouped into six generalized densities:
  1875. .. code:: text
  1876. ldpi - 120 dpi
  1877. mdpi - 160 dpi
  1878. hdpi - 240 dpi
  1879. xhdpi - 320 dpi
  1880. xxhdpi - 480 dpi
  1881. xxxhdpi - 640 dpi
  1882. \ **Note:** This method is implemented on Android, Linux (X11/Wayland), macOS and Windows. Returns ``72`` on unsupported platforms.
  1883. .. rst-class:: classref-item-separator
  1884. ----
  1885. .. _class_DisplayServer_method_screen_get_image:
  1886. .. rst-class:: classref-method
  1887. :ref:`Image<class_Image>` **screen_get_image**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_image>`
  1888. Returns screenshot of the ``screen``.
  1889. \ **Note:** This method is implemented on Linux (X11), macOS, and Windows.
  1890. \ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.
  1891. .. rst-class:: classref-item-separator
  1892. ----
  1893. .. _class_DisplayServer_method_screen_get_image_rect:
  1894. .. rst-class:: classref-method
  1895. :ref:`Image<class_Image>` **screen_get_image_rect**\ (\ rect\: :ref:`Rect2i<class_Rect2i>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_image_rect>`
  1896. Returns screenshot of the screen ``rect``.
  1897. \ **Note:** This method is implemented on macOS and Windows.
  1898. \ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.
  1899. .. rst-class:: classref-item-separator
  1900. ----
  1901. .. _class_DisplayServer_method_screen_get_max_scale:
  1902. .. rst-class:: classref-method
  1903. :ref:`float<class_float>` **screen_get_max_scale**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_max_scale>`
  1904. Returns the greatest scale factor of all screens.
  1905. \ **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.
  1906. \ **Note:** This method is implemented only on macOS.
  1907. .. rst-class:: classref-item-separator
  1908. ----
  1909. .. _class_DisplayServer_method_screen_get_orientation:
  1910. .. rst-class:: classref-method
  1911. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **screen_get_orientation**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_orientation>`
  1912. Returns the ``screen``'s current orientation. See also :ref:`screen_set_orientation<class_DisplayServer_method_screen_set_orientation>`.
  1913. \ **Note:** This method is implemented on Android and iOS.
  1914. .. rst-class:: classref-item-separator
  1915. ----
  1916. .. _class_DisplayServer_method_screen_get_pixel:
  1917. .. rst-class:: classref-method
  1918. :ref:`Color<class_Color>` **screen_get_pixel**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_pixel>`
  1919. Returns color of the display pixel at the ``position``.
  1920. \ **Note:** This method is implemented on Linux (X11), macOS, and Windows.
  1921. \ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.
  1922. .. rst-class:: classref-item-separator
  1923. ----
  1924. .. _class_DisplayServer_method_screen_get_position:
  1925. .. rst-class:: classref-method
  1926. :ref:`Vector2i<class_Vector2i>` **screen_get_position**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_position>`
  1927. 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:
  1928. .. code:: text
  1929. * (0, 0) +-------+
  1930. | |
  1931. +-------------+ | |
  1932. | | | |
  1933. | | | |
  1934. +-------------+ +-------+
  1935. See also :ref:`screen_get_size<class_DisplayServer_method_screen_get_size>`.
  1936. \ **Note:** On Linux (Wayland) this method always returns ``(0, 0)``.
  1937. .. rst-class:: classref-item-separator
  1938. ----
  1939. .. _class_DisplayServer_method_screen_get_refresh_rate:
  1940. .. rst-class:: classref-method
  1941. :ref:`float<class_float>` **screen_get_refresh_rate**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_refresh_rate>`
  1942. 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.
  1943. \ **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.
  1944. To fallback to a default refresh rate if the method fails, try:
  1945. ::
  1946. var refresh_rate = DisplayServer.screen_get_refresh_rate()
  1947. if refresh_rate < 0:
  1948. refresh_rate = 60.0
  1949. .. rst-class:: classref-item-separator
  1950. ----
  1951. .. _class_DisplayServer_method_screen_get_scale:
  1952. .. rst-class:: classref-method
  1953. :ref:`float<class_float>` **screen_get_scale**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_scale>`
  1954. Returns the scale factor of the specified screen by index.
  1955. \ **Note:** On macOS, the returned value is ``2.0`` for hiDPI (Retina) screens, and ``1.0`` for all other cases.
  1956. \ **Note:** On Linux (Wayland), the returned value is accurate only when ``screen`` is :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`. Due to API limitations, passing a direct index will return a rounded-up integer, if the screen has a fractional scale (e.g. ``1.25`` would get rounded up to ``2.0``).
  1957. \ **Note:** This method is implemented on Android, iOS, Web, macOS, and Linux (Wayland).
  1958. .. rst-class:: classref-item-separator
  1959. ----
  1960. .. _class_DisplayServer_method_screen_get_size:
  1961. .. rst-class:: classref-method
  1962. :ref:`Vector2i<class_Vector2i>` **screen_get_size**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_size>`
  1963. 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>`.
  1964. .. rst-class:: classref-item-separator
  1965. ----
  1966. .. _class_DisplayServer_method_screen_get_usable_rect:
  1967. .. rst-class:: classref-method
  1968. :ref:`Rect2i<class_Rect2i>` **screen_get_usable_rect**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_usable_rect>`
  1969. 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>`.
  1970. .. rst-class:: classref-item-separator
  1971. ----
  1972. .. _class_DisplayServer_method_screen_is_kept_on:
  1973. .. rst-class:: classref-method
  1974. :ref:`bool<class_bool>` **screen_is_kept_on**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_is_kept_on>`
  1975. 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>`.
  1976. .. rst-class:: classref-item-separator
  1977. ----
  1978. .. _class_DisplayServer_method_screen_set_keep_on:
  1979. .. rst-class:: classref-method
  1980. |void| **screen_set_keep_on**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_screen_set_keep_on>`
  1981. 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>`.
  1982. .. rst-class:: classref-item-separator
  1983. ----
  1984. .. _class_DisplayServer_method_screen_set_orientation:
  1985. .. rst-class:: classref-method
  1986. |void| **screen_set_orientation**\ (\ orientation\: :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>`, screen\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_screen_set_orientation>`
  1987. Sets the ``screen``'s ``orientation``. See also :ref:`screen_get_orientation<class_DisplayServer_method_screen_get_orientation>`.
  1988. \ **Note:** On iOS, this method has no effect if :ref:`ProjectSettings.display/window/handheld/orientation<class_ProjectSettings_property_display/window/handheld/orientation>` is not set to :ref:`SCREEN_SENSOR<class_DisplayServer_constant_SCREEN_SENSOR>`.
  1989. .. rst-class:: classref-item-separator
  1990. ----
  1991. .. _class_DisplayServer_method_set_icon:
  1992. .. rst-class:: classref-method
  1993. |void| **set_icon**\ (\ image\: :ref:`Image<class_Image>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_set_icon>`
  1994. 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.
  1995. \ **Note:** Requires support for :ref:`FEATURE_ICON<class_DisplayServer_constant_FEATURE_ICON>`.
  1996. .. rst-class:: classref-item-separator
  1997. ----
  1998. .. _class_DisplayServer_method_set_native_icon:
  1999. .. rst-class:: classref-method
  2000. |void| **set_native_icon**\ (\ filename\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_set_native_icon>`
  2001. 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.
  2002. \ **Note:** Requires support for :ref:`FEATURE_NATIVE_ICON<class_DisplayServer_constant_FEATURE_NATIVE_ICON>`.
  2003. .. rst-class:: classref-item-separator
  2004. ----
  2005. .. _class_DisplayServer_method_set_system_theme_change_callback:
  2006. .. rst-class:: classref-method
  2007. |void| **set_system_theme_change_callback**\ (\ callable\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_set_system_theme_change_callback>`
  2008. Sets the ``callable`` that should be called when system theme settings are changed. Callback method should have zero arguments.
  2009. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
  2010. .. rst-class:: classref-item-separator
  2011. ----
  2012. .. _class_DisplayServer_method_status_indicator_get_rect:
  2013. .. rst-class:: classref-method
  2014. :ref:`Rect2<class_Rect2>` **status_indicator_get_rect**\ (\ id\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_status_indicator_get_rect>`
  2015. Returns the rectangle for the given status indicator ``id`` in screen coordinates. If the status indicator is not visible, returns an empty :ref:`Rect2<class_Rect2>`.
  2016. \ **Note:** This method is implemented on macOS and Windows.
  2017. .. rst-class:: classref-item-separator
  2018. ----
  2019. .. _class_DisplayServer_method_status_indicator_set_callback:
  2020. .. rst-class:: classref-method
  2021. |void| **status_indicator_set_callback**\ (\ id\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_status_indicator_set_callback>`
  2022. Sets the application status indicator activation callback. ``callback`` should take two arguments: :ref:`int<class_int>` mouse button index (one of :ref:`MouseButton<enum_@GlobalScope_MouseButton>` values) and :ref:`Vector2i<class_Vector2i>` click position in screen coordinates.
  2023. \ **Note:** This method is implemented on macOS and Windows.
  2024. .. rst-class:: classref-item-separator
  2025. ----
  2026. .. _class_DisplayServer_method_status_indicator_set_icon:
  2027. .. rst-class:: classref-method
  2028. |void| **status_indicator_set_icon**\ (\ id\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_status_indicator_set_icon>`
  2029. Sets the application status indicator icon.
  2030. \ **Note:** This method is implemented on macOS and Windows.
  2031. .. rst-class:: classref-item-separator
  2032. ----
  2033. .. _class_DisplayServer_method_status_indicator_set_menu:
  2034. .. rst-class:: classref-method
  2035. |void| **status_indicator_set_menu**\ (\ id\: :ref:`int<class_int>`, menu_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_status_indicator_set_menu>`
  2036. Sets the application status indicator native popup menu.
  2037. \ **Note:** On macOS, the menu is activated by any mouse button. Its activation callback is *not* triggered.
  2038. \ **Note:** On Windows, the menu is activated by the right mouse button, selecting the status icon and pressing :kbd:`Shift + F10`, or the applications key. The menu's activation callback for the other mouse buttons is still triggered.
  2039. \ **Note:** Native popup is only supported if :ref:`NativeMenu<class_NativeMenu>` supports the :ref:`NativeMenu.FEATURE_POPUP_MENU<class_NativeMenu_constant_FEATURE_POPUP_MENU>` feature.
  2040. .. rst-class:: classref-item-separator
  2041. ----
  2042. .. _class_DisplayServer_method_status_indicator_set_tooltip:
  2043. .. rst-class:: classref-method
  2044. |void| **status_indicator_set_tooltip**\ (\ id\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_status_indicator_set_tooltip>`
  2045. Sets the application status indicator tooltip.
  2046. \ **Note:** This method is implemented on macOS and Windows.
  2047. .. rst-class:: classref-item-separator
  2048. ----
  2049. .. _class_DisplayServer_method_tablet_get_current_driver:
  2050. .. rst-class:: classref-method
  2051. :ref:`String<class_String>` **tablet_get_current_driver**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tablet_get_current_driver>`
  2052. Returns current active tablet driver name.
  2053. \ **Note:** This method is implemented only on Windows.
  2054. .. rst-class:: classref-item-separator
  2055. ----
  2056. .. _class_DisplayServer_method_tablet_get_driver_count:
  2057. .. rst-class:: classref-method
  2058. :ref:`int<class_int>` **tablet_get_driver_count**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tablet_get_driver_count>`
  2059. Returns the total number of available tablet drivers.
  2060. \ **Note:** This method is implemented only on Windows.
  2061. .. rst-class:: classref-item-separator
  2062. ----
  2063. .. _class_DisplayServer_method_tablet_get_driver_name:
  2064. .. rst-class:: classref-method
  2065. :ref:`String<class_String>` **tablet_get_driver_name**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tablet_get_driver_name>`
  2066. Returns the tablet driver name for the given index.
  2067. \ **Note:** This method is implemented only on Windows.
  2068. .. rst-class:: classref-item-separator
  2069. ----
  2070. .. _class_DisplayServer_method_tablet_set_current_driver:
  2071. .. rst-class:: classref-method
  2072. |void| **tablet_set_current_driver**\ (\ name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tablet_set_current_driver>`
  2073. Set active tablet driver name.
  2074. Supported drivers:
  2075. - ``winink``: Windows Ink API, default (Windows 8.1+ required).
  2076. - ``wintab``: Wacom Wintab API (compatible device driver required).
  2077. - ``dummy``: Dummy driver, tablet input is disabled.
  2078. \ **Note:** This method is implemented only on Windows.
  2079. .. rst-class:: classref-item-separator
  2080. ----
  2081. .. _class_DisplayServer_method_tts_get_voices:
  2082. .. rst-class:: classref-method
  2083. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **tts_get_voices**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tts_get_voices>`
  2084. Returns an :ref:`Array<class_Array>` of voice information dictionaries.
  2085. Each :ref:`Dictionary<class_Dictionary>` contains two :ref:`String<class_String>` entries:
  2086. - ``name`` is voice name.
  2087. - ``id`` is voice identifier.
  2088. - ``language`` is language code in ``lang_Variant`` format. The ``lang`` part is a 2 or 3-letter code based on the ISO-639 standard, in lowercase. The ``Variant`` part is an engine-dependent string describing country, region or/and dialect.
  2089. 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.
  2090. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  2091. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
  2092. .. rst-class:: classref-item-separator
  2093. ----
  2094. .. _class_DisplayServer_method_tts_get_voices_for_language:
  2095. .. rst-class:: classref-method
  2096. :ref:`PackedStringArray<class_PackedStringArray>` **tts_get_voices_for_language**\ (\ language\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tts_get_voices_for_language>`
  2097. Returns an :ref:`PackedStringArray<class_PackedStringArray>` of voice identifiers for the ``language``.
  2098. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  2099. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
  2100. .. rst-class:: classref-item-separator
  2101. ----
  2102. .. _class_DisplayServer_method_tts_is_paused:
  2103. .. rst-class:: classref-method
  2104. :ref:`bool<class_bool>` **tts_is_paused**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tts_is_paused>`
  2105. Returns ``true`` if the synthesizer is in a paused state.
  2106. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  2107. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
  2108. .. rst-class:: classref-item-separator
  2109. ----
  2110. .. _class_DisplayServer_method_tts_is_speaking:
  2111. .. rst-class:: classref-method
  2112. :ref:`bool<class_bool>` **tts_is_speaking**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tts_is_speaking>`
  2113. Returns ``true`` if the synthesizer is generating speech, or have utterance waiting in the queue.
  2114. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  2115. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
  2116. .. rst-class:: classref-item-separator
  2117. ----
  2118. .. _class_DisplayServer_method_tts_pause:
  2119. .. rst-class:: classref-method
  2120. |void| **tts_pause**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tts_pause>`
  2121. Puts the synthesizer into a paused state.
  2122. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  2123. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
  2124. .. rst-class:: classref-item-separator
  2125. ----
  2126. .. _class_DisplayServer_method_tts_resume:
  2127. .. rst-class:: classref-method
  2128. |void| **tts_resume**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tts_resume>`
  2129. Resumes the synthesizer if it was paused.
  2130. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  2131. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
  2132. .. rst-class:: classref-item-separator
  2133. ----
  2134. .. _class_DisplayServer_method_tts_set_utterance_callback:
  2135. .. rst-class:: classref-method
  2136. |void| **tts_set_utterance_callback**\ (\ event\: :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>`, callable\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tts_set_utterance_callback>`
  2137. Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary.
  2138. - :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.
  2139. - :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.
  2140. \ **Note:** The granularity of the boundary callbacks is engine dependent.
  2141. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  2142. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
  2143. .. rst-class:: classref-item-separator
  2144. ----
  2145. .. _class_DisplayServer_method_tts_speak:
  2146. .. rst-class:: classref-method
  2147. |void| **tts_speak**\ (\ text\: :ref:`String<class_String>`, voice\: :ref:`String<class_String>`, volume\: :ref:`int<class_int>` = 50, pitch\: :ref:`float<class_float>` = 1.0, rate\: :ref:`float<class_float>` = 1.0, utterance_id\: :ref:`int<class_int>` = 0, interrupt\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tts_speak>`
  2148. Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is cleared first.
  2149. - ``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>`.
  2150. - ``volume`` ranges from ``0`` (lowest) to ``100`` (highest).
  2151. - ``pitch`` ranges from ``0.0`` (lowest) to ``2.0`` (highest), ``1.0`` is default pitch for the current voice.
  2152. - ``rate`` ranges from ``0.1`` (lowest) to ``10.0`` (highest), ``1.0`` is a normal speaking rate. Other values act as a percentage relative.
  2153. - ``utterance_id`` is passed as a parameter to the callback functions.
  2154. \ **Note:** On Windows and Linux (X11/Wayland), utterance ``text`` can use SSML markup. SSML support is engine and voice dependent. If the engine does not support SSML, you should strip out all XML markup before calling :ref:`tts_speak<class_DisplayServer_method_tts_speak>`.
  2155. \ **Note:** The granularity of pitch, rate, and volume is engine and voice dependent. Values may be truncated.
  2156. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
  2157. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
  2158. .. rst-class:: classref-item-separator
  2159. ----
  2160. .. _class_DisplayServer_method_tts_stop:
  2161. .. rst-class:: classref-method
  2162. |void| **tts_stop**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tts_stop>`
  2163. Stops synthesis in progress and removes all utterances from the queue.
  2164. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Linux), macOS, and Windows.
  2165. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
  2166. .. rst-class:: classref-item-separator
  2167. ----
  2168. .. _class_DisplayServer_method_unregister_additional_output:
  2169. .. rst-class:: classref-method
  2170. |void| **unregister_additional_output**\ (\ object\: :ref:`Object<class_Object>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_unregister_additional_output>`
  2171. Unregisters an :ref:`Object<class_Object>` representing an additional output, that was registered via :ref:`register_additional_output<class_DisplayServer_method_register_additional_output>`.
  2172. .. rst-class:: classref-item-separator
  2173. ----
  2174. .. _class_DisplayServer_method_virtual_keyboard_get_height:
  2175. .. rst-class:: classref-method
  2176. :ref:`int<class_int>` **virtual_keyboard_get_height**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_virtual_keyboard_get_height>`
  2177. Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.
  2178. .. rst-class:: classref-item-separator
  2179. ----
  2180. .. _class_DisplayServer_method_virtual_keyboard_hide:
  2181. .. rst-class:: classref-method
  2182. |void| **virtual_keyboard_hide**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_virtual_keyboard_hide>`
  2183. Hides the virtual keyboard if it is shown, does nothing otherwise.
  2184. .. rst-class:: classref-item-separator
  2185. ----
  2186. .. _class_DisplayServer_method_virtual_keyboard_show:
  2187. .. rst-class:: classref-method
  2188. |void| **virtual_keyboard_show**\ (\ existing_text\: :ref:`String<class_String>`, position\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0), type\: :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` = 0, max_length\: :ref:`int<class_int>` = -1, cursor_start\: :ref:`int<class_int>` = -1, cursor_end\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_virtual_keyboard_show>`
  2189. Shows the virtual keyboard if the platform has one.
  2190. \ ``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).
  2191. \ ``position`` parameter is the screen space :ref:`Rect2<class_Rect2>` of the edited text.
  2192. \ ``type`` parameter allows configuring which type of virtual keyboard to show.
  2193. \ ``max_length`` limits the number of characters that can be entered if different from ``-1``.
  2194. \ ``cursor_start`` can optionally define the current text cursor position if ``cursor_end`` is not set.
  2195. \ ``cursor_start`` and ``cursor_end`` can optionally define the current text selection.
  2196. \ **Note:** This method is implemented on Android, iOS and Web.
  2197. .. rst-class:: classref-item-separator
  2198. ----
  2199. .. _class_DisplayServer_method_warp_mouse:
  2200. .. rst-class:: classref-method
  2201. |void| **warp_mouse**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_warp_mouse>`
  2202. 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.
  2203. \ **Note:** :ref:`warp_mouse<class_DisplayServer_method_warp_mouse>` is only supported on Windows, macOS, and Linux (X11/Wayland). It has no effect on Android, iOS, and Web.
  2204. .. rst-class:: classref-item-separator
  2205. ----
  2206. .. _class_DisplayServer_method_window_can_draw:
  2207. .. rst-class:: classref-method
  2208. :ref:`bool<class_bool>` **window_can_draw**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_can_draw>`
  2209. 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``.
  2210. .. rst-class:: classref-item-separator
  2211. ----
  2212. .. _class_DisplayServer_method_window_get_active_popup:
  2213. .. rst-class:: classref-method
  2214. :ref:`int<class_int>` **window_get_active_popup**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_active_popup>`
  2215. Returns ID of the active popup window, or :ref:`INVALID_WINDOW_ID<class_DisplayServer_constant_INVALID_WINDOW_ID>` if there is none.
  2216. .. rst-class:: classref-item-separator
  2217. ----
  2218. .. _class_DisplayServer_method_window_get_attached_instance_id:
  2219. .. rst-class:: classref-method
  2220. :ref:`int<class_int>` **window_get_attached_instance_id**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_attached_instance_id>`
  2221. 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.
  2222. .. rst-class:: classref-item-separator
  2223. ----
  2224. .. _class_DisplayServer_method_window_get_current_screen:
  2225. .. rst-class:: classref-method
  2226. :ref:`int<class_int>` **window_get_current_screen**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_current_screen>`
  2227. 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>`.
  2228. .. rst-class:: classref-item-separator
  2229. ----
  2230. .. _class_DisplayServer_method_window_get_flag:
  2231. .. rst-class:: classref-method
  2232. :ref:`bool<class_bool>` **window_get_flag**\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_flag>`
  2233. Returns the current value of the given window's ``flag``.
  2234. .. rst-class:: classref-item-separator
  2235. ----
  2236. .. _class_DisplayServer_method_window_get_max_size:
  2237. .. rst-class:: classref-method
  2238. :ref:`Vector2i<class_Vector2i>` **window_get_max_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_max_size>`
  2239. Returns the window's maximum size (in pixels). See also :ref:`window_set_max_size<class_DisplayServer_method_window_set_max_size>`.
  2240. .. rst-class:: classref-item-separator
  2241. ----
  2242. .. _class_DisplayServer_method_window_get_min_size:
  2243. .. rst-class:: classref-method
  2244. :ref:`Vector2i<class_Vector2i>` **window_get_min_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_min_size>`
  2245. Returns the window's minimum size (in pixels). See also :ref:`window_set_min_size<class_DisplayServer_method_window_set_min_size>`.
  2246. .. rst-class:: classref-item-separator
  2247. ----
  2248. .. _class_DisplayServer_method_window_get_mode:
  2249. .. rst-class:: classref-method
  2250. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **window_get_mode**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_mode>`
  2251. Returns the mode of the given window.
  2252. .. rst-class:: classref-item-separator
  2253. ----
  2254. .. _class_DisplayServer_method_window_get_native_handle:
  2255. .. rst-class:: classref-method
  2256. :ref:`int<class_int>` **window_get_native_handle**\ (\ handle_type\: :ref:`HandleType<enum_DisplayServer_HandleType>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_native_handle>`
  2257. Returns internal structure pointers for use in plugins.
  2258. \ **Note:** This method is implemented on Android, Linux (X11/Wayland), macOS, and Windows.
  2259. .. rst-class:: classref-item-separator
  2260. ----
  2261. .. _class_DisplayServer_method_window_get_popup_safe_rect:
  2262. .. rst-class:: classref-method
  2263. :ref:`Rect2i<class_Rect2i>` **window_get_popup_safe_rect**\ (\ window\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_popup_safe_rect>`
  2264. Returns the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system.
  2265. .. rst-class:: classref-item-separator
  2266. ----
  2267. .. _class_DisplayServer_method_window_get_position:
  2268. .. rst-class:: classref-method
  2269. :ref:`Vector2i<class_Vector2i>` **window_get_position**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_position>`
  2270. Returns the position of the client area of the given window on the screen.
  2271. .. rst-class:: classref-item-separator
  2272. ----
  2273. .. _class_DisplayServer_method_window_get_position_with_decorations:
  2274. .. rst-class:: classref-method
  2275. :ref:`Vector2i<class_Vector2i>` **window_get_position_with_decorations**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_position_with_decorations>`
  2276. 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>`.
  2277. .. rst-class:: classref-item-separator
  2278. ----
  2279. .. _class_DisplayServer_method_window_get_safe_title_margins:
  2280. .. rst-class:: classref-method
  2281. :ref:`Vector3i<class_Vector3i>` **window_get_safe_title_margins**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_safe_title_margins>`
  2282. 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.
  2283. .. rst-class:: classref-item-separator
  2284. ----
  2285. .. _class_DisplayServer_method_window_get_size:
  2286. .. rst-class:: classref-method
  2287. :ref:`Vector2i<class_Vector2i>` **window_get_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_size>`
  2288. 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>`.
  2289. .. rst-class:: classref-item-separator
  2290. ----
  2291. .. _class_DisplayServer_method_window_get_size_with_decorations:
  2292. .. rst-class:: classref-method
  2293. :ref:`Vector2i<class_Vector2i>` **window_get_size_with_decorations**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_size_with_decorations>`
  2294. 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>`.
  2295. .. rst-class:: classref-item-separator
  2296. ----
  2297. .. _class_DisplayServer_method_window_get_title_size:
  2298. .. rst-class:: classref-method
  2299. :ref:`Vector2i<class_Vector2i>` **window_get_title_size**\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_title_size>`
  2300. Returns the estimated window title bar size (including text and window buttons) for the window specified by ``window_id`` (in pixels). This method does not change the window title.
  2301. \ **Note:** This method is implemented on macOS and Windows.
  2302. .. rst-class:: classref-item-separator
  2303. ----
  2304. .. _class_DisplayServer_method_window_get_vsync_mode:
  2305. .. rst-class:: classref-method
  2306. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **window_get_vsync_mode**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_vsync_mode>`
  2307. Returns the V-Sync mode of the given window.
  2308. .. rst-class:: classref-item-separator
  2309. ----
  2310. .. _class_DisplayServer_method_window_is_focused:
  2311. .. rst-class:: classref-method
  2312. :ref:`bool<class_bool>` **window_is_focused**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_is_focused>`
  2313. Returns ``true`` if the window specified by ``window_id`` is focused.
  2314. .. rst-class:: classref-item-separator
  2315. ----
  2316. .. _class_DisplayServer_method_window_is_maximize_allowed:
  2317. .. rst-class:: classref-method
  2318. :ref:`bool<class_bool>` **window_is_maximize_allowed**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_is_maximize_allowed>`
  2319. Returns ``true`` if the given window can be maximized (the maximize button is enabled).
  2320. .. rst-class:: classref-item-separator
  2321. ----
  2322. .. _class_DisplayServer_method_window_maximize_on_title_dbl_click:
  2323. .. rst-class:: classref-method
  2324. :ref:`bool<class_bool>` **window_maximize_on_title_dbl_click**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_maximize_on_title_dbl_click>`
  2325. Returns ``true``, if double-click on a window title should maximize it.
  2326. \ **Note:** This method is implemented only on macOS.
  2327. .. rst-class:: classref-item-separator
  2328. ----
  2329. .. _class_DisplayServer_method_window_minimize_on_title_dbl_click:
  2330. .. rst-class:: classref-method
  2331. :ref:`bool<class_bool>` **window_minimize_on_title_dbl_click**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_minimize_on_title_dbl_click>`
  2332. Returns ``true``, if double-click on a window title should minimize it.
  2333. \ **Note:** This method is implemented only on macOS.
  2334. .. rst-class:: classref-item-separator
  2335. ----
  2336. .. _class_DisplayServer_method_window_move_to_foreground:
  2337. .. rst-class:: classref-method
  2338. |void| **window_move_to_foreground**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_move_to_foreground>`
  2339. Moves the window specified by ``window_id`` to the foreground, so that it is visible over other windows.
  2340. .. rst-class:: classref-item-separator
  2341. ----
  2342. .. _class_DisplayServer_method_window_request_attention:
  2343. .. rst-class:: classref-method
  2344. |void| **window_request_attention**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_request_attention>`
  2345. 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.
  2346. .. rst-class:: classref-item-separator
  2347. ----
  2348. .. _class_DisplayServer_method_window_set_current_screen:
  2349. .. rst-class:: classref-method
  2350. |void| **window_set_current_screen**\ (\ screen\: :ref:`int<class_int>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_current_screen>`
  2351. 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>`.
  2352. .. rst-class:: classref-item-separator
  2353. ----
  2354. .. _class_DisplayServer_method_window_set_drop_files_callback:
  2355. .. rst-class:: classref-method
  2356. |void| **window_set_drop_files_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_drop_files_callback>`
  2357. Sets the ``callback`` that should be called when files are dropped from the operating system's file manager to the window specified by ``window_id``. ``callback`` should take one :ref:`PackedStringArray<class_PackedStringArray>` argument, which is the list of dropped files.
  2358. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
  2359. \ **Note:** This method is implemented on Windows, macOS, Linux (X11/Wayland), and Web.
  2360. .. rst-class:: classref-item-separator
  2361. ----
  2362. .. _class_DisplayServer_method_window_set_exclusive:
  2363. .. rst-class:: classref-method
  2364. |void| **window_set_exclusive**\ (\ window_id\: :ref:`int<class_int>`, exclusive\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_exclusive>`
  2365. 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.
  2366. \ **Note:** On macOS, exclusive windows are confined to the same space (virtual desktop or screen) as the parent window.
  2367. \ **Note:** This method is implemented on macOS and Windows.
  2368. .. rst-class:: classref-item-separator
  2369. ----
  2370. .. _class_DisplayServer_method_window_set_flag:
  2371. .. rst-class:: classref-method
  2372. |void| **window_set_flag**\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, enabled\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_flag>`
  2373. Enables or disables the given window's given ``flag``. See :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` for possible values and their behavior.
  2374. .. rst-class:: classref-item-separator
  2375. ----
  2376. .. _class_DisplayServer_method_window_set_ime_active:
  2377. .. rst-class:: classref-method
  2378. |void| **window_set_ime_active**\ (\ active\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_ime_active>`
  2379. 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>`.
  2380. .. rst-class:: classref-item-separator
  2381. ----
  2382. .. _class_DisplayServer_method_window_set_ime_position:
  2383. .. rst-class:: classref-method
  2384. |void| **window_set_ime_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_ime_position>`
  2385. 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``.
  2386. .. rst-class:: classref-item-separator
  2387. ----
  2388. .. _class_DisplayServer_method_window_set_input_event_callback:
  2389. .. rst-class:: classref-method
  2390. |void| **window_set_input_event_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_input_event_callback>`
  2391. Sets the ``callback`` that should be called when any :ref:`InputEvent<class_InputEvent>` is sent to the window specified by ``window_id``.
  2392. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
  2393. .. rst-class:: classref-item-separator
  2394. ----
  2395. .. _class_DisplayServer_method_window_set_input_text_callback:
  2396. .. rst-class:: classref-method
  2397. |void| **window_set_input_text_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_input_text_callback>`
  2398. Sets the ``callback`` that should be called when text is entered using the virtual keyboard to the window specified by ``window_id``.
  2399. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
  2400. .. rst-class:: classref-item-separator
  2401. ----
  2402. .. _class_DisplayServer_method_window_set_max_size:
  2403. .. rst-class:: classref-method
  2404. |void| **window_set_max_size**\ (\ max_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_max_size>`
  2405. Sets the maximum size of the window specified by ``window_id`` in pixels. Normally, the user will not be able to drag the window to make it larger than the specified size. See also :ref:`window_get_max_size<class_DisplayServer_method_window_get_max_size>`.
  2406. \ **Note:** It's recommended to change this value using :ref:`Window.max_size<class_Window_property_max_size>` instead.
  2407. \ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.
  2408. .. rst-class:: classref-item-separator
  2409. ----
  2410. .. _class_DisplayServer_method_window_set_min_size:
  2411. .. rst-class:: classref-method
  2412. |void| **window_set_min_size**\ (\ min_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_min_size>`
  2413. Sets the minimum size for the given window to ``min_size`` in pixels. Normally, the user will not be able to drag the window to make it smaller than the specified size. See also :ref:`window_get_min_size<class_DisplayServer_method_window_get_min_size>`.
  2414. \ **Note:** It's recommended to change this value using :ref:`Window.min_size<class_Window_property_min_size>` instead.
  2415. \ **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.
  2416. \ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.
  2417. .. rst-class:: classref-item-separator
  2418. ----
  2419. .. _class_DisplayServer_method_window_set_mode:
  2420. .. rst-class:: classref-method
  2421. |void| **window_set_mode**\ (\ mode\: :ref:`WindowMode<enum_DisplayServer_WindowMode>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_mode>`
  2422. Sets window mode for the given window to ``mode``. See :ref:`WindowMode<enum_DisplayServer_WindowMode>` for possible values and how each mode behaves.
  2423. \ **Note:** On Android, setting it to :ref:`WINDOW_MODE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN>` or :ref:`WINDOW_MODE_EXCLUSIVE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN>` will enable immersive mode.
  2424. \ **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.
  2425. .. rst-class:: classref-item-separator
  2426. ----
  2427. .. _class_DisplayServer_method_window_set_mouse_passthrough:
  2428. .. rst-class:: classref-method
  2429. |void| **window_set_mouse_passthrough**\ (\ region\: :ref:`PackedVector2Array<class_PackedVector2Array>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_mouse_passthrough>`
  2430. Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through.
  2431. Passing an empty array will disable passthrough support (all mouse events will be intercepted by the window, which is the default behavior).
  2432. .. tabs::
  2433. .. code-tab:: gdscript
  2434. # Set region, using Path2D node.
  2435. DisplayServer.window_set_mouse_passthrough($Path2D.curve.get_baked_points())
  2436. # Set region, using Polygon2D node.
  2437. DisplayServer.window_set_mouse_passthrough($Polygon2D.polygon)
  2438. # Reset region to default.
  2439. DisplayServer.window_set_mouse_passthrough([])
  2440. .. code-tab:: csharp
  2441. // Set region, using Path2D node.
  2442. DisplayServer.WindowSetMousePassthrough(GetNode<Path2D>("Path2D").Curve.GetBakedPoints());
  2443. // Set region, using Polygon2D node.
  2444. DisplayServer.WindowSetMousePassthrough(GetNode<Polygon2D>("Polygon2D").Polygon);
  2445. // Reset region to default.
  2446. DisplayServer.WindowSetMousePassthrough(new Vector2[] {});
  2447. \ **Note:** On Windows, the portion of a window that lies outside the region is not drawn, while on Linux (X11) and macOS it is.
  2448. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
  2449. .. rst-class:: classref-item-separator
  2450. ----
  2451. .. _class_DisplayServer_method_window_set_popup_safe_rect:
  2452. .. rst-class:: classref-method
  2453. |void| **window_set_popup_safe_rect**\ (\ window\: :ref:`int<class_int>`, rect\: :ref:`Rect2i<class_Rect2i>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_popup_safe_rect>`
  2454. 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.
  2455. .. rst-class:: classref-item-separator
  2456. ----
  2457. .. _class_DisplayServer_method_window_set_position:
  2458. .. rst-class:: classref-method
  2459. |void| **window_set_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_position>`
  2460. 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:
  2461. .. code:: text
  2462. * (0, 0) +-------+
  2463. | |
  2464. +-------------+ | |
  2465. | | | |
  2466. | | | |
  2467. +-------------+ +-------+
  2468. See also :ref:`window_get_position<class_DisplayServer_method_window_get_position>` and :ref:`window_set_size<class_DisplayServer_method_window_set_size>`.
  2469. \ **Note:** It's recommended to change this value using :ref:`Window.position<class_Window_property_position>` instead.
  2470. \ **Note:** On Linux (Wayland): this method is a no-op.
  2471. .. rst-class:: classref-item-separator
  2472. ----
  2473. .. _class_DisplayServer_method_window_set_rect_changed_callback:
  2474. .. rst-class:: classref-method
  2475. |void| **window_set_rect_changed_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_rect_changed_callback>`
  2476. Sets the ``callback`` that will be called when the window specified by ``window_id`` is moved or resized.
  2477. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
  2478. .. rst-class:: classref-item-separator
  2479. ----
  2480. .. _class_DisplayServer_method_window_set_size:
  2481. .. rst-class:: classref-method
  2482. |void| **window_set_size**\ (\ size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_size>`
  2483. 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>`.
  2484. \ **Note:** It's recommended to change this value using :ref:`Window.size<class_Window_property_size>` instead.
  2485. .. rst-class:: classref-item-separator
  2486. ----
  2487. .. _class_DisplayServer_method_window_set_title:
  2488. .. rst-class:: classref-method
  2489. |void| **window_set_title**\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_title>`
  2490. Sets the title of the given window to ``title``.
  2491. \ **Note:** It's recommended to change this value using :ref:`Window.title<class_Window_property_title>` instead.
  2492. \ **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.
  2493. .. rst-class:: classref-item-separator
  2494. ----
  2495. .. _class_DisplayServer_method_window_set_transient:
  2496. .. rst-class:: classref-method
  2497. |void| **window_set_transient**\ (\ window_id\: :ref:`int<class_int>`, parent_window_id\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_transient>`
  2498. Sets window transient parent. Transient window will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can't enter full-screen mode.
  2499. \ **Note:** It's recommended to change this value using :ref:`Window.transient<class_Window_property_transient>` instead.
  2500. \ **Note:** The behavior might be different depending on the platform.
  2501. .. rst-class:: classref-item-separator
  2502. ----
  2503. .. _class_DisplayServer_method_window_set_vsync_mode:
  2504. .. rst-class:: classref-method
  2505. |void| **window_set_vsync_mode**\ (\ vsync_mode\: :ref:`VSyncMode<enum_DisplayServer_VSyncMode>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_vsync_mode>`
  2506. 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>`.
  2507. See :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` for possible values and how they affect the behavior of your application.
  2508. 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.
  2509. \ **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.
  2510. .. rst-class:: classref-item-separator
  2511. ----
  2512. .. _class_DisplayServer_method_window_set_window_buttons_offset:
  2513. .. rst-class:: classref-method
  2514. |void| **window_set_window_buttons_offset**\ (\ offset\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_window_buttons_offset>`
  2515. 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.
  2516. \ **Note:** This flag is implemented only on macOS.
  2517. .. rst-class:: classref-item-separator
  2518. ----
  2519. .. _class_DisplayServer_method_window_set_window_event_callback:
  2520. .. rst-class:: classref-method
  2521. |void| **window_set_window_event_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_window_event_callback>`
  2522. Sets the ``callback`` that will be called when an event occurs in the window specified by ``window_id``.
  2523. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
  2524. .. rst-class:: classref-item-separator
  2525. ----
  2526. .. _class_DisplayServer_method_window_start_drag:
  2527. .. rst-class:: classref-method
  2528. |void| **window_start_drag**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_start_drag>`
  2529. Starts a drag operation on the window with the given ``window_id``, using the current mouse position. Call this method when handling a mouse button being pressed to simulate a pressed event on the window's title bar. Using this method allows the window to participate in space switching, tiling, and other system features.
  2530. \ **Note:** This method is implemented on Linux(X11/Wayland), macOS, and Windows.
  2531. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2532. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2533. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2534. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2535. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2536. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  2537. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  2538. .. |void| replace:: :abbr:`void (No return value.)`