Ana Sayfa Keşfet Yardım
Giriş Yap
Godot
/
godot-docs
şunun yansıması https://github.com/godotengine/godot-docs.git
2
0
Çatalla 0
Dosyalar Sorunlar 0 Wiki
Ağaç: b3214b14c2
Dallar Biçim İmleri
godot-docs
/
classes
/
class_displayserver.rst

class_displayserver.rst 306 KB
Geçmiş Ham

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854 
  1. :github_url: hide
    2. 

  2. 

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

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

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

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

  7. 

  8. .. _class_DisplayServer:
    9. 

  9. 

  10. DisplayServer
    11. 

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

  12. 

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

  14. 

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

  16. 

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

  18. 

  19. Description
    20. 

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

  21. 

  22. **DisplayServer** handles everything related to window management. It is separated from :ref:`OS<class_OS>` as a single operating system may support multiple display servers.
    23. 

  23. 

  24. \ **Headless mode:** Starting the engine with the ``--headless`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>` disables all rendering and window management functions. Most functions from **DisplayServer** will return dummy values in this case.
    25. 

  25. 

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

  27. 

  28. Methods
    29. 

  29. -------
    30. 

  30. 

  31. .. table::
    32. 

  32.    :widths: auto
    33. 

  33. 

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

  35.    | :ref:`String<class_String>`                                             | :ref:`clipboard_get<class_DisplayServer_method_clipboard_get>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                    |
    36. 

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

  37.    | :ref:`String<class_String>`                                             | :ref:`clipboard_get_primary<class_DisplayServer_method_clipboard_get_primary>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                    |
    38. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  57.    | :ref:`Error<enum_@GlobalScope_Error>`                                   | :ref:`file_dialog_show<class_DisplayServer_method_file_dialog_show>` **(** :ref:`String<class_String>` title, :ref:`String<class_String>` current_directory, :ref:`String<class_String>` filename, :ref:`bool<class_bool>` show_hidden, :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` mode, :ref:`PackedStringArray<class_PackedStringArray>` filters, :ref:`Callable<class_Callable>` callback **)**                                                                                      |
    58. 

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

  59.    | void                                                                    | :ref:`force_process_and_drop_events<class_DisplayServer_method_force_process_and_drop_events>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                            |
    60. 

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

  61.    | :ref:`Color<class_Color>`                                               | :ref:`get_accent_color<class_DisplayServer_method_get_accent_color>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                              |
    62. 

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

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

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

  65.    | :ref:`Rect2i<class_Rect2i>`                                             | :ref:`get_display_safe_area<class_DisplayServer_method_get_display_safe_area>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                    |
    66. 

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

  67.    | :ref:`int<class_int>`                                                   | :ref:`get_keyboard_focus_screen<class_DisplayServer_method_get_keyboard_focus_screen>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                            |
    68. 

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

  69.    | :ref:`String<class_String>`                                             | :ref:`get_name<class_DisplayServer_method_get_name>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                              |
    70. 

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

  71.    | :ref:`int<class_int>`                                                   | :ref:`get_primary_screen<class_DisplayServer_method_get_primary_screen>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                          |
    72. 

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

  73.    | :ref:`int<class_int>`                                                   | :ref:`get_screen_count<class_DisplayServer_method_get_screen_count>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                              |
    74. 

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

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

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

  77.    | :ref:`bool<class_bool>`                                                 | :ref:`get_swap_cancel_ok<class_DisplayServer_method_get_swap_cancel_ok>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                                  |
    78. 

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

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

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

  81.    | :ref:`PackedInt32Array<class_PackedInt32Array>`                         | :ref:`get_window_list<class_DisplayServer_method_get_window_list>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                |
    82. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  173.    | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`ime_get_selection<class_DisplayServer_method_ime_get_selection>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                            |
    174. 

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

  175.    | :ref:`String<class_String>`                                             | :ref:`ime_get_text<class_DisplayServer_method_ime_get_text>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                      |
    176. 

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

  177.    | :ref:`bool<class_bool>`                                                 | :ref:`is_dark_mode<class_DisplayServer_method_is_dark_mode>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                      |
    178. 

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

  179.    | :ref:`bool<class_bool>`                                                 | :ref:`is_dark_mode_supported<class_DisplayServer_method_is_dark_mode_supported>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                  |
    180. 

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

  181.    | :ref:`bool<class_bool>`                                                 | :ref:`is_touchscreen_available<class_DisplayServer_method_is_touchscreen_available>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                              |
    182. 

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

  183.    | :ref:`int<class_int>`                                                   | :ref:`keyboard_get_current_layout<class_DisplayServer_method_keyboard_get_current_layout>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                        |
    184. 

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

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

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

  187.    | :ref:`Key<enum_@GlobalScope_Key>`                                       | :ref:`keyboard_get_label_from_physical<class_DisplayServer_method_keyboard_get_label_from_physical>` **(** :ref:`Key<enum_@GlobalScope_Key>` keycode **)** |const|                                                                                                                                                                                                                                                                                                                                    |
    188. 

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

  189.    | :ref:`int<class_int>`                                                   | :ref:`keyboard_get_layout_count<class_DisplayServer_method_keyboard_get_layout_count>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                            |
    190. 

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

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

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

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

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

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

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

  197.    | |bitfield|\<:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>`\> | :ref:`mouse_get_button_state<class_DisplayServer_method_mouse_get_button_state>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                  |
    198. 

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

  199.    | :ref:`MouseMode<enum_DisplayServer_MouseMode>`                          | :ref:`mouse_get_mode<class_DisplayServer_method_mouse_get_mode>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                  |
    200. 

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

  201.    | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`mouse_get_position<class_DisplayServer_method_mouse_get_position>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                          |
    202. 

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

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

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

  205.    | void                                                                    | :ref:`process_events<class_DisplayServer_method_process_events>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                                          |
    206. 

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

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

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

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

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

  211.    | :ref:`float<class_float>`                                               | :ref:`screen_get_max_scale<class_DisplayServer_method_screen_get_max_scale>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                      |
    212. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  227.    | :ref:`bool<class_bool>`                                                 | :ref:`screen_is_kept_on<class_DisplayServer_method_screen_is_kept_on>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                            |
    228. 

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

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

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

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

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

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

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

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

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

  237.    | :ref:`String<class_String>`                                             | :ref:`tablet_get_current_driver<class_DisplayServer_method_tablet_get_current_driver>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                            |
    238. 

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

  239.    | :ref:`int<class_int>`                                                   | :ref:`tablet_get_driver_count<class_DisplayServer_method_tablet_get_driver_count>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                |
    240. 

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

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

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

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

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

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

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

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

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

  249.    | :ref:`bool<class_bool>`                                                 | :ref:`tts_is_paused<class_DisplayServer_method_tts_is_paused>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                    |
    250. 

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

  251.    | :ref:`bool<class_bool>`                                                 | :ref:`tts_is_speaking<class_DisplayServer_method_tts_is_speaking>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                |
    252. 

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

  253.    | void                                                                    | :ref:`tts_pause<class_DisplayServer_method_tts_pause>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    254. 

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

  255.    | void                                                                    | :ref:`tts_resume<class_DisplayServer_method_tts_resume>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    256. 

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

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

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

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

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

  261.    | void                                                                    | :ref:`tts_stop<class_DisplayServer_method_tts_stop>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    262. 

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

  263.    | :ref:`int<class_int>`                                                   | :ref:`virtual_keyboard_get_height<class_DisplayServer_method_virtual_keyboard_get_height>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                        |
    264. 

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

  265.    | void                                                                    | :ref:`virtual_keyboard_hide<class_DisplayServer_method_virtual_keyboard_hide>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                            |
    266. 

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

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

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

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

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

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

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

  273.    | :ref:`int<class_int>`                                                   | :ref:`window_get_active_popup<class_DisplayServer_method_window_get_active_popup>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                |
    274. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  303.    | :ref:`bool<class_bool>`                                                 | :ref:`window_is_focused<class_DisplayServer_method_window_is_focused>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                                          |
    304. 

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

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

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

  307.    | :ref:`bool<class_bool>`                                                 | :ref:`window_maximize_on_title_dbl_click<class_DisplayServer_method_window_maximize_on_title_dbl_click>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                          |
    308. 

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

  309.    | :ref:`bool<class_bool>`                                                 | :ref:`window_minimize_on_title_dbl_click<class_DisplayServer_method_window_minimize_on_title_dbl_click>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                          |
    310. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  357. 

  358. .. rst-class:: classref-section-separator
    359. 

  359. 

  360. ----
    361. 

  361. 

  362. .. rst-class:: classref-descriptions-group
    363. 

  363. 

  364. Enumerations
    365. 

  365. ------------
    366. 

  366. 

  367. .. _enum_DisplayServer_Feature:
    368. 

  368. 

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

  370. 

  371. enum **Feature**:
    372. 

  372. 

  373. .. _class_DisplayServer_constant_FEATURE_GLOBAL_MENU:
    374. 

  374. 

  375. .. rst-class:: classref-enumeration-constant
    376. 

  376. 

  377. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_GLOBAL_MENU** = ``0``
    378. 

  378. 

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

  380. 

  381. .. _class_DisplayServer_constant_FEATURE_SUBWINDOWS:
    382. 

  382. 

  383. .. rst-class:: classref-enumeration-constant
    384. 

  384. 

  385. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SUBWINDOWS** = ``1``
    386. 

  386. 

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

  388. 

  389. .. _class_DisplayServer_constant_FEATURE_TOUCHSCREEN:
    390. 

  390. 

  391. .. rst-class:: classref-enumeration-constant
    392. 

  392. 

  393. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TOUCHSCREEN** = ``2``
    394. 

  394. 

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

  396. 

  397. .. _class_DisplayServer_constant_FEATURE_MOUSE:
    398. 

  398. 

  399. .. rst-class:: classref-enumeration-constant
    400. 

  400. 

  401. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE** = ``3``
    402. 

  402. 

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

  404. 

  405. .. _class_DisplayServer_constant_FEATURE_MOUSE_WARP:
    406. 

  406. 

  407. .. rst-class:: classref-enumeration-constant
    408. 

  408. 

  409. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE_WARP** = ``4``
    410. 

  410. 

  411. 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)**
    412. 

  412. 

  413. .. _class_DisplayServer_constant_FEATURE_CLIPBOARD:
    414. 

  414. 

  415. .. rst-class:: classref-enumeration-constant
    416. 

  416. 

  417. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD** = ``5``
    418. 

  418. 

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

  420. 

  421. .. _class_DisplayServer_constant_FEATURE_VIRTUAL_KEYBOARD:
    422. 

  422. 

  423. .. rst-class:: classref-enumeration-constant
    424. 

  424. 

  425. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_VIRTUAL_KEYBOARD** = ``6``
    426. 

  426. 

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

  428. 

  429. .. _class_DisplayServer_constant_FEATURE_CURSOR_SHAPE:
    430. 

  430. 

  431. .. rst-class:: classref-enumeration-constant
    432. 

  432. 

  433. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CURSOR_SHAPE** = ``7``
    434. 

  434. 

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

  436. 

  437. .. _class_DisplayServer_constant_FEATURE_CUSTOM_CURSOR_SHAPE:
    438. 

  438. 

  439. .. rst-class:: classref-enumeration-constant
    440. 

  440. 

  441. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CUSTOM_CURSOR_SHAPE** = ``8``
    442. 

  442. 

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

  444. 

  445. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG:
    446. 

  446. 

  447. .. rst-class:: classref-enumeration-constant
    448. 

  448. 

  449. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG** = ``9``
    450. 

  450. 

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

  452. 

  453. .. _class_DisplayServer_constant_FEATURE_IME:
    454. 

  454. 

  455. .. rst-class:: classref-enumeration-constant
    456. 

  456. 

  457. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_IME** = ``10``
    458. 

  458. 

  459. 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)**
    460. 

  460. 

  461. .. _class_DisplayServer_constant_FEATURE_WINDOW_TRANSPARENCY:
    462. 

  462. 

  463. .. rst-class:: classref-enumeration-constant
    464. 

  464. 

  465. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_TRANSPARENCY** = ``11``
    466. 

  466. 

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

  468. 

  469. .. _class_DisplayServer_constant_FEATURE_HIDPI:
    470. 

  470. 

  471. .. rst-class:: classref-enumeration-constant
    472. 

  472. 

  473. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_HIDPI** = ``12``
    474. 

  474. 

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

  476. 

  477. .. _class_DisplayServer_constant_FEATURE_ICON:
    478. 

  478. 

  479. .. rst-class:: classref-enumeration-constant
    480. 

  480. 

  481. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ICON** = ``13``
    482. 

  482. 

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

  484. 

  485. .. _class_DisplayServer_constant_FEATURE_NATIVE_ICON:
    486. 

  486. 

  487. .. rst-class:: classref-enumeration-constant
    488. 

  488. 

  489. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_ICON** = ``14``
    490. 

  490. 

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

  492. 

  493. .. _class_DisplayServer_constant_FEATURE_ORIENTATION:
    494. 

  494. 

  495. .. rst-class:: classref-enumeration-constant
    496. 

  496. 

  497. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ORIENTATION** = ``15``
    498. 

  498. 

  499. Display server supports changing the screen orientation. **Android, iOS**
    500. 

  500. 

  501. .. _class_DisplayServer_constant_FEATURE_SWAP_BUFFERS:
    502. 

  502. 

  503. .. rst-class:: classref-enumeration-constant
    504. 

  504. 

  505. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SWAP_BUFFERS** = ``16``
    506. 

  506. 

  507. 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)**
    508. 

  508. 

  509. .. _class_DisplayServer_constant_FEATURE_CLIPBOARD_PRIMARY:
    510. 

  510. 

  511. .. rst-class:: classref-enumeration-constant
    512. 

  512. 

  513. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD_PRIMARY** = ``18``
    514. 

  514. 

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

  516. 

  517. .. _class_DisplayServer_constant_FEATURE_TEXT_TO_SPEECH:
    518. 

  518. 

  519. .. rst-class:: classref-enumeration-constant
    520. 

  520. 

  521. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TEXT_TO_SPEECH** = ``19``
    522. 

  522. 

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

  524. 

  525. .. _class_DisplayServer_constant_FEATURE_EXTEND_TO_TITLE:
    526. 

  526. 

  527. .. rst-class:: classref-enumeration-constant
    528. 

  528. 

  529. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_EXTEND_TO_TITLE** = ``20``
    530. 

  530. 

  531. 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**
    532. 

  532. 

  533. .. _class_DisplayServer_constant_FEATURE_SCREEN_CAPTURE:
    534. 

  534. 

  535. .. rst-class:: classref-enumeration-constant
    536. 

  536. 

  537. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SCREEN_CAPTURE** = ``21``
    538. 

  538. 

  539. Display server supports reading screen pixels. See :ref:`screen_get_pixel<class_DisplayServer_method_screen_get_pixel>`.
    540. 

  540. 

  541. .. rst-class:: classref-item-separator
    542. 

  542. 

  543. ----
    544. 

  544. 

  545. .. _enum_DisplayServer_MouseMode:
    546. 

  546. 

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

  548. 

  549. enum **MouseMode**:
    550. 

  550. 

  551. .. _class_DisplayServer_constant_MOUSE_MODE_VISIBLE:
    552. 

  552. 

  553. .. rst-class:: classref-enumeration-constant
    554. 

  554. 

  555. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_VISIBLE** = ``0``
    556. 

  556. 

  557. Makes the mouse cursor visible if it is hidden.
    558. 

  558. 

  559. .. _class_DisplayServer_constant_MOUSE_MODE_HIDDEN:
    560. 

  560. 

  561. .. rst-class:: classref-enumeration-constant
    562. 

  562. 

  563. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_HIDDEN** = ``1``
    564. 

  564. 

  565. Makes the mouse cursor hidden if it is visible.
    566. 

  566. 

  567. .. _class_DisplayServer_constant_MOUSE_MODE_CAPTURED:
    568. 

  568. 

  569. .. rst-class:: classref-enumeration-constant
    570. 

  570. 

  571. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CAPTURED** = ``2``
    572. 

  572. 

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

  574. 

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

  576. 

  577. .. _class_DisplayServer_constant_MOUSE_MODE_CONFINED:
    578. 

  578. 

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

  580. 

  581. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED** = ``3``
    582. 

  582. 

  583. Confines the mouse cursor to the game window, and make it visible.
    584. 

  584. 

  585. .. _class_DisplayServer_constant_MOUSE_MODE_CONFINED_HIDDEN:
    586. 

  586. 

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

  588. 

  589. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED_HIDDEN** = ``4``
    590. 

  590. 

  591. Confines the mouse cursor to the game window, and make it hidden.
    592. 

  592. 

  593. .. rst-class:: classref-item-separator
    594. 

  594. 

  595. ----
    596. 

  596. 

  597. .. _enum_DisplayServer_ScreenOrientation:
    598. 

  598. 

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

  600. 

  601. enum **ScreenOrientation**:
    602. 

  602. 

  603. .. _class_DisplayServer_constant_SCREEN_LANDSCAPE:
    604. 

  604. 

  605. .. rst-class:: classref-enumeration-constant
    606. 

  606. 

  607. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_LANDSCAPE** = ``0``
    608. 

  608. 

  609. Default landscape orientation.
    610. 

  610. 

  611. .. _class_DisplayServer_constant_SCREEN_PORTRAIT:
    612. 

  612. 

  613. .. rst-class:: classref-enumeration-constant
    614. 

  614. 

  615. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_PORTRAIT** = ``1``
    616. 

  616. 

  617. Default portrait orientation.
    618. 

  618. 

  619. .. _class_DisplayServer_constant_SCREEN_REVERSE_LANDSCAPE:
    620. 

  620. 

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

  622. 

  623. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_LANDSCAPE** = ``2``
    624. 

  624. 

  625. Reverse landscape orientation (upside down).
    626. 

  626. 

  627. .. _class_DisplayServer_constant_SCREEN_REVERSE_PORTRAIT:
    628. 

  628. 

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

  630. 

  631. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_PORTRAIT** = ``3``
    632. 

  632. 

  633. Reverse portrait orientation (upside down).
    634. 

  634. 

  635. .. _class_DisplayServer_constant_SCREEN_SENSOR_LANDSCAPE:
    636. 

  636. 

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

  638. 

  639. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_LANDSCAPE** = ``4``
    640. 

  640. 

  641. Automatic landscape orientation (default or reverse depending on sensor).
    642. 

  642. 

  643. .. _class_DisplayServer_constant_SCREEN_SENSOR_PORTRAIT:
    644. 

  644. 

  645. .. rst-class:: classref-enumeration-constant
    646. 

  646. 

  647. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_PORTRAIT** = ``5``
    648. 

  648. 

  649. Automatic portrait orientation (default or reverse depending on sensor).
    650. 

  650. 

  651. .. _class_DisplayServer_constant_SCREEN_SENSOR:
    652. 

  652. 

  653. .. rst-class:: classref-enumeration-constant
    654. 

  654. 

  655. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR** = ``6``
    656. 

  656. 

  657. Automatic landscape or portrait orientation (default or reverse depending on sensor).
    658. 

  658. 

  659. .. rst-class:: classref-item-separator
    660. 

  660. 

  661. ----
    662. 

  662. 

  663. .. _enum_DisplayServer_VirtualKeyboardType:
    664. 

  664. 

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

  666. 

  667. enum **VirtualKeyboardType**:
    668. 

  668. 

  669. .. _class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT:
    670. 

  670. 

  671. .. rst-class:: classref-enumeration-constant
    672. 

  672. 

  673. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_DEFAULT** = ``0``
    674. 

  674. 

  675. Default text virtual keyboard.
    676. 

  676. 

  677. .. _class_DisplayServer_constant_KEYBOARD_TYPE_MULTILINE:
    678. 

  678. 

  679. .. rst-class:: classref-enumeration-constant
    680. 

  680. 

  681. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_MULTILINE** = ``1``
    682. 

  682. 

  683. Multiline virtual keyboard.
    684. 

  684. 

  685. .. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER:
    686. 

  686. 

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

  688. 

  689. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER** = ``2``
    690. 

  690. 

  691. Virtual number keypad, useful for PIN entry.
    692. 

  692. 

  693. .. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER_DECIMAL:
    694. 

  694. 

  695. .. rst-class:: classref-enumeration-constant
    696. 

  696. 

  697. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER_DECIMAL** = ``3``
    698. 

  698. 

  699. Virtual number keypad, useful for entering fractional numbers.
    700. 

  700. 

  701. .. _class_DisplayServer_constant_KEYBOARD_TYPE_PHONE:
    702. 

  702. 

  703. .. rst-class:: classref-enumeration-constant
    704. 

  704. 

  705. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PHONE** = ``4``
    706. 

  706. 

  707. Virtual phone number keypad.
    708. 

  708. 

  709. .. _class_DisplayServer_constant_KEYBOARD_TYPE_EMAIL_ADDRESS:
    710. 

  710. 

  711. .. rst-class:: classref-enumeration-constant
    712. 

  712. 

  713. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_EMAIL_ADDRESS** = ``5``
    714. 

  714. 

  715. Virtual keyboard with additional keys to assist with typing email addresses.
    716. 

  716. 

  717. .. _class_DisplayServer_constant_KEYBOARD_TYPE_PASSWORD:
    718. 

  718. 

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

  720. 

  721. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PASSWORD** = ``6``
    722. 

  722. 

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

  724. 

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

  726. 

  727. .. _class_DisplayServer_constant_KEYBOARD_TYPE_URL:
    728. 

  728. 

  729. .. rst-class:: classref-enumeration-constant
    730. 

  730. 

  731. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_URL** = ``7``
    732. 

  732. 

  733. Virtual keyboard with additional keys to assist with typing URLs.
    734. 

  734. 

  735. .. rst-class:: classref-item-separator
    736. 

  736. 

  737. ----
    738. 

  738. 

  739. .. _enum_DisplayServer_CursorShape:
    740. 

  740. 

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

  742. 

  743. enum **CursorShape**:
    744. 

  744. 

  745. .. _class_DisplayServer_constant_CURSOR_ARROW:
    746. 

  746. 

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

  748. 

  749. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_ARROW** = ``0``
    750. 

  750. 

  751. 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>`.
    752. 

  752. 

  753. .. _class_DisplayServer_constant_CURSOR_IBEAM:
    754. 

  754. 

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

  756. 

  757. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_IBEAM** = ``1``
    758. 

  758. 

  759. 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>`.
    760. 

  760. 

  761. .. _class_DisplayServer_constant_CURSOR_POINTING_HAND:
    762. 

  762. 

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

  764. 

  765. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_POINTING_HAND** = ``2``
    766. 

  766. 

  767. 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>`.
    768. 

  768. 

  769. .. _class_DisplayServer_constant_CURSOR_CROSS:
    770. 

  770. 

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

  772. 

  773. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CROSS** = ``3``
    774. 

  774. 

  775. 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.
    776. 

  776. 

  777. .. _class_DisplayServer_constant_CURSOR_WAIT:
    778. 

  778. 

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

  780. 

  781. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_WAIT** = ``4``
    782. 

  782. 

  783. 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>`.
    784. 

  784. 

  785. .. _class_DisplayServer_constant_CURSOR_BUSY:
    786. 

  786. 

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

  788. 

  789. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BUSY** = ``5``
    790. 

  790. 

  791. 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>`.
    792. 

  792. 

  793. .. _class_DisplayServer_constant_CURSOR_DRAG:
    794. 

  794. 

  795. .. rst-class:: classref-enumeration-constant
    796. 

  796. 

  797. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_DRAG** = ``6``
    798. 

  798. 

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

  800. 

  801. .. _class_DisplayServer_constant_CURSOR_CAN_DROP:
    802. 

  802. 

  803. .. rst-class:: classref-enumeration-constant
    804. 

  804. 

  805. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CAN_DROP** = ``7``
    806. 

  806. 

  807. "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>`.
    808. 

  808. 

  809. .. _class_DisplayServer_constant_CURSOR_FORBIDDEN:
    810. 

  810. 

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

  812. 

  813. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FORBIDDEN** = ``8``
    814. 

  814. 

  815. 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.
    816. 

  816. 

  817. .. _class_DisplayServer_constant_CURSOR_VSIZE:
    818. 

  818. 

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

  820. 

  821. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSIZE** = ``9``
    822. 

  822. 

  823. 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>`.
    824. 

  824. 

  825. .. _class_DisplayServer_constant_CURSOR_HSIZE:
    826. 

  826. 

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

  828. 

  829. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSIZE** = ``10``
    830. 

  830. 

  831. 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>`.
    832. 

  832. 

  833. .. _class_DisplayServer_constant_CURSOR_BDIAGSIZE:
    834. 

  834. 

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

  836. 

  837. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BDIAGSIZE** = ``11``
    838. 

  838. 

  839. 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.
    840. 

  840. 

  841. .. _class_DisplayServer_constant_CURSOR_FDIAGSIZE:
    842. 

  842. 

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

  844. 

  845. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FDIAGSIZE** = ``12``
    846. 

  846. 

  847. 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.
    848. 

  848. 

  849. .. _class_DisplayServer_constant_CURSOR_MOVE:
    850. 

  850. 

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

  852. 

  853. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MOVE** = ``13``
    854. 

  854. 

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

  856. 

  857. .. _class_DisplayServer_constant_CURSOR_VSPLIT:
    858. 

  858. 

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

  860. 

  861. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSPLIT** = ``14``
    862. 

  862. 

  863. 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>`.
    864. 

  864. 

  865. .. _class_DisplayServer_constant_CURSOR_HSPLIT:
    866. 

  866. 

  867. .. rst-class:: classref-enumeration-constant
    868. 

  868. 

  869. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSPLIT** = ``15``
    870. 

  870. 

  871. 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>`.
    872. 

  872. 

  873. .. _class_DisplayServer_constant_CURSOR_HELP:
    874. 

  874. 

  875. .. rst-class:: classref-enumeration-constant
    876. 

  876. 

  877. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HELP** = ``16``
    878. 

  878. 

  879. 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.
    880. 

  880. 

  881. .. _class_DisplayServer_constant_CURSOR_MAX:
    882. 

  882. 

  883. .. rst-class:: classref-enumeration-constant
    884. 

  884. 

  885. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MAX** = ``17``
    886. 

  886. 

  887. Represents the size of the :ref:`CursorShape<enum_DisplayServer_CursorShape>` enum.
    888. 

  888. 

  889. .. rst-class:: classref-item-separator
    890. 

  890. 

  891. ----
    892. 

  892. 

  893. .. _enum_DisplayServer_FileDialogMode:
    894. 

  894. 

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

  896. 

  897. enum **FileDialogMode**:
    898. 

  898. 

  899. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILE:
    900. 

  900. 

  901. .. rst-class:: classref-enumeration-constant
    902. 

  902. 

  903. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILE** = ``0``
    904. 

  904. 

  905. The native file dialog allows selecting one, and only one file.
    906. 

  906. 

  907. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILES:
    908. 

  908. 

  909. .. rst-class:: classref-enumeration-constant
    910. 

  910. 

  911. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILES** = ``1``
    912. 

  912. 

  913. The native file dialog allows selecting multiple files.
    914. 

  914. 

  915. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_DIR:
    916. 

  916. 

  917. .. rst-class:: classref-enumeration-constant
    918. 

  918. 

  919. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_DIR** = ``2``
    920. 

  920. 

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

  922. 

  923. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_ANY:
    924. 

  924. 

  925. .. rst-class:: classref-enumeration-constant
    926. 

  926. 

  927. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_ANY** = ``3``
    928. 

  928. 

  929. The native file dialog allows selecting one file or directory.
    930. 

  930. 

  931. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_SAVE_FILE:
    932. 

  932. 

  933. .. rst-class:: classref-enumeration-constant
    934. 

  934. 

  935. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_SAVE_FILE** = ``4``
    936. 

  936. 

  937. The native file dialog will warn when a file exists.
    938. 

  938. 

  939. .. rst-class:: classref-item-separator
    940. 

  940. 

  941. ----
    942. 

  942. 

  943. .. _enum_DisplayServer_WindowMode:
    944. 

  944. 

  945. .. rst-class:: classref-enumeration
    946. 

  946. 

  947. enum **WindowMode**:
    948. 

  948. 

  949. .. _class_DisplayServer_constant_WINDOW_MODE_WINDOWED:
    950. 

  950. 

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

  952. 

  953. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_WINDOWED** = ``0``
    954. 

  954. 

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

  956. 

  957. .. _class_DisplayServer_constant_WINDOW_MODE_MINIMIZED:
    958. 

  958. 

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

  960. 

  961. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MINIMIZED** = ``1``
    962. 

  962. 

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

  964. 

  965. .. _class_DisplayServer_constant_WINDOW_MODE_MAXIMIZED:
    966. 

  966. 

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

  968. 

  969. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MAXIMIZED** = ``2``
    970. 

  970. 

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

  972. 

  973. .. _class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN:
    974. 

  974. 

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

  976. 

  977. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_FULLSCREEN** = ``3``
    978. 

  978. 

  979. Full screen mode with full multi-window support.
    980. 

  980. 

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

  982. 

  983. \ **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.
    984. 

  984. 

  985. .. _class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN:
    986. 

  986. 

  987. .. rst-class:: classref-enumeration-constant
    988. 

  988. 

  989. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_EXCLUSIVE_FULLSCREEN** = ``4``
    990. 

  990. 

  991. 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).
    992. 

  992. 

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

  994. 

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

  996. 

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

  998. 

  999. \ **On Linux (X11):** Exclusive full screen mode bypasses compositor.
    1000. 

  1000. 

  1001. \ **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.
    1002. 

  1002. 

  1003. .. rst-class:: classref-item-separator
    1004. 

  1004. 

  1005. ----
    1006. 

  1006. 

  1007. .. _enum_DisplayServer_WindowFlags:
    1008. 

  1008. 

  1009. .. rst-class:: classref-enumeration
    1010. 

  1010. 

  1011. enum **WindowFlags**:
    1012. 

  1012. 

  1013. .. _class_DisplayServer_constant_WINDOW_FLAG_RESIZE_DISABLED:
    1014. 

  1014. 

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

  1016. 

  1017. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_RESIZE_DISABLED** = ``0``
    1018. 

  1018. 

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

  1020. 

  1021. .. _class_DisplayServer_constant_WINDOW_FLAG_BORDERLESS:
    1022. 

  1022. 

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

  1024. 

  1025. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_BORDERLESS** = ``1``
    1026. 

  1026. 

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

  1028. 

  1029. .. _class_DisplayServer_constant_WINDOW_FLAG_ALWAYS_ON_TOP:
    1030. 

  1030. 

  1031. .. rst-class:: classref-enumeration-constant
    1032. 

  1032. 

  1033. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_ALWAYS_ON_TOP** = ``2``
    1034. 

  1034. 

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

  1036. 

  1037. .. _class_DisplayServer_constant_WINDOW_FLAG_TRANSPARENT:
    1038. 

  1038. 

  1039. .. rst-class:: classref-enumeration-constant
    1040. 

  1040. 

  1041. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_TRANSPARENT** = ``3``
    1042. 

  1042. 

  1043. The window background can be transparent.
    1044. 

  1044. 

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

  1046. 

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

  1048. 

  1049. .. _class_DisplayServer_constant_WINDOW_FLAG_NO_FOCUS:
    1050. 

  1050. 

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

  1052. 

  1053. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_NO_FOCUS** = ``4``
    1054. 

  1054. 

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

  1056. 

  1057. .. _class_DisplayServer_constant_WINDOW_FLAG_POPUP:
    1058. 

  1058. 

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

  1060. 

  1061. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_POPUP** = ``5``
    1062. 

  1062. 

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

  1064. 

  1065. .. _class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE:
    1066. 

  1066. 

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

  1068. 

  1069. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_EXTEND_TO_TITLE** = ``6``
    1070. 

  1070. 

  1071. 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.
    1072. 

  1072. 

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

  1074. 

  1075. 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.
    1076. 

  1076. 

  1077. \ **Note:** This flag is implemented only on macOS.
    1078. 

  1078. 

  1079. .. _class_DisplayServer_constant_WINDOW_FLAG_MOUSE_PASSTHROUGH:
    1080. 

  1080. 

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

  1082. 

  1083. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MOUSE_PASSTHROUGH** = ``7``
    1084. 

  1084. 

  1085. All mouse events are passed to the underlying window of the same application.
    1086. 

  1086. 

  1087. .. _class_DisplayServer_constant_WINDOW_FLAG_MAX:
    1088. 

  1088. 

  1089. .. rst-class:: classref-enumeration-constant
    1090. 

  1090. 

  1091. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MAX** = ``8``
    1092. 

  1092. 

  1093. Max value of the :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`.
    1094. 

  1094. 

  1095. .. rst-class:: classref-item-separator
    1096. 

  1096. 

  1097. ----
    1098. 

  1098. 

  1099. .. _enum_DisplayServer_WindowEvent:
    1100. 

  1100. 

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

  1102. 

  1103. enum **WindowEvent**:
    1104. 

  1104. 

  1105. .. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_ENTER:
    1106. 

  1106. 

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

  1108. 

  1109. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_ENTER** = ``0``
    1110. 

  1110. 

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

  1112. 

  1113. .. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_EXIT:
    1114. 

  1114. 

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

  1116. 

  1117. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_EXIT** = ``1``
    1118. 

  1118. 

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

  1120. 

  1121. .. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_IN:
    1122. 

  1122. 

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

  1124. 

  1125. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_IN** = ``2``
    1126. 

  1126. 

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

  1128. 

  1129. .. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_OUT:
    1130. 

  1130. 

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

  1132. 

  1133. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_OUT** = ``3``
    1134. 

  1134. 

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

  1136. 

  1137. .. _class_DisplayServer_constant_WINDOW_EVENT_CLOSE_REQUEST:
    1138. 

  1138. 

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

  1140. 

  1141. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_CLOSE_REQUEST** = ``4``
    1142. 

  1142. 

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

  1144. 

  1145. .. _class_DisplayServer_constant_WINDOW_EVENT_GO_BACK_REQUEST:
    1146. 

  1146. 

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

  1148. 

  1149. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_GO_BACK_REQUEST** = ``5``
    1150. 

  1150. 

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

  1152. 

  1153. \ **Note:** This event is implemented only on Android.
    1154. 

  1154. 

  1155. .. _class_DisplayServer_constant_WINDOW_EVENT_DPI_CHANGE:
    1156. 

  1156. 

  1157. .. rst-class:: classref-enumeration-constant
    1158. 

  1158. 

  1159. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_DPI_CHANGE** = ``6``
    1160. 

  1160. 

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

  1162. 

  1163. \ **Note:** This flag is implemented only on macOS.
    1164. 

  1164. 

  1165. .. _class_DisplayServer_constant_WINDOW_EVENT_TITLEBAR_CHANGE:
    1166. 

  1166. 

  1167. .. rst-class:: classref-enumeration-constant
    1168. 

  1168. 

  1169. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_TITLEBAR_CHANGE** = ``7``
    1170. 

  1170. 

  1171. Sent when the window title bar decoration is changed (e.g. :ref:`WINDOW_FLAG_EXTEND_TO_TITLE<class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE>` is set or window entered/exited full screen mode), see :ref:`window_set_window_event_callback<class_DisplayServer_method_window_set_window_event_callback>`.
    1172. 

  1172. 

  1173. \ **Note:** This flag is implemented only on macOS.
    1174. 

  1174. 

  1175. .. rst-class:: classref-item-separator
    1176. 

  1176. 

  1177. ----
    1178. 

  1178. 

  1179. .. _enum_DisplayServer_VSyncMode:
    1180. 

  1180. 

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

  1182. 

  1183. enum **VSyncMode**:
    1184. 

  1184. 

  1185. .. _class_DisplayServer_constant_VSYNC_DISABLED:
    1186. 

  1186. 

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

  1188. 

  1189. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_DISABLED** = ``0``
    1190. 

  1190. 

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

  1192. 

  1193. .. _class_DisplayServer_constant_VSYNC_ENABLED:
    1194. 

  1194. 

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

  1196. 

  1197. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ENABLED** = ``1``
    1198. 

  1198. 

  1199. Default vertical synchronization mode, the image is displayed only on vertical blanking intervals (no tearing is visible). Framerate is limited by the monitor refresh rate (nonwithstanding :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
    1200. 

  1200. 

  1201. .. _class_DisplayServer_constant_VSYNC_ADAPTIVE:
    1202. 

  1202. 

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

  1204. 

  1205. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ADAPTIVE** = ``2``
    1206. 

  1206. 

  1207. Behaves like :ref:`VSYNC_DISABLED<class_DisplayServer_constant_VSYNC_DISABLED>` when the framerate drops below the screen's refresh rate to reduce stuttering (tearing may be visible). Otherwise, vertical synchronization is enabled to avoid tearing. Framerate is limited by the monitor refresh rate (nonwithstanding :ref:`Engine.max_fps<class_Engine_property_max_fps>`). Behaves like :ref:`VSYNC_ENABLED<class_DisplayServer_constant_VSYNC_ENABLED>` when using the Compatibility rendering method.
    1208. 

  1208. 

  1209. .. _class_DisplayServer_constant_VSYNC_MAILBOX:
    1210. 

  1210. 

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

  1212. 

  1213. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_MAILBOX** = ``3``
    1214. 

  1214. 

  1215. Displays the most recent image in the queue on vertical blanking intervals, while rendering to the other images (no tearing is visible). Framerate is unlimited (nonwithstanding :ref:`Engine.max_fps<class_Engine_property_max_fps>`).
    1216. 

  1216. 

  1217. 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.
    1218. 

  1218. 

  1219. .. rst-class:: classref-item-separator
    1220. 

  1220. 

  1221. ----
    1222. 

  1222. 

  1223. .. _enum_DisplayServer_HandleType:
    1224. 

  1224. 

  1225. .. rst-class:: classref-enumeration
    1226. 

  1226. 

  1227. enum **HandleType**:
    1228. 

  1228. 

  1229. .. _class_DisplayServer_constant_DISPLAY_HANDLE:
    1230. 

  1230. 

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

  1232. 

  1233. :ref:`HandleType<enum_DisplayServer_HandleType>` **DISPLAY_HANDLE** = ``0``
    1234. 

  1234. 

  1235. Display handle:
    1236. 

  1236. 

  1237. - Linux (X11): ``X11::Display*`` for the display.
    1238. 

  1238. 

  1239. - Android: ``EGLDisplay`` for the display.
    1240. 

  1240. 

  1241. .. _class_DisplayServer_constant_WINDOW_HANDLE:
    1242. 

  1242. 

  1243. .. rst-class:: classref-enumeration-constant
    1244. 

  1244. 

  1245. :ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_HANDLE** = ``1``
    1246. 

  1246. 

  1247. Window handle:
    1248. 

  1248. 

  1249. - Windows: ``HWND`` for the window.
    1250. 

  1250. 

  1251. - Linux (X11): ``X11::Window*`` for the window.
    1252. 

  1252. 

  1253. - macOS: ``NSWindow*`` for the window.
    1254. 

  1254. 

  1255. - iOS: ``UIViewController*`` for the view controller.
    1256. 

  1256. 

  1257. - Android: ``jObject`` for the activity.
    1258. 

  1258. 

  1259. .. _class_DisplayServer_constant_WINDOW_VIEW:
    1260. 

  1260. 

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

  1262. 

  1263. :ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_VIEW** = ``2``
    1264. 

  1264. 

  1265. Window view:
    1266. 

  1266. 

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

  1268. 

  1269. - macOS: ``NSView*`` for the window main view.
    1270. 

  1270. 

  1271. - iOS: ``UIView*`` for the window main view.
    1272. 

  1272. 

  1273. .. _class_DisplayServer_constant_OPENGL_CONTEXT:
    1274. 

  1274. 

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

  1276. 

  1277. :ref:`HandleType<enum_DisplayServer_HandleType>` **OPENGL_CONTEXT** = ``3``
    1278. 

  1278. 

  1279. OpenGL context (only with the GL Compatibility renderer):
    1280. 

  1280. 

  1281. - Windows: ``HGLRC`` for the window.
    1282. 

  1282. 

  1283. - Linux: ``GLXContext*`` for the window.
    1284. 

  1284. 

  1285. - macOS: ``NSOpenGLContext*`` for the window.
    1286. 

  1286. 

  1287. - Android: ``EGLContext`` for the window.
    1288. 

  1288. 

  1289. .. rst-class:: classref-item-separator
    1290. 

  1290. 

  1291. ----
    1292. 

  1292. 

  1293. .. _enum_DisplayServer_TTSUtteranceEvent:
    1294. 

  1294. 

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

  1296. 

  1297. enum **TTSUtteranceEvent**:
    1298. 

  1298. 

  1299. .. _class_DisplayServer_constant_TTS_UTTERANCE_STARTED:
    1300. 

  1300. 

  1301. .. rst-class:: classref-enumeration-constant
    1302. 

  1302. 

  1303. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_STARTED** = ``0``
    1304. 

  1304. 

  1305. Utterance has begun to be spoken.
    1306. 

  1306. 

  1307. .. _class_DisplayServer_constant_TTS_UTTERANCE_ENDED:
    1308. 

  1308. 

  1309. .. rst-class:: classref-enumeration-constant
    1310. 

  1310. 

  1311. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_ENDED** = ``1``
    1312. 

  1312. 

  1313. Utterance was successfully finished.
    1314. 

  1314. 

  1315. .. _class_DisplayServer_constant_TTS_UTTERANCE_CANCELED:
    1316. 

  1316. 

  1317. .. rst-class:: classref-enumeration-constant
    1318. 

  1318. 

  1319. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_CANCELED** = ``2``
    1320. 

  1320. 

  1321. Utterance was canceled, or TTS service was unable to process it.
    1322. 

  1322. 

  1323. .. _class_DisplayServer_constant_TTS_UTTERANCE_BOUNDARY:
    1324. 

  1324. 

  1325. .. rst-class:: classref-enumeration-constant
    1326. 

  1326. 

  1327. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_BOUNDARY** = ``3``
    1328. 

  1328. 

  1329. Utterance reached a word or sentence boundary.
    1330. 

  1330. 

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

  1332. 

  1333. ----
    1334. 

  1334. 

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

  1336. 

  1337. Constants
    1338. 

  1338. ---------
    1339. 

  1339. 

  1340. .. _class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS:
    1341. 

  1341. 

  1342. .. rst-class:: classref-constant
    1343. 

  1343. 

  1344. **SCREEN_WITH_MOUSE_FOCUS** = ``-4``
    1345. 

  1345. 

  1346. Represents the screen containing the mouse pointer.
    1347. 

  1347. 

  1348. .. _class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS:
    1349. 

  1349. 

  1350. .. rst-class:: classref-constant
    1351. 

  1351. 

  1352. **SCREEN_WITH_KEYBOARD_FOCUS** = ``-3``
    1353. 

  1353. 

  1354. Represents the screen containing the window with the keyboard focus.
    1355. 

  1355. 

  1356. .. _class_DisplayServer_constant_SCREEN_PRIMARY:
    1357. 

  1357. 

  1358. .. rst-class:: classref-constant
    1359. 

  1359. 

  1360. **SCREEN_PRIMARY** = ``-2``
    1361. 

  1361. 

  1362. Represents the primary screen.
    1363. 

  1363. 

  1364. .. _class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW:
    1365. 

  1365. 

  1366. .. rst-class:: classref-constant
    1367. 

  1367. 

  1368. **SCREEN_OF_MAIN_WINDOW** = ``-1``
    1369. 

  1369. 

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

  1371. 

  1372. .. _class_DisplayServer_constant_MAIN_WINDOW_ID:
    1373. 

  1373. 

  1374. .. rst-class:: classref-constant
    1375. 

  1375. 

  1376. **MAIN_WINDOW_ID** = ``0``
    1377. 

  1377. 

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

  1379. 

  1380. .. _class_DisplayServer_constant_INVALID_WINDOW_ID:
    1381. 

  1381. 

  1382. .. rst-class:: classref-constant
    1383. 

  1383. 

  1384. **INVALID_WINDOW_ID** = ``-1``
    1385. 

  1385. 

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

  1387. 

  1388. .. rst-class:: classref-section-separator
    1389. 

  1389. 

  1390. ----
    1391. 

  1391. 

  1392. .. rst-class:: classref-descriptions-group
    1393. 

  1393. 

  1394. Method Descriptions
    1395. 

  1395. -------------------
    1396. 

  1396. 

  1397. .. _class_DisplayServer_method_clipboard_get:
    1398. 

  1398. 

  1399. .. rst-class:: classref-method
    1400. 

  1400. 

  1401. :ref:`String<class_String>` **clipboard_get** **(** **)** |const|
    1402. 

  1402. 

  1403. Returns the user's clipboard as a string if possible.
    1404. 

  1404. 

  1405. .. rst-class:: classref-item-separator
    1406. 

  1406. 

  1407. ----
    1408. 

  1408. 

  1409. .. _class_DisplayServer_method_clipboard_get_primary:
    1410. 

  1410. 

  1411. .. rst-class:: classref-method
    1412. 

  1412. 

  1413. :ref:`String<class_String>` **clipboard_get_primary** **(** **)** |const|
    1414. 

  1414. 

  1415. 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.
    1416. 

  1416. 

  1417. \ **Note:** This method is only implemented on Linux (X11).
    1418. 

  1418. 

  1419. .. rst-class:: classref-item-separator
    1420. 

  1420. 

  1421. ----
    1422. 

  1422. 

  1423. .. _class_DisplayServer_method_clipboard_has:
    1424. 

  1424. 

  1425. .. rst-class:: classref-method
    1426. 

  1426. 

  1427. :ref:`bool<class_bool>` **clipboard_has** **(** **)** |const|
    1428. 

  1428. 

  1429. Returns ``true`` if there is content on the user's clipboard.
    1430. 

  1430. 

  1431. .. rst-class:: classref-item-separator
    1432. 

  1432. 

  1433. ----
    1434. 

  1434. 

  1435. .. _class_DisplayServer_method_clipboard_set:
    1436. 

  1436. 

  1437. .. rst-class:: classref-method
    1438. 

  1438. 

  1439. void **clipboard_set** **(** :ref:`String<class_String>` clipboard **)**
    1440. 

  1440. 

  1441. Sets the user's clipboard content to the given string.
    1442. 

  1442. 

  1443. .. rst-class:: classref-item-separator
    1444. 

  1444. 

  1445. ----
    1446. 

  1446. 

  1447. .. _class_DisplayServer_method_clipboard_set_primary:
    1448. 

  1448. 

  1449. .. rst-class:: classref-method
    1450. 

  1450. 

  1451. void **clipboard_set_primary** **(** :ref:`String<class_String>` clipboard_primary **)**
    1452. 

  1452. 

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

  1454. 

  1455. \ **Note:** This method is only implemented on Linux (X11).
    1456. 

  1456. 

  1457. .. rst-class:: classref-item-separator
    1458. 

  1458. 

  1459. ----
    1460. 

  1460. 

  1461. .. _class_DisplayServer_method_cursor_get_shape:
    1462. 

  1462. 

  1463. .. rst-class:: classref-method
    1464. 

  1464. 

  1465. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **cursor_get_shape** **(** **)** |const|
    1466. 

  1466. 

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

  1468. 

  1469. .. rst-class:: classref-item-separator
    1470. 

  1470. 

  1471. ----
    1472. 

  1472. 

  1473. .. _class_DisplayServer_method_cursor_set_custom_image:
    1474. 

  1474. 

  1475. .. rst-class:: classref-method
    1476. 

  1476. 

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

  1478. 

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

  1480. 

  1481. .. rst-class:: classref-item-separator
    1482. 

  1482. 

  1483. ----
    1484. 

  1484. 

  1485. .. _class_DisplayServer_method_cursor_set_shape:
    1486. 

  1486. 

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

  1488. 

  1489. void **cursor_set_shape** **(** :ref:`CursorShape<enum_DisplayServer_CursorShape>` shape **)**
    1490. 

  1490. 

  1491. 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>`.
    1492. 

  1492. 

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

  1494. 

  1495. ----
    1496. 

  1496. 

  1497. .. _class_DisplayServer_method_dialog_input_text:
    1498. 

  1498. 

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

  1500. 

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

  1502. 

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

  1504. 

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

  1506. 

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

  1508. 

  1509. ----
    1510. 

  1510. 

  1511. .. _class_DisplayServer_method_dialog_show:
    1512. 

  1512. 

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

  1514. 

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

  1516. 

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

  1518. 

  1519. \ **Note:** This method is implemented only on macOS.
    1520. 

  1520. 

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

  1522. 

  1523. ----
    1524. 

  1524. 

  1525. .. _class_DisplayServer_method_enable_for_stealing_focus:
    1526. 

  1526. 

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

  1528. 

  1529. void **enable_for_stealing_focus** **(** :ref:`int<class_int>` process_id **)**
    1530. 

  1530. 

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

  1532. 

  1533. \ **Note:** This method is implemented only on Windows.
    1534. 

  1534. 

  1535. .. rst-class:: classref-item-separator
    1536. 

  1536. 

  1537. ----
    1538. 

  1538. 

  1539. .. _class_DisplayServer_method_file_dialog_show:
    1540. 

  1540. 

  1541. .. rst-class:: classref-method
    1542. 

  1542. 

  1543. :ref:`Error<enum_@GlobalScope_Error>` **file_dialog_show** **(** :ref:`String<class_String>` title, :ref:`String<class_String>` current_directory, :ref:`String<class_String>` filename, :ref:`bool<class_bool>` show_hidden, :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` mode, :ref:`PackedStringArray<class_PackedStringArray>` filters, :ref:`Callable<class_Callable>` callback **)**
    1544. 

  1544. 

  1545. Displays OS native dialog for selecting files or directories in the file system.
    1546. 

  1546. 

  1547. Callbacks have the following arguments: ``bool status, PackedStringArray selected_paths``.
    1548. 

  1548. 

  1549. \ **Note:** This method is implemented if the display server has the ``FEATURE_NATIVE_DIALOG`` feature.
    1550. 

  1550. 

  1551. \ **Note:** This method is implemented on macOS.
    1552. 

  1552. 

  1553. \ **Note:** On macOS, native file dialogs have no title.
    1554. 

  1554. 

  1555. \ **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.
    1556. 

  1556. 

  1557. .. rst-class:: classref-item-separator
    1558. 

  1558. 

  1559. ----
    1560. 

  1560. 

  1561. .. _class_DisplayServer_method_force_process_and_drop_events:
    1562. 

  1562. 

  1563. .. rst-class:: classref-method
    1564. 

  1564. 

  1565. void **force_process_and_drop_events** **(** **)**
    1566. 

  1566. 

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

  1568. 

  1569. \ **Note:** This method is implemented on Windows and macOS.
    1570. 

  1570. 

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

  1572. 

  1573. ----
    1574. 

  1574. 

  1575. .. _class_DisplayServer_method_get_accent_color:
    1576. 

  1576. 

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

  1578. 

  1579. :ref:`Color<class_Color>` **get_accent_color** **(** **)** |const|
    1580. 

  1580. 

  1581. Returns OS theme accent color. Returns ``Color(0, 0, 0, 0)``, if accent color is unknown.
    1582. 

  1582. 

  1583. \ **Note:** This method is implemented on macOS and Windows.
    1584. 

  1584. 

  1585. .. rst-class:: classref-item-separator
    1586. 

  1586. 

  1587. ----
    1588. 

  1588. 

  1589. .. _class_DisplayServer_method_get_display_cutouts:
    1590. 

  1590. 

  1591. .. rst-class:: classref-method
    1592. 

  1592. 

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

  1594. 

  1595. 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>`.
    1596. 

  1596. 

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

  1598. 

  1599. .. rst-class:: classref-item-separator
    1600. 

  1600. 

  1601. ----
    1602. 

  1602. 

  1603. .. _class_DisplayServer_method_get_display_safe_area:
    1604. 

  1604. 

  1605. .. rst-class:: classref-method
    1606. 

  1606. 

  1607. :ref:`Rect2i<class_Rect2i>` **get_display_safe_area** **(** **)** |const|
    1608. 

  1608. 

  1609. 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>`.
    1610. 

  1610. 

  1611. .. rst-class:: classref-item-separator
    1612. 

  1612. 

  1613. ----
    1614. 

  1614. 

  1615. .. _class_DisplayServer_method_get_keyboard_focus_screen:
    1616. 

  1616. 

  1617. .. rst-class:: classref-method
    1618. 

  1618. 

  1619. :ref:`int<class_int>` **get_keyboard_focus_screen** **(** **)** |const|
    1620. 

  1620. 

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

  1622. 

  1623. .. rst-class:: classref-item-separator
    1624. 

  1624. 

  1625. ----
    1626. 

  1626. 

  1627. .. _class_DisplayServer_method_get_name:
    1628. 

  1628. 

  1629. .. rst-class:: classref-method
    1630. 

  1630. 

  1631. :ref:`String<class_String>` **get_name** **(** **)** |const|
    1632. 

  1632. 

  1633. Returns the name of the **DisplayServer** currently in use. Most operating systems only have a single **DisplayServer**, but Linux has access to more than one **DisplayServer** (although only X11 is currently implemented in Godot).
    1634. 

  1634. 

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

  1636. 

  1637. .. rst-class:: classref-item-separator
    1638. 

  1638. 

  1639. ----
    1640. 

  1640. 

  1641. .. _class_DisplayServer_method_get_primary_screen:
    1642. 

  1642. 

  1643. .. rst-class:: classref-method
    1644. 

  1644. 

  1645. :ref:`int<class_int>` **get_primary_screen** **(** **)** |const|
    1646. 

  1646. 

  1647. Returns index of the primary screen.
    1648. 

  1648. 

  1649. .. rst-class:: classref-item-separator
    1650. 

  1650. 

  1651. ----
    1652. 

  1652. 

  1653. .. _class_DisplayServer_method_get_screen_count:
    1654. 

  1654. 

  1655. .. rst-class:: classref-method
    1656. 

  1656. 

  1657. :ref:`int<class_int>` **get_screen_count** **(** **)** |const|
    1658. 

  1658. 

  1659. Returns the number of displays available.
    1660. 

  1660. 

  1661. .. rst-class:: classref-item-separator
    1662. 

  1662. 

  1663. ----
    1664. 

  1664. 

  1665. .. _class_DisplayServer_method_get_screen_from_rect:
    1666. 

  1666. 

  1667. .. rst-class:: classref-method
    1668. 

  1668. 

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

  1670. 

  1671. Returns index of the screen which contains specified rectangle.
    1672. 

  1672. 

  1673. .. rst-class:: classref-item-separator
    1674. 

  1674. 

  1675. ----
    1676. 

  1676. 

  1677. .. _class_DisplayServer_method_get_swap_cancel_ok:
    1678. 

  1678. 

  1679. .. rst-class:: classref-method
    1680. 

  1680. 

  1681. :ref:`bool<class_bool>` **get_swap_cancel_ok** **(** **)**
    1682. 

  1682. 

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

  1684. 

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

  1686. 

  1687. .. rst-class:: classref-item-separator
    1688. 

  1688. 

  1689. ----
    1690. 

  1690. 

  1691. .. _class_DisplayServer_method_get_window_at_screen_position:
    1692. 

  1692. 

  1693. .. rst-class:: classref-method
    1694. 

  1694. 

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

  1696. 

  1697. 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:
    1698. 

  1698. 

  1699. ::
    1700. 

  1700. 

  1701.     * (0, 0)        +-------+
    1702. 

  1702.                     |       |
    1703. 

  1703.     +-------------+ |       |
    1704. 

  1704.     |             | |       |
    1705. 

  1705.     |             | |       |
    1706. 

  1706.     +-------------+ +-------+
    1707. 

  1707. 

  1708. .. rst-class:: classref-item-separator
    1709. 

  1709. 

  1710. ----
    1711. 

  1711. 

  1712. .. _class_DisplayServer_method_get_window_list:
    1713. 

  1713. 

  1714. .. rst-class:: classref-method
    1715. 

  1715. 

  1716. :ref:`PackedInt32Array<class_PackedInt32Array>` **get_window_list** **(** **)** |const|
    1717. 

  1717. 

  1718. Returns the list of Godot window IDs belonging to this process.
    1719. 

  1719. 

  1720. \ **Note:** Native dialogs are not included in this list.
    1721. 

  1721. 

  1722. .. rst-class:: classref-item-separator
    1723. 

  1723. 

  1724. ----
    1725. 

  1725. 

  1726. .. _class_DisplayServer_method_global_menu_add_check_item:
    1727. 

  1727. 

  1728. .. rst-class:: classref-method
    1729. 

  1729. 

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

  1731. 

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

  1733. 

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

  1735. 

  1736. 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`).
    1737. 

  1737. 

  1738. \ **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``.
    1739. 

  1739. 

  1740. \ **Note:** This method is implemented only on macOS.
    1741. 

  1741. 

  1742. \ **Supported system menu IDs:**\ 
    1743. 

  1743. 

  1744. ::
    1745. 

  1745. 

  1746.     "_main" - Main menu (macOS).
    1747. 

  1747.     "_dock" - Dock popup menu (macOS).
    1748. 

  1748. 

  1749. .. rst-class:: classref-item-separator
    1750. 

  1750. 

  1751. ----
    1752. 

  1752. 

  1753. .. _class_DisplayServer_method_global_menu_add_icon_check_item:
    1754. 

  1754. 

  1755. .. rst-class:: classref-method
    1756. 

  1756. 

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

  1758. 

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

  1760. 

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

  1762. 

  1763. 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`).
    1764. 

  1764. 

  1765. \ **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``.
    1766. 

  1766. 

  1767. \ **Note:** This method is implemented only on macOS.
    1768. 

  1768. 

  1769. \ **Supported system menu IDs:**\ 
    1770. 

  1770. 

  1771. ::
    1772. 

  1772. 

  1773.     "_main" - Main menu (macOS).
    1774. 

  1774.     "_dock" - Dock popup menu (macOS).
    1775. 

  1775. 

  1776. .. rst-class:: classref-item-separator
    1777. 

  1777. 

  1778. ----
    1779. 

  1779. 

  1780. .. _class_DisplayServer_method_global_menu_add_icon_item:
    1781. 

  1781. 

  1782. .. rst-class:: classref-method
    1783. 

  1783. 

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

  1785. 

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

  1787. 

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

  1789. 

  1790. 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`).
    1791. 

  1791. 

  1792. \ **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``.
    1793. 

  1793. 

  1794. \ **Note:** This method is implemented only on macOS.
    1795. 

  1795. 

  1796. \ **Supported system menu IDs:**\ 
    1797. 

  1797. 

  1798. ::
    1799. 

  1799. 

  1800.     "_main" - Main menu (macOS).
    1801. 

  1801.     "_dock" - Dock popup menu (macOS).
    1802. 

  1802. 

  1803. .. rst-class:: classref-item-separator
    1804. 

  1804. 

  1805. ----
    1806. 

  1806. 

  1807. .. _class_DisplayServer_method_global_menu_add_icon_radio_check_item:
    1808. 

  1808. 

  1809. .. rst-class:: classref-method
    1810. 

  1810. 

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

  1812. 

  1813. Adds a new radio-checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
    1814. 

  1814. 

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

  1816. 

  1817. 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`).
    1818. 

  1818. 

  1819. \ **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.
    1820. 

  1820. 

  1821. \ **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``.
    1822. 

  1822. 

  1823. \ **Note:** This method is implemented only on macOS.
    1824. 

  1824. 

  1825. \ **Supported system menu IDs:**\ 
    1826. 

  1826. 

  1827. ::
    1828. 

  1828. 

  1829.     "_main" - Main menu (macOS).
    1830. 

  1830.     "_dock" - Dock popup menu (macOS).
    1831. 

  1831. 

  1832. .. rst-class:: classref-item-separator
    1833. 

  1833. 

  1834. ----
    1835. 

  1835. 

  1836. .. _class_DisplayServer_method_global_menu_add_item:
    1837. 

  1837. 

  1838. .. rst-class:: classref-method
    1839. 

  1839. 

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

  1841. 

  1842. Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
    1843. 

  1843. 

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

  1845. 

  1846. 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`).
    1847. 

  1847. 

  1848. \ **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``.
    1849. 

  1849. 

  1850. \ **Note:** This method is implemented only on macOS.
    1851. 

  1851. 

  1852. \ **Supported system menu IDs:**\ 
    1853. 

  1853. 

  1854. ::
    1855. 

  1855. 

  1856.     "_main" - Main menu (macOS).
    1857. 

  1857.     "_dock" - Dock popup menu (macOS).
    1858. 

  1858. 

  1859. .. rst-class:: classref-item-separator
    1860. 

  1860. 

  1861. ----
    1862. 

  1862. 

  1863. .. _class_DisplayServer_method_global_menu_add_multistate_item:
    1864. 

  1864. 

  1865. .. rst-class:: classref-method
    1866. 

  1866. 

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

  1868. 

  1869. Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
    1870. 

  1870. 

  1871. 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``.
    1872. 

  1872. 

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

  1874. 

  1875. 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`).
    1876. 

  1876. 

  1877. \ **Note:** By default, there's no indication of the current item state, it should be changed manually.
    1878. 

  1878. 

  1879. \ **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``.
    1880. 

  1880. 

  1881. \ **Note:** This method is implemented only on macOS.
    1882. 

  1882. 

  1883. \ **Supported system menu IDs:**\ 
    1884. 

  1884. 

  1885. ::
    1886. 

  1886. 

  1887.     "_main" - Main menu (macOS).
    1888. 

  1888.     "_dock" - Dock popup menu (macOS).
    1889. 

  1889. 

  1890. .. rst-class:: classref-item-separator
    1891. 

  1891. 

  1892. ----
    1893. 

  1893. 

  1894. .. _class_DisplayServer_method_global_menu_add_radio_check_item:
    1895. 

  1895. 

  1896. .. rst-class:: classref-method
    1897. 

  1897. 

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

  1899. 

  1900. Adds a new radio-checkable item with text ``label`` to the global menu with ID ``menu_root``.
    1901. 

  1901. 

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

  1903. 

  1904. 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`).
    1905. 

  1905. 

  1906. \ **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.
    1907. 

  1907. 

  1908. \ **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``.
    1909. 

  1909. 

  1910. \ **Note:** This method is implemented only on macOS.
    1911. 

  1911. 

  1912. \ **Supported system menu IDs:**\ 
    1913. 

  1913. 

  1914. ::
    1915. 

  1915. 

  1916.     "_main" - Main menu (macOS).
    1917. 

  1917.     "_dock" - Dock popup menu (macOS).
    1918. 

  1918. 

  1919. .. rst-class:: classref-item-separator
    1920. 

  1920. 

  1921. ----
    1922. 

  1922. 

  1923. .. _class_DisplayServer_method_global_menu_add_separator:
    1924. 

  1924. 

  1925. .. rst-class:: classref-method
    1926. 

  1926. 

  1927. :ref:`int<class_int>` **global_menu_add_separator** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` index=-1 **)**
    1928. 

  1928. 

  1929. Adds a separator between items to the global menu with ID ``menu_root``. Separators also occupy an index.
    1930. 

  1930. 

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

  1932. 

  1933. \ **Note:** This method is implemented only on macOS.
    1934. 

  1934. 

  1935. \ **Supported system menu IDs:**\ 
    1936. 

  1936. 

  1937. ::
    1938. 

  1938. 

  1939.     "_main" - Main menu (macOS).
    1940. 

  1940.     "_dock" - Dock popup menu (macOS).
    1941. 

  1941. 

  1942. .. rst-class:: classref-item-separator
    1943. 

  1943. 

  1944. ----
    1945. 

  1945. 

  1946. .. _class_DisplayServer_method_global_menu_add_submenu_item:
    1947. 

  1947. 

  1948. .. rst-class:: classref-method
    1949. 

  1949. 

  1950. :ref:`int<class_int>` **global_menu_add_submenu_item** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`String<class_String>` submenu, :ref:`int<class_int>` index=-1 **)**
    1951. 

  1951. 

  1952. 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.
    1953. 

  1953. 

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

  1955. 

  1956. \ **Note:** This method is implemented only on macOS.
    1957. 

  1957. 

  1958. \ **Supported system menu IDs:**\ 
    1959. 

  1959. 

  1960. ::
    1961. 

  1961. 

  1962.     "_main" - Main menu (macOS).
    1963. 

  1963.     "_dock" - Dock popup menu (macOS).
    1964. 

  1964. 

  1965. .. rst-class:: classref-item-separator
    1966. 

  1966. 

  1967. ----
    1968. 

  1968. 

  1969. .. _class_DisplayServer_method_global_menu_clear:
    1970. 

  1970. 

  1971. .. rst-class:: classref-method
    1972. 

  1972. 

  1973. void **global_menu_clear** **(** :ref:`String<class_String>` menu_root **)**
    1974. 

  1974. 

  1975. Removes all items from the global menu with ID ``menu_root``.
    1976. 

  1976. 

  1977. \ **Note:** This method is implemented only on macOS.
    1978. 

  1978. 

  1979. \ **Supported system menu IDs:**\ 
    1980. 

  1980. 

  1981. ::
    1982. 

  1982. 

  1983.     "_main" - Main menu (macOS).
    1984. 

  1984.     "_dock" - Dock popup menu (macOS).
    1985. 

  1985. 

  1986. .. rst-class:: classref-item-separator
    1987. 

  1987. 

  1988. ----
    1989. 

  1989. 

  1990. .. _class_DisplayServer_method_global_menu_get_item_accelerator:
    1991. 

  1991. 

  1992. .. rst-class:: classref-method
    1993. 

  1993. 

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

  1995. 

  1996. 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.
    1997. 

  1997. 

  1998. \ **Note:** This method is implemented only on macOS.
    1999. 

  1999. 

  2000. .. rst-class:: classref-item-separator
    2001. 

  2001. 

  2002. ----
    2003. 

  2003. 

  2004. .. _class_DisplayServer_method_global_menu_get_item_callback:
    2005. 

  2005. 

  2006. .. rst-class:: classref-method
    2007. 

  2007. 

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

  2009. 

  2010. Returns the callback of the item at index ``idx``.
    2011. 

  2011. 

  2012. \ **Note:** This method is implemented only on macOS.
    2013. 

  2013. 

  2014. .. rst-class:: classref-item-separator
    2015. 

  2015. 

  2016. ----
    2017. 

  2017. 

  2018. .. _class_DisplayServer_method_global_menu_get_item_count:
    2019. 

  2019. 

  2020. .. rst-class:: classref-method
    2021. 

  2021. 

  2022. :ref:`int<class_int>` **global_menu_get_item_count** **(** :ref:`String<class_String>` menu_root **)** |const|
    2023. 

  2023. 

  2024. Returns number of items in the global menu with ID ``menu_root``.
    2025. 

  2025. 

  2026. \ **Note:** This method is implemented only on macOS.
    2027. 

  2027. 

  2028. .. rst-class:: classref-item-separator
    2029. 

  2029. 

  2030. ----
    2031. 

  2031. 

  2032. .. _class_DisplayServer_method_global_menu_get_item_icon:
    2033. 

  2033. 

  2034. .. rst-class:: classref-method
    2035. 

  2035. 

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

  2037. 

  2038. Returns the icon of the item at index ``idx``.
    2039. 

  2039. 

  2040. \ **Note:** This method is implemented only on macOS.
    2041. 

  2041. 

  2042. .. rst-class:: classref-item-separator
    2043. 

  2043. 

  2044. ----
    2045. 

  2045. 

  2046. .. _class_DisplayServer_method_global_menu_get_item_indentation_level:
    2047. 

  2047. 

  2048. .. rst-class:: classref-method
    2049. 

  2049. 

  2050. :ref:`int<class_int>` **global_menu_get_item_indentation_level** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2051. 

  2051. 

  2052. Returns the horizontal offset of the item at the given ``idx``.
    2053. 

  2053. 

  2054. \ **Note:** This method is implemented only on macOS.
    2055. 

  2055. 

  2056. .. rst-class:: classref-item-separator
    2057. 

  2057. 

  2058. ----
    2059. 

  2059. 

  2060. .. _class_DisplayServer_method_global_menu_get_item_index_from_tag:
    2061. 

  2061. 

  2062. .. rst-class:: classref-method
    2063. 

  2063. 

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

  2065. 

  2066. Returns the index of the item with the specified ``tag``. Index is automatically assigned to each item by the engine. Index can not be set manually.
    2067. 

  2067. 

  2068. \ **Note:** This method is implemented only on macOS.
    2069. 

  2069. 

  2070. .. rst-class:: classref-item-separator
    2071. 

  2071. 

  2072. ----
    2073. 

  2073. 

  2074. .. _class_DisplayServer_method_global_menu_get_item_index_from_text:
    2075. 

  2075. 

  2076. .. rst-class:: classref-method
    2077. 

  2077. 

  2078. :ref:`int<class_int>` **global_menu_get_item_index_from_text** **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` text **)** |const|
    2079. 

  2079. 

  2080. Returns the index of the item with the specified ``text``. Index is automatically assigned to each item by the engine. Index can not be set manually.
    2081. 

  2081. 

  2082. \ **Note:** This method is implemented only on macOS.
    2083. 

  2083. 

  2084. .. rst-class:: classref-item-separator
    2085. 

  2085. 

  2086. ----
    2087. 

  2087. 

  2088. .. _class_DisplayServer_method_global_menu_get_item_key_callback:
    2089. 

  2089. 

  2090. .. rst-class:: classref-method
    2091. 

  2091. 

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

  2093. 

  2094. Returns the callback of the item accelerator at index ``idx``.
    2095. 

  2095. 

  2096. \ **Note:** This method is implemented only on macOS.
    2097. 

  2097. 

  2098. .. rst-class:: classref-item-separator
    2099. 

  2099. 

  2100. ----
    2101. 

  2101. 

  2102. .. _class_DisplayServer_method_global_menu_get_item_max_states:
    2103. 

  2103. 

  2104. .. rst-class:: classref-method
    2105. 

  2105. 

  2106. :ref:`int<class_int>` **global_menu_get_item_max_states** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2107. 

  2107. 

  2108. 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.
    2109. 

  2109. 

  2110. \ **Note:** This method is implemented only on macOS.
    2111. 

  2111. 

  2112. .. rst-class:: classref-item-separator
    2113. 

  2113. 

  2114. ----
    2115. 

  2115. 

  2116. .. _class_DisplayServer_method_global_menu_get_item_state:
    2117. 

  2117. 

  2118. .. rst-class:: classref-method
    2119. 

  2119. 

  2120. :ref:`int<class_int>` **global_menu_get_item_state** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2121. 

  2121. 

  2122. Returns the state of a multistate item. See :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
    2123. 

  2123. 

  2124. \ **Note:** This method is implemented only on macOS.
    2125. 

  2125. 

  2126. .. rst-class:: classref-item-separator
    2127. 

  2127. 

  2128. ----
    2129. 

  2129. 

  2130. .. _class_DisplayServer_method_global_menu_get_item_submenu:
    2131. 

  2131. 

  2132. .. rst-class:: classref-method
    2133. 

  2133. 

  2134. :ref:`String<class_String>` **global_menu_get_item_submenu** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2135. 

  2135. 

  2136. 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.
    2137. 

  2137. 

  2138. \ **Note:** This method is implemented only on macOS.
    2139. 

  2139. 

  2140. .. rst-class:: classref-item-separator
    2141. 

  2141. 

  2142. ----
    2143. 

  2143. 

  2144. .. _class_DisplayServer_method_global_menu_get_item_tag:
    2145. 

  2145. 

  2146. .. rst-class:: classref-method
    2147. 

  2147. 

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

  2149. 

  2150. 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.
    2151. 

  2151. 

  2152. \ **Note:** This method is implemented only on macOS.
    2153. 

  2153. 

  2154. .. rst-class:: classref-item-separator
    2155. 

  2155. 

  2156. ----
    2157. 

  2157. 

  2158. .. _class_DisplayServer_method_global_menu_get_item_text:
    2159. 

  2159. 

  2160. .. rst-class:: classref-method
    2161. 

  2161. 

  2162. :ref:`String<class_String>` **global_menu_get_item_text** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2163. 

  2163. 

  2164. Returns the text of the item at index ``idx``.
    2165. 

  2165. 

  2166. \ **Note:** This method is implemented only on macOS.
    2167. 

  2167. 

  2168. .. rst-class:: classref-item-separator
    2169. 

  2169. 

  2170. ----
    2171. 

  2171. 

  2172. .. _class_DisplayServer_method_global_menu_get_item_tooltip:
    2173. 

  2173. 

  2174. .. rst-class:: classref-method
    2175. 

  2175. 

  2176. :ref:`String<class_String>` **global_menu_get_item_tooltip** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|
    2177. 

  2177. 

  2178. Returns the tooltip associated with the specified index ``idx``.
    2179. 

  2179. 

  2180. \ **Note:** This method is implemented only on macOS.
    2181. 

  2181. 

  2182. .. rst-class:: classref-item-separator
    2183. 

  2183. 

  2184. ----
    2185. 

  2185. 

  2186. .. _class_DisplayServer_method_global_menu_is_item_checkable:
    2187. 

  2187. 

  2188. .. rst-class:: classref-method
    2189. 

  2189. 

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

  2191. 

  2192. Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if it has a checkbox or radio button.
    2193. 

  2193. 

  2194. \ **Note:** This method is implemented only on macOS.
    2195. 

  2195. 

  2196. .. rst-class:: classref-item-separator
    2197. 

  2197. 

  2198. ----
    2199. 

  2199. 

  2200. .. _class_DisplayServer_method_global_menu_is_item_checked:
    2201. 

  2201. 

  2202. .. rst-class:: classref-method
    2203. 

  2203. 

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

  2205. 

  2206. Returns ``true`` if the item at index ``idx`` is checked.
    2207. 

  2207. 

  2208. \ **Note:** This method is implemented only on macOS.
    2209. 

  2209. 

  2210. .. rst-class:: classref-item-separator
    2211. 

  2211. 

  2212. ----
    2213. 

  2213. 

  2214. .. _class_DisplayServer_method_global_menu_is_item_disabled:
    2215. 

  2215. 

  2216. .. rst-class:: classref-method
    2217. 

  2217. 

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

  2219. 

  2220. Returns ``true`` if the item at index ``idx`` is disabled. When it is disabled it can't be selected, or its action invoked.
    2221. 

  2221. 

  2222. See :ref:`global_menu_set_item_disabled<class_DisplayServer_method_global_menu_set_item_disabled>` for more info on how to disable an item.
    2223. 

  2223. 

  2224. \ **Note:** This method is implemented only on macOS.
    2225. 

  2225. 

  2226. .. rst-class:: classref-item-separator
    2227. 

  2227. 

  2228. ----
    2229. 

  2229. 

  2230. .. _class_DisplayServer_method_global_menu_is_item_radio_checkable:
    2231. 

  2231. 

  2232. .. rst-class:: classref-method
    2233. 

  2233. 

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

  2235. 

  2236. Returns ``true`` if the item at index ``idx`` has radio button-style checkability.
    2237. 

  2237. 

  2238. \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
    2239. 

  2239. 

  2240. \ **Note:** This method is implemented only on macOS.
    2241. 

  2241. 

  2242. .. rst-class:: classref-item-separator
    2243. 

  2243. 

  2244. ----
    2245. 

  2245. 

  2246. .. _class_DisplayServer_method_global_menu_remove_item:
    2247. 

  2247. 

  2248. .. rst-class:: classref-method
    2249. 

  2249. 

  2250. void **global_menu_remove_item** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)**
    2251. 

  2251. 

  2252. Removes the item at index ``idx`` from the global menu ``menu_root``.
    2253. 

  2253. 

  2254. \ **Note:** The indices of items after the removed item will be shifted by one.
    2255. 

  2255. 

  2256. \ **Note:** This method is implemented only on macOS.
    2257. 

  2257. 

  2258. .. rst-class:: classref-item-separator
    2259. 

  2259. 

  2260. ----
    2261. 

  2261. 

  2262. .. _class_DisplayServer_method_global_menu_set_item_accelerator:
    2263. 

  2263. 

  2264. .. rst-class:: classref-method
    2265. 

  2265. 

  2266. void **global_menu_set_item_accelerator** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Key<enum_@GlobalScope_Key>` keycode **)**
    2267. 

  2267. 

  2268. 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`).
    2269. 

  2269. 

  2270. \ **Note:** This method is implemented only on macOS.
    2271. 

  2271. 

  2272. .. rst-class:: classref-item-separator
    2273. 

  2273. 

  2274. ----
    2275. 

  2275. 

  2276. .. _class_DisplayServer_method_global_menu_set_item_callback:
    2277. 

  2277. 

  2278. .. rst-class:: classref-method
    2279. 

  2279. 

  2280. void **global_menu_set_item_callback** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Callable<class_Callable>` callback **)**
    2281. 

  2281. 

  2282. Sets the callback of the item at index ``idx``. Callback is emitted when an item is pressed.
    2283. 

  2283. 

  2284. \ **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.
    2285. 

  2285. 

  2286. \ **Note:** This method is implemented only on macOS.
    2287. 

  2287. 

  2288. .. rst-class:: classref-item-separator
    2289. 

  2289. 

  2290. ----
    2291. 

  2291. 

  2292. .. _class_DisplayServer_method_global_menu_set_item_checkable:
    2293. 

  2293. 

  2294. .. rst-class:: classref-method
    2295. 

  2295. 

  2296. void **global_menu_set_item_checkable** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checkable **)**
    2297. 

  2297. 

  2298. Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the type of the item to plain text.
    2299. 

  2299. 

  2300. \ **Note:** This method is implemented only on macOS.
    2301. 

  2301. 

  2302. .. rst-class:: classref-item-separator
    2303. 

  2303. 

  2304. ----
    2305. 

  2305. 

  2306. .. _class_DisplayServer_method_global_menu_set_item_checked:
    2307. 

  2307. 

  2308. .. rst-class:: classref-method
    2309. 

  2309. 

  2310. void **global_menu_set_item_checked** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checked **)**
    2311. 

  2311. 

  2312. Sets the checkstate status of the item at index ``idx``.
    2313. 

  2313. 

  2314. \ **Note:** This method is implemented only on macOS.
    2315. 

  2315. 

  2316. .. rst-class:: classref-item-separator
    2317. 

  2317. 

  2318. ----
    2319. 

  2319. 

  2320. .. _class_DisplayServer_method_global_menu_set_item_disabled:
    2321. 

  2321. 

  2322. .. rst-class:: classref-method
    2323. 

  2323. 

  2324. void **global_menu_set_item_disabled** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)**
    2325. 

  2325. 

  2326. Enables/disables the item at index ``idx``. When it is disabled, it can't be selected and its action can't be invoked.
    2327. 

  2327. 

  2328. \ **Note:** This method is implemented only on macOS.
    2329. 

  2329. 

  2330. .. rst-class:: classref-item-separator
    2331. 

  2331. 

  2332. ----
    2333. 

  2333. 

  2334. .. _class_DisplayServer_method_global_menu_set_item_icon:
    2335. 

  2335. 

  2336. .. rst-class:: classref-method
    2337. 

  2337. 

  2338. void **global_menu_set_item_icon** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Texture2D<class_Texture2D>` icon **)**
    2339. 

  2339. 

  2340. Replaces the :ref:`Texture2D<class_Texture2D>` icon of the specified ``idx``.
    2341. 

  2341. 

  2342. \ **Note:** This method is implemented only on macOS.
    2343. 

  2343. 

  2344. \ **Note:** This method is not supported by macOS "_dock" menu items.
    2345. 

  2345. 

  2346. .. rst-class:: classref-item-separator
    2347. 

  2347. 

  2348. ----
    2349. 

  2349. 

  2350. .. _class_DisplayServer_method_global_menu_set_item_indentation_level:
    2351. 

  2351. 

  2352. .. rst-class:: classref-method
    2353. 

  2353. 

  2354. void **global_menu_set_item_indentation_level** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` level **)**
    2355. 

  2355. 

  2356. Sets the horizontal offset of the item at the given ``idx``.
    2357. 

  2357. 

  2358. \ **Note:** This method is implemented only on macOS.
    2359. 

  2359. 

  2360. .. rst-class:: classref-item-separator
    2361. 

  2361. 

  2362. ----
    2363. 

  2363. 

  2364. .. _class_DisplayServer_method_global_menu_set_item_key_callback:
    2365. 

  2365. 

  2366. .. rst-class:: classref-method
    2367. 

  2367. 

  2368. void **global_menu_set_item_key_callback** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Callable<class_Callable>` key_callback **)**
    2369. 

  2369. 

  2370. Sets the callback of the item at index ``idx``. Callback is emitted when its accelerator is activated.
    2371. 

  2371. 

  2372. \ **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.
    2373. 

  2373. 

  2374. \ **Note:** This method is implemented only on macOS.
    2375. 

  2375. 

  2376. .. rst-class:: classref-item-separator
    2377. 

  2377. 

  2378. ----
    2379. 

  2379. 

  2380. .. _class_DisplayServer_method_global_menu_set_item_max_states:
    2381. 

  2381. 

  2382. .. rst-class:: classref-method
    2383. 

  2383. 

  2384. void **global_menu_set_item_max_states** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` max_states **)**
    2385. 

  2385. 

  2386. 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.
    2387. 

  2387. 

  2388. \ **Note:** This method is implemented only on macOS.
    2389. 

  2389. 

  2390. .. rst-class:: classref-item-separator
    2391. 

  2391. 

  2392. ----
    2393. 

  2393. 

  2394. .. _class_DisplayServer_method_global_menu_set_item_radio_checkable:
    2395. 

  2395. 

  2396. .. rst-class:: classref-method
    2397. 

  2397. 

  2398. void **global_menu_set_item_radio_checkable** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checkable **)**
    2399. 

  2399. 

  2400. 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.
    2401. 

  2401. 

  2402. \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
    2403. 

  2403. 

  2404. \ **Note:** This method is implemented only on macOS.
    2405. 

  2405. 

  2406. .. rst-class:: classref-item-separator
    2407. 

  2407. 

  2408. ----
    2409. 

  2409. 

  2410. .. _class_DisplayServer_method_global_menu_set_item_state:
    2411. 

  2411. 

  2412. .. rst-class:: classref-method
    2413. 

  2413. 

  2414. void **global_menu_set_item_state** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` state **)**
    2415. 

  2415. 

  2416. Sets the state of a multistate item. See :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
    2417. 

  2417. 

  2418. \ **Note:** This method is implemented only on macOS.
    2419. 

  2419. 

  2420. .. rst-class:: classref-item-separator
    2421. 

  2421. 

  2422. ----
    2423. 

  2423. 

  2424. .. _class_DisplayServer_method_global_menu_set_item_submenu:
    2425. 

  2425. 

  2426. .. rst-class:: classref-method
    2427. 

  2427. 

  2428. void **global_menu_set_item_submenu** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`String<class_String>` submenu **)**
    2429. 

  2429. 

  2430. 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.
    2431. 

  2431. 

  2432. \ **Note:** This method is implemented only on macOS.
    2433. 

  2433. 

  2434. .. rst-class:: classref-item-separator
    2435. 

  2435. 

  2436. ----
    2437. 

  2437. 

  2438. .. _class_DisplayServer_method_global_menu_set_item_tag:
    2439. 

  2439. 

  2440. .. rst-class:: classref-method
    2441. 

  2441. 

  2442. void **global_menu_set_item_tag** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` tag **)**
    2443. 

  2443. 

  2444. 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.
    2445. 

  2445. 

  2446. \ **Note:** This method is implemented only on macOS.
    2447. 

  2447. 

  2448. .. rst-class:: classref-item-separator
    2449. 

  2449. 

  2450. ----
    2451. 

  2451. 

  2452. .. _class_DisplayServer_method_global_menu_set_item_text:
    2453. 

  2453. 

  2454. .. rst-class:: classref-method
    2455. 

  2455. 

  2456. void **global_menu_set_item_text** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`String<class_String>` text **)**
    2457. 

  2457. 

  2458. Sets the text of the item at index ``idx``.
    2459. 

  2459. 

  2460. \ **Note:** This method is implemented only on macOS.
    2461. 

  2461. 

  2462. .. rst-class:: classref-item-separator
    2463. 

  2463. 

  2464. ----
    2465. 

  2465. 

  2466. .. _class_DisplayServer_method_global_menu_set_item_tooltip:
    2467. 

  2467. 

  2468. .. rst-class:: classref-method
    2469. 

  2469. 

  2470. void **global_menu_set_item_tooltip** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`String<class_String>` tooltip **)**
    2471. 

  2471. 

  2472. Sets the :ref:`String<class_String>` tooltip of the item at the specified index ``idx``.
    2473. 

  2473. 

  2474. \ **Note:** This method is implemented only on macOS.
    2475. 

  2475. 

  2476. .. rst-class:: classref-item-separator
    2477. 

  2477. 

  2478. ----
    2479. 

  2479. 

  2480. .. _class_DisplayServer_method_has_feature:
    2481. 

  2481. 

  2482. .. rst-class:: classref-method
    2483. 

  2483. 

  2484. :ref:`bool<class_bool>` **has_feature** **(** :ref:`Feature<enum_DisplayServer_Feature>` feature **)** |const|
    2485. 

  2485. 

  2486. Returns ``true`` if the specified ``feature`` is supported by the current **DisplayServer**, ``false`` otherwise.
    2487. 

  2487. 

  2488. .. rst-class:: classref-item-separator
    2489. 

  2489. 

  2490. ----
    2491. 

  2491. 

  2492. .. _class_DisplayServer_method_ime_get_selection:
    2493. 

  2493. 

  2494. .. rst-class:: classref-method
    2495. 

  2495. 

  2496. :ref:`Vector2i<class_Vector2i>` **ime_get_selection** **(** **)** |const|
    2497. 

  2497. 

  2498. 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.
    2499. 

  2499. 

  2500. \ **Note:** This method is implemented only on macOS.
    2501. 

  2501. 

  2502. .. rst-class:: classref-item-separator
    2503. 

  2503. 

  2504. ----
    2505. 

  2505. 

  2506. .. _class_DisplayServer_method_ime_get_text:
    2507. 

  2507. 

  2508. .. rst-class:: classref-method
    2509. 

  2509. 

  2510. :ref:`String<class_String>` **ime_get_text** **(** **)** |const|
    2511. 

  2511. 

  2512. Returns the composition string contained within the `Input Method Editor <https://en.wikipedia.org/wiki/Input_method>`__ window.
    2513. 

  2513. 

  2514. \ **Note:** This method is implemented only on macOS.
    2515. 

  2515. 

  2516. .. rst-class:: classref-item-separator
    2517. 

  2517. 

  2518. ----
    2519. 

  2519. 

  2520. .. _class_DisplayServer_method_is_dark_mode:
    2521. 

  2521. 

  2522. .. rst-class:: classref-method
    2523. 

  2523. 

  2524. :ref:`bool<class_bool>` **is_dark_mode** **(** **)** |const|
    2525. 

  2525. 

  2526. Returns ``true`` if OS is using dark mode.
    2527. 

  2527. 

  2528. \ **Note:** This method is implemented on macOS, Windows and Linux (X11).
    2529. 

  2529. 

  2530. .. rst-class:: classref-item-separator
    2531. 

  2531. 

  2532. ----
    2533. 

  2533. 

  2534. .. _class_DisplayServer_method_is_dark_mode_supported:
    2535. 

  2535. 

  2536. .. rst-class:: classref-method
    2537. 

  2537. 

  2538. :ref:`bool<class_bool>` **is_dark_mode_supported** **(** **)** |const|
    2539. 

  2539. 

  2540. Returns ``true`` if OS supports dark mode.
    2541. 

  2541. 

  2542. \ **Note:** This method is implemented on macOS, Windows and Linux (X11).
    2543. 

  2543. 

  2544. .. rst-class:: classref-item-separator
    2545. 

  2545. 

  2546. ----
    2547. 

  2547. 

  2548. .. _class_DisplayServer_method_is_touchscreen_available:
    2549. 

  2549. 

  2550. .. rst-class:: classref-method
    2551. 

  2551. 

  2552. :ref:`bool<class_bool>` **is_touchscreen_available** **(** **)** |const|
    2553. 

  2553. 

  2554. Returns ``true`` if touch events are available (Android or iOS), the capability is detected on the Webplatform or if :ref:`ProjectSettings.input_devices/pointing/emulate_touch_from_mouse<class_ProjectSettings_property_input_devices/pointing/emulate_touch_from_mouse>` is ``true``.
    2555. 

  2555. 

  2556. .. rst-class:: classref-item-separator
    2557. 

  2557. 

  2558. ----
    2559. 

  2559. 

  2560. .. _class_DisplayServer_method_keyboard_get_current_layout:
    2561. 

  2561. 

  2562. .. rst-class:: classref-method
    2563. 

  2563. 

  2564. :ref:`int<class_int>` **keyboard_get_current_layout** **(** **)** |const|
    2565. 

  2565. 

  2566. Returns active keyboard layout index.
    2567. 

  2567. 

  2568. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    2569. 

  2569. 

  2570. .. rst-class:: classref-item-separator
    2571. 

  2571. 

  2572. ----
    2573. 

  2573. 

  2574. .. _class_DisplayServer_method_keyboard_get_keycode_from_physical:
    2575. 

  2575. 

  2576. .. rst-class:: classref-method
    2577. 

  2577. 

  2578. :ref:`Key<enum_@GlobalScope_Key>` **keyboard_get_keycode_from_physical** **(** :ref:`Key<enum_@GlobalScope_Key>` keycode **)** |const|
    2579. 

  2579. 

  2580. Converts a physical (US QWERTY) ``keycode`` to one in the active keyboard layout.
    2581. 

  2581. 

  2582. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    2583. 

  2583. 

  2584. .. rst-class:: classref-item-separator
    2585. 

  2585. 

  2586. ----
    2587. 

  2587. 

  2588. .. _class_DisplayServer_method_keyboard_get_label_from_physical:
    2589. 

  2589. 

  2590. .. rst-class:: classref-method
    2591. 

  2591. 

  2592. :ref:`Key<enum_@GlobalScope_Key>` **keyboard_get_label_from_physical** **(** :ref:`Key<enum_@GlobalScope_Key>` keycode **)** |const|
    2593. 

  2593. 

  2594. Converts a physical (US QWERTY) ``keycode`` to localized label printed on the key in the active keyboard layout.
    2595. 

  2595. 

  2596. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    2597. 

  2597. 

  2598. .. rst-class:: classref-item-separator
    2599. 

  2599. 

  2600. ----
    2601. 

  2601. 

  2602. .. _class_DisplayServer_method_keyboard_get_layout_count:
    2603. 

  2603. 

  2604. .. rst-class:: classref-method
    2605. 

  2605. 

  2606. :ref:`int<class_int>` **keyboard_get_layout_count** **(** **)** |const|
    2607. 

  2607. 

  2608. Returns the number of keyboard layouts.
    2609. 

  2609. 

  2610. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    2611. 

  2611. 

  2612. .. rst-class:: classref-item-separator
    2613. 

  2613. 

  2614. ----
    2615. 

  2615. 

  2616. .. _class_DisplayServer_method_keyboard_get_layout_language:
    2617. 

  2617. 

  2618. .. rst-class:: classref-method
    2619. 

  2619. 

  2620. :ref:`String<class_String>` **keyboard_get_layout_language** **(** :ref:`int<class_int>` index **)** |const|
    2621. 

  2621. 

  2622. Returns the ISO-639/BCP-47 language code of the keyboard layout at position ``index``.
    2623. 

  2623. 

  2624. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    2625. 

  2625. 

  2626. .. rst-class:: classref-item-separator
    2627. 

  2627. 

  2628. ----
    2629. 

  2629. 

  2630. .. _class_DisplayServer_method_keyboard_get_layout_name:
    2631. 

  2631. 

  2632. .. rst-class:: classref-method
    2633. 

  2633. 

  2634. :ref:`String<class_String>` **keyboard_get_layout_name** **(** :ref:`int<class_int>` index **)** |const|
    2635. 

  2635. 

  2636. Returns the localized name of the keyboard layout at position ``index``.
    2637. 

  2637. 

  2638. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    2639. 

  2639. 

  2640. .. rst-class:: classref-item-separator
    2641. 

  2641. 

  2642. ----
    2643. 

  2643. 

  2644. .. _class_DisplayServer_method_keyboard_set_current_layout:
    2645. 

  2645. 

  2646. .. rst-class:: classref-method
    2647. 

  2647. 

  2648. void **keyboard_set_current_layout** **(** :ref:`int<class_int>` index **)**
    2649. 

  2649. 

  2650. Sets the active keyboard layout.
    2651. 

  2651. 

  2652. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    2653. 

  2653. 

  2654. .. rst-class:: classref-item-separator
    2655. 

  2655. 

  2656. ----
    2657. 

  2657. 

  2658. .. _class_DisplayServer_method_mouse_get_button_state:
    2659. 

  2659. 

  2660. .. rst-class:: classref-method
    2661. 

  2661. 

  2662. |bitfield|\<:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>`\> **mouse_get_button_state** **(** **)** |const|
    2663. 

  2663. 

  2664. 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>`.
    2665. 

  2665. 

  2666. .. rst-class:: classref-item-separator
    2667. 

  2667. 

  2668. ----
    2669. 

  2669. 

  2670. .. _class_DisplayServer_method_mouse_get_mode:
    2671. 

  2671. 

  2672. .. rst-class:: classref-method
    2673. 

  2673. 

  2674. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **mouse_get_mode** **(** **)** |const|
    2675. 

  2675. 

  2676. Returns the current mouse mode. See also :ref:`mouse_set_mode<class_DisplayServer_method_mouse_set_mode>`.
    2677. 

  2677. 

  2678. .. rst-class:: classref-item-separator
    2679. 

  2679. 

  2680. ----
    2681. 

  2681. 

  2682. .. _class_DisplayServer_method_mouse_get_position:
    2683. 

  2683. 

  2684. .. rst-class:: classref-method
    2685. 

  2685. 

  2686. :ref:`Vector2i<class_Vector2i>` **mouse_get_position** **(** **)** |const|
    2687. 

  2687. 

  2688. Returns the mouse cursor's current position in screen coordinates.
    2689. 

  2689. 

  2690. .. rst-class:: classref-item-separator
    2691. 

  2691. 

  2692. ----
    2693. 

  2693. 

  2694. .. _class_DisplayServer_method_mouse_set_mode:
    2695. 

  2695. 

  2696. .. rst-class:: classref-method
    2697. 

  2697. 

  2698. void **mouse_set_mode** **(** :ref:`MouseMode<enum_DisplayServer_MouseMode>` mouse_mode **)**
    2699. 

  2699. 

  2700. Sets the current mouse mode. See also :ref:`mouse_get_mode<class_DisplayServer_method_mouse_get_mode>`.
    2701. 

  2701. 

  2702. .. rst-class:: classref-item-separator
    2703. 

  2703. 

  2704. ----
    2705. 

  2705. 

  2706. .. _class_DisplayServer_method_process_events:
    2707. 

  2707. 

  2708. .. rst-class:: classref-method
    2709. 

  2709. 

  2710. void **process_events** **(** **)**
    2711. 

  2711. 

  2712. 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>`.
    2713. 

  2713. 

  2714. .. rst-class:: classref-item-separator
    2715. 

  2715. 

  2716. ----
    2717. 

  2717. 

  2718. .. _class_DisplayServer_method_screen_get_dpi:
    2719. 

  2719. 

  2720. .. rst-class:: classref-method
    2721. 

  2721. 

  2722. :ref:`int<class_int>` **screen_get_dpi** **(** :ref:`int<class_int>` screen=-1 **)** |const|
    2723. 

  2723. 

  2724. 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.
    2725. 

  2725. 

  2726. \ **Note:** On macOS, returned value is inaccurate if fractional display scaling mode is used.
    2727. 

  2727. 

  2728. \ **Note:** On Android devices, the actual screen densities are grouped into six generalized densities:
    2729. 

  2729. 

  2730. ::
    2731. 

  2731. 

  2732.        ldpi - 120 dpi
    2733. 

  2733.        mdpi - 160 dpi
    2734. 

  2734.        hdpi - 240 dpi
    2735. 

  2735.       xhdpi - 320 dpi
    2736. 

  2736.      xxhdpi - 480 dpi
    2737. 

  2737.     xxxhdpi - 640 dpi
    2738. 

  2738. 

  2739. \ **Note:** This method is implemented on Android, Linux (X11), macOS and Windows. Returns ``72`` on unsupported platforms.
    2740. 

  2740. 

  2741. .. rst-class:: classref-item-separator
    2742. 

  2742. 

  2743. ----
    2744. 

  2744. 

  2745. .. _class_DisplayServer_method_screen_get_image:
    2746. 

  2746. 

  2747. .. rst-class:: classref-method
    2748. 

  2748. 

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

  2750. 

  2751. Returns screenshot of the ``screen``.
    2752. 

  2752. 

  2753. \ **Note:** This method is implemented on Linux (X11), macOS, and Windows.
    2754. 

  2754. 

  2755. \ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.
    2756. 

  2756. 

  2757. .. rst-class:: classref-item-separator
    2758. 

  2758. 

  2759. ----
    2760. 

  2760. 

  2761. .. _class_DisplayServer_method_screen_get_max_scale:
    2762. 

  2762. 

  2763. .. rst-class:: classref-method
    2764. 

  2764. 

  2765. :ref:`float<class_float>` **screen_get_max_scale** **(** **)** |const|
    2766. 

  2766. 

  2767. Returns the greatest scale factor of all screens.
    2768. 

  2768. 

  2769. \ **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.
    2770. 

  2770. 

  2771. \ **Note:** This method is implemented only on macOS.
    2772. 

  2772. 

  2773. .. rst-class:: classref-item-separator
    2774. 

  2774. 

  2775. ----
    2776. 

  2776. 

  2777. .. _class_DisplayServer_method_screen_get_orientation:
    2778. 

  2778. 

  2779. .. rst-class:: classref-method
    2780. 

  2780. 

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

  2782. 

  2783. Returns the ``screen``'s current orientation. See also :ref:`screen_set_orientation<class_DisplayServer_method_screen_set_orientation>`.
    2784. 

  2784. 

  2785. \ **Note:** This method is implemented on Android and iOS.
    2786. 

  2786. 

  2787. .. rst-class:: classref-item-separator
    2788. 

  2788. 

  2789. ----
    2790. 

  2790. 

  2791. .. _class_DisplayServer_method_screen_get_pixel:
    2792. 

  2792. 

  2793. .. rst-class:: classref-method
    2794. 

  2794. 

  2795. :ref:`Color<class_Color>` **screen_get_pixel** **(** :ref:`Vector2i<class_Vector2i>` position **)** |const|
    2796. 

  2796. 

  2797. Returns color of the display pixel at the ``position``.
    2798. 

  2798. 

  2799. \ **Note:** This method is implemented on Linux (X11), macOS, and Windows.
    2800. 

  2800. 

  2801. \ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.
    2802. 

  2802. 

  2803. .. rst-class:: classref-item-separator
    2804. 

  2804. 

  2805. ----
    2806. 

  2806. 

  2807. .. _class_DisplayServer_method_screen_get_position:
    2808. 

  2808. 

  2809. .. rst-class:: classref-method
    2810. 

  2810. 

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

  2812. 

  2813. 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:
    2814. 

  2814. 

  2815. ::
    2816. 

  2816. 

  2817.     * (0, 0)        +-------+
    2818. 

  2818.                     |       |
    2819. 

  2819.     +-------------+ |       |
    2820. 

  2820.     |             | |       |
    2821. 

  2821.     |             | |       |
    2822. 

  2822.     +-------------+ +-------+
    2823. 

  2823. 

  2824. See also :ref:`screen_get_size<class_DisplayServer_method_screen_get_size>`.
    2825. 

  2825. 

  2826. .. rst-class:: classref-item-separator
    2827. 

  2827. 

  2828. ----
    2829. 

  2829. 

  2830. .. _class_DisplayServer_method_screen_get_refresh_rate:
    2831. 

  2831. 

  2832. .. rst-class:: classref-method
    2833. 

  2833. 

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

  2835. 

  2836. 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.
    2837. 

  2837. 

  2838. \ **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.
    2839. 

  2839. 

  2840. To fallback to a default refresh rate if the method fails, try:
    2841. 

  2841. 

  2842. ::
    2843. 

  2843. 

  2844.     var refresh_rate = DisplayServer.screen_get_refresh_rate()
    2845. 

  2845.     if refresh_rate < 0:
    2846. 

  2846.         refresh_rate = 60.0
    2847. 

  2847. 

  2848. .. rst-class:: classref-item-separator
    2849. 

  2849. 

  2850. ----
    2851. 

  2851. 

  2852. .. _class_DisplayServer_method_screen_get_scale:
    2853. 

  2853. 

  2854. .. rst-class:: classref-method
    2855. 

  2855. 

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

  2857. 

  2858. Returns the scale factor of the specified screen by index.
    2859. 

  2859. 

  2860. \ **Note:** On macOS returned value is ``2.0`` for hiDPI (Retina) screen, and ``1.0`` for all other cases.
    2861. 

  2861. 

  2862. \ **Note:** This method is implemented only on macOS.
    2863. 

  2863. 

  2864. .. rst-class:: classref-item-separator
    2865. 

  2865. 

  2866. ----
    2867. 

  2867. 

  2868. .. _class_DisplayServer_method_screen_get_size:
    2869. 

  2869. 

  2870. .. rst-class:: classref-method
    2871. 

  2871. 

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

  2873. 

  2874. 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>`.
    2875. 

  2875. 

  2876. .. rst-class:: classref-item-separator
    2877. 

  2877. 

  2878. ----
    2879. 

  2879. 

  2880. .. _class_DisplayServer_method_screen_get_usable_rect:
    2881. 

  2881. 

  2882. .. rst-class:: classref-method
    2883. 

  2883. 

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

  2885. 

  2886. 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>`.
    2887. 

  2887. 

  2888. .. rst-class:: classref-item-separator
    2889. 

  2889. 

  2890. ----
    2891. 

  2891. 

  2892. .. _class_DisplayServer_method_screen_is_kept_on:
    2893. 

  2893. 

  2894. .. rst-class:: classref-method
    2895. 

  2895. 

  2896. :ref:`bool<class_bool>` **screen_is_kept_on** **(** **)** |const|
    2897. 

  2897. 

  2898. 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>`.
    2899. 

  2899. 

  2900. .. rst-class:: classref-item-separator
    2901. 

  2901. 

  2902. ----
    2903. 

  2903. 

  2904. .. _class_DisplayServer_method_screen_set_keep_on:
    2905. 

  2905. 

  2906. .. rst-class:: classref-method
    2907. 

  2907. 

  2908. void **screen_set_keep_on** **(** :ref:`bool<class_bool>` enable **)**
    2909. 

  2909. 

  2910. 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>`.
    2911. 

  2911. 

  2912. .. rst-class:: classref-item-separator
    2913. 

  2913. 

  2914. ----
    2915. 

  2915. 

  2916. .. _class_DisplayServer_method_screen_set_orientation:
    2917. 

  2917. 

  2918. .. rst-class:: classref-method
    2919. 

  2919. 

  2920. void **screen_set_orientation** **(** :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` orientation, :ref:`int<class_int>` screen=-1 **)**
    2921. 

  2921. 

  2922. Sets the ``screen``'s ``orientation``. See also :ref:`screen_get_orientation<class_DisplayServer_method_screen_get_orientation>`.
    2923. 

  2923. 

  2924. \ **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>`.
    2925. 

  2925. 

  2926. .. rst-class:: classref-item-separator
    2927. 

  2927. 

  2928. ----
    2929. 

  2929. 

  2930. .. _class_DisplayServer_method_set_icon:
    2931. 

  2931. 

  2932. .. rst-class:: classref-method
    2933. 

  2933. 

  2934. void **set_icon** **(** :ref:`Image<class_Image>` image **)**
    2935. 

  2935. 

  2936. 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.
    2937. 

  2937. 

  2938. .. rst-class:: classref-item-separator
    2939. 

  2939. 

  2940. ----
    2941. 

  2941. 

  2942. .. _class_DisplayServer_method_set_native_icon:
    2943. 

  2943. 

  2944. .. rst-class:: classref-method
    2945. 

  2945. 

  2946. void **set_native_icon** **(** :ref:`String<class_String>` filename **)**
    2947. 

  2947. 

  2948. 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.
    2949. 

  2949. 

  2950. .. rst-class:: classref-item-separator
    2951. 

  2951. 

  2952. ----
    2953. 

  2953. 

  2954. .. _class_DisplayServer_method_tablet_get_current_driver:
    2955. 

  2955. 

  2956. .. rst-class:: classref-method
    2957. 

  2957. 

  2958. :ref:`String<class_String>` **tablet_get_current_driver** **(** **)** |const|
    2959. 

  2959. 

  2960. Returns current active tablet driver name.
    2961. 

  2961. 

  2962. \ **Note:** This method is implemented only on Windows.
    2963. 

  2963. 

  2964. .. rst-class:: classref-item-separator
    2965. 

  2965. 

  2966. ----
    2967. 

  2967. 

  2968. .. _class_DisplayServer_method_tablet_get_driver_count:
    2969. 

  2969. 

  2970. .. rst-class:: classref-method
    2971. 

  2971. 

  2972. :ref:`int<class_int>` **tablet_get_driver_count** **(** **)** |const|
    2973. 

  2973. 

  2974. Returns the total number of available tablet drivers.
    2975. 

  2975. 

  2976. \ **Note:** This method is implemented only on Windows.
    2977. 

  2977. 

  2978. .. rst-class:: classref-item-separator
    2979. 

  2979. 

  2980. ----
    2981. 

  2981. 

  2982. .. _class_DisplayServer_method_tablet_get_driver_name:
    2983. 

  2983. 

  2984. .. rst-class:: classref-method
    2985. 

  2985. 

  2986. :ref:`String<class_String>` **tablet_get_driver_name** **(** :ref:`int<class_int>` idx **)** |const|
    2987. 

  2987. 

  2988. Returns the tablet driver name for the given index.
    2989. 

  2989. 

  2990. \ **Note:** This method is implemented only on Windows.
    2991. 

  2991. 

  2992. .. rst-class:: classref-item-separator
    2993. 

  2993. 

  2994. ----
    2995. 

  2995. 

  2996. .. _class_DisplayServer_method_tablet_set_current_driver:
    2997. 

  2997. 

  2998. .. rst-class:: classref-method
    2999. 

  2999. 

  3000. void **tablet_set_current_driver** **(** :ref:`String<class_String>` name **)**
    3001. 

  3001. 

  3002. Set active tablet driver name.
    3003. 

  3003. 

  3004. \ **Note:** This method is implemented only on Windows.
    3005. 

  3005. 

  3006. .. rst-class:: classref-item-separator
    3007. 

  3007. 

  3008. ----
    3009. 

  3009. 

  3010. .. _class_DisplayServer_method_tts_get_voices:
    3011. 

  3011. 

  3012. .. rst-class:: classref-method
    3013. 

  3013. 

  3014. :ref:`Dictionary[]<class_Dictionary>` **tts_get_voices** **(** **)** |const|
    3015. 

  3015. 

  3016. Returns an :ref:`Array<class_Array>` of voice information dictionaries.
    3017. 

  3017. 

  3018. Each :ref:`Dictionary<class_Dictionary>` contains two :ref:`String<class_String>` entries:
    3019. 

  3019. 

  3020. - ``name`` is voice name.
    3021. 

  3021. 

  3022. - ``id`` is voice identifier.
    3023. 

  3023. 

  3024. - ``language`` is language code in ``lang_Variant`` format. ``lang`` part is a 2 or 3-letter code based on the ISO-639 standard, in lowercase. And ``Variant`` part is an engine dependent string describing country, region or/and dialect.
    3025. 

  3025. 

  3026. 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.
    3027. 

  3027. 

  3028. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    3029. 

  3029. 

  3030. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3031. 

  3031. 

  3032. .. rst-class:: classref-item-separator
    3033. 

  3033. 

  3034. ----
    3035. 

  3035. 

  3036. .. _class_DisplayServer_method_tts_get_voices_for_language:
    3037. 

  3037. 

  3038. .. rst-class:: classref-method
    3039. 

  3039. 

  3040. :ref:`PackedStringArray<class_PackedStringArray>` **tts_get_voices_for_language** **(** :ref:`String<class_String>` language **)** |const|
    3041. 

  3041. 

  3042. Returns an :ref:`PackedStringArray<class_PackedStringArray>` of voice identifiers for the ``language``.
    3043. 

  3043. 

  3044. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    3045. 

  3045. 

  3046. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3047. 

  3047. 

  3048. .. rst-class:: classref-item-separator
    3049. 

  3049. 

  3050. ----
    3051. 

  3051. 

  3052. .. _class_DisplayServer_method_tts_is_paused:
    3053. 

  3053. 

  3054. .. rst-class:: classref-method
    3055. 

  3055. 

  3056. :ref:`bool<class_bool>` **tts_is_paused** **(** **)** |const|
    3057. 

  3057. 

  3058. Returns ``true`` if the synthesizer is in a paused state.
    3059. 

  3059. 

  3060. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    3061. 

  3061. 

  3062. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3063. 

  3063. 

  3064. .. rst-class:: classref-item-separator
    3065. 

  3065. 

  3066. ----
    3067. 

  3067. 

  3068. .. _class_DisplayServer_method_tts_is_speaking:
    3069. 

  3069. 

  3070. .. rst-class:: classref-method
    3071. 

  3071. 

  3072. :ref:`bool<class_bool>` **tts_is_speaking** **(** **)** |const|
    3073. 

  3073. 

  3074. Returns ``true`` if the synthesizer is generating speech, or have utterance waiting in the queue.
    3075. 

  3075. 

  3076. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    3077. 

  3077. 

  3078. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3079. 

  3079. 

  3080. .. rst-class:: classref-item-separator
    3081. 

  3081. 

  3082. ----
    3083. 

  3083. 

  3084. .. _class_DisplayServer_method_tts_pause:
    3085. 

  3085. 

  3086. .. rst-class:: classref-method
    3087. 

  3087. 

  3088. void **tts_pause** **(** **)**
    3089. 

  3089. 

  3090. Puts the synthesizer into a paused state.
    3091. 

  3091. 

  3092. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    3093. 

  3093. 

  3094. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3095. 

  3095. 

  3096. .. rst-class:: classref-item-separator
    3097. 

  3097. 

  3098. ----
    3099. 

  3099. 

  3100. .. _class_DisplayServer_method_tts_resume:
    3101. 

  3101. 

  3102. .. rst-class:: classref-method
    3103. 

  3103. 

  3104. void **tts_resume** **(** **)**
    3105. 

  3105. 

  3106. Resumes the synthesizer if it was paused.
    3107. 

  3107. 

  3108. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    3109. 

  3109. 

  3110. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3111. 

  3111. 

  3112. .. rst-class:: classref-item-separator
    3113. 

  3113. 

  3114. ----
    3115. 

  3115. 

  3116. .. _class_DisplayServer_method_tts_set_utterance_callback:
    3117. 

  3117. 

  3118. .. rst-class:: classref-method
    3119. 

  3119. 

  3120. void **tts_set_utterance_callback** **(** :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` event, :ref:`Callable<class_Callable>` callable **)**
    3121. 

  3121. 

  3122. Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary.
    3123. 

  3123. 

  3124. - :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.
    3125. 

  3125. 

  3126. - :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.
    3127. 

  3127. 

  3128. \ **Note:** The granularity of the boundary callbacks is engine dependent.
    3129. 

  3129. 

  3130. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    3131. 

  3131. 

  3132. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3133. 

  3133. 

  3134. .. rst-class:: classref-item-separator
    3135. 

  3135. 

  3136. ----
    3137. 

  3137. 

  3138. .. _class_DisplayServer_method_tts_speak:
    3139. 

  3139. 

  3140. .. rst-class:: classref-method
    3141. 

  3141. 

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

  3143. 

  3144. Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is cleared first.
    3145. 

  3145. 

  3146. - ``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>`.
    3147. 

  3147. 

  3148. - ``volume`` ranges from ``0`` (lowest) to ``100`` (highest).
    3149. 

  3149. 

  3150. - ``pitch`` ranges from ``0.0`` (lowest) to ``2.0`` (highest), ``1.0`` is default pitch for the current voice.
    3151. 

  3151. 

  3152. - ``rate`` ranges from ``0.1`` (lowest) to ``10.0`` (highest), ``1.0`` is a normal speaking rate. Other values act as a percentage relative.
    3153. 

  3153. 

  3154. - ``utterance_id`` is passed as a parameter to the callback functions.
    3155. 

  3155. 

  3156. \ **Note:** On Windows and Linux (X11), utterance ``text`` can use SSML markup. SSML support is engine and voice dependent. If the engine does not support SSML, you should strip out all XML markup before calling :ref:`tts_speak<class_DisplayServer_method_tts_speak>`.
    3157. 

  3157. 

  3158. \ **Note:** The granularity of pitch, rate, and volume is engine and voice dependent. Values may be truncated.
    3159. 

  3159. 

  3160. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    3161. 

  3161. 

  3162. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3163. 

  3163. 

  3164. .. rst-class:: classref-item-separator
    3165. 

  3165. 

  3166. ----
    3167. 

  3167. 

  3168. .. _class_DisplayServer_method_tts_stop:
    3169. 

  3169. 

  3170. .. rst-class:: classref-method
    3171. 

  3171. 

  3172. void **tts_stop** **(** **)**
    3173. 

  3173. 

  3174. Stops synthesis in progress and removes all utterances from the queue.
    3175. 

  3175. 

  3176. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.
    3177. 

  3177. 

  3178. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3179. 

  3179. 

  3180. .. rst-class:: classref-item-separator
    3181. 

  3181. 

  3182. ----
    3183. 

  3183. 

  3184. .. _class_DisplayServer_method_virtual_keyboard_get_height:
    3185. 

  3185. 

  3186. .. rst-class:: classref-method
    3187. 

  3187. 

  3188. :ref:`int<class_int>` **virtual_keyboard_get_height** **(** **)** |const|
    3189. 

  3189. 

  3190. Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.
    3191. 

  3191. 

  3192. .. rst-class:: classref-item-separator
    3193. 

  3193. 

  3194. ----
    3195. 

  3195. 

  3196. .. _class_DisplayServer_method_virtual_keyboard_hide:
    3197. 

  3197. 

  3198. .. rst-class:: classref-method
    3199. 

  3199. 

  3200. void **virtual_keyboard_hide** **(** **)**
    3201. 

  3201. 

  3202. Hides the virtual keyboard if it is shown, does nothing otherwise.
    3203. 

  3203. 

  3204. .. rst-class:: classref-item-separator
    3205. 

  3205. 

  3206. ----
    3207. 

  3207. 

  3208. .. _class_DisplayServer_method_virtual_keyboard_show:
    3209. 

  3209. 

  3210. .. rst-class:: classref-method
    3211. 

  3211. 

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

  3213. 

  3214. Shows the virtual keyboard if the platform has one.
    3215. 

  3215. 

  3216. \ ``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).
    3217. 

  3217. 

  3218. \ ``position`` parameter is the screen space :ref:`Rect2<class_Rect2>` of the edited text.
    3219. 

  3219. 

  3220. \ ``type`` parameter allows configuring which type of virtual keyboard to show.
    3221. 

  3221. 

  3222. \ ``max_length`` limits the number of characters that can be entered if different from ``-1``.
    3223. 

  3223. 

  3224. \ ``cursor_start`` can optionally define the current text cursor position if ``cursor_end`` is not set.
    3225. 

  3225. 

  3226. \ ``cursor_start`` and ``cursor_end`` can optionally define the current text selection.
    3227. 

  3227. 

  3228. \ **Note:** This method is implemented on Android, iOS and Web.
    3229. 

  3229. 

  3230. .. rst-class:: classref-item-separator
    3231. 

  3231. 

  3232. ----
    3233. 

  3233. 

  3234. .. _class_DisplayServer_method_warp_mouse:
    3235. 

  3235. 

  3236. .. rst-class:: classref-method
    3237. 

  3237. 

  3238. void **warp_mouse** **(** :ref:`Vector2i<class_Vector2i>` position **)**
    3239. 

  3239. 

  3240. 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.
    3241. 

  3241. 

  3242. \ **Note:** :ref:`warp_mouse<class_DisplayServer_method_warp_mouse>` is only supported on Windows, macOS and Linux. It has no effect on Android, iOS and Web.
    3243. 

  3243. 

  3244. .. rst-class:: classref-item-separator
    3245. 

  3245. 

  3246. ----
    3247. 

  3247. 

  3248. .. _class_DisplayServer_method_window_can_draw:
    3249. 

  3249. 

  3250. .. rst-class:: classref-method
    3251. 

  3251. 

  3252. :ref:`bool<class_bool>` **window_can_draw** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3253. 

  3253. 

  3254. 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``.
    3255. 

  3255. 

  3256. .. rst-class:: classref-item-separator
    3257. 

  3257. 

  3258. ----
    3259. 

  3259. 

  3260. .. _class_DisplayServer_method_window_get_active_popup:
    3261. 

  3261. 

  3262. .. rst-class:: classref-method
    3263. 

  3263. 

  3264. :ref:`int<class_int>` **window_get_active_popup** **(** **)** |const|
    3265. 

  3265. 

  3266. Returns ID of the active popup window, or :ref:`INVALID_WINDOW_ID<class_DisplayServer_constant_INVALID_WINDOW_ID>` if there is none.
    3267. 

  3267. 

  3268. .. rst-class:: classref-item-separator
    3269. 

  3269. 

  3270. ----
    3271. 

  3271. 

  3272. .. _class_DisplayServer_method_window_get_attached_instance_id:
    3273. 

  3273. 

  3274. .. rst-class:: classref-method
    3275. 

  3275. 

  3276. :ref:`int<class_int>` **window_get_attached_instance_id** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3277. 

  3277. 

  3278. 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.
    3279. 

  3279. 

  3280. .. rst-class:: classref-item-separator
    3281. 

  3281. 

  3282. ----
    3283. 

  3283. 

  3284. .. _class_DisplayServer_method_window_get_current_screen:
    3285. 

  3285. 

  3286. .. rst-class:: classref-method
    3287. 

  3287. 

  3288. :ref:`int<class_int>` **window_get_current_screen** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3289. 

  3289. 

  3290. 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>`.
    3291. 

  3291. 

  3292. .. rst-class:: classref-item-separator
    3293. 

  3293. 

  3294. ----
    3295. 

  3295. 

  3296. .. _class_DisplayServer_method_window_get_flag:
    3297. 

  3297. 

  3298. .. rst-class:: classref-method
    3299. 

  3299. 

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

  3301. 

  3302. Returns the current value of the given window's ``flag``.
    3303. 

  3303. 

  3304. .. rst-class:: classref-item-separator
    3305. 

  3305. 

  3306. ----
    3307. 

  3307. 

  3308. .. _class_DisplayServer_method_window_get_max_size:
    3309. 

  3309. 

  3310. .. rst-class:: classref-method
    3311. 

  3311. 

  3312. :ref:`Vector2i<class_Vector2i>` **window_get_max_size** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3313. 

  3313. 

  3314. Returns the window's maximum size (in pixels). See also :ref:`window_set_max_size<class_DisplayServer_method_window_set_max_size>`.
    3315. 

  3315. 

  3316. .. rst-class:: classref-item-separator
    3317. 

  3317. 

  3318. ----
    3319. 

  3319. 

  3320. .. _class_DisplayServer_method_window_get_min_size:
    3321. 

  3321. 

  3322. .. rst-class:: classref-method
    3323. 

  3323. 

  3324. :ref:`Vector2i<class_Vector2i>` **window_get_min_size** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3325. 

  3325. 

  3326. Returns the window's minimum size (in pixels). See also :ref:`window_set_min_size<class_DisplayServer_method_window_set_min_size>`.
    3327. 

  3327. 

  3328. .. rst-class:: classref-item-separator
    3329. 

  3329. 

  3330. ----
    3331. 

  3331. 

  3332. .. _class_DisplayServer_method_window_get_mode:
    3333. 

  3333. 

  3334. .. rst-class:: classref-method
    3335. 

  3335. 

  3336. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **window_get_mode** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3337. 

  3337. 

  3338. Returns the mode of the given window.
    3339. 

  3339. 

  3340. .. rst-class:: classref-item-separator
    3341. 

  3341. 

  3342. ----
    3343. 

  3343. 

  3344. .. _class_DisplayServer_method_window_get_native_handle:
    3345. 

  3345. 

  3346. .. rst-class:: classref-method
    3347. 

  3347. 

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

  3349. 

  3350. Returns internal structure pointers for use in plugins.
    3351. 

  3351. 

  3352. \ **Note:** This method is implemented on Android, Linux (X11), macOS and Windows.
    3353. 

  3353. 

  3354. .. rst-class:: classref-item-separator
    3355. 

  3355. 

  3356. ----
    3357. 

  3357. 

  3358. .. _class_DisplayServer_method_window_get_popup_safe_rect:
    3359. 

  3359. 

  3360. .. rst-class:: classref-method
    3361. 

  3361. 

  3362. :ref:`Rect2i<class_Rect2i>` **window_get_popup_safe_rect** **(** :ref:`int<class_int>` window **)** |const|
    3363. 

  3363. 

  3364. Returns the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system.
    3365. 

  3365. 

  3366. .. rst-class:: classref-item-separator
    3367. 

  3367. 

  3368. ----
    3369. 

  3369. 

  3370. .. _class_DisplayServer_method_window_get_position:
    3371. 

  3371. 

  3372. .. rst-class:: classref-method
    3373. 

  3373. 

  3374. :ref:`Vector2i<class_Vector2i>` **window_get_position** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3375. 

  3375. 

  3376. Returns the position of the client area of the given window on the screen.
    3377. 

  3377. 

  3378. .. rst-class:: classref-item-separator
    3379. 

  3379. 

  3380. ----
    3381. 

  3381. 

  3382. .. _class_DisplayServer_method_window_get_position_with_decorations:
    3383. 

  3383. 

  3384. .. rst-class:: classref-method
    3385. 

  3385. 

  3386. :ref:`Vector2i<class_Vector2i>` **window_get_position_with_decorations** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3387. 

  3387. 

  3388. 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>`.
    3389. 

  3389. 

  3390. .. rst-class:: classref-item-separator
    3391. 

  3391. 

  3392. ----
    3393. 

  3393. 

  3394. .. _class_DisplayServer_method_window_get_safe_title_margins:
    3395. 

  3395. 

  3396. .. rst-class:: classref-method
    3397. 

  3397. 

  3398. :ref:`Vector3i<class_Vector3i>` **window_get_safe_title_margins** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3399. 

  3399. 

  3400. 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.
    3401. 

  3401. 

  3402. .. rst-class:: classref-item-separator
    3403. 

  3403. 

  3404. ----
    3405. 

  3405. 

  3406. .. _class_DisplayServer_method_window_get_size:
    3407. 

  3407. 

  3408. .. rst-class:: classref-method
    3409. 

  3409. 

  3410. :ref:`Vector2i<class_Vector2i>` **window_get_size** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3411. 

  3411. 

  3412. 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>`.
    3413. 

  3413. 

  3414. .. rst-class:: classref-item-separator
    3415. 

  3415. 

  3416. ----
    3417. 

  3417. 

  3418. .. _class_DisplayServer_method_window_get_size_with_decorations:
    3419. 

  3419. 

  3420. .. rst-class:: classref-method
    3421. 

  3421. 

  3422. :ref:`Vector2i<class_Vector2i>` **window_get_size_with_decorations** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3423. 

  3423. 

  3424. 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>`.
    3425. 

  3425. 

  3426. .. rst-class:: classref-item-separator
    3427. 

  3427. 

  3428. ----
    3429. 

  3429. 

  3430. .. _class_DisplayServer_method_window_get_vsync_mode:
    3431. 

  3431. 

  3432. .. rst-class:: classref-method
    3433. 

  3433. 

  3434. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **window_get_vsync_mode** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3435. 

  3435. 

  3436. Returns the V-Sync mode of the given window.
    3437. 

  3437. 

  3438. .. rst-class:: classref-item-separator
    3439. 

  3439. 

  3440. ----
    3441. 

  3441. 

  3442. .. _class_DisplayServer_method_window_is_focused:
    3443. 

  3443. 

  3444. .. rst-class:: classref-method
    3445. 

  3445. 

  3446. :ref:`bool<class_bool>` **window_is_focused** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3447. 

  3447. 

  3448. Returns ``true`` if the window specified by ``window_id`` is focused.
    3449. 

  3449. 

  3450. .. rst-class:: classref-item-separator
    3451. 

  3451. 

  3452. ----
    3453. 

  3453. 

  3454. .. _class_DisplayServer_method_window_is_maximize_allowed:
    3455. 

  3455. 

  3456. .. rst-class:: classref-method
    3457. 

  3457. 

  3458. :ref:`bool<class_bool>` **window_is_maximize_allowed** **(** :ref:`int<class_int>` window_id=0 **)** |const|
    3459. 

  3459. 

  3460. Returns ``true`` if the given window can be maximized (the maximize button is enabled).
    3461. 

  3461. 

  3462. .. rst-class:: classref-item-separator
    3463. 

  3463. 

  3464. ----
    3465. 

  3465. 

  3466. .. _class_DisplayServer_method_window_maximize_on_title_dbl_click:
    3467. 

  3467. 

  3468. .. rst-class:: classref-method
    3469. 

  3469. 

  3470. :ref:`bool<class_bool>` **window_maximize_on_title_dbl_click** **(** **)** |const|
    3471. 

  3471. 

  3472. Returns ``true``, if double-click on a window title should maximize it.
    3473. 

  3473. 

  3474. \ **Note:** This method is implemented only on macOS.
    3475. 

  3475. 

  3476. .. rst-class:: classref-item-separator
    3477. 

  3477. 

  3478. ----
    3479. 

  3479. 

  3480. .. _class_DisplayServer_method_window_minimize_on_title_dbl_click:
    3481. 

  3481. 

  3482. .. rst-class:: classref-method
    3483. 

  3483. 

  3484. :ref:`bool<class_bool>` **window_minimize_on_title_dbl_click** **(** **)** |const|
    3485. 

  3485. 

  3486. Returns ``true``, if double-click on a window title should minimize it.
    3487. 

  3487. 

  3488. \ **Note:** This method is implemented only on macOS.
    3489. 

  3489. 

  3490. .. rst-class:: classref-item-separator
    3491. 

  3491. 

  3492. ----
    3493. 

  3493. 

  3494. .. _class_DisplayServer_method_window_move_to_foreground:
    3495. 

  3495. 

  3496. .. rst-class:: classref-method
    3497. 

  3497. 

  3498. void **window_move_to_foreground** **(** :ref:`int<class_int>` window_id=0 **)**
    3499. 

  3499. 

  3500. Moves the window specified by ``window_id`` to the foreground, so that it is visible over other windows.
    3501. 

  3501. 

  3502. .. rst-class:: classref-item-separator
    3503. 

  3503. 

  3504. ----
    3505. 

  3505. 

  3506. .. _class_DisplayServer_method_window_request_attention:
    3507. 

  3507. 

  3508. .. rst-class:: classref-method
    3509. 

  3509. 

  3510. void **window_request_attention** **(** :ref:`int<class_int>` window_id=0 **)**
    3511. 

  3511. 

  3512. 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.
    3513. 

  3513. 

  3514. .. rst-class:: classref-item-separator
    3515. 

  3515. 

  3516. ----
    3517. 

  3517. 

  3518. .. _class_DisplayServer_method_window_set_current_screen:
    3519. 

  3519. 

  3520. .. rst-class:: classref-method
    3521. 

  3521. 

  3522. void **window_set_current_screen** **(** :ref:`int<class_int>` screen, :ref:`int<class_int>` window_id=0 **)**
    3523. 

  3523. 

  3524. 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>`.
    3525. 

  3525. 

  3526. .. rst-class:: classref-item-separator
    3527. 

  3527. 

  3528. ----
    3529. 

  3529. 

  3530. .. _class_DisplayServer_method_window_set_drop_files_callback:
    3531. 

  3531. 

  3532. .. rst-class:: classref-method
    3533. 

  3533. 

  3534. void **window_set_drop_files_callback** **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**
    3535. 

  3535. 

  3536. 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``.
    3537. 

  3537. 

  3538. \ **Note:** This method is implemented on Windows, macOS, Linux (X11) and Web.
    3539. 

  3539. 

  3540. .. rst-class:: classref-item-separator
    3541. 

  3541. 

  3542. ----
    3543. 

  3543. 

  3544. .. _class_DisplayServer_method_window_set_exclusive:
    3545. 

  3545. 

  3546. .. rst-class:: classref-method
    3547. 

  3547. 

  3548. void **window_set_exclusive** **(** :ref:`int<class_int>` window_id, :ref:`bool<class_bool>` exclusive **)**
    3549. 

  3549. 

  3550. 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.
    3551. 

  3551. 

  3552. \ **Note:** On macOS, exclusive windows are confined to the same space (virtual desktop or screen) as the parent window.
    3553. 

  3553. 

  3554. \ **Note:** This method is implemented on macOS and Windows.
    3555. 

  3555. 

  3556. .. rst-class:: classref-item-separator
    3557. 

  3557. 

  3558. ----
    3559. 

  3559. 

  3560. .. _class_DisplayServer_method_window_set_flag:
    3561. 

  3561. 

  3562. .. rst-class:: classref-method
    3563. 

  3563. 

  3564. void **window_set_flag** **(** :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` flag, :ref:`bool<class_bool>` enabled, :ref:`int<class_int>` window_id=0 **)**
    3565. 

  3565. 

  3566. Enables or disables the given window's given ``flag``. See :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` for possible values and their behavior.
    3567. 

  3567. 

  3568. .. rst-class:: classref-item-separator
    3569. 

  3569. 

  3570. ----
    3571. 

  3571. 

  3572. .. _class_DisplayServer_method_window_set_ime_active:
    3573. 

  3573. 

  3574. .. rst-class:: classref-method
    3575. 

  3575. 

  3576. void **window_set_ime_active** **(** :ref:`bool<class_bool>` active, :ref:`int<class_int>` window_id=0 **)**
    3577. 

  3577. 

  3578. 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>`.
    3579. 

  3579. 

  3580. .. rst-class:: classref-item-separator
    3581. 

  3581. 

  3582. ----
    3583. 

  3583. 

  3584. .. _class_DisplayServer_method_window_set_ime_position:
    3585. 

  3585. 

  3586. .. rst-class:: classref-method
    3587. 

  3587. 

  3588. void **window_set_ime_position** **(** :ref:`Vector2i<class_Vector2i>` position, :ref:`int<class_int>` window_id=0 **)**
    3589. 

  3589. 

  3590. 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``.
    3591. 

  3591. 

  3592. .. rst-class:: classref-item-separator
    3593. 

  3593. 

  3594. ----
    3595. 

  3595. 

  3596. .. _class_DisplayServer_method_window_set_input_event_callback:
    3597. 

  3597. 

  3598. .. rst-class:: classref-method
    3599. 

  3599. 

  3600. void **window_set_input_event_callback** **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**
    3601. 

  3601. 

  3602. Sets the ``callback`` that should be called when any :ref:`InputEvent<class_InputEvent>` is sent to the window specified by ``window_id``.
    3603. 

  3603. 

  3604. .. rst-class:: classref-item-separator
    3605. 

  3605. 

  3606. ----
    3607. 

  3607. 

  3608. .. _class_DisplayServer_method_window_set_input_text_callback:
    3609. 

  3609. 

  3610. .. rst-class:: classref-method
    3611. 

  3611. 

  3612. void **window_set_input_text_callback** **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**
    3613. 

  3613. 

  3614. Sets the ``callback`` that should be called when text is entered using the virtual keyboard to the window specified by ``window_id``.
    3615. 

  3615. 

  3616. .. rst-class:: classref-item-separator
    3617. 

  3617. 

  3618. ----
    3619. 

  3619. 

  3620. .. _class_DisplayServer_method_window_set_max_size:
    3621. 

  3621. 

  3622. .. rst-class:: classref-method
    3623. 

  3623. 

  3624. void **window_set_max_size** **(** :ref:`Vector2i<class_Vector2i>` max_size, :ref:`int<class_int>` window_id=0 **)**
    3625. 

  3625. 

  3626. Sets the maximum size of the window specified by ``window_id`` in pixels. Normally, the user will not be able to drag the window to make it smaller than the specified size. See also :ref:`window_get_max_size<class_DisplayServer_method_window_get_max_size>`.
    3627. 

  3627. 

  3628. \ **Note:** It's recommended to change this value using :ref:`Window.max_size<class_Window_property_max_size>` instead.
    3629. 

  3629. 

  3630. \ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.
    3631. 

  3631. 

  3632. .. rst-class:: classref-item-separator
    3633. 

  3633. 

  3634. ----
    3635. 

  3635. 

  3636. .. _class_DisplayServer_method_window_set_min_size:
    3637. 

  3637. 

  3638. .. rst-class:: classref-method
    3639. 

  3639. 

  3640. void **window_set_min_size** **(** :ref:`Vector2i<class_Vector2i>` min_size, :ref:`int<class_int>` window_id=0 **)**
    3641. 

  3641. 

  3642. Sets the minimum size for the given window to ``min_size`` (in pixels). Normally, the user will not be able to drag the window to make it larger than the specified size. See also :ref:`window_get_min_size<class_DisplayServer_method_window_get_min_size>`.
    3643. 

  3643. 

  3644. \ **Note:** It's recommended to change this value using :ref:`Window.min_size<class_Window_property_min_size>` instead.
    3645. 

  3645. 

  3646. \ **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.
    3647. 

  3647. 

  3648. \ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.
    3649. 

  3649. 

  3650. .. rst-class:: classref-item-separator
    3651. 

  3651. 

  3652. ----
    3653. 

  3653. 

  3654. .. _class_DisplayServer_method_window_set_mode:
    3655. 

  3655. 

  3656. .. rst-class:: classref-method
    3657. 

  3657. 

  3658. void **window_set_mode** **(** :ref:`WindowMode<enum_DisplayServer_WindowMode>` mode, :ref:`int<class_int>` window_id=0 **)**
    3659. 

  3659. 

  3660. Sets window mode for the given window to ``mode``. See :ref:`WindowMode<enum_DisplayServer_WindowMode>` for possible values and how each mode behaves.
    3661. 

  3661. 

  3662. \ **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.
    3663. 

  3663. 

  3664. .. rst-class:: classref-item-separator
    3665. 

  3665. 

  3666. ----
    3667. 

  3667. 

  3668. .. _class_DisplayServer_method_window_set_mouse_passthrough:
    3669. 

  3669. 

  3670. .. rst-class:: classref-method
    3671. 

  3671. 

  3672. void **window_set_mouse_passthrough** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` region, :ref:`int<class_int>` window_id=0 **)**
    3673. 

  3673. 

  3674. Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through.
    3675. 

  3675. 

  3676. Passing an empty array will disable passthrough support (all mouse events will be intercepted by the window, which is the default behavior).
    3677. 

  3677. 

  3678. 

  3679. .. tabs::
    3680. 

  3680. 

  3681.  .. code-tab:: gdscript
    3682. 

  3682. 

  3683.     # Set region, using Path2D node.
    3684. 

  3684.     DisplayServer.window_set_mouse_passthrough($Path2D.curve.get_baked_points())
    3685. 

  3685.     
    3686. 

  3686.     # Set region, using Polygon2D node.
    3687. 

  3687.     DisplayServer.window_set_mouse_passthrough($Polygon2D.polygon)
    3688. 

  3688.     
    3689. 

  3689.     # Reset region to default.
    3690. 

  3690.     DisplayServer.window_set_mouse_passthrough([])
    3691. 

  3691. 

  3692.  .. code-tab:: csharp
    3693. 

  3693. 

  3694.     // Set region, using Path2D node.
    3695. 

  3695.     DisplayServer.WindowSetMousePassthrough(GetNode<Path2D>("Path2D").Curve.GetBakedPoints());
    3696. 

  3696.     
    3697. 

  3697.     // Set region, using Polygon2D node.
    3698. 

  3698.     DisplayServer.WindowSetMousePassthrough(GetNode<Polygon2D>("Polygon2D").Polygon);
    3699. 

  3699.     
    3700. 

  3700.     // Reset region to default.
    3701. 

  3701.     DisplayServer.WindowSetMousePassthrough(new Vector2[] {});
    3702. 

  3702. 

  3703. 

  3704. 

  3705. \ **Note:** On Windows, the portion of a window that lies outside the region is not drawn, while on Linux (X11) and macOS it is.
    3706. 

  3706. 

  3707. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    3708. 

  3708. 

  3709. .. rst-class:: classref-item-separator
    3710. 

  3710. 

  3711. ----
    3712. 

  3712. 

  3713. .. _class_DisplayServer_method_window_set_popup_safe_rect:
    3714. 

  3714. 

  3715. .. rst-class:: classref-method
    3716. 

  3716. 

  3717. void **window_set_popup_safe_rect** **(** :ref:`int<class_int>` window, :ref:`Rect2i<class_Rect2i>` rect **)**
    3718. 

  3718. 

  3719. 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.
    3720. 

  3720. 

  3721. .. rst-class:: classref-item-separator
    3722. 

  3722. 

  3723. ----
    3724. 

  3724. 

  3725. .. _class_DisplayServer_method_window_set_position:
    3726. 

  3726. 

  3727. .. rst-class:: classref-method
    3728. 

  3728. 

  3729. void **window_set_position** **(** :ref:`Vector2i<class_Vector2i>` position, :ref:`int<class_int>` window_id=0 **)**
    3730. 

  3730. 

  3731. 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:
    3732. 

  3732. 

  3733. ::
    3734. 

  3734. 

  3735.     * (0, 0)        +-------+
    3736. 

  3736.                     |       |
    3737. 

  3737.     +-------------+ |       |
    3738. 

  3738.     |             | |       |
    3739. 

  3739.     |             | |       |
    3740. 

  3740.     +-------------+ +-------+
    3741. 

  3741. 

  3742. See also :ref:`window_get_position<class_DisplayServer_method_window_get_position>` and :ref:`window_set_size<class_DisplayServer_method_window_set_size>`.
    3743. 

  3743. 

  3744. \ **Note:** It's recommended to change this value using :ref:`Window.position<class_Window_property_position>` instead.
    3745. 

  3745. 

  3746. .. rst-class:: classref-item-separator
    3747. 

  3747. 

  3748. ----
    3749. 

  3749. 

  3750. .. _class_DisplayServer_method_window_set_rect_changed_callback:
    3751. 

  3751. 

  3752. .. rst-class:: classref-method
    3753. 

  3753. 

  3754. void **window_set_rect_changed_callback** **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**
    3755. 

  3755. 

  3756. Sets the ``callback`` that will be called when the window specified by ``window_id`` is moved or resized.
    3757. 

  3757. 

  3758. .. rst-class:: classref-item-separator
    3759. 

  3759. 

  3760. ----
    3761. 

  3761. 

  3762. .. _class_DisplayServer_method_window_set_size:
    3763. 

  3763. 

  3764. .. rst-class:: classref-method
    3765. 

  3765. 

  3766. void **window_set_size** **(** :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` window_id=0 **)**
    3767. 

  3767. 

  3768. 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>`.
    3769. 

  3769. 

  3770. \ **Note:** It's recommended to change this value using :ref:`Window.size<class_Window_property_size>` instead.
    3771. 

  3771. 

  3772. .. rst-class:: classref-item-separator
    3773. 

  3773. 

  3774. ----
    3775. 

  3775. 

  3776. .. _class_DisplayServer_method_window_set_title:
    3777. 

  3777. 

  3778. .. rst-class:: classref-method
    3779. 

  3779. 

  3780. void **window_set_title** **(** :ref:`String<class_String>` title, :ref:`int<class_int>` window_id=0 **)**
    3781. 

  3781. 

  3782. Sets the title of the given window to ``title``.
    3783. 

  3783. 

  3784. \ **Note:** It's recommended to change this value using :ref:`Window.title<class_Window_property_title>` instead.
    3785. 

  3785. 

  3786. \ **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.
    3787. 

  3787. 

  3788. .. rst-class:: classref-item-separator
    3789. 

  3789. 

  3790. ----
    3791. 

  3791. 

  3792. .. _class_DisplayServer_method_window_set_transient:
    3793. 

  3793. 

  3794. .. rst-class:: classref-method
    3795. 

  3795. 

  3796. void **window_set_transient** **(** :ref:`int<class_int>` window_id, :ref:`int<class_int>` parent_window_id **)**
    3797. 

  3797. 

  3798. Sets window transient parent. Transient window is will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can't enter full-screen mode.
    3799. 

  3799. 

  3800. \ **Note:** It's recommended to change this value using :ref:`Window.transient<class_Window_property_transient>` instead.
    3801. 

  3801. 

  3802. \ **Note:** The behavior might be different depending on the platform.
    3803. 

  3803. 

  3804. .. rst-class:: classref-item-separator
    3805. 

  3805. 

  3806. ----
    3807. 

  3807. 

  3808. .. _class_DisplayServer_method_window_set_vsync_mode:
    3809. 

  3809. 

  3810. .. rst-class:: classref-method
    3811. 

  3811. 

  3812. void **window_set_vsync_mode** **(** :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` vsync_mode, :ref:`int<class_int>` window_id=0 **)**
    3813. 

  3813. 

  3814. 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>`.
    3815. 

  3815. 

  3816. See :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` for possible values and how they affect the behavior of your application.
    3817. 

  3817. 

  3818. 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.
    3819. 

  3819. 

  3820. \ **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.
    3821. 

  3821. 

  3822. .. rst-class:: classref-item-separator
    3823. 

  3823. 

  3824. ----
    3825. 

  3825. 

  3826. .. _class_DisplayServer_method_window_set_window_buttons_offset:
    3827. 

  3827. 

  3828. .. rst-class:: classref-method
    3829. 

  3829. 

  3830. void **window_set_window_buttons_offset** **(** :ref:`Vector2i<class_Vector2i>` offset, :ref:`int<class_int>` window_id=0 **)**
    3831. 

  3831. 

  3832. 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.
    3833. 

  3833. 

  3834. \ **Note:** This flag is implemented only on macOS.
    3835. 

  3835. 

  3836. .. rst-class:: classref-item-separator
    3837. 

  3837. 

  3838. ----
    3839. 

  3839. 

  3840. .. _class_DisplayServer_method_window_set_window_event_callback:
    3841. 

  3841. 

  3842. .. rst-class:: classref-method
    3843. 

  3843. 

  3844. void **window_set_window_event_callback** **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**
    3845. 

  3845. 

  3846. Sets the ``callback`` that will be called when an event occurs in the window specified by ``window_id``.
    3847. 

  3847. 

  3848. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    3849. 

  3849. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    3850. 

  3850. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    3851. 

  3851. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    3852. 

  3852. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    3853. 

  3853. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    3854. 

  3854. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    3855.