Home Esplora Aiuto
Accedi
Godot
/
godot-docs
mirror da https://github.com/godotengine/godot-docs.git
2
0
Forka 0
File Problemi 0 Wiki
Albero (Tree): 406e44b289
Rami (Branch) Tag
godot-docs
/
classes
/
class_displayserver.rst

class_displayserver.rst 399 KB
Cronologia Originale

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571 
  1. :github_url: hide
    2. 

  2. 

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

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

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

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

  7. 

  8. .. _class_DisplayServer:
    9. 

  9. 

  10. DisplayServer
    11. 

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

  12. 

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

  14. 

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

  16. 

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

  18. 

  19. Description
    20. 

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

  21. 

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

  23. 

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

  25. 

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

  27. 

  28. Methods
    29. 

  29. -------
    30. 

  30. 

  31. .. table::
    32. 

  32.    :widths: auto
    33. 

  33. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  51.    | :ref:`int<class_int>`                                                   | :ref:`create_status_indicator<class_DisplayServer_method_create_status_indicator>`\ (\ icon\: :ref:`Texture2D<class_Texture2D>`, tooltip\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ )                                                                                                                                                                                                                                                                                                                                               |
    52. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  69.    | :ref:`Error<enum_@GlobalScope_Error>`                                   | :ref:`file_dialog_with_options_show<class_DisplayServer_method_file_dialog_with_options_show>`\ (\ title\: :ref:`String<class_String>`, current_directory\: :ref:`String<class_String>`, root\: :ref:`String<class_String>`, filename\: :ref:`String<class_String>`, show_hidden\: :ref:`bool<class_bool>`, mode\: :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>`, filters\: :ref:`PackedStringArray<class_PackedStringArray>`, options\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\], callback\: :ref:`Callable<class_Callable>`\ ) |
    70. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  111.    | :ref:`int<class_int>`                                                   | :ref:`global_menu_add_separator<class_DisplayServer_method_global_menu_add_separator>`\ (\ menu_root\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ )                                                                                                                                                                                                                                                                                                                                                                                           |
    112. 

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

  113.    | :ref:`int<class_int>`                                                   | :ref:`global_menu_add_submenu_item<class_DisplayServer_method_global_menu_add_submenu_item>`\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, submenu\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ )                                                                                                                                                                                                                                                                                                         |
    114. 

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

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

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

  117.    | :ref:`Key<enum_@GlobalScope_Key>`                                       | :ref:`global_menu_get_item_accelerator<class_DisplayServer_method_global_menu_get_item_accelerator>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                            |
    118. 

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

  119.    | :ref:`Callable<class_Callable>`                                         | :ref:`global_menu_get_item_callback<class_DisplayServer_method_global_menu_get_item_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                  |
    120. 

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

  121.    | :ref:`int<class_int>`                                                   | :ref:`global_menu_get_item_count<class_DisplayServer_method_global_menu_get_item_count>`\ (\ menu_root\: :ref:`String<class_String>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                     |
    122. 

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

  123.    | :ref:`Texture2D<class_Texture2D>`                                       | :ref:`global_menu_get_item_icon<class_DisplayServer_method_global_menu_get_item_icon>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                          |
    124. 

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

  125.    | :ref:`int<class_int>`                                                   | :ref:`global_menu_get_item_indentation_level<class_DisplayServer_method_global_menu_get_item_indentation_level>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                |
    126. 

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

  127.    | :ref:`int<class_int>`                                                   | :ref:`global_menu_get_item_index_from_tag<class_DisplayServer_method_global_menu_get_item_index_from_tag>`\ (\ menu_root\: :ref:`String<class_String>`, tag\: :ref:`Variant<class_Variant>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                              |
    128. 

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

  129.    | :ref:`int<class_int>`                                                   | :ref:`global_menu_get_item_index_from_text<class_DisplayServer_method_global_menu_get_item_index_from_text>`\ (\ menu_root\: :ref:`String<class_String>`, text\: :ref:`String<class_String>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                             |
    130. 

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

  131.    | :ref:`Callable<class_Callable>`                                         | :ref:`global_menu_get_item_key_callback<class_DisplayServer_method_global_menu_get_item_key_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                          |
    132. 

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

  133.    | :ref:`int<class_int>`                                                   | :ref:`global_menu_get_item_max_states<class_DisplayServer_method_global_menu_get_item_max_states>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                              |
    134. 

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

  135.    | :ref:`int<class_int>`                                                   | :ref:`global_menu_get_item_state<class_DisplayServer_method_global_menu_get_item_state>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                        |
    136. 

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

  137.    | :ref:`String<class_String>`                                             | :ref:`global_menu_get_item_submenu<class_DisplayServer_method_global_menu_get_item_submenu>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                    |
    138. 

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

  139.    | :ref:`Variant<class_Variant>`                                           | :ref:`global_menu_get_item_tag<class_DisplayServer_method_global_menu_get_item_tag>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                            |
    140. 

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

  141.    | :ref:`String<class_String>`                                             | :ref:`global_menu_get_item_text<class_DisplayServer_method_global_menu_get_item_text>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                          |
    142. 

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

  143.    | :ref:`String<class_String>`                                             | :ref:`global_menu_get_item_tooltip<class_DisplayServer_method_global_menu_get_item_tooltip>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                    |
    144. 

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

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

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

  147.    | :ref:`bool<class_bool>`                                                 | :ref:`global_menu_is_item_checkable<class_DisplayServer_method_global_menu_is_item_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                  |
    148. 

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

  149.    | :ref:`bool<class_bool>`                                                 | :ref:`global_menu_is_item_checked<class_DisplayServer_method_global_menu_is_item_checked>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                      |
    150. 

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

  151.    | :ref:`bool<class_bool>`                                                 | :ref:`global_menu_is_item_disabled<class_DisplayServer_method_global_menu_is_item_disabled>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                    |
    152. 

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

  153.    | :ref:`bool<class_bool>`                                                 | :ref:`global_menu_is_item_hidden<class_DisplayServer_method_global_menu_is_item_hidden>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                        |
    154. 

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

  155.    | :ref:`bool<class_bool>`                                                 | :ref:`global_menu_is_item_radio_checkable<class_DisplayServer_method_global_menu_is_item_radio_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                      |
    156. 

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

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

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

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

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

  161.    | |void|                                                                  | :ref:`global_menu_set_item_callback<class_DisplayServer_method_global_menu_set_item_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ )                                                                                                                                                                                                                                                                                                                                              |
    162. 

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

  163.    | |void|                                                                  | :ref:`global_menu_set_item_checkable<class_DisplayServer_method_global_menu_set_item_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                                                                   |
    164. 

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

  165.    | |void|                                                                  | :ref:`global_menu_set_item_checked<class_DisplayServer_method_global_menu_set_item_checked>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checked\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                                                                         |
    166. 

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

  167.    | |void|                                                                  | :ref:`global_menu_set_item_disabled<class_DisplayServer_method_global_menu_set_item_disabled>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                                                                      |
    168. 

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

  169.    | |void|                                                                  | :ref:`global_menu_set_item_hidden<class_DisplayServer_method_global_menu_set_item_hidden>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, hidden\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                                                                            |
    170. 

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

  171.    | |void|                                                                  | :ref:`global_menu_set_item_hover_callbacks<class_DisplayServer_method_global_menu_set_item_hover_callbacks>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ )                                                                                                                                                                                                                                                                                                                                |
    172. 

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

  173.    | |void|                                                                  | :ref:`global_menu_set_item_icon<class_DisplayServer_method_global_menu_set_item_icon>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ )                                                                                                                                                                                                                                                                                                                                                        |
    174. 

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

  175.    | |void|                                                                  | :ref:`global_menu_set_item_indentation_level<class_DisplayServer_method_global_menu_set_item_indentation_level>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, level\: :ref:`int<class_int>`\ )                                                                                                                                                                                                                                                                                                                                         |
    176. 

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

  177.    | |void|                                                                  | :ref:`global_menu_set_item_key_callback<class_DisplayServer_method_global_menu_set_item_key_callback>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, key_callback\: :ref:`Callable<class_Callable>`\ )                                                                                                                                                                                                                                                                                                                                  |
    178. 

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

  179.    | |void|                                                                  | :ref:`global_menu_set_item_max_states<class_DisplayServer_method_global_menu_set_item_max_states>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, max_states\: :ref:`int<class_int>`\ )                                                                                                                                                                                                                                                                                                                                                  |
    180. 

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

  181.    | |void|                                                                  | :ref:`global_menu_set_item_radio_checkable<class_DisplayServer_method_global_menu_set_item_radio_checkable>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                                                       |
    182. 

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

  183.    | |void|                                                                  | :ref:`global_menu_set_item_state<class_DisplayServer_method_global_menu_set_item_state>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, state\: :ref:`int<class_int>`\ )                                                                                                                                                                                                                                                                                                                                                                 |
    184. 

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

  185.    | |void|                                                                  | :ref:`global_menu_set_item_submenu<class_DisplayServer_method_global_menu_set_item_submenu>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, submenu\: :ref:`String<class_String>`\ )                                                                                                                                                                                                                                                                                                                                                     |
    186. 

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

  187.    | |void|                                                                  | :ref:`global_menu_set_item_tag<class_DisplayServer_method_global_menu_set_item_tag>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tag\: :ref:`Variant<class_Variant>`\ )                                                                                                                                                                                                                                                                                                                                                               |
    188. 

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

  189.    | |void|                                                                  | :ref:`global_menu_set_item_text<class_DisplayServer_method_global_menu_set_item_text>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, text\: :ref:`String<class_String>`\ )                                                                                                                                                                                                                                                                                                                                                              |
    190. 

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

  191.    | |void|                                                                  | :ref:`global_menu_set_item_tooltip<class_DisplayServer_method_global_menu_set_item_tooltip>`\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ )                                                                                                                                                                                                                                                                                                                                                     |
    192. 

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

  193.    | |void|                                                                  | :ref:`global_menu_set_popup_callbacks<class_DisplayServer_method_global_menu_set_popup_callbacks>`\ (\ menu_root\: :ref:`String<class_String>`, open_callback\: :ref:`Callable<class_Callable>`, close_callback\: :ref:`Callable<class_Callable>`\ )                                                                                                                                                                                                                                                                                                                |
    194. 

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

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

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

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

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

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

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

  201.    | |void|                                                                  | :ref:`help_set_search_callbacks<class_DisplayServer_method_help_set_search_callbacks>`\ (\ search_callback\: :ref:`Callable<class_Callable>`, action_callback\: :ref:`Callable<class_Callable>`\ )                                                                                                                                                                                                                                                                                                                                                                  |
    202. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  217.    | :ref:`Key<enum_@GlobalScope_Key>`                                       | :ref:`keyboard_get_keycode_from_physical<class_DisplayServer_method_keyboard_get_keycode_from_physical>`\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                 |
    218. 

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

  219.    | :ref:`Key<enum_@GlobalScope_Key>`                                       | :ref:`keyboard_get_label_from_physical<class_DisplayServer_method_keyboard_get_label_from_physical>`\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                     |
    220. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  245.    | :ref:`float<class_float>`                                               | :ref:`screen_get_max_scale<class_DisplayServer_method_screen_get_max_scale>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    246. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  261.    | :ref:`bool<class_bool>`                                                 | :ref:`screen_is_kept_on<class_DisplayServer_method_screen_is_kept_on>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    262. 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  283.    | :ref:`String<class_String>`                                             | :ref:`tablet_get_current_driver<class_DisplayServer_method_tablet_get_current_driver>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    284. 

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

  285.    | :ref:`int<class_int>`                                                   | :ref:`tablet_get_driver_count<class_DisplayServer_method_tablet_get_driver_count>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    286. 

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

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

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

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

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

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

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

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

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

  295.    | :ref:`bool<class_bool>`                                                 | :ref:`tts_is_paused<class_DisplayServer_method_tts_is_paused>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    296. 

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

  297.    | :ref:`bool<class_bool>`                                                 | :ref:`tts_is_speaking<class_DisplayServer_method_tts_is_speaking>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    298. 

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

  299.    | |void|                                                                  | :ref:`tts_pause<class_DisplayServer_method_tts_pause>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    300. 

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

  301.    | |void|                                                                  | :ref:`tts_resume<class_DisplayServer_method_tts_resume>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    302. 

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

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

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

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

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

  307.    | |void|                                                                  | :ref:`tts_stop<class_DisplayServer_method_tts_stop>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    308. 

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

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

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

  311.    | :ref:`int<class_int>`                                                   | :ref:`virtual_keyboard_get_height<class_DisplayServer_method_virtual_keyboard_get_height>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
    312. 

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

  313.    | |void|                                                                  | :ref:`virtual_keyboard_hide<class_DisplayServer_method_virtual_keyboard_hide>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    314. 

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

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

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

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

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

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

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

  321.    | :ref:`int<class_int>`                                                   | :ref:`window_get_active_popup<class_DisplayServer_method_window_get_active_popup>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    322. 

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

  323.    | :ref:`int<class_int>`                                                   | :ref:`window_get_attached_instance_id<class_DisplayServer_method_window_get_attached_instance_id>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                             |
    324. 

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

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

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

  327.    | :ref:`bool<class_bool>`                                                 | :ref:`window_get_flag<class_DisplayServer_method_window_get_flag>`\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                  |
    328. 

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

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

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

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

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

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

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

  335.    | :ref:`int<class_int>`                                                   | :ref:`window_get_native_handle<class_DisplayServer_method_window_get_native_handle>`\ (\ handle_type\: :ref:`HandleType<enum_DisplayServer_HandleType>`, window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                           |
    336. 

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

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

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

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

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

  341.    | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`window_get_position_with_decorations<class_DisplayServer_method_window_get_position_with_decorations>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                   |
    342. 

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

  343.    | :ref:`Vector3i<class_Vector3i>`                                         | :ref:`window_get_safe_title_margins<class_DisplayServer_method_window_get_safe_title_margins>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                 |
    344. 

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

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

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

  347.    | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`window_get_size_with_decorations<class_DisplayServer_method_window_get_size_with_decorations>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                           |
    348. 

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

  349.    | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`window_get_title_size<class_DisplayServer_method_window_get_title_size>`\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                            |
    350. 

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

  351.    | :ref:`VSyncMode<enum_DisplayServer_VSyncMode>`                          | :ref:`window_get_vsync_mode<class_DisplayServer_method_window_get_vsync_mode>`\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    352. 

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

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

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

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

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

  357.    | :ref:`bool<class_bool>`                                                 | :ref:`window_maximize_on_title_dbl_click<class_DisplayServer_method_window_maximize_on_title_dbl_click>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    358. 

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

  359.    | :ref:`bool<class_bool>`                                                 | :ref:`window_minimize_on_title_dbl_click<class_DisplayServer_method_window_minimize_on_title_dbl_click>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    360. 

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

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

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

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

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

  365.    | |void|                                                                  | :ref:`window_set_current_screen<class_DisplayServer_method_window_set_current_screen>`\ (\ screen\: :ref:`int<class_int>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                                                 |
    366. 

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

  367.    | |void|                                                                  | :ref:`window_set_drop_files_callback<class_DisplayServer_method_window_set_drop_files_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                           |
    368. 

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

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

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

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

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

  373.    | |void|                                                                  | :ref:`window_set_ime_active<class_DisplayServer_method_window_set_ime_active>`\ (\ active\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                                                       |
    374. 

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

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

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

  377.    | |void|                                                                  | :ref:`window_set_input_event_callback<class_DisplayServer_method_window_set_input_event_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                         |
    378. 

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

  379.    | |void|                                                                  | :ref:`window_set_input_text_callback<class_DisplayServer_method_window_set_input_text_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                           |
    380. 

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

  381.    | |void|                                                                  | :ref:`window_set_max_size<class_DisplayServer_method_window_set_max_size>`\ (\ max_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                                                 |
    382. 

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

  383.    | |void|                                                                  | :ref:`window_set_min_size<class_DisplayServer_method_window_set_min_size>`\ (\ min_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                                                 |
    384. 

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

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

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

  387.    | |void|                                                                  | :ref:`window_set_mouse_passthrough<class_DisplayServer_method_window_set_mouse_passthrough>`\ (\ region\: :ref:`PackedVector2Array<class_PackedVector2Array>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                             |
    388. 

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

  389.    | |void|                                                                  | :ref:`window_set_popup_safe_rect<class_DisplayServer_method_window_set_popup_safe_rect>`\ (\ window\: :ref:`int<class_int>`, rect\: :ref:`Rect2i<class_Rect2i>`\ )                                                                                                                                                                                                                                                                                                                                                                                                  |
    390. 

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

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

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

  393.    | |void|                                                                  | :ref:`window_set_rect_changed_callback<class_DisplayServer_method_window_set_rect_changed_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                       |
    394. 

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

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

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

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

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

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

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

  401.    | |void|                                                                  | :ref:`window_set_vsync_mode<class_DisplayServer_method_window_set_vsync_mode>`\ (\ vsync_mode\: :ref:`VSyncMode<enum_DisplayServer_VSyncMode>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                            |
    402. 

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

  403.    | |void|                                                                  | :ref:`window_set_window_buttons_offset<class_DisplayServer_method_window_set_window_buttons_offset>`\ (\ offset\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                         |
    404. 

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

  405.    | |void|                                                                  | :ref:`window_set_window_event_callback<class_DisplayServer_method_window_set_window_event_callback>`\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ )                                                                                                                                                                                                                                                                                                                                                                       |
    406. 

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

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

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

  409. 

  410. .. rst-class:: classref-section-separator
    411. 

  411. 

  412. ----
    413. 

  413. 

  414. .. rst-class:: classref-descriptions-group
    415. 

  415. 

  416. Enumerations
    417. 

  417. ------------
    418. 

  418. 

  419. .. _enum_DisplayServer_Feature:
    420. 

  420. 

  421. .. rst-class:: classref-enumeration
    422. 

  422. 

  423. enum **Feature**: :ref:`๐Ÿ”—<enum_DisplayServer_Feature>`
    424. 

  424. 

  425. .. _class_DisplayServer_constant_FEATURE_GLOBAL_MENU:
    426. 

  426. 

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

  428. 

  429. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_GLOBAL_MENU** = ``0``
    430. 

  430. 

  431. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    432. 

  432. 

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

  434. 

  435. .. _class_DisplayServer_constant_FEATURE_SUBWINDOWS:
    436. 

  436. 

  437. .. rst-class:: classref-enumeration-constant
    438. 

  438. 

  439. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SUBWINDOWS** = ``1``
    440. 

  440. 

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

  442. 

  443. .. _class_DisplayServer_constant_FEATURE_TOUCHSCREEN:
    444. 

  444. 

  445. .. rst-class:: classref-enumeration-constant
    446. 

  446. 

  447. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TOUCHSCREEN** = ``2``
    448. 

  448. 

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

  450. 

  451. .. _class_DisplayServer_constant_FEATURE_MOUSE:
    452. 

  452. 

  453. .. rst-class:: classref-enumeration-constant
    454. 

  454. 

  455. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE** = ``3``
    456. 

  456. 

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

  458. 

  459. .. _class_DisplayServer_constant_FEATURE_MOUSE_WARP:
    460. 

  460. 

  461. .. rst-class:: classref-enumeration-constant
    462. 

  462. 

  463. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE_WARP** = ``4``
    464. 

  464. 

  465. Display server supports warping mouse coordinates to keep the mouse cursor constrained within an area, but looping when one of the edges is reached. **Windows, macOS, Linux (X11/Wayland)**
    466. 

  466. 

  467. .. _class_DisplayServer_constant_FEATURE_CLIPBOARD:
    468. 

  468. 

  469. .. rst-class:: classref-enumeration-constant
    470. 

  470. 

  471. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD** = ``5``
    472. 

  472. 

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

  474. 

  475. .. _class_DisplayServer_constant_FEATURE_VIRTUAL_KEYBOARD:
    476. 

  476. 

  477. .. rst-class:: classref-enumeration-constant
    478. 

  478. 

  479. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_VIRTUAL_KEYBOARD** = ``6``
    480. 

  480. 

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

  482. 

  483. .. _class_DisplayServer_constant_FEATURE_CURSOR_SHAPE:
    484. 

  484. 

  485. .. rst-class:: classref-enumeration-constant
    486. 

  486. 

  487. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CURSOR_SHAPE** = ``7``
    488. 

  488. 

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

  490. 

  491. .. _class_DisplayServer_constant_FEATURE_CUSTOM_CURSOR_SHAPE:
    492. 

  492. 

  493. .. rst-class:: classref-enumeration-constant
    494. 

  494. 

  495. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CUSTOM_CURSOR_SHAPE** = ``8``
    496. 

  496. 

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

  498. 

  499. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG:
    500. 

  500. 

  501. .. rst-class:: classref-enumeration-constant
    502. 

  502. 

  503. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG** = ``9``
    504. 

  504. 

  505. Display server supports spawning text dialogs using the operating system's native look-and-feel. See :ref:`dialog_show<class_DisplayServer_method_dialog_show>`. **Windows, macOS**
    506. 

  506. 

  507. .. _class_DisplayServer_constant_FEATURE_IME:
    508. 

  508. 

  509. .. rst-class:: classref-enumeration-constant
    510. 

  510. 

  511. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_IME** = ``10``
    512. 

  512. 

  513. 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)**
    514. 

  514. 

  515. .. _class_DisplayServer_constant_FEATURE_WINDOW_TRANSPARENCY:
    516. 

  516. 

  517. .. rst-class:: classref-enumeration-constant
    518. 

  518. 

  519. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_TRANSPARENCY** = ``11``
    520. 

  520. 

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

  522. 

  523. .. _class_DisplayServer_constant_FEATURE_HIDPI:
    524. 

  524. 

  525. .. rst-class:: classref-enumeration-constant
    526. 

  526. 

  527. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_HIDPI** = ``12``
    528. 

  528. 

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

  530. 

  531. .. _class_DisplayServer_constant_FEATURE_ICON:
    532. 

  532. 

  533. .. rst-class:: classref-enumeration-constant
    534. 

  534. 

  535. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ICON** = ``13``
    536. 

  536. 

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

  538. 

  539. .. _class_DisplayServer_constant_FEATURE_NATIVE_ICON:
    540. 

  540. 

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

  542. 

  543. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_ICON** = ``14``
    544. 

  544. 

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

  546. 

  547. .. _class_DisplayServer_constant_FEATURE_ORIENTATION:
    548. 

  548. 

  549. .. rst-class:: classref-enumeration-constant
    550. 

  550. 

  551. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ORIENTATION** = ``15``
    552. 

  552. 

  553. Display server supports changing the screen orientation. **Android, iOS**
    554. 

  554. 

  555. .. _class_DisplayServer_constant_FEATURE_SWAP_BUFFERS:
    556. 

  556. 

  557. .. rst-class:: classref-enumeration-constant
    558. 

  558. 

  559. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SWAP_BUFFERS** = ``16``
    560. 

  560. 

  561. Display server supports V-Sync status can be changed from the default (which is forced to be enabled platforms not supporting this feature). **Windows, macOS, Linux (X11/Wayland)**
    562. 

  562. 

  563. .. _class_DisplayServer_constant_FEATURE_CLIPBOARD_PRIMARY:
    564. 

  564. 

  565. .. rst-class:: classref-enumeration-constant
    566. 

  566. 

  567. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD_PRIMARY** = ``18``
    568. 

  568. 

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

  570. 

  571. .. _class_DisplayServer_constant_FEATURE_TEXT_TO_SPEECH:
    572. 

  572. 

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

  574. 

  575. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TEXT_TO_SPEECH** = ``19``
    576. 

  576. 

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

  578. 

  579. .. _class_DisplayServer_constant_FEATURE_EXTEND_TO_TITLE:
    580. 

  580. 

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

  582. 

  583. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_EXTEND_TO_TITLE** = ``20``
    584. 

  584. 

  585. 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**
    586. 

  586. 

  587. .. _class_DisplayServer_constant_FEATURE_SCREEN_CAPTURE:
    588. 

  588. 

  589. .. rst-class:: classref-enumeration-constant
    590. 

  590. 

  591. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SCREEN_CAPTURE** = ``21``
    592. 

  592. 

  593. Display server supports reading screen pixels. See :ref:`screen_get_pixel<class_DisplayServer_method_screen_get_pixel>`.
    594. 

  594. 

  595. .. _class_DisplayServer_constant_FEATURE_STATUS_INDICATOR:
    596. 

  596. 

  597. .. rst-class:: classref-enumeration-constant
    598. 

  598. 

  599. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_STATUS_INDICATOR** = ``22``
    600. 

  600. 

  601. Display server supports application status indicators.
    602. 

  602. 

  603. .. _class_DisplayServer_constant_FEATURE_NATIVE_HELP:
    604. 

  604. 

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

  606. 

  607. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_HELP** = ``23``
    608. 

  608. 

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

  610. 

  611. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_INPUT:
    612. 

  612. 

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

  614. 

  615. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_INPUT** = ``24``
    616. 

  616. 

  617. Display server supports spawning text input dialogs using the operating system's native look-and-feel. See :ref:`dialog_input_text<class_DisplayServer_method_dialog_input_text>`. **Windows, macOS**
    618. 

  618. 

  619. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE:
    620. 

  620. 

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

  622. 

  623. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE** = ``25``
    624. 

  624. 

  625. Display server supports spawning dialogs for selecting files or directories using the operating system's native look-and-feel. See :ref:`file_dialog_show<class_DisplayServer_method_file_dialog_show>`. **Windows, macOS, Linux (X11/Wayland), Android**
    626. 

  626. 

  627. .. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE_EXTRA:
    628. 

  628. 

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

  630. 

  631. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE_EXTRA** = ``26``
    632. 

  632. 

  633. The display server supports all features of :ref:`FEATURE_NATIVE_DIALOG_FILE<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE>`, with the added functionality of Options and native dialog file access to ``res://`` and ``user://`` paths. See :ref:`file_dialog_show<class_DisplayServer_method_file_dialog_show>` and :ref:`file_dialog_with_options_show<class_DisplayServer_method_file_dialog_with_options_show>`. **Windows, macOS, Linux (X11/Wayland)**
    634. 

  634. 

  635. .. _class_DisplayServer_constant_FEATURE_WINDOW_DRAG:
    636. 

  636. 

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

  638. 

  639. :ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_DRAG** = ``27``
    640. 

  640. 

  641. The display server supports initiating window drag operation on demand. See :ref:`window_start_drag<class_DisplayServer_method_window_start_drag>`.
    642. 

  642. 

  643. .. rst-class:: classref-item-separator
    644. 

  644. 

  645. ----
    646. 

  646. 

  647. .. _enum_DisplayServer_MouseMode:
    648. 

  648. 

  649. .. rst-class:: classref-enumeration
    650. 

  650. 

  651. enum **MouseMode**: :ref:`๐Ÿ”—<enum_DisplayServer_MouseMode>`
    652. 

  652. 

  653. .. _class_DisplayServer_constant_MOUSE_MODE_VISIBLE:
    654. 

  654. 

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

  656. 

  657. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_VISIBLE** = ``0``
    658. 

  658. 

  659. Makes the mouse cursor visible if it is hidden.
    660. 

  660. 

  661. .. _class_DisplayServer_constant_MOUSE_MODE_HIDDEN:
    662. 

  662. 

  663. .. rst-class:: classref-enumeration-constant
    664. 

  664. 

  665. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_HIDDEN** = ``1``
    666. 

  666. 

  667. Makes the mouse cursor hidden if it is visible.
    668. 

  668. 

  669. .. _class_DisplayServer_constant_MOUSE_MODE_CAPTURED:
    670. 

  670. 

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

  672. 

  673. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CAPTURED** = ``2``
    674. 

  674. 

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

  676. 

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

  678. 

  679. .. _class_DisplayServer_constant_MOUSE_MODE_CONFINED:
    680. 

  680. 

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

  682. 

  683. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED** = ``3``
    684. 

  684. 

  685. Confines the mouse cursor to the game window, and make it visible.
    686. 

  686. 

  687. .. _class_DisplayServer_constant_MOUSE_MODE_CONFINED_HIDDEN:
    688. 

  688. 

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

  690. 

  691. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED_HIDDEN** = ``4``
    692. 

  692. 

  693. Confines the mouse cursor to the game window, and make it hidden.
    694. 

  694. 

  695. .. rst-class:: classref-item-separator
    696. 

  696. 

  697. ----
    698. 

  698. 

  699. .. _enum_DisplayServer_ScreenOrientation:
    700. 

  700. 

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

  702. 

  703. enum **ScreenOrientation**: :ref:`๐Ÿ”—<enum_DisplayServer_ScreenOrientation>`
    704. 

  704. 

  705. .. _class_DisplayServer_constant_SCREEN_LANDSCAPE:
    706. 

  706. 

  707. .. rst-class:: classref-enumeration-constant
    708. 

  708. 

  709. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_LANDSCAPE** = ``0``
    710. 

  710. 

  711. Default landscape orientation.
    712. 

  712. 

  713. .. _class_DisplayServer_constant_SCREEN_PORTRAIT:
    714. 

  714. 

  715. .. rst-class:: classref-enumeration-constant
    716. 

  716. 

  717. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_PORTRAIT** = ``1``
    718. 

  718. 

  719. Default portrait orientation.
    720. 

  720. 

  721. .. _class_DisplayServer_constant_SCREEN_REVERSE_LANDSCAPE:
    722. 

  722. 

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

  724. 

  725. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_LANDSCAPE** = ``2``
    726. 

  726. 

  727. Reverse landscape orientation (upside down).
    728. 

  728. 

  729. .. _class_DisplayServer_constant_SCREEN_REVERSE_PORTRAIT:
    730. 

  730. 

  731. .. rst-class:: classref-enumeration-constant
    732. 

  732. 

  733. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_PORTRAIT** = ``3``
    734. 

  734. 

  735. Reverse portrait orientation (upside down).
    736. 

  736. 

  737. .. _class_DisplayServer_constant_SCREEN_SENSOR_LANDSCAPE:
    738. 

  738. 

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

  740. 

  741. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_LANDSCAPE** = ``4``
    742. 

  742. 

  743. Automatic landscape orientation (default or reverse depending on sensor).
    744. 

  744. 

  745. .. _class_DisplayServer_constant_SCREEN_SENSOR_PORTRAIT:
    746. 

  746. 

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

  748. 

  749. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_PORTRAIT** = ``5``
    750. 

  750. 

  751. Automatic portrait orientation (default or reverse depending on sensor).
    752. 

  752. 

  753. .. _class_DisplayServer_constant_SCREEN_SENSOR:
    754. 

  754. 

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

  756. 

  757. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR** = ``6``
    758. 

  758. 

  759. Automatic landscape or portrait orientation (default or reverse depending on sensor).
    760. 

  760. 

  761. .. rst-class:: classref-item-separator
    762. 

  762. 

  763. ----
    764. 

  764. 

  765. .. _enum_DisplayServer_VirtualKeyboardType:
    766. 

  766. 

  767. .. rst-class:: classref-enumeration
    768. 

  768. 

  769. enum **VirtualKeyboardType**: :ref:`๐Ÿ”—<enum_DisplayServer_VirtualKeyboardType>`
    770. 

  770. 

  771. .. _class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT:
    772. 

  772. 

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

  774. 

  775. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_DEFAULT** = ``0``
    776. 

  776. 

  777. Default text virtual keyboard.
    778. 

  778. 

  779. .. _class_DisplayServer_constant_KEYBOARD_TYPE_MULTILINE:
    780. 

  780. 

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

  782. 

  783. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_MULTILINE** = ``1``
    784. 

  784. 

  785. Multiline virtual keyboard.
    786. 

  786. 

  787. .. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER:
    788. 

  788. 

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

  790. 

  791. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER** = ``2``
    792. 

  792. 

  793. Virtual number keypad, useful for PIN entry.
    794. 

  794. 

  795. .. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER_DECIMAL:
    796. 

  796. 

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

  798. 

  799. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER_DECIMAL** = ``3``
    800. 

  800. 

  801. Virtual number keypad, useful for entering fractional numbers.
    802. 

  802. 

  803. .. _class_DisplayServer_constant_KEYBOARD_TYPE_PHONE:
    804. 

  804. 

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

  806. 

  807. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PHONE** = ``4``
    808. 

  808. 

  809. Virtual phone number keypad.
    810. 

  810. 

  811. .. _class_DisplayServer_constant_KEYBOARD_TYPE_EMAIL_ADDRESS:
    812. 

  812. 

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

  814. 

  815. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_EMAIL_ADDRESS** = ``5``
    816. 

  816. 

  817. Virtual keyboard with additional keys to assist with typing email addresses.
    818. 

  818. 

  819. .. _class_DisplayServer_constant_KEYBOARD_TYPE_PASSWORD:
    820. 

  820. 

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

  822. 

  823. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PASSWORD** = ``6``
    824. 

  824. 

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

  826. 

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

  828. 

  829. .. _class_DisplayServer_constant_KEYBOARD_TYPE_URL:
    830. 

  830. 

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

  832. 

  833. :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_URL** = ``7``
    834. 

  834. 

  835. Virtual keyboard with additional keys to assist with typing URLs.
    836. 

  836. 

  837. .. rst-class:: classref-item-separator
    838. 

  838. 

  839. ----
    840. 

  840. 

  841. .. _enum_DisplayServer_CursorShape:
    842. 

  842. 

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

  844. 

  845. enum **CursorShape**: :ref:`๐Ÿ”—<enum_DisplayServer_CursorShape>`
    846. 

  846. 

  847. .. _class_DisplayServer_constant_CURSOR_ARROW:
    848. 

  848. 

  849. .. rst-class:: classref-enumeration-constant
    850. 

  850. 

  851. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_ARROW** = ``0``
    852. 

  852. 

  853. 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>`.
    854. 

  854. 

  855. .. _class_DisplayServer_constant_CURSOR_IBEAM:
    856. 

  856. 

  857. .. rst-class:: classref-enumeration-constant
    858. 

  858. 

  859. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_IBEAM** = ``1``
    860. 

  860. 

  861. 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>`.
    862. 

  862. 

  863. .. _class_DisplayServer_constant_CURSOR_POINTING_HAND:
    864. 

  864. 

  865. .. rst-class:: classref-enumeration-constant
    866. 

  866. 

  867. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_POINTING_HAND** = ``2``
    868. 

  868. 

  869. 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>`.
    870. 

  870. 

  871. .. _class_DisplayServer_constant_CURSOR_CROSS:
    872. 

  872. 

  873. .. rst-class:: classref-enumeration-constant
    874. 

  874. 

  875. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CROSS** = ``3``
    876. 

  876. 

  877. 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.
    878. 

  878. 

  879. .. _class_DisplayServer_constant_CURSOR_WAIT:
    880. 

  880. 

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

  882. 

  883. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_WAIT** = ``4``
    884. 

  884. 

  885. 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>`.
    886. 

  886. 

  887. .. _class_DisplayServer_constant_CURSOR_BUSY:
    888. 

  888. 

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

  890. 

  891. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BUSY** = ``5``
    892. 

  892. 

  893. 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>`.
    894. 

  894. 

  895. .. _class_DisplayServer_constant_CURSOR_DRAG:
    896. 

  896. 

  897. .. rst-class:: classref-enumeration-constant
    898. 

  898. 

  899. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_DRAG** = ``6``
    900. 

  900. 

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

  902. 

  903. .. _class_DisplayServer_constant_CURSOR_CAN_DROP:
    904. 

  904. 

  905. .. rst-class:: classref-enumeration-constant
    906. 

  906. 

  907. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CAN_DROP** = ``7``
    908. 

  908. 

  909. "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>`.
    910. 

  910. 

  911. .. _class_DisplayServer_constant_CURSOR_FORBIDDEN:
    912. 

  912. 

  913. .. rst-class:: classref-enumeration-constant
    914. 

  914. 

  915. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FORBIDDEN** = ``8``
    916. 

  916. 

  917. 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.
    918. 

  918. 

  919. .. _class_DisplayServer_constant_CURSOR_VSIZE:
    920. 

  920. 

  921. .. rst-class:: classref-enumeration-constant
    922. 

  922. 

  923. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSIZE** = ``9``
    924. 

  924. 

  925. 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>`.
    926. 

  926. 

  927. .. _class_DisplayServer_constant_CURSOR_HSIZE:
    928. 

  928. 

  929. .. rst-class:: classref-enumeration-constant
    930. 

  930. 

  931. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSIZE** = ``10``
    932. 

  932. 

  933. 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>`.
    934. 

  934. 

  935. .. _class_DisplayServer_constant_CURSOR_BDIAGSIZE:
    936. 

  936. 

  937. .. rst-class:: classref-enumeration-constant
    938. 

  938. 

  939. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BDIAGSIZE** = ``11``
    940. 

  940. 

  941. 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.
    942. 

  942. 

  943. .. _class_DisplayServer_constant_CURSOR_FDIAGSIZE:
    944. 

  944. 

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

  946. 

  947. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FDIAGSIZE** = ``12``
    948. 

  948. 

  949. 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.
    950. 

  950. 

  951. .. _class_DisplayServer_constant_CURSOR_MOVE:
    952. 

  952. 

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

  954. 

  955. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MOVE** = ``13``
    956. 

  956. 

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

  958. 

  959. .. _class_DisplayServer_constant_CURSOR_VSPLIT:
    960. 

  960. 

  961. .. rst-class:: classref-enumeration-constant
    962. 

  962. 

  963. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSPLIT** = ``14``
    964. 

  964. 

  965. 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>`.
    966. 

  966. 

  967. .. _class_DisplayServer_constant_CURSOR_HSPLIT:
    968. 

  968. 

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

  970. 

  971. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSPLIT** = ``15``
    972. 

  972. 

  973. 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>`.
    974. 

  974. 

  975. .. _class_DisplayServer_constant_CURSOR_HELP:
    976. 

  976. 

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

  978. 

  979. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HELP** = ``16``
    980. 

  980. 

  981. 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.
    982. 

  982. 

  983. .. _class_DisplayServer_constant_CURSOR_MAX:
    984. 

  984. 

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

  986. 

  987. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MAX** = ``17``
    988. 

  988. 

  989. Represents the size of the :ref:`CursorShape<enum_DisplayServer_CursorShape>` enum.
    990. 

  990. 

  991. .. rst-class:: classref-item-separator
    992. 

  992. 

  993. ----
    994. 

  994. 

  995. .. _enum_DisplayServer_FileDialogMode:
    996. 

  996. 

  997. .. rst-class:: classref-enumeration
    998. 

  998. 

  999. enum **FileDialogMode**: :ref:`๐Ÿ”—<enum_DisplayServer_FileDialogMode>`
    1000. 

  1000. 

  1001. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILE:
    1002. 

  1002. 

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

  1004. 

  1005. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILE** = ``0``
    1006. 

  1006. 

  1007. The native file dialog allows selecting one, and only one file.
    1008. 

  1008. 

  1009. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILES:
    1010. 

  1010. 

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

  1012. 

  1013. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILES** = ``1``
    1014. 

  1014. 

  1015. The native file dialog allows selecting multiple files.
    1016. 

  1016. 

  1017. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_DIR:
    1018. 

  1018. 

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

  1020. 

  1021. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_DIR** = ``2``
    1022. 

  1022. 

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

  1024. 

  1025. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_ANY:
    1026. 

  1026. 

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

  1028. 

  1029. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_ANY** = ``3``
    1030. 

  1030. 

  1031. The native file dialog allows selecting one file or directory.
    1032. 

  1032. 

  1033. .. _class_DisplayServer_constant_FILE_DIALOG_MODE_SAVE_FILE:
    1034. 

  1034. 

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

  1036. 

  1037. :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_SAVE_FILE** = ``4``
    1038. 

  1038. 

  1039. The native file dialog will warn when a file exists.
    1040. 

  1040. 

  1041. .. rst-class:: classref-item-separator
    1042. 

  1042. 

  1043. ----
    1044. 

  1044. 

  1045. .. _enum_DisplayServer_WindowMode:
    1046. 

  1046. 

  1047. .. rst-class:: classref-enumeration
    1048. 

  1048. 

  1049. enum **WindowMode**: :ref:`๐Ÿ”—<enum_DisplayServer_WindowMode>`
    1050. 

  1050. 

  1051. .. _class_DisplayServer_constant_WINDOW_MODE_WINDOWED:
    1052. 

  1052. 

  1053. .. rst-class:: classref-enumeration-constant
    1054. 

  1054. 

  1055. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_WINDOWED** = ``0``
    1056. 

  1056. 

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

  1058. 

  1059. .. _class_DisplayServer_constant_WINDOW_MODE_MINIMIZED:
    1060. 

  1060. 

  1061. .. rst-class:: classref-enumeration-constant
    1062. 

  1062. 

  1063. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MINIMIZED** = ``1``
    1064. 

  1064. 

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

  1066. 

  1067. .. _class_DisplayServer_constant_WINDOW_MODE_MAXIMIZED:
    1068. 

  1068. 

  1069. .. rst-class:: classref-enumeration-constant
    1070. 

  1070. 

  1071. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MAXIMIZED** = ``2``
    1072. 

  1072. 

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

  1074. 

  1075. .. _class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN:
    1076. 

  1076. 

  1077. .. rst-class:: classref-enumeration-constant
    1078. 

  1078. 

  1079. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_FULLSCREEN** = ``3``
    1080. 

  1080. 

  1081. Full screen mode with full multi-window support.
    1082. 

  1082. 

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

  1084. 

  1085. \ **On Android:** This enables immersive mode.
    1086. 

  1086. 

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

  1088. 

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

  1090. 

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

  1092. 

  1093. .. _class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN:
    1094. 

  1094. 

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

  1096. 

  1097. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_EXCLUSIVE_FULLSCREEN** = ``4``
    1098. 

  1098. 

  1099. 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).
    1100. 

  1100. 

  1101. Full screen window covers the entire display area of a screen and has no border or decorations. The display's video mode is not changed.
    1102. 

  1102. 

  1103. \ **On Android:** This enables immersive mode.
    1104. 

  1104. 

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

  1106. 

  1107. \ **On macOS:** A new desktop is used to display the running project. Exclusive full screen mode prevents Dock and Menu from showing up when the mouse pointer is hovering the edge of the screen.
    1108. 

  1108. 

  1109. \ **On Linux (X11):** Exclusive full screen mode bypasses compositor.
    1110. 

  1110. 

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

  1112. 

  1113. .. rst-class:: classref-item-separator
    1114. 

  1114. 

  1115. ----
    1116. 

  1116. 

  1117. .. _enum_DisplayServer_WindowFlags:
    1118. 

  1118. 

  1119. .. rst-class:: classref-enumeration
    1120. 

  1120. 

  1121. enum **WindowFlags**: :ref:`๐Ÿ”—<enum_DisplayServer_WindowFlags>`
    1122. 

  1122. 

  1123. .. _class_DisplayServer_constant_WINDOW_FLAG_RESIZE_DISABLED:
    1124. 

  1124. 

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

  1126. 

  1127. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_RESIZE_DISABLED** = ``0``
    1128. 

  1128. 

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

  1130. 

  1131. .. _class_DisplayServer_constant_WINDOW_FLAG_BORDERLESS:
    1132. 

  1132. 

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

  1134. 

  1135. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_BORDERLESS** = ``1``
    1136. 

  1136. 

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

  1138. 

  1139. .. _class_DisplayServer_constant_WINDOW_FLAG_ALWAYS_ON_TOP:
    1140. 

  1140. 

  1141. .. rst-class:: classref-enumeration-constant
    1142. 

  1142. 

  1143. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_ALWAYS_ON_TOP** = ``2``
    1144. 

  1144. 

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

  1146. 

  1147. .. _class_DisplayServer_constant_WINDOW_FLAG_TRANSPARENT:
    1148. 

  1148. 

  1149. .. rst-class:: classref-enumeration-constant
    1150. 

  1150. 

  1151. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_TRANSPARENT** = ``3``
    1152. 

  1152. 

  1153. The window background can be transparent.
    1154. 

  1154. 

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

  1156. 

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

  1158. 

  1159. .. _class_DisplayServer_constant_WINDOW_FLAG_NO_FOCUS:
    1160. 

  1160. 

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

  1162. 

  1163. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_NO_FOCUS** = ``4``
    1164. 

  1164. 

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

  1166. 

  1167. .. _class_DisplayServer_constant_WINDOW_FLAG_POPUP:
    1168. 

  1168. 

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

  1170. 

  1171. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_POPUP** = ``5``
    1172. 

  1172. 

  1173. 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>`).
    1174. 

  1174. 

  1175. .. _class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE:
    1176. 

  1176. 

  1177. .. rst-class:: classref-enumeration-constant
    1178. 

  1178. 

  1179. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_EXTEND_TO_TITLE** = ``6``
    1180. 

  1180. 

  1181. 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.
    1182. 

  1182. 

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

  1184. 

  1185. 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.
    1186. 

  1186. 

  1187. \ **Note:** This flag is implemented only on macOS.
    1188. 

  1188. 

  1189. .. _class_DisplayServer_constant_WINDOW_FLAG_MOUSE_PASSTHROUGH:
    1190. 

  1190. 

  1191. .. rst-class:: classref-enumeration-constant
    1192. 

  1192. 

  1193. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MOUSE_PASSTHROUGH** = ``7``
    1194. 

  1194. 

  1195. All mouse events are passed to the underlying window of the same application.
    1196. 

  1196. 

  1197. .. _class_DisplayServer_constant_WINDOW_FLAG_SHARP_CORNERS:
    1198. 

  1198. 

  1199. .. rst-class:: classref-enumeration-constant
    1200. 

  1200. 

  1201. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_SHARP_CORNERS** = ``8``
    1202. 

  1202. 

  1203. Window style is overridden, forcing sharp corners.
    1204. 

  1204. 

  1205. \ **Note:** This flag is implemented only on Windows (11).
    1206. 

  1206. 

  1207. .. _class_DisplayServer_constant_WINDOW_FLAG_MAX:
    1208. 

  1208. 

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

  1210. 

  1211. :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MAX** = ``9``
    1212. 

  1212. 

  1213. Max value of the :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`.
    1214. 

  1214. 

  1215. .. rst-class:: classref-item-separator
    1216. 

  1216. 

  1217. ----
    1218. 

  1218. 

  1219. .. _enum_DisplayServer_WindowEvent:
    1220. 

  1220. 

  1221. .. rst-class:: classref-enumeration
    1222. 

  1222. 

  1223. enum **WindowEvent**: :ref:`๐Ÿ”—<enum_DisplayServer_WindowEvent>`
    1224. 

  1224. 

  1225. .. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_ENTER:
    1226. 

  1226. 

  1227. .. rst-class:: classref-enumeration-constant
    1228. 

  1228. 

  1229. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_ENTER** = ``0``
    1230. 

  1230. 

  1231. Sent when the mouse pointer enters the window.
    1232. 

  1232. 

  1233. .. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_EXIT:
    1234. 

  1234. 

  1235. .. rst-class:: classref-enumeration-constant
    1236. 

  1236. 

  1237. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_EXIT** = ``1``
    1238. 

  1238. 

  1239. Sent when the mouse pointer exits the window.
    1240. 

  1240. 

  1241. .. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_IN:
    1242. 

  1242. 

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

  1244. 

  1245. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_IN** = ``2``
    1246. 

  1246. 

  1247. Sent when the window grabs focus.
    1248. 

  1248. 

  1249. .. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_OUT:
    1250. 

  1250. 

  1251. .. rst-class:: classref-enumeration-constant
    1252. 

  1252. 

  1253. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_OUT** = ``3``
    1254. 

  1254. 

  1255. Sent when the window loses focus.
    1256. 

  1256. 

  1257. .. _class_DisplayServer_constant_WINDOW_EVENT_CLOSE_REQUEST:
    1258. 

  1258. 

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

  1260. 

  1261. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_CLOSE_REQUEST** = ``4``
    1262. 

  1262. 

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

  1264. 

  1265. .. _class_DisplayServer_constant_WINDOW_EVENT_GO_BACK_REQUEST:
    1266. 

  1266. 

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

  1268. 

  1269. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_GO_BACK_REQUEST** = ``5``
    1270. 

  1270. 

  1271. Sent when the device "Back" button is pressed.
    1272. 

  1272. 

  1273. \ **Note:** This event is implemented only on Android.
    1274. 

  1274. 

  1275. .. _class_DisplayServer_constant_WINDOW_EVENT_DPI_CHANGE:
    1276. 

  1276. 

  1277. .. rst-class:: classref-enumeration-constant
    1278. 

  1278. 

  1279. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_DPI_CHANGE** = ``6``
    1280. 

  1280. 

  1281. Sent when the window is moved to the display with different DPI, or display DPI is changed.
    1282. 

  1282. 

  1283. \ **Note:** This flag is implemented only on macOS.
    1284. 

  1284. 

  1285. .. _class_DisplayServer_constant_WINDOW_EVENT_TITLEBAR_CHANGE:
    1286. 

  1286. 

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

  1288. 

  1289. :ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_TITLEBAR_CHANGE** = ``7``
    1290. 

  1290. 

  1291. 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).
    1292. 

  1292. 

  1293. \ **Note:** This flag is implemented only on macOS.
    1294. 

  1294. 

  1295. .. rst-class:: classref-item-separator
    1296. 

  1296. 

  1297. ----
    1298. 

  1298. 

  1299. .. _enum_DisplayServer_VSyncMode:
    1300. 

  1300. 

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

  1302. 

  1303. enum **VSyncMode**: :ref:`๐Ÿ”—<enum_DisplayServer_VSyncMode>`
    1304. 

  1304. 

  1305. .. _class_DisplayServer_constant_VSYNC_DISABLED:
    1306. 

  1306. 

  1307. .. rst-class:: classref-enumeration-constant
    1308. 

  1308. 

  1309. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_DISABLED** = ``0``
    1310. 

  1310. 

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

  1312. 

  1313. .. _class_DisplayServer_constant_VSYNC_ENABLED:
    1314. 

  1314. 

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

  1316. 

  1317. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ENABLED** = ``1``
    1318. 

  1318. 

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

  1320. 

  1321. .. _class_DisplayServer_constant_VSYNC_ADAPTIVE:
    1322. 

  1322. 

  1323. .. rst-class:: classref-enumeration-constant
    1324. 

  1324. 

  1325. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ADAPTIVE** = ``2``
    1326. 

  1326. 

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

  1328. 

  1329. .. _class_DisplayServer_constant_VSYNC_MAILBOX:
    1330. 

  1330. 

  1331. .. rst-class:: classref-enumeration-constant
    1332. 

  1332. 

  1333. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_MAILBOX** = ``3``
    1334. 

  1334. 

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

  1336. 

  1337. 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.
    1338. 

  1338. 

  1339. .. rst-class:: classref-item-separator
    1340. 

  1340. 

  1341. ----
    1342. 

  1342. 

  1343. .. _enum_DisplayServer_HandleType:
    1344. 

  1344. 

  1345. .. rst-class:: classref-enumeration
    1346. 

  1346. 

  1347. enum **HandleType**: :ref:`๐Ÿ”—<enum_DisplayServer_HandleType>`
    1348. 

  1348. 

  1349. .. _class_DisplayServer_constant_DISPLAY_HANDLE:
    1350. 

  1350. 

  1351. .. rst-class:: classref-enumeration-constant
    1352. 

  1352. 

  1353. :ref:`HandleType<enum_DisplayServer_HandleType>` **DISPLAY_HANDLE** = ``0``
    1354. 

  1354. 

  1355. Display handle:
    1356. 

  1356. 

  1357. - Linux (X11): ``X11::Display*`` for the display.
    1358. 

  1358. 

  1359. - Linux (Wayland): ``wl_display`` for the display.
    1360. 

  1360. 

  1361. - Android: ``EGLDisplay`` for the display.
    1362. 

  1362. 

  1363. .. _class_DisplayServer_constant_WINDOW_HANDLE:
    1364. 

  1364. 

  1365. .. rst-class:: classref-enumeration-constant
    1366. 

  1366. 

  1367. :ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_HANDLE** = ``1``
    1368. 

  1368. 

  1369. Window handle:
    1370. 

  1370. 

  1371. - Windows: ``HWND`` for the window.
    1372. 

  1372. 

  1373. - Linux (X11): ``X11::Window*`` for the window.
    1374. 

  1374. 

  1375. - Linux (Wayland): ``wl_surface`` for the window.
    1376. 

  1376. 

  1377. - macOS: ``NSWindow*`` for the window.
    1378. 

  1378. 

  1379. - iOS: ``UIViewController*`` for the view controller.
    1380. 

  1380. 

  1381. - Android: ``jObject`` for the activity.
    1382. 

  1382. 

  1383. .. _class_DisplayServer_constant_WINDOW_VIEW:
    1384. 

  1384. 

  1385. .. rst-class:: classref-enumeration-constant
    1386. 

  1386. 

  1387. :ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_VIEW** = ``2``
    1388. 

  1388. 

  1389. Window view:
    1390. 

  1390. 

  1391. - Windows: ``HDC`` for the window (only with the Compatibility renderer).
    1392. 

  1392. 

  1393. - macOS: ``NSView*`` for the window main view.
    1394. 

  1394. 

  1395. - iOS: ``UIView*`` for the window main view.
    1396. 

  1396. 

  1397. .. _class_DisplayServer_constant_OPENGL_CONTEXT:
    1398. 

  1398. 

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

  1400. 

  1401. :ref:`HandleType<enum_DisplayServer_HandleType>` **OPENGL_CONTEXT** = ``3``
    1402. 

  1402. 

  1403. OpenGL context (only with the Compatibility renderer):
    1404. 

  1404. 

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

  1406. 

  1407. - Linux (X11): ``GLXContext*`` for the window.
    1408. 

  1408. 

  1409. - Linux (Wayland): ``EGLContext`` for the window.
    1410. 

  1410. 

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

  1412. 

  1413. - Android: ``EGLContext`` for the window.
    1414. 

  1414. 

  1415. .. _class_DisplayServer_constant_EGL_DISPLAY:
    1416. 

  1416. 

  1417. .. rst-class:: classref-enumeration-constant
    1418. 

  1418. 

  1419. :ref:`HandleType<enum_DisplayServer_HandleType>` **EGL_DISPLAY** = ``4``
    1420. 

  1420. 

  1421. - Windows: ``EGLDisplay`` for the window (ANGLE).
    1422. 

  1422. 

  1423. - macOS: ``EGLDisplay`` for the window (ANGLE).
    1424. 

  1424. 

  1425. - Linux (Wayland): ``EGLDisplay`` for the window.
    1426. 

  1426. 

  1427. .. _class_DisplayServer_constant_EGL_CONFIG:
    1428. 

  1428. 

  1429. .. rst-class:: classref-enumeration-constant
    1430. 

  1430. 

  1431. :ref:`HandleType<enum_DisplayServer_HandleType>` **EGL_CONFIG** = ``5``
    1432. 

  1432. 

  1433. - Windows: ``EGLConfig`` for the window (ANGLE).
    1434. 

  1434. 

  1435. - macOS: ``EGLConfig`` for the window (ANGLE).
    1436. 

  1436. 

  1437. - Linux (Wayland): ``EGLConfig`` for the window.
    1438. 

  1438. 

  1439. .. rst-class:: classref-item-separator
    1440. 

  1440. 

  1441. ----
    1442. 

  1442. 

  1443. .. _enum_DisplayServer_TTSUtteranceEvent:
    1444. 

  1444. 

  1445. .. rst-class:: classref-enumeration
    1446. 

  1446. 

  1447. enum **TTSUtteranceEvent**: :ref:`๐Ÿ”—<enum_DisplayServer_TTSUtteranceEvent>`
    1448. 

  1448. 

  1449. .. _class_DisplayServer_constant_TTS_UTTERANCE_STARTED:
    1450. 

  1450. 

  1451. .. rst-class:: classref-enumeration-constant
    1452. 

  1452. 

  1453. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_STARTED** = ``0``
    1454. 

  1454. 

  1455. Utterance has begun to be spoken.
    1456. 

  1456. 

  1457. .. _class_DisplayServer_constant_TTS_UTTERANCE_ENDED:
    1458. 

  1458. 

  1459. .. rst-class:: classref-enumeration-constant
    1460. 

  1460. 

  1461. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_ENDED** = ``1``
    1462. 

  1462. 

  1463. Utterance was successfully finished.
    1464. 

  1464. 

  1465. .. _class_DisplayServer_constant_TTS_UTTERANCE_CANCELED:
    1466. 

  1466. 

  1467. .. rst-class:: classref-enumeration-constant
    1468. 

  1468. 

  1469. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_CANCELED** = ``2``
    1470. 

  1470. 

  1471. Utterance was canceled, or TTS service was unable to process it.
    1472. 

  1472. 

  1473. .. _class_DisplayServer_constant_TTS_UTTERANCE_BOUNDARY:
    1474. 

  1474. 

  1475. .. rst-class:: classref-enumeration-constant
    1476. 

  1476. 

  1477. :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_BOUNDARY** = ``3``
    1478. 

  1478. 

  1479. Utterance reached a word or sentence boundary.
    1480. 

  1480. 

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

  1482. 

  1483. ----
    1484. 

  1484. 

  1485. .. rst-class:: classref-descriptions-group
    1486. 

  1486. 

  1487. Constants
    1488. 

  1488. ---------
    1489. 

  1489. 

  1490. .. _class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS:
    1491. 

  1491. 

  1492. .. rst-class:: classref-constant
    1493. 

  1493. 

  1494. **SCREEN_WITH_MOUSE_FOCUS** = ``-4`` :ref:`๐Ÿ”—<class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS>`
    1495. 

  1495. 

  1496. Represents the screen containing the mouse pointer.
    1497. 

  1497. 

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

  1499. 

  1500. .. _class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS:
    1501. 

  1501. 

  1502. .. rst-class:: classref-constant
    1503. 

  1503. 

  1504. **SCREEN_WITH_KEYBOARD_FOCUS** = ``-3`` :ref:`๐Ÿ”—<class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS>`
    1505. 

  1505. 

  1506. Represents the screen containing the window with the keyboard focus.
    1507. 

  1507. 

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

  1509. 

  1510. .. _class_DisplayServer_constant_SCREEN_PRIMARY:
    1511. 

  1511. 

  1512. .. rst-class:: classref-constant
    1513. 

  1513. 

  1514. **SCREEN_PRIMARY** = ``-2`` :ref:`๐Ÿ”—<class_DisplayServer_constant_SCREEN_PRIMARY>`
    1515. 

  1515. 

  1516. Represents the primary screen.
    1517. 

  1517. 

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

  1519. 

  1520. .. _class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW:
    1521. 

  1521. 

  1522. .. rst-class:: classref-constant
    1523. 

  1523. 

  1524. **SCREEN_OF_MAIN_WINDOW** = ``-1`` :ref:`๐Ÿ”—<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`
    1525. 

  1525. 

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

  1527. 

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

  1529. 

  1530. .. _class_DisplayServer_constant_MAIN_WINDOW_ID:
    1531. 

  1531. 

  1532. .. rst-class:: classref-constant
    1533. 

  1533. 

  1534. **MAIN_WINDOW_ID** = ``0`` :ref:`๐Ÿ”—<class_DisplayServer_constant_MAIN_WINDOW_ID>`
    1535. 

  1535. 

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

  1537. 

  1538. .. _class_DisplayServer_constant_INVALID_WINDOW_ID:
    1539. 

  1539. 

  1540. .. rst-class:: classref-constant
    1541. 

  1541. 

  1542. **INVALID_WINDOW_ID** = ``-1`` :ref:`๐Ÿ”—<class_DisplayServer_constant_INVALID_WINDOW_ID>`
    1543. 

  1543. 

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

  1545. 

  1546. .. _class_DisplayServer_constant_INVALID_INDICATOR_ID:
    1547. 

  1547. 

  1548. .. rst-class:: classref-constant
    1549. 

  1549. 

  1550. **INVALID_INDICATOR_ID** = ``-1`` :ref:`๐Ÿ”—<class_DisplayServer_constant_INVALID_INDICATOR_ID>`
    1551. 

  1551. 

  1552. The ID that refers to a nonexistent application status indicator.
    1553. 

  1553. 

  1554. .. rst-class:: classref-section-separator
    1555. 

  1555. 

  1556. ----
    1557. 

  1557. 

  1558. .. rst-class:: classref-descriptions-group
    1559. 

  1559. 

  1560. Method Descriptions
    1561. 

  1561. -------------------
    1562. 

  1562. 

  1563. .. _class_DisplayServer_method_beep:
    1564. 

  1564. 

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

  1566. 

  1567. |void| **beep**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_beep>`
    1568. 

  1568. 

  1569. Plays the beep sound from the operative system, if possible. Because it comes from the OS, the beep sound will be audible even if the application is muted. It may also be disabled for the entire OS by the user.
    1570. 

  1570. 

  1571. \ **Note:** This method is implemented on macOS, Linux (X11/Wayland), and Windows.
    1572. 

  1572. 

  1573. .. rst-class:: classref-item-separator
    1574. 

  1574. 

  1575. ----
    1576. 

  1576. 

  1577. .. _class_DisplayServer_method_clipboard_get:
    1578. 

  1578. 

  1579. .. rst-class:: classref-method
    1580. 

  1580. 

  1581. :ref:`String<class_String>` **clipboard_get**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_get>`
    1582. 

  1582. 

  1583. Returns the user's clipboard as a string if possible.
    1584. 

  1584. 

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

  1586. 

  1587. ----
    1588. 

  1588. 

  1589. .. _class_DisplayServer_method_clipboard_get_image:
    1590. 

  1590. 

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

  1592. 

  1593. :ref:`Image<class_Image>` **clipboard_get_image**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_get_image>`
    1594. 

  1594. 

  1595. Returns the user's clipboard as an image if possible.
    1596. 

  1596. 

  1597. \ **Note:** This method uses the copied pixel data, e.g. from a image editing software or a web browser, not an image file copied from file explorer.
    1598. 

  1598. 

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

  1600. 

  1601. ----
    1602. 

  1602. 

  1603. .. _class_DisplayServer_method_clipboard_get_primary:
    1604. 

  1604. 

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

  1606. 

  1607. :ref:`String<class_String>` **clipboard_get_primary**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_get_primary>`
    1608. 

  1608. 

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

  1610. 

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

  1612. 

  1613. .. rst-class:: classref-item-separator
    1614. 

  1614. 

  1615. ----
    1616. 

  1616. 

  1617. .. _class_DisplayServer_method_clipboard_has:
    1618. 

  1618. 

  1619. .. rst-class:: classref-method
    1620. 

  1620. 

  1621. :ref:`bool<class_bool>` **clipboard_has**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_has>`
    1622. 

  1622. 

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

  1624. 

  1625. .. rst-class:: classref-item-separator
    1626. 

  1626. 

  1627. ----
    1628. 

  1628. 

  1629. .. _class_DisplayServer_method_clipboard_has_image:
    1630. 

  1630. 

  1631. .. rst-class:: classref-method
    1632. 

  1632. 

  1633. :ref:`bool<class_bool>` **clipboard_has_image**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_has_image>`
    1634. 

  1634. 

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

  1636. 

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

  1638. 

  1639. ----
    1640. 

  1640. 

  1641. .. _class_DisplayServer_method_clipboard_set:
    1642. 

  1642. 

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

  1644. 

  1645. |void| **clipboard_set**\ (\ clipboard\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_set>`
    1646. 

  1646. 

  1647. Sets the user's clipboard content to the given string.
    1648. 

  1648. 

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

  1650. 

  1651. ----
    1652. 

  1652. 

  1653. .. _class_DisplayServer_method_clipboard_set_primary:
    1654. 

  1654. 

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

  1656. 

  1657. |void| **clipboard_set_primary**\ (\ clipboard_primary\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_clipboard_set_primary>`
    1658. 

  1658. 

  1659. 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.
    1660. 

  1660. 

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

  1662. 

  1663. .. rst-class:: classref-item-separator
    1664. 

  1664. 

  1665. ----
    1666. 

  1666. 

  1667. .. _class_DisplayServer_method_create_status_indicator:
    1668. 

  1668. 

  1669. .. rst-class:: classref-method
    1670. 

  1670. 

  1671. :ref:`int<class_int>` **create_status_indicator**\ (\ icon\: :ref:`Texture2D<class_Texture2D>`, tooltip\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_create_status_indicator>`
    1672. 

  1672. 

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

  1674. 

  1675. \ ``callback`` should take two arguments: the pressed mouse button (one of the :ref:`MouseButton<enum_@GlobalScope_MouseButton>` constants) and the click position in screen coordinates (a :ref:`Vector2i<class_Vector2i>`).
    1676. 

  1676. 

  1677. .. rst-class:: classref-item-separator
    1678. 

  1678. 

  1679. ----
    1680. 

  1680. 

  1681. .. _class_DisplayServer_method_cursor_get_shape:
    1682. 

  1682. 

  1683. .. rst-class:: classref-method
    1684. 

  1684. 

  1685. :ref:`CursorShape<enum_DisplayServer_CursorShape>` **cursor_get_shape**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_cursor_get_shape>`
    1686. 

  1686. 

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

  1688. 

  1689. .. rst-class:: classref-item-separator
    1690. 

  1690. 

  1691. ----
    1692. 

  1692. 

  1693. .. _class_DisplayServer_method_cursor_set_custom_image:
    1694. 

  1694. 

  1695. .. rst-class:: classref-method
    1696. 

  1696. 

  1697. |void| **cursor_set_custom_image**\ (\ cursor\: :ref:`Resource<class_Resource>`, shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>` = 0, hotspot\: :ref:`Vector2<class_Vector2>` = Vector2(0, 0)\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_cursor_set_custom_image>`
    1698. 

  1698. 

  1699. Sets a custom mouse cursor image for the given ``shape``. This means the user's operating system and mouse cursor theme will no longer influence the mouse cursor's appearance.
    1700. 

  1700. 

  1701. \ ``cursor`` can be either a :ref:`Texture2D<class_Texture2D>` or an :ref:`Image<class_Image>`, and it should not be larger than 256ร—256 to display correctly. Optionally, ``hotspot`` can be set to offset the image's position relative to the click point. By default, ``hotspot`` is set to the top-left corner of the image. See also :ref:`cursor_set_shape<class_DisplayServer_method_cursor_set_shape>`.
    1702. 

  1702. 

  1703. .. rst-class:: classref-item-separator
    1704. 

  1704. 

  1705. ----
    1706. 

  1706. 

  1707. .. _class_DisplayServer_method_cursor_set_shape:
    1708. 

  1708. 

  1709. .. rst-class:: classref-method
    1710. 

  1710. 

  1711. |void| **cursor_set_shape**\ (\ shape\: :ref:`CursorShape<enum_DisplayServer_CursorShape>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_cursor_set_shape>`
    1712. 

  1712. 

  1713. 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>`.
    1714. 

  1714. 

  1715. .. rst-class:: classref-item-separator
    1716. 

  1716. 

  1717. ----
    1718. 

  1718. 

  1719. .. _class_DisplayServer_method_delete_status_indicator:
    1720. 

  1720. 

  1721. .. rst-class:: classref-method
    1722. 

  1722. 

  1723. |void| **delete_status_indicator**\ (\ id\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_delete_status_indicator>`
    1724. 

  1724. 

  1725. Removes the application status indicator.
    1726. 

  1726. 

  1727. .. rst-class:: classref-item-separator
    1728. 

  1728. 

  1729. ----
    1730. 

  1730. 

  1731. .. _class_DisplayServer_method_dialog_input_text:
    1732. 

  1732. 

  1733. .. rst-class:: classref-method
    1734. 

  1734. 

  1735. :ref:`Error<enum_@GlobalScope_Error>` **dialog_input_text**\ (\ title\: :ref:`String<class_String>`, description\: :ref:`String<class_String>`, existing_text\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_dialog_input_text>`
    1736. 

  1736. 

  1737. Shows a text input dialog which uses the operating system's native look-and-feel. ``callback`` should accept a single :ref:`String<class_String>` parameter which contains the text field's contents.
    1738. 

  1738. 

  1739. \ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_INPUT<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_INPUT>` feature. Supported platforms include macOS, Windows, and Android.
    1740. 

  1740. 

  1741. .. rst-class:: classref-item-separator
    1742. 

  1742. 

  1743. ----
    1744. 

  1744. 

  1745. .. _class_DisplayServer_method_dialog_show:
    1746. 

  1746. 

  1747. .. rst-class:: classref-method
    1748. 

  1748. 

  1749. :ref:`Error<enum_@GlobalScope_Error>` **dialog_show**\ (\ title\: :ref:`String<class_String>`, description\: :ref:`String<class_String>`, buttons\: :ref:`PackedStringArray<class_PackedStringArray>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_dialog_show>`
    1750. 

  1750. 

  1751. Shows a text dialog which uses the operating system's native look-and-feel. ``callback`` should accept a single :ref:`int<class_int>` parameter which corresponds to the index of the pressed button.
    1752. 

  1752. 

  1753. \ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG>` feature. Supported platforms include macOS and Windows.
    1754. 

  1754. 

  1755. .. rst-class:: classref-item-separator
    1756. 

  1756. 

  1757. ----
    1758. 

  1758. 

  1759. .. _class_DisplayServer_method_enable_for_stealing_focus:
    1760. 

  1760. 

  1761. .. rst-class:: classref-method
    1762. 

  1762. 

  1763. |void| **enable_for_stealing_focus**\ (\ process_id\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_enable_for_stealing_focus>`
    1764. 

  1764. 

  1765. 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.
    1766. 

  1766. 

  1767. \ **Note:** This method is implemented only on Windows.
    1768. 

  1768. 

  1769. .. rst-class:: classref-item-separator
    1770. 

  1770. 

  1771. ----
    1772. 

  1772. 

  1773. .. _class_DisplayServer_method_file_dialog_show:
    1774. 

  1774. 

  1775. .. rst-class:: classref-method
    1776. 

  1776. 

  1777. :ref:`Error<enum_@GlobalScope_Error>` **file_dialog_show**\ (\ title\: :ref:`String<class_String>`, current_directory\: :ref:`String<class_String>`, filename\: :ref:`String<class_String>`, show_hidden\: :ref:`bool<class_bool>`, mode\: :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>`, filters\: :ref:`PackedStringArray<class_PackedStringArray>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_file_dialog_show>`
    1778. 

  1778. 

  1779. Displays OS native dialog for selecting files or directories in the file system.
    1780. 

  1780. 

  1781. Each filter string in the ``filters`` array should be formatted like this: ``*.txt,*.doc;Text Files``. The description text of the filter is optional and can be omitted. See also :ref:`FileDialog.filters<class_FileDialog_property_filters>`.
    1782. 

  1782. 

  1783. Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int``. **On Android,** callback argument ``selected_filter_index`` is always zero.
    1784. 

  1784. 

  1785. \ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_FILE<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE>` feature. Supported platforms include Linux (X11/Wayland), Windows, macOS, and Android.
    1786. 

  1786. 

  1787. \ **Note:** ``current_directory`` might be ignored.
    1788. 

  1788. 

  1789. \ **Note:** On Android, the filter strings in the ``filters`` array should be specified using MIME types, for example:``image/png, image/jpeg"``. Additionally, the ``mode`` :ref:`FILE_DIALOG_MODE_OPEN_ANY<class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_ANY>` is not supported on Android.
    1790. 

  1790. 

  1791. \ **Note:** On Android and Linux, ``show_hidden`` is ignored.
    1792. 

  1792. 

  1793. \ **Note:** On Android and macOS, native file dialogs have no title.
    1794. 

  1794. 

  1795. \ **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.
    1796. 

  1796. 

  1797. .. rst-class:: classref-item-separator
    1798. 

  1798. 

  1799. ----
    1800. 

  1800. 

  1801. .. _class_DisplayServer_method_file_dialog_with_options_show:
    1802. 

  1802. 

  1803. .. rst-class:: classref-method
    1804. 

  1804. 

  1805. :ref:`Error<enum_@GlobalScope_Error>` **file_dialog_with_options_show**\ (\ title\: :ref:`String<class_String>`, current_directory\: :ref:`String<class_String>`, root\: :ref:`String<class_String>`, filename\: :ref:`String<class_String>`, show_hidden\: :ref:`bool<class_bool>`, mode\: :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>`, filters\: :ref:`PackedStringArray<class_PackedStringArray>`, options\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\], callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_file_dialog_with_options_show>`
    1806. 

  1806. 

  1807. Displays OS native dialog for selecting files or directories in the file system with additional user selectable options.
    1808. 

  1808. 

  1809. Each filter string in the ``filters`` array should be formatted like this: ``*.txt,*.doc;Text Files``. The description text of the filter is optional and can be omitted. See also :ref:`FileDialog.filters<class_FileDialog_property_filters>`.
    1810. 

  1810. 

  1811. \ ``options`` is array of :ref:`Dictionary<class_Dictionary>`\ s with the following keys:
    1812. 

  1812. 

  1813. - ``"name"`` - option's name :ref:`String<class_String>`.
    1814. 

  1814. 

  1815. - ``"values"`` - :ref:`PackedStringArray<class_PackedStringArray>` of values. If empty, boolean option (check box) is used.
    1816. 

  1816. 

  1817. - ``"default"`` - default selected option index (:ref:`int<class_int>`) or default boolean value (:ref:`bool<class_bool>`).
    1818. 

  1818. 

  1819. Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int, selected_option: Dictionary``.
    1820. 

  1820. 

  1821. \ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_FILE_EXTRA<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE_EXTRA>` feature. Supported platforms include Linux (X11/Wayland), Windows, and macOS.
    1822. 

  1822. 

  1823. \ **Note:** ``current_directory`` might be ignored.
    1824. 

  1824. 

  1825. \ **Note:** On Linux (X11), ``show_hidden`` is ignored.
    1826. 

  1826. 

  1827. \ **Note:** On macOS, native file dialogs have no title.
    1828. 

  1828. 

  1829. \ **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.
    1830. 

  1830. 

  1831. .. rst-class:: classref-item-separator
    1832. 

  1832. 

  1833. ----
    1834. 

  1834. 

  1835. .. _class_DisplayServer_method_force_process_and_drop_events:
    1836. 

  1836. 

  1837. .. rst-class:: classref-method
    1838. 

  1838. 

  1839. |void| **force_process_and_drop_events**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_force_process_and_drop_events>`
    1840. 

  1840. 

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

  1842. 

  1843. \ **Note:** This method is implemented on Windows and macOS.
    1844. 

  1844. 

  1845. .. rst-class:: classref-item-separator
    1846. 

  1846. 

  1847. ----
    1848. 

  1848. 

  1849. .. _class_DisplayServer_method_get_accent_color:
    1850. 

  1850. 

  1851. .. rst-class:: classref-method
    1852. 

  1852. 

  1853. :ref:`Color<class_Color>` **get_accent_color**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_accent_color>`
    1854. 

  1854. 

  1855. Returns OS theme accent color. Returns ``Color(0, 0, 0, 0)``, if accent color is unknown.
    1856. 

  1856. 

  1857. \ **Note:** This method is implemented on macOS, Windows, and Android.
    1858. 

  1858. 

  1859. .. rst-class:: classref-item-separator
    1860. 

  1860. 

  1861. ----
    1862. 

  1862. 

  1863. .. _class_DisplayServer_method_get_base_color:
    1864. 

  1864. 

  1865. .. rst-class:: classref-method
    1866. 

  1866. 

  1867. :ref:`Color<class_Color>` **get_base_color**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_base_color>`
    1868. 

  1868. 

  1869. Returns the OS theme base color (default control background). Returns ``Color(0, 0, 0, 0)`` if the base color is unknown.
    1870. 

  1870. 

  1871. \ **Note:** This method is implemented on macOS and Windows.
    1872. 

  1872. 

  1873. .. rst-class:: classref-item-separator
    1874. 

  1874. 

  1875. ----
    1876. 

  1876. 

  1877. .. _class_DisplayServer_method_get_display_cutouts:
    1878. 

  1878. 

  1879. .. rst-class:: classref-method
    1880. 

  1880. 

  1881. :ref:`Array<class_Array>`\[:ref:`Rect2<class_Rect2>`\] **get_display_cutouts**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_display_cutouts>`
    1882. 

  1882. 

  1883. 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>`.
    1884. 

  1884. 

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

  1886. 

  1887. .. rst-class:: classref-item-separator
    1888. 

  1888. 

  1889. ----
    1890. 

  1890. 

  1891. .. _class_DisplayServer_method_get_display_safe_area:
    1892. 

  1892. 

  1893. .. rst-class:: classref-method
    1894. 

  1894. 

  1895. :ref:`Rect2i<class_Rect2i>` **get_display_safe_area**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_display_safe_area>`
    1896. 

  1896. 

  1897. 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>`.
    1898. 

  1898. 

  1899. .. rst-class:: classref-item-separator
    1900. 

  1900. 

  1901. ----
    1902. 

  1902. 

  1903. .. _class_DisplayServer_method_get_keyboard_focus_screen:
    1904. 

  1904. 

  1905. .. rst-class:: classref-method
    1906. 

  1906. 

  1907. :ref:`int<class_int>` **get_keyboard_focus_screen**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_keyboard_focus_screen>`
    1908. 

  1908. 

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

  1910. 

  1911. .. rst-class:: classref-item-separator
    1912. 

  1912. 

  1913. ----
    1914. 

  1914. 

  1915. .. _class_DisplayServer_method_get_name:
    1916. 

  1916. 

  1917. .. rst-class:: classref-method
    1918. 

  1918. 

  1919. :ref:`String<class_String>` **get_name**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_name>`
    1920. 

  1920. 

  1921. Returns the name of the **DisplayServer** currently in use. Most operating systems only have a single **DisplayServer**, but Linux has access to more than one **DisplayServer** (currently X11 and Wayland).
    1922. 

  1922. 

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

  1924. 

  1925. .. rst-class:: classref-item-separator
    1926. 

  1926. 

  1927. ----
    1928. 

  1928. 

  1929. .. _class_DisplayServer_method_get_primary_screen:
    1930. 

  1930. 

  1931. .. rst-class:: classref-method
    1932. 

  1932. 

  1933. :ref:`int<class_int>` **get_primary_screen**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_primary_screen>`
    1934. 

  1934. 

  1935. Returns index of the primary screen.
    1936. 

  1936. 

  1937. .. rst-class:: classref-item-separator
    1938. 

  1938. 

  1939. ----
    1940. 

  1940. 

  1941. .. _class_DisplayServer_method_get_screen_count:
    1942. 

  1942. 

  1943. .. rst-class:: classref-method
    1944. 

  1944. 

  1945. :ref:`int<class_int>` **get_screen_count**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_screen_count>`
    1946. 

  1946. 

  1947. Returns the number of displays available.
    1948. 

  1948. 

  1949. .. rst-class:: classref-item-separator
    1950. 

  1950. 

  1951. ----
    1952. 

  1952. 

  1953. .. _class_DisplayServer_method_get_screen_from_rect:
    1954. 

  1954. 

  1955. .. rst-class:: classref-method
    1956. 

  1956. 

  1957. :ref:`int<class_int>` **get_screen_from_rect**\ (\ rect\: :ref:`Rect2<class_Rect2>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_screen_from_rect>`
    1958. 

  1958. 

  1959. Returns the index of the screen that overlaps the most with the given rectangle. Returns ``-1`` if the rectangle doesn't overlap with any screen or has no area.
    1960. 

  1960. 

  1961. .. rst-class:: classref-item-separator
    1962. 

  1962. 

  1963. ----
    1964. 

  1964. 

  1965. .. _class_DisplayServer_method_get_swap_cancel_ok:
    1966. 

  1966. 

  1967. .. rst-class:: classref-method
    1968. 

  1968. 

  1969. :ref:`bool<class_bool>` **get_swap_cancel_ok**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_get_swap_cancel_ok>`
    1970. 

  1970. 

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

  1972. 

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

  1974. 

  1975. .. rst-class:: classref-item-separator
    1976. 

  1976. 

  1977. ----
    1978. 

  1978. 

  1979. .. _class_DisplayServer_method_get_window_at_screen_position:
    1980. 

  1980. 

  1981. .. rst-class:: classref-method
    1982. 

  1982. 

  1983. :ref:`int<class_int>` **get_window_at_screen_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_window_at_screen_position>`
    1984. 

  1984. 

  1985. 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:
    1986. 

  1986. 

  1987. .. code:: text
    1988. 

  1988. 

  1989.     * (0, 0)        +-------+
    1990. 

  1990.                     |       |
    1991. 

  1991.     +-------------+ |       |
    1992. 

  1992.     |             | |       |
    1993. 

  1993.     |             | |       |
    1994. 

  1994.     +-------------+ +-------+
    1995. 

  1995. 

  1996. .. rst-class:: classref-item-separator
    1997. 

  1997. 

  1998. ----
    1999. 

  1999. 

  2000. .. _class_DisplayServer_method_get_window_list:
    2001. 

  2001. 

  2002. .. rst-class:: classref-method
    2003. 

  2003. 

  2004. :ref:`PackedInt32Array<class_PackedInt32Array>` **get_window_list**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_get_window_list>`
    2005. 

  2005. 

  2006. Returns the list of Godot window IDs belonging to this process.
    2007. 

  2007. 

  2008. \ **Note:** Native dialogs are not included in this list.
    2009. 

  2009. 

  2010. .. rst-class:: classref-item-separator
    2011. 

  2011. 

  2012. ----
    2013. 

  2013. 

  2014. .. _class_DisplayServer_method_global_menu_add_check_item:
    2015. 

  2015. 

  2016. .. rst-class:: classref-method
    2017. 

  2017. 

  2018. :ref:`int<class_int>` **global_menu_add_check_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_check_item>`
    2019. 

  2019. 

  2020. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2021. 

  2021. 

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

  2023. 

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

  2025. 

  2026. 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`).
    2027. 

  2027. 

  2028. \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
    2029. 

  2029. 

  2030. \ **Note:** This method is implemented only on macOS.
    2031. 

  2031. 

  2032. \ **Supported system menu IDs:**\ 
    2033. 

  2033. 

  2034. .. code:: text
    2035. 

  2035. 

  2036.     "_main" - Main menu (macOS).
    2037. 

  2037.     "_dock" - Dock popup menu (macOS).
    2038. 

  2038.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2039. 

  2039.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2040. 

  2040.     "_help" - Help menu (macOS).
    2041. 

  2041. 

  2042. .. rst-class:: classref-item-separator
    2043. 

  2043. 

  2044. ----
    2045. 

  2045. 

  2046. .. _class_DisplayServer_method_global_menu_add_icon_check_item:
    2047. 

  2047. 

  2048. .. rst-class:: classref-method
    2049. 

  2049. 

  2050. :ref:`int<class_int>` **global_menu_add_icon_check_item**\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_icon_check_item>`
    2051. 

  2051. 

  2052. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2053. 

  2053. 

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

  2055. 

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

  2057. 

  2058. An ``accelerator`` can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The ``accelerator`` is generally a combination of :ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>`\ s and :ref:`Key<enum_@GlobalScope_Key>`\ s using bitwise OR such as ``KEY_MASK_CTRL | KEY_A`` (:kbd:`Ctrl + A`).
    2059. 

  2059. 

  2060. \ **Note:** The ``callback`` and ``key_callback`` Callables need to accept exactly one Variant parameter, the parameter passed to the Callables will be the value passed to ``tag``.
    2061. 

  2061. 

  2062. \ **Note:** This method is implemented only on macOS.
    2063. 

  2063. 

  2064. \ **Supported system menu IDs:**\ 
    2065. 

  2065. 

  2066. .. code:: text
    2067. 

  2067. 

  2068.     "_main" - Main menu (macOS).
    2069. 

  2069.     "_dock" - Dock popup menu (macOS).
    2070. 

  2070.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2071. 

  2071.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2072. 

  2072.     "_help" - Help menu (macOS).
    2073. 

  2073. 

  2074. .. rst-class:: classref-item-separator
    2075. 

  2075. 

  2076. ----
    2077. 

  2077. 

  2078. .. _class_DisplayServer_method_global_menu_add_icon_item:
    2079. 

  2079. 

  2080. .. rst-class:: classref-method
    2081. 

  2081. 

  2082. :ref:`int<class_int>` **global_menu_add_icon_item**\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_icon_item>`
    2083. 

  2083. 

  2084. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2085. 

  2085. 

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

  2087. 

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

  2089. 

  2090. 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`).
    2091. 

  2091. 

  2092. \ **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``.
    2093. 

  2093. 

  2094. \ **Note:** This method is implemented only on macOS.
    2095. 

  2095. 

  2096. \ **Supported system menu IDs:**\ 
    2097. 

  2097. 

  2098. .. code:: text
    2099. 

  2099. 

  2100.     "_main" - Main menu (macOS).
    2101. 

  2101.     "_dock" - Dock popup menu (macOS).
    2102. 

  2102.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2103. 

  2103.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2104. 

  2104.     "_help" - Help menu (macOS).
    2105. 

  2105. 

  2106. .. rst-class:: classref-item-separator
    2107. 

  2107. 

  2108. ----
    2109. 

  2109. 

  2110. .. _class_DisplayServer_method_global_menu_add_icon_radio_check_item:
    2111. 

  2111. 

  2112. .. rst-class:: classref-method
    2113. 

  2113. 

  2114. :ref:`int<class_int>` **global_menu_add_icon_radio_check_item**\ (\ menu_root\: :ref:`String<class_String>`, icon\: :ref:`Texture2D<class_Texture2D>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_icon_radio_check_item>`
    2115. 

  2115. 

  2116. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2117. 

  2117. 

  2118. Adds a new radio-checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``.
    2119. 

  2119. 

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

  2121. 

  2122. 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`).
    2123. 

  2123. 

  2124. \ **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.
    2125. 

  2125. 

  2126. \ **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``.
    2127. 

  2127. 

  2128. \ **Note:** This method is implemented only on macOS.
    2129. 

  2129. 

  2130. \ **Supported system menu IDs:**\ 
    2131. 

  2131. 

  2132. .. code:: text
    2133. 

  2133. 

  2134.     "_main" - Main menu (macOS).
    2135. 

  2135.     "_dock" - Dock popup menu (macOS).
    2136. 

  2136.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2137. 

  2137.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2138. 

  2138.     "_help" - Help menu (macOS).
    2139. 

  2139. 

  2140. .. rst-class:: classref-item-separator
    2141. 

  2141. 

  2142. ----
    2143. 

  2143. 

  2144. .. _class_DisplayServer_method_global_menu_add_item:
    2145. 

  2145. 

  2146. .. rst-class:: classref-method
    2147. 

  2147. 

  2148. :ref:`int<class_int>` **global_menu_add_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_item>`
    2149. 

  2149. 

  2150. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2151. 

  2151. 

  2152. Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
    2153. 

  2153. 

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

  2155. 

  2156. 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`).
    2157. 

  2157. 

  2158. \ **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``.
    2159. 

  2159. 

  2160. \ **Note:** This method is implemented only on macOS.
    2161. 

  2161. 

  2162. \ **Supported system menu IDs:**\ 
    2163. 

  2163. 

  2164. .. code:: text
    2165. 

  2165. 

  2166.     "_main" - Main menu (macOS).
    2167. 

  2167.     "_dock" - Dock popup menu (macOS).
    2168. 

  2168.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2169. 

  2169.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2170. 

  2170.     "_help" - Help menu (macOS).
    2171. 

  2171. 

  2172. .. rst-class:: classref-item-separator
    2173. 

  2173. 

  2174. ----
    2175. 

  2175. 

  2176. .. _class_DisplayServer_method_global_menu_add_multistate_item:
    2177. 

  2177. 

  2178. .. rst-class:: classref-method
    2179. 

  2179. 

  2180. :ref:`int<class_int>` **global_menu_add_multistate_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, max_states\: :ref:`int<class_int>`, default_state\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_multistate_item>`
    2181. 

  2181. 

  2182. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2183. 

  2183. 

  2184. Adds a new item with text ``label`` to the global menu with ID ``menu_root``.
    2185. 

  2185. 

  2186. 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``.
    2187. 

  2187. 

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

  2189. 

  2190. 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`).
    2191. 

  2191. 

  2192. \ **Note:** By default, there's no indication of the current item state, it should be changed manually.
    2193. 

  2193. 

  2194. \ **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``.
    2195. 

  2195. 

  2196. \ **Note:** This method is implemented only on macOS.
    2197. 

  2197. 

  2198. \ **Supported system menu IDs:**\ 
    2199. 

  2199. 

  2200. .. code:: text
    2201. 

  2201. 

  2202.     "_main" - Main menu (macOS).
    2203. 

  2203.     "_dock" - Dock popup menu (macOS).
    2204. 

  2204.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2205. 

  2205.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2206. 

  2206.     "_help" - Help menu (macOS).
    2207. 

  2207. 

  2208. .. rst-class:: classref-item-separator
    2209. 

  2209. 

  2210. ----
    2211. 

  2211. 

  2212. .. _class_DisplayServer_method_global_menu_add_radio_check_item:
    2213. 

  2213. 

  2214. .. rst-class:: classref-method
    2215. 

  2215. 

  2216. :ref:`int<class_int>` **global_menu_add_radio_check_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, callback\: :ref:`Callable<class_Callable>` = Callable(), key_callback\: :ref:`Callable<class_Callable>` = Callable(), tag\: :ref:`Variant<class_Variant>` = null, accelerator\: :ref:`Key<enum_@GlobalScope_Key>` = 0, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_radio_check_item>`
    2217. 

  2217. 

  2218. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2219. 

  2219. 

  2220. Adds a new radio-checkable item with text ``label`` to the global menu with ID ``menu_root``.
    2221. 

  2221. 

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

  2223. 

  2224. 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`).
    2225. 

  2225. 

  2226. \ **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.
    2227. 

  2227. 

  2228. \ **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``.
    2229. 

  2229. 

  2230. \ **Note:** This method is implemented only on macOS.
    2231. 

  2231. 

  2232. \ **Supported system menu IDs:**\ 
    2233. 

  2233. 

  2234. .. code:: text
    2235. 

  2235. 

  2236.     "_main" - Main menu (macOS).
    2237. 

  2237.     "_dock" - Dock popup menu (macOS).
    2238. 

  2238.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2239. 

  2239.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2240. 

  2240.     "_help" - Help menu (macOS).
    2241. 

  2241. 

  2242. .. rst-class:: classref-item-separator
    2243. 

  2243. 

  2244. ----
    2245. 

  2245. 

  2246. .. _class_DisplayServer_method_global_menu_add_separator:
    2247. 

  2247. 

  2248. .. rst-class:: classref-method
    2249. 

  2249. 

  2250. :ref:`int<class_int>` **global_menu_add_separator**\ (\ menu_root\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_separator>`
    2251. 

  2251. 

  2252. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2253. 

  2253. 

  2254. Adds a separator between items to the global menu with ID ``menu_root``. Separators also occupy an index.
    2255. 

  2255. 

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

  2257. 

  2258. \ **Note:** This method is implemented only on macOS.
    2259. 

  2259. 

  2260. \ **Supported system menu IDs:**\ 
    2261. 

  2261. 

  2262. .. code:: text
    2263. 

  2263. 

  2264.     "_main" - Main menu (macOS).
    2265. 

  2265.     "_dock" - Dock popup menu (macOS).
    2266. 

  2266.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2267. 

  2267.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2268. 

  2268.     "_help" - Help menu (macOS).
    2269. 

  2269. 

  2270. .. rst-class:: classref-item-separator
    2271. 

  2271. 

  2272. ----
    2273. 

  2273. 

  2274. .. _class_DisplayServer_method_global_menu_add_submenu_item:
    2275. 

  2275. 

  2276. .. rst-class:: classref-method
    2277. 

  2277. 

  2278. :ref:`int<class_int>` **global_menu_add_submenu_item**\ (\ menu_root\: :ref:`String<class_String>`, label\: :ref:`String<class_String>`, submenu\: :ref:`String<class_String>`, index\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_add_submenu_item>`
    2279. 

  2279. 

  2280. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2281. 

  2281. 

  2282. 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.
    2283. 

  2283. 

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

  2285. 

  2286. \ **Note:** This method is implemented only on macOS.
    2287. 

  2287. 

  2288. \ **Supported system menu IDs:**\ 
    2289. 

  2289. 

  2290. .. code:: text
    2291. 

  2291. 

  2292.     "_main" - Main menu (macOS).
    2293. 

  2293.     "_dock" - Dock popup menu (macOS).
    2294. 

  2294.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2295. 

  2295.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2296. 

  2296.     "_help" - Help menu (macOS).
    2297. 

  2297. 

  2298. .. rst-class:: classref-item-separator
    2299. 

  2299. 

  2300. ----
    2301. 

  2301. 

  2302. .. _class_DisplayServer_method_global_menu_clear:
    2303. 

  2303. 

  2304. .. rst-class:: classref-method
    2305. 

  2305. 

  2306. |void| **global_menu_clear**\ (\ menu_root\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_clear>`
    2307. 

  2307. 

  2308. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2309. 

  2309. 

  2310. Removes all items from the global menu with ID ``menu_root``.
    2311. 

  2311. 

  2312. \ **Note:** This method is implemented only on macOS.
    2313. 

  2313. 

  2314. \ **Supported system menu IDs:**\ 
    2315. 

  2315. 

  2316. .. code:: text
    2317. 

  2317. 

  2318.     "_main" - Main menu (macOS).
    2319. 

  2319.     "_dock" - Dock popup menu (macOS).
    2320. 

  2320.     "_apple" - Apple menu (macOS, custom items added before "Services").
    2321. 

  2321.     "_window" - Window menu (macOS, custom items added after "Bring All to Front").
    2322. 

  2322.     "_help" - Help menu (macOS).
    2323. 

  2323. 

  2324. .. rst-class:: classref-item-separator
    2325. 

  2325. 

  2326. ----
    2327. 

  2327. 

  2328. .. _class_DisplayServer_method_global_menu_get_item_accelerator:
    2329. 

  2329. 

  2330. .. rst-class:: classref-method
    2331. 

  2331. 

  2332. :ref:`Key<enum_@GlobalScope_Key>` **global_menu_get_item_accelerator**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_accelerator>`
    2333. 

  2333. 

  2334. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2335. 

  2335. 

  2336. 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.
    2337. 

  2337. 

  2338. \ **Note:** This method is implemented only on macOS.
    2339. 

  2339. 

  2340. .. rst-class:: classref-item-separator
    2341. 

  2341. 

  2342. ----
    2343. 

  2343. 

  2344. .. _class_DisplayServer_method_global_menu_get_item_callback:
    2345. 

  2345. 

  2346. .. rst-class:: classref-method
    2347. 

  2347. 

  2348. :ref:`Callable<class_Callable>` **global_menu_get_item_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_callback>`
    2349. 

  2349. 

  2350. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2351. 

  2351. 

  2352. Returns the callback of the item at index ``idx``.
    2353. 

  2353. 

  2354. \ **Note:** This method is implemented only on macOS.
    2355. 

  2355. 

  2356. .. rst-class:: classref-item-separator
    2357. 

  2357. 

  2358. ----
    2359. 

  2359. 

  2360. .. _class_DisplayServer_method_global_menu_get_item_count:
    2361. 

  2361. 

  2362. .. rst-class:: classref-method
    2363. 

  2363. 

  2364. :ref:`int<class_int>` **global_menu_get_item_count**\ (\ menu_root\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_count>`
    2365. 

  2365. 

  2366. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2367. 

  2367. 

  2368. Returns number of items in the global menu with ID ``menu_root``.
    2369. 

  2369. 

  2370. \ **Note:** This method is implemented only on macOS.
    2371. 

  2371. 

  2372. .. rst-class:: classref-item-separator
    2373. 

  2373. 

  2374. ----
    2375. 

  2375. 

  2376. .. _class_DisplayServer_method_global_menu_get_item_icon:
    2377. 

  2377. 

  2378. .. rst-class:: classref-method
    2379. 

  2379. 

  2380. :ref:`Texture2D<class_Texture2D>` **global_menu_get_item_icon**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_icon>`
    2381. 

  2381. 

  2382. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2383. 

  2383. 

  2384. Returns the icon of the item at index ``idx``.
    2385. 

  2385. 

  2386. \ **Note:** This method is implemented only on macOS.
    2387. 

  2387. 

  2388. .. rst-class:: classref-item-separator
    2389. 

  2389. 

  2390. ----
    2391. 

  2391. 

  2392. .. _class_DisplayServer_method_global_menu_get_item_indentation_level:
    2393. 

  2393. 

  2394. .. rst-class:: classref-method
    2395. 

  2395. 

  2396. :ref:`int<class_int>` **global_menu_get_item_indentation_level**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_indentation_level>`
    2397. 

  2397. 

  2398. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2399. 

  2399. 

  2400. Returns the horizontal offset of the item at the given ``idx``.
    2401. 

  2401. 

  2402. \ **Note:** This method is implemented only on macOS.
    2403. 

  2403. 

  2404. .. rst-class:: classref-item-separator
    2405. 

  2405. 

  2406. ----
    2407. 

  2407. 

  2408. .. _class_DisplayServer_method_global_menu_get_item_index_from_tag:
    2409. 

  2409. 

  2410. .. rst-class:: classref-method
    2411. 

  2411. 

  2412. :ref:`int<class_int>` **global_menu_get_item_index_from_tag**\ (\ menu_root\: :ref:`String<class_String>`, tag\: :ref:`Variant<class_Variant>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_index_from_tag>`
    2413. 

  2413. 

  2414. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2415. 

  2415. 

  2416. Returns the index of the item with the specified ``tag``. Indices are automatically assigned to each item by the engine, and cannot be set manually.
    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_get_item_index_from_text:
    2425. 

  2425. 

  2426. .. rst-class:: classref-method
    2427. 

  2427. 

  2428. :ref:`int<class_int>` **global_menu_get_item_index_from_text**\ (\ menu_root\: :ref:`String<class_String>`, text\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_index_from_text>`
    2429. 

  2429. 

  2430. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2431. 

  2431. 

  2432. Returns the index of the item with the specified ``text``. Indices are automatically assigned to each item by the engine, and cannot be set manually.
    2433. 

  2433. 

  2434. \ **Note:** This method is implemented only on macOS.
    2435. 

  2435. 

  2436. .. rst-class:: classref-item-separator
    2437. 

  2437. 

  2438. ----
    2439. 

  2439. 

  2440. .. _class_DisplayServer_method_global_menu_get_item_key_callback:
    2441. 

  2441. 

  2442. .. rst-class:: classref-method
    2443. 

  2443. 

  2444. :ref:`Callable<class_Callable>` **global_menu_get_item_key_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_key_callback>`
    2445. 

  2445. 

  2446. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2447. 

  2447. 

  2448. Returns the callback of the item accelerator at index ``idx``.
    2449. 

  2449. 

  2450. \ **Note:** This method is implemented only on macOS.
    2451. 

  2451. 

  2452. .. rst-class:: classref-item-separator
    2453. 

  2453. 

  2454. ----
    2455. 

  2455. 

  2456. .. _class_DisplayServer_method_global_menu_get_item_max_states:
    2457. 

  2457. 

  2458. .. rst-class:: classref-method
    2459. 

  2459. 

  2460. :ref:`int<class_int>` **global_menu_get_item_max_states**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_max_states>`
    2461. 

  2461. 

  2462. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2463. 

  2463. 

  2464. 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.
    2465. 

  2465. 

  2466. \ **Note:** This method is implemented only on macOS.
    2467. 

  2467. 

  2468. .. rst-class:: classref-item-separator
    2469. 

  2469. 

  2470. ----
    2471. 

  2471. 

  2472. .. _class_DisplayServer_method_global_menu_get_item_state:
    2473. 

  2473. 

  2474. .. rst-class:: classref-method
    2475. 

  2475. 

  2476. :ref:`int<class_int>` **global_menu_get_item_state**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_state>`
    2477. 

  2477. 

  2478. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2479. 

  2479. 

  2480. Returns the state of a multistate item. See :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
    2481. 

  2481. 

  2482. \ **Note:** This method is implemented only on macOS.
    2483. 

  2483. 

  2484. .. rst-class:: classref-item-separator
    2485. 

  2485. 

  2486. ----
    2487. 

  2487. 

  2488. .. _class_DisplayServer_method_global_menu_get_item_submenu:
    2489. 

  2489. 

  2490. .. rst-class:: classref-method
    2491. 

  2491. 

  2492. :ref:`String<class_String>` **global_menu_get_item_submenu**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_submenu>`
    2493. 

  2493. 

  2494. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2495. 

  2495. 

  2496. 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.
    2497. 

  2497. 

  2498. \ **Note:** This method is implemented only on macOS.
    2499. 

  2499. 

  2500. .. rst-class:: classref-item-separator
    2501. 

  2501. 

  2502. ----
    2503. 

  2503. 

  2504. .. _class_DisplayServer_method_global_menu_get_item_tag:
    2505. 

  2505. 

  2506. .. rst-class:: classref-method
    2507. 

  2507. 

  2508. :ref:`Variant<class_Variant>` **global_menu_get_item_tag**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_tag>`
    2509. 

  2509. 

  2510. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2511. 

  2511. 

  2512. 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.
    2513. 

  2513. 

  2514. \ **Note:** This method is implemented only on macOS.
    2515. 

  2515. 

  2516. .. rst-class:: classref-item-separator
    2517. 

  2517. 

  2518. ----
    2519. 

  2519. 

  2520. .. _class_DisplayServer_method_global_menu_get_item_text:
    2521. 

  2521. 

  2522. .. rst-class:: classref-method
    2523. 

  2523. 

  2524. :ref:`String<class_String>` **global_menu_get_item_text**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_text>`
    2525. 

  2525. 

  2526. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2527. 

  2527. 

  2528. Returns the text of the item at index ``idx``.
    2529. 

  2529. 

  2530. \ **Note:** This method is implemented only on macOS.
    2531. 

  2531. 

  2532. .. rst-class:: classref-item-separator
    2533. 

  2533. 

  2534. ----
    2535. 

  2535. 

  2536. .. _class_DisplayServer_method_global_menu_get_item_tooltip:
    2537. 

  2537. 

  2538. .. rst-class:: classref-method
    2539. 

  2539. 

  2540. :ref:`String<class_String>` **global_menu_get_item_tooltip**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_item_tooltip>`
    2541. 

  2541. 

  2542. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2543. 

  2543. 

  2544. Returns the tooltip associated with the specified index ``idx``.
    2545. 

  2545. 

  2546. \ **Note:** This method is implemented only on macOS.
    2547. 

  2547. 

  2548. .. rst-class:: classref-item-separator
    2549. 

  2549. 

  2550. ----
    2551. 

  2551. 

  2552. .. _class_DisplayServer_method_global_menu_get_system_menu_roots:
    2553. 

  2553. 

  2554. .. rst-class:: classref-method
    2555. 

  2555. 

  2556. :ref:`Dictionary<class_Dictionary>` **global_menu_get_system_menu_roots**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_get_system_menu_roots>`
    2557. 

  2557. 

  2558. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2559. 

  2559. 

  2560. Returns Dictionary of supported system menu IDs and names.
    2561. 

  2561. 

  2562. \ **Note:** This method is implemented only on macOS.
    2563. 

  2563. 

  2564. .. rst-class:: classref-item-separator
    2565. 

  2565. 

  2566. ----
    2567. 

  2567. 

  2568. .. _class_DisplayServer_method_global_menu_is_item_checkable:
    2569. 

  2569. 

  2570. .. rst-class:: classref-method
    2571. 

  2571. 

  2572. :ref:`bool<class_bool>` **global_menu_is_item_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_is_item_checkable>`
    2573. 

  2573. 

  2574. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2575. 

  2575. 

  2576. Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if it has a checkbox or radio button.
    2577. 

  2577. 

  2578. \ **Note:** This method is implemented only on macOS.
    2579. 

  2579. 

  2580. .. rst-class:: classref-item-separator
    2581. 

  2581. 

  2582. ----
    2583. 

  2583. 

  2584. .. _class_DisplayServer_method_global_menu_is_item_checked:
    2585. 

  2585. 

  2586. .. rst-class:: classref-method
    2587. 

  2587. 

  2588. :ref:`bool<class_bool>` **global_menu_is_item_checked**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_is_item_checked>`
    2589. 

  2589. 

  2590. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2591. 

  2591. 

  2592. Returns ``true`` if the item at index ``idx`` is checked.
    2593. 

  2593. 

  2594. \ **Note:** This method is implemented only on macOS.
    2595. 

  2595. 

  2596. .. rst-class:: classref-item-separator
    2597. 

  2597. 

  2598. ----
    2599. 

  2599. 

  2600. .. _class_DisplayServer_method_global_menu_is_item_disabled:
    2601. 

  2601. 

  2602. .. rst-class:: classref-method
    2603. 

  2603. 

  2604. :ref:`bool<class_bool>` **global_menu_is_item_disabled**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_is_item_disabled>`
    2605. 

  2605. 

  2606. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2607. 

  2607. 

  2608. Returns ``true`` if the item at index ``idx`` is disabled. When it is disabled it can't be selected, or its action invoked.
    2609. 

  2609. 

  2610. See :ref:`global_menu_set_item_disabled<class_DisplayServer_method_global_menu_set_item_disabled>` for more info on how to disable an item.
    2611. 

  2611. 

  2612. \ **Note:** This method is implemented only on macOS.
    2613. 

  2613. 

  2614. .. rst-class:: classref-item-separator
    2615. 

  2615. 

  2616. ----
    2617. 

  2617. 

  2618. .. _class_DisplayServer_method_global_menu_is_item_hidden:
    2619. 

  2619. 

  2620. .. rst-class:: classref-method
    2621. 

  2621. 

  2622. :ref:`bool<class_bool>` **global_menu_is_item_hidden**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_is_item_hidden>`
    2623. 

  2623. 

  2624. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2625. 

  2625. 

  2626. Returns ``true`` if the item at index ``idx`` is hidden.
    2627. 

  2627. 

  2628. See :ref:`global_menu_set_item_hidden<class_DisplayServer_method_global_menu_set_item_hidden>` for more info on how to hide an item.
    2629. 

  2629. 

  2630. \ **Note:** This method is implemented only on macOS.
    2631. 

  2631. 

  2632. .. rst-class:: classref-item-separator
    2633. 

  2633. 

  2634. ----
    2635. 

  2635. 

  2636. .. _class_DisplayServer_method_global_menu_is_item_radio_checkable:
    2637. 

  2637. 

  2638. .. rst-class:: classref-method
    2639. 

  2639. 

  2640. :ref:`bool<class_bool>` **global_menu_is_item_radio_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_is_item_radio_checkable>`
    2641. 

  2641. 

  2642. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2643. 

  2643. 

  2644. Returns ``true`` if the item at index ``idx`` has radio button-style checkability.
    2645. 

  2645. 

  2646. \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
    2647. 

  2647. 

  2648. \ **Note:** This method is implemented only on macOS.
    2649. 

  2649. 

  2650. .. rst-class:: classref-item-separator
    2651. 

  2651. 

  2652. ----
    2653. 

  2653. 

  2654. .. _class_DisplayServer_method_global_menu_remove_item:
    2655. 

  2655. 

  2656. .. rst-class:: classref-method
    2657. 

  2657. 

  2658. |void| **global_menu_remove_item**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_remove_item>`
    2659. 

  2659. 

  2660. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2661. 

  2661. 

  2662. Removes the item at index ``idx`` from the global menu ``menu_root``.
    2663. 

  2663. 

  2664. \ **Note:** The indices of items after the removed item will be shifted by one.
    2665. 

  2665. 

  2666. \ **Note:** This method is implemented only on macOS.
    2667. 

  2667. 

  2668. .. rst-class:: classref-item-separator
    2669. 

  2669. 

  2670. ----
    2671. 

  2671. 

  2672. .. _class_DisplayServer_method_global_menu_set_item_accelerator:
    2673. 

  2673. 

  2674. .. rst-class:: classref-method
    2675. 

  2675. 

  2676. |void| **global_menu_set_item_accelerator**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_accelerator>`
    2677. 

  2677. 

  2678. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2679. 

  2679. 

  2680. 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`).
    2681. 

  2681. 

  2682. \ **Note:** This method is implemented only on macOS.
    2683. 

  2683. 

  2684. .. rst-class:: classref-item-separator
    2685. 

  2685. 

  2686. ----
    2687. 

  2687. 

  2688. .. _class_DisplayServer_method_global_menu_set_item_callback:
    2689. 

  2689. 

  2690. .. rst-class:: classref-method
    2691. 

  2691. 

  2692. |void| **global_menu_set_item_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_callback>`
    2693. 

  2693. 

  2694. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2695. 

  2695. 

  2696. Sets the callback of the item at index ``idx``. Callback is emitted when an item is pressed.
    2697. 

  2697. 

  2698. \ **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.
    2699. 

  2699. 

  2700. \ **Note:** This method is implemented only on macOS.
    2701. 

  2701. 

  2702. .. rst-class:: classref-item-separator
    2703. 

  2703. 

  2704. ----
    2705. 

  2705. 

  2706. .. _class_DisplayServer_method_global_menu_set_item_checkable:
    2707. 

  2707. 

  2708. .. rst-class:: classref-method
    2709. 

  2709. 

  2710. |void| **global_menu_set_item_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_checkable>`
    2711. 

  2711. 

  2712. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2713. 

  2713. 

  2714. Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the type of the item to plain text.
    2715. 

  2715. 

  2716. \ **Note:** This method is implemented only on macOS.
    2717. 

  2717. 

  2718. .. rst-class:: classref-item-separator
    2719. 

  2719. 

  2720. ----
    2721. 

  2721. 

  2722. .. _class_DisplayServer_method_global_menu_set_item_checked:
    2723. 

  2723. 

  2724. .. rst-class:: classref-method
    2725. 

  2725. 

  2726. |void| **global_menu_set_item_checked**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checked\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_checked>`
    2727. 

  2727. 

  2728. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2729. 

  2729. 

  2730. Sets the checkstate status of the item at index ``idx``.
    2731. 

  2731. 

  2732. \ **Note:** This method is implemented only on macOS.
    2733. 

  2733. 

  2734. .. rst-class:: classref-item-separator
    2735. 

  2735. 

  2736. ----
    2737. 

  2737. 

  2738. .. _class_DisplayServer_method_global_menu_set_item_disabled:
    2739. 

  2739. 

  2740. .. rst-class:: classref-method
    2741. 

  2741. 

  2742. |void| **global_menu_set_item_disabled**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, disabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_disabled>`
    2743. 

  2743. 

  2744. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2745. 

  2745. 

  2746. Enables/disables the item at index ``idx``. When it is disabled, it can't be selected and its action can't be invoked.
    2747. 

  2747. 

  2748. \ **Note:** This method is implemented only on macOS.
    2749. 

  2749. 

  2750. .. rst-class:: classref-item-separator
    2751. 

  2751. 

  2752. ----
    2753. 

  2753. 

  2754. .. _class_DisplayServer_method_global_menu_set_item_hidden:
    2755. 

  2755. 

  2756. .. rst-class:: classref-method
    2757. 

  2757. 

  2758. |void| **global_menu_set_item_hidden**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, hidden\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_hidden>`
    2759. 

  2759. 

  2760. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2761. 

  2761. 

  2762. Hides/shows the item at index ``idx``. When it is hidden, an item does not appear in a menu and its action cannot be invoked.
    2763. 

  2763. 

  2764. \ **Note:** This method is implemented only on macOS.
    2765. 

  2765. 

  2766. .. rst-class:: classref-item-separator
    2767. 

  2767. 

  2768. ----
    2769. 

  2769. 

  2770. .. _class_DisplayServer_method_global_menu_set_item_hover_callbacks:
    2771. 

  2771. 

  2772. .. rst-class:: classref-method
    2773. 

  2773. 

  2774. |void| **global_menu_set_item_hover_callbacks**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_hover_callbacks>`
    2775. 

  2775. 

  2776. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2777. 

  2777. 

  2778. Sets the callback of the item at index ``idx``. The callback is emitted when an item is hovered.
    2779. 

  2779. 

  2780. \ **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.
    2781. 

  2781. 

  2782. \ **Note:** This method is implemented only on macOS.
    2783. 

  2783. 

  2784. .. rst-class:: classref-item-separator
    2785. 

  2785. 

  2786. ----
    2787. 

  2787. 

  2788. .. _class_DisplayServer_method_global_menu_set_item_icon:
    2789. 

  2789. 

  2790. .. rst-class:: classref-method
    2791. 

  2791. 

  2792. |void| **global_menu_set_item_icon**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_icon>`
    2793. 

  2793. 

  2794. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2795. 

  2795. 

  2796. Replaces the :ref:`Texture2D<class_Texture2D>` icon of the specified ``idx``.
    2797. 

  2797. 

  2798. \ **Note:** This method is implemented only on macOS.
    2799. 

  2799. 

  2800. \ **Note:** This method is not supported by macOS "_dock" menu items.
    2801. 

  2801. 

  2802. .. rst-class:: classref-item-separator
    2803. 

  2803. 

  2804. ----
    2805. 

  2805. 

  2806. .. _class_DisplayServer_method_global_menu_set_item_indentation_level:
    2807. 

  2807. 

  2808. .. rst-class:: classref-method
    2809. 

  2809. 

  2810. |void| **global_menu_set_item_indentation_level**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, level\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_indentation_level>`
    2811. 

  2811. 

  2812. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2813. 

  2813. 

  2814. Sets the horizontal offset of the item at the given ``idx``.
    2815. 

  2815. 

  2816. \ **Note:** This method is implemented only on macOS.
    2817. 

  2817. 

  2818. .. rst-class:: classref-item-separator
    2819. 

  2819. 

  2820. ----
    2821. 

  2821. 

  2822. .. _class_DisplayServer_method_global_menu_set_item_key_callback:
    2823. 

  2823. 

  2824. .. rst-class:: classref-method
    2825. 

  2825. 

  2826. |void| **global_menu_set_item_key_callback**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, key_callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_key_callback>`
    2827. 

  2827. 

  2828. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2829. 

  2829. 

  2830. Sets the callback of the item at index ``idx``. Callback is emitted when its accelerator is activated.
    2831. 

  2831. 

  2832. \ **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.
    2833. 

  2833. 

  2834. \ **Note:** This method is implemented only on macOS.
    2835. 

  2835. 

  2836. .. rst-class:: classref-item-separator
    2837. 

  2837. 

  2838. ----
    2839. 

  2839. 

  2840. .. _class_DisplayServer_method_global_menu_set_item_max_states:
    2841. 

  2841. 

  2842. .. rst-class:: classref-method
    2843. 

  2843. 

  2844. |void| **global_menu_set_item_max_states**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, max_states\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_max_states>`
    2845. 

  2845. 

  2846. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2847. 

  2847. 

  2848. 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.
    2849. 

  2849. 

  2850. \ **Note:** This method is implemented only on macOS.
    2851. 

  2851. 

  2852. .. rst-class:: classref-item-separator
    2853. 

  2853. 

  2854. ----
    2855. 

  2855. 

  2856. .. _class_DisplayServer_method_global_menu_set_item_radio_checkable:
    2857. 

  2857. 

  2858. .. rst-class:: classref-method
    2859. 

  2859. 

  2860. |void| **global_menu_set_item_radio_checkable**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, checkable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_radio_checkable>`
    2861. 

  2861. 

  2862. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2863. 

  2863. 

  2864. 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.
    2865. 

  2865. 

  2866. \ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
    2867. 

  2867. 

  2868. \ **Note:** This method is implemented only on macOS.
    2869. 

  2869. 

  2870. .. rst-class:: classref-item-separator
    2871. 

  2871. 

  2872. ----
    2873. 

  2873. 

  2874. .. _class_DisplayServer_method_global_menu_set_item_state:
    2875. 

  2875. 

  2876. .. rst-class:: classref-method
    2877. 

  2877. 

  2878. |void| **global_menu_set_item_state**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, state\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_state>`
    2879. 

  2879. 

  2880. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2881. 

  2881. 

  2882. Sets the state of a multistate item. See :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` for details.
    2883. 

  2883. 

  2884. \ **Note:** This method is implemented only on macOS.
    2885. 

  2885. 

  2886. .. rst-class:: classref-item-separator
    2887. 

  2887. 

  2888. ----
    2889. 

  2889. 

  2890. .. _class_DisplayServer_method_global_menu_set_item_submenu:
    2891. 

  2891. 

  2892. .. rst-class:: classref-method
    2893. 

  2893. 

  2894. |void| **global_menu_set_item_submenu**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, submenu\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_submenu>`
    2895. 

  2895. 

  2896. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2897. 

  2897. 

  2898. 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.
    2899. 

  2899. 

  2900. \ **Note:** This method is implemented only on macOS.
    2901. 

  2901. 

  2902. .. rst-class:: classref-item-separator
    2903. 

  2903. 

  2904. ----
    2905. 

  2905. 

  2906. .. _class_DisplayServer_method_global_menu_set_item_tag:
    2907. 

  2907. 

  2908. .. rst-class:: classref-method
    2909. 

  2909. 

  2910. |void| **global_menu_set_item_tag**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tag\: :ref:`Variant<class_Variant>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_tag>`
    2911. 

  2911. 

  2912. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2913. 

  2913. 

  2914. 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.
    2915. 

  2915. 

  2916. \ **Note:** This method is implemented only on macOS.
    2917. 

  2917. 

  2918. .. rst-class:: classref-item-separator
    2919. 

  2919. 

  2920. ----
    2921. 

  2921. 

  2922. .. _class_DisplayServer_method_global_menu_set_item_text:
    2923. 

  2923. 

  2924. .. rst-class:: classref-method
    2925. 

  2925. 

  2926. |void| **global_menu_set_item_text**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, text\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_text>`
    2927. 

  2927. 

  2928. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2929. 

  2929. 

  2930. Sets the text of the item at index ``idx``.
    2931. 

  2931. 

  2932. \ **Note:** This method is implemented only on macOS.
    2933. 

  2933. 

  2934. .. rst-class:: classref-item-separator
    2935. 

  2935. 

  2936. ----
    2937. 

  2937. 

  2938. .. _class_DisplayServer_method_global_menu_set_item_tooltip:
    2939. 

  2939. 

  2940. .. rst-class:: classref-method
    2941. 

  2941. 

  2942. |void| **global_menu_set_item_tooltip**\ (\ menu_root\: :ref:`String<class_String>`, idx\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_item_tooltip>`
    2943. 

  2943. 

  2944. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2945. 

  2945. 

  2946. Sets the :ref:`String<class_String>` tooltip of the item at the specified index ``idx``.
    2947. 

  2947. 

  2948. \ **Note:** This method is implemented only on macOS.
    2949. 

  2949. 

  2950. .. rst-class:: classref-item-separator
    2951. 

  2951. 

  2952. ----
    2953. 

  2953. 

  2954. .. _class_DisplayServer_method_global_menu_set_popup_callbacks:
    2955. 

  2955. 

  2956. .. rst-class:: classref-method
    2957. 

  2957. 

  2958. |void| **global_menu_set_popup_callbacks**\ (\ menu_root\: :ref:`String<class_String>`, open_callback\: :ref:`Callable<class_Callable>`, close_callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_global_menu_set_popup_callbacks>`
    2959. 

  2959. 

  2960. **Deprecated:** Use :ref:`NativeMenu<class_NativeMenu>` or :ref:`PopupMenu<class_PopupMenu>` instead.
    2961. 

  2961. 

  2962. Registers callables to emit when the menu is respectively about to show or closed. Callback methods should have zero arguments.
    2963. 

  2963. 

  2964. .. rst-class:: classref-item-separator
    2965. 

  2965. 

  2966. ----
    2967. 

  2967. 

  2968. .. _class_DisplayServer_method_has_additional_outputs:
    2969. 

  2969. 

  2970. .. rst-class:: classref-method
    2971. 

  2971. 

  2972. :ref:`bool<class_bool>` **has_additional_outputs**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_has_additional_outputs>`
    2973. 

  2973. 

  2974. Returns ``true`` if any additional outputs have been registered via :ref:`register_additional_output<class_DisplayServer_method_register_additional_output>`.
    2975. 

  2975. 

  2976. .. rst-class:: classref-item-separator
    2977. 

  2977. 

  2978. ----
    2979. 

  2979. 

  2980. .. _class_DisplayServer_method_has_feature:
    2981. 

  2981. 

  2982. .. rst-class:: classref-method
    2983. 

  2983. 

  2984. :ref:`bool<class_bool>` **has_feature**\ (\ feature\: :ref:`Feature<enum_DisplayServer_Feature>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_has_feature>`
    2985. 

  2985. 

  2986. Returns ``true`` if the specified ``feature`` is supported by the current **DisplayServer**, ``false`` otherwise.
    2987. 

  2987. 

  2988. .. rst-class:: classref-item-separator
    2989. 

  2989. 

  2990. ----
    2991. 

  2991. 

  2992. .. _class_DisplayServer_method_has_hardware_keyboard:
    2993. 

  2993. 

  2994. .. rst-class:: classref-method
    2995. 

  2995. 

  2996. :ref:`bool<class_bool>` **has_hardware_keyboard**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_has_hardware_keyboard>`
    2997. 

  2997. 

  2998. Returns ``true`` if hardware keyboard is connected.
    2999. 

  2999. 

  3000. \ **Note:** This method is implemented on Android and iOS, on other platforms this method always returns ``true``.
    3001. 

  3001. 

  3002. .. rst-class:: classref-item-separator
    3003. 

  3003. 

  3004. ----
    3005. 

  3005. 

  3006. .. _class_DisplayServer_method_help_set_search_callbacks:
    3007. 

  3007. 

  3008. .. rst-class:: classref-method
    3009. 

  3009. 

  3010. |void| **help_set_search_callbacks**\ (\ search_callback\: :ref:`Callable<class_Callable>`, action_callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_help_set_search_callbacks>`
    3011. 

  3011. 

  3012. Sets native help system search callbacks.
    3013. 

  3013. 

  3014. \ ``search_callback`` has the following arguments: ``String search_string, int result_limit`` and return a :ref:`Dictionary<class_Dictionary>` with "key, display name" pairs for the search results. Called when the user enters search terms in the ``Help`` menu.
    3015. 

  3015. 

  3016. \ ``action_callback`` has the following arguments: ``String key``. Called when the user selects a search result in the ``Help`` menu.
    3017. 

  3017. 

  3018. \ **Note:** This method is implemented only on macOS.
    3019. 

  3019. 

  3020. .. rst-class:: classref-item-separator
    3021. 

  3021. 

  3022. ----
    3023. 

  3023. 

  3024. .. _class_DisplayServer_method_ime_get_selection:
    3025. 

  3025. 

  3026. .. rst-class:: classref-method
    3027. 

  3027. 

  3028. :ref:`Vector2i<class_Vector2i>` **ime_get_selection**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_ime_get_selection>`
    3029. 

  3029. 

  3030. 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.
    3031. 

  3031. 

  3032. \ **Note:** This method is implemented only on macOS.
    3033. 

  3033. 

  3034. .. rst-class:: classref-item-separator
    3035. 

  3035. 

  3036. ----
    3037. 

  3037. 

  3038. .. _class_DisplayServer_method_ime_get_text:
    3039. 

  3039. 

  3040. .. rst-class:: classref-method
    3041. 

  3041. 

  3042. :ref:`String<class_String>` **ime_get_text**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_ime_get_text>`
    3043. 

  3043. 

  3044. Returns the composition string contained within the `Input Method Editor <https://en.wikipedia.org/wiki/Input_method>`__ window.
    3045. 

  3045. 

  3046. \ **Note:** This method is implemented only on macOS.
    3047. 

  3047. 

  3048. .. rst-class:: classref-item-separator
    3049. 

  3049. 

  3050. ----
    3051. 

  3051. 

  3052. .. _class_DisplayServer_method_is_dark_mode:
    3053. 

  3053. 

  3054. .. rst-class:: classref-method
    3055. 

  3055. 

  3056. :ref:`bool<class_bool>` **is_dark_mode**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_is_dark_mode>`
    3057. 

  3057. 

  3058. Returns ``true`` if OS is using dark mode.
    3059. 

  3059. 

  3060. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
    3061. 

  3061. 

  3062. .. rst-class:: classref-item-separator
    3063. 

  3063. 

  3064. ----
    3065. 

  3065. 

  3066. .. _class_DisplayServer_method_is_dark_mode_supported:
    3067. 

  3067. 

  3068. .. rst-class:: classref-method
    3069. 

  3069. 

  3070. :ref:`bool<class_bool>` **is_dark_mode_supported**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_is_dark_mode_supported>`
    3071. 

  3071. 

  3072. Returns ``true`` if OS supports dark mode.
    3073. 

  3073. 

  3074. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
    3075. 

  3075. 

  3076. .. rst-class:: classref-item-separator
    3077. 

  3077. 

  3078. ----
    3079. 

  3079. 

  3080. .. _class_DisplayServer_method_is_touchscreen_available:
    3081. 

  3081. 

  3082. .. rst-class:: classref-method
    3083. 

  3083. 

  3084. :ref:`bool<class_bool>` **is_touchscreen_available**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_is_touchscreen_available>`
    3085. 

  3085. 

  3086. Returns ``true`` if touch events are available (Android or iOS), the capability is detected on the Web platform or if :ref:`ProjectSettings.input_devices/pointing/emulate_touch_from_mouse<class_ProjectSettings_property_input_devices/pointing/emulate_touch_from_mouse>` is ``true``.
    3087. 

  3087. 

  3088. .. rst-class:: classref-item-separator
    3089. 

  3089. 

  3090. ----
    3091. 

  3091. 

  3092. .. _class_DisplayServer_method_is_window_transparency_available:
    3093. 

  3093. 

  3094. .. rst-class:: classref-method
    3095. 

  3095. 

  3096. :ref:`bool<class_bool>` **is_window_transparency_available**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_is_window_transparency_available>`
    3097. 

  3097. 

  3098. Returns ``true`` if the window background can be made transparent. This method returns ``false`` if :ref:`ProjectSettings.display/window/per_pixel_transparency/allowed<class_ProjectSettings_property_display/window/per_pixel_transparency/allowed>` is set to ``false``, or if transparency is not supported by the renderer or OS compositor.
    3099. 

  3099. 

  3100. .. rst-class:: classref-item-separator
    3101. 

  3101. 

  3102. ----
    3103. 

  3103. 

  3104. .. _class_DisplayServer_method_keyboard_get_current_layout:
    3105. 

  3105. 

  3106. .. rst-class:: classref-method
    3107. 

  3107. 

  3108. :ref:`int<class_int>` **keyboard_get_current_layout**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_current_layout>`
    3109. 

  3109. 

  3110. Returns active keyboard layout index.
    3111. 

  3111. 

  3112. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS, and Windows.
    3113. 

  3113. 

  3114. .. rst-class:: classref-item-separator
    3115. 

  3115. 

  3116. ----
    3117. 

  3117. 

  3118. .. _class_DisplayServer_method_keyboard_get_keycode_from_physical:
    3119. 

  3119. 

  3120. .. rst-class:: classref-method
    3121. 

  3121. 

  3122. :ref:`Key<enum_@GlobalScope_Key>` **keyboard_get_keycode_from_physical**\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_keycode_from_physical>`
    3123. 

  3123. 

  3124. Converts a physical (US QWERTY) ``keycode`` to one in the active keyboard layout.
    3125. 

  3125. 

  3126. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3127. 

  3127. 

  3128. .. rst-class:: classref-item-separator
    3129. 

  3129. 

  3130. ----
    3131. 

  3131. 

  3132. .. _class_DisplayServer_method_keyboard_get_label_from_physical:
    3133. 

  3133. 

  3134. .. rst-class:: classref-method
    3135. 

  3135. 

  3136. :ref:`Key<enum_@GlobalScope_Key>` **keyboard_get_label_from_physical**\ (\ keycode\: :ref:`Key<enum_@GlobalScope_Key>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_label_from_physical>`
    3137. 

  3137. 

  3138. Converts a physical (US QWERTY) ``keycode`` to localized label printed on the key in the active keyboard layout.
    3139. 

  3139. 

  3140. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3141. 

  3141. 

  3142. .. rst-class:: classref-item-separator
    3143. 

  3143. 

  3144. ----
    3145. 

  3145. 

  3146. .. _class_DisplayServer_method_keyboard_get_layout_count:
    3147. 

  3147. 

  3148. .. rst-class:: classref-method
    3149. 

  3149. 

  3150. :ref:`int<class_int>` **keyboard_get_layout_count**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_layout_count>`
    3151. 

  3151. 

  3152. Returns the number of keyboard layouts.
    3153. 

  3153. 

  3154. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3155. 

  3155. 

  3156. .. rst-class:: classref-item-separator
    3157. 

  3157. 

  3158. ----
    3159. 

  3159. 

  3160. .. _class_DisplayServer_method_keyboard_get_layout_language:
    3161. 

  3161. 

  3162. .. rst-class:: classref-method
    3163. 

  3163. 

  3164. :ref:`String<class_String>` **keyboard_get_layout_language**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_layout_language>`
    3165. 

  3165. 

  3166. Returns the ISO-639/BCP-47 language code of the keyboard layout at position ``index``.
    3167. 

  3167. 

  3168. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3169. 

  3169. 

  3170. .. rst-class:: classref-item-separator
    3171. 

  3171. 

  3172. ----
    3173. 

  3173. 

  3174. .. _class_DisplayServer_method_keyboard_get_layout_name:
    3175. 

  3175. 

  3176. .. rst-class:: classref-method
    3177. 

  3177. 

  3178. :ref:`String<class_String>` **keyboard_get_layout_name**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_get_layout_name>`
    3179. 

  3179. 

  3180. Returns the localized name of the keyboard layout at position ``index``.
    3181. 

  3181. 

  3182. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3183. 

  3183. 

  3184. .. rst-class:: classref-item-separator
    3185. 

  3185. 

  3186. ----
    3187. 

  3187. 

  3188. .. _class_DisplayServer_method_keyboard_set_current_layout:
    3189. 

  3189. 

  3190. .. rst-class:: classref-method
    3191. 

  3191. 

  3192. |void| **keyboard_set_current_layout**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_keyboard_set_current_layout>`
    3193. 

  3193. 

  3194. Sets the active keyboard layout.
    3195. 

  3195. 

  3196. \ **Note:** This method is implemented on Linux (X11/Wayland), macOS and Windows.
    3197. 

  3197. 

  3198. .. rst-class:: classref-item-separator
    3199. 

  3199. 

  3200. ----
    3201. 

  3201. 

  3202. .. _class_DisplayServer_method_mouse_get_button_state:
    3203. 

  3203. 

  3204. .. rst-class:: classref-method
    3205. 

  3205. 

  3206. |bitfield|\[:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>`\] **mouse_get_button_state**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_mouse_get_button_state>`
    3207. 

  3207. 

  3208. 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>`.
    3209. 

  3209. 

  3210. .. rst-class:: classref-item-separator
    3211. 

  3211. 

  3212. ----
    3213. 

  3213. 

  3214. .. _class_DisplayServer_method_mouse_get_mode:
    3215. 

  3215. 

  3216. .. rst-class:: classref-method
    3217. 

  3217. 

  3218. :ref:`MouseMode<enum_DisplayServer_MouseMode>` **mouse_get_mode**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_mouse_get_mode>`
    3219. 

  3219. 

  3220. Returns the current mouse mode. See also :ref:`mouse_set_mode<class_DisplayServer_method_mouse_set_mode>`.
    3221. 

  3221. 

  3222. .. rst-class:: classref-item-separator
    3223. 

  3223. 

  3224. ----
    3225. 

  3225. 

  3226. .. _class_DisplayServer_method_mouse_get_position:
    3227. 

  3227. 

  3228. .. rst-class:: classref-method
    3229. 

  3229. 

  3230. :ref:`Vector2i<class_Vector2i>` **mouse_get_position**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_mouse_get_position>`
    3231. 

  3231. 

  3232. Returns the mouse cursor's current position in screen coordinates.
    3233. 

  3233. 

  3234. .. rst-class:: classref-item-separator
    3235. 

  3235. 

  3236. ----
    3237. 

  3237. 

  3238. .. _class_DisplayServer_method_mouse_set_mode:
    3239. 

  3239. 

  3240. .. rst-class:: classref-method
    3241. 

  3241. 

  3242. |void| **mouse_set_mode**\ (\ mouse_mode\: :ref:`MouseMode<enum_DisplayServer_MouseMode>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_mouse_set_mode>`
    3243. 

  3243. 

  3244. Sets the current mouse mode. See also :ref:`mouse_get_mode<class_DisplayServer_method_mouse_get_mode>`.
    3245. 

  3245. 

  3246. .. rst-class:: classref-item-separator
    3247. 

  3247. 

  3248. ----
    3249. 

  3249. 

  3250. .. _class_DisplayServer_method_process_events:
    3251. 

  3251. 

  3252. .. rst-class:: classref-method
    3253. 

  3253. 

  3254. |void| **process_events**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_process_events>`
    3255. 

  3255. 

  3256. 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>`.
    3257. 

  3257. 

  3258. .. rst-class:: classref-item-separator
    3259. 

  3259. 

  3260. ----
    3261. 

  3261. 

  3262. .. _class_DisplayServer_method_register_additional_output:
    3263. 

  3263. 

  3264. .. rst-class:: classref-method
    3265. 

  3265. 

  3266. |void| **register_additional_output**\ (\ object\: :ref:`Object<class_Object>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_register_additional_output>`
    3267. 

  3267. 

  3268. Registers an :ref:`Object<class_Object>` which represents an additional output that will be rendered too, beyond normal windows. The :ref:`Object<class_Object>` is only used as an identifier, which can be later passed to :ref:`unregister_additional_output<class_DisplayServer_method_unregister_additional_output>`.
    3269. 

  3269. 

  3270. This can be used to prevent Godot from skipping rendering when no normal windows are visible.
    3271. 

  3271. 

  3272. .. rst-class:: classref-item-separator
    3273. 

  3273. 

  3274. ----
    3275. 

  3275. 

  3276. .. _class_DisplayServer_method_screen_get_dpi:
    3277. 

  3277. 

  3278. .. rst-class:: classref-method
    3279. 

  3279. 

  3280. :ref:`int<class_int>` **screen_get_dpi**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_dpi>`
    3281. 

  3281. 

  3282. 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.
    3283. 

  3283. 

  3284. \ **Note:** On macOS, returned value is inaccurate if fractional display scaling mode is used.
    3285. 

  3285. 

  3286. \ **Note:** On Android devices, the actual screen densities are grouped into six generalized densities:
    3287. 

  3287. 

  3288. .. code:: text
    3289. 

  3289. 

  3290.        ldpi - 120 dpi
    3291. 

  3291.        mdpi - 160 dpi
    3292. 

  3292.        hdpi - 240 dpi
    3293. 

  3293.       xhdpi - 320 dpi
    3294. 

  3294.      xxhdpi - 480 dpi
    3295. 

  3295.     xxxhdpi - 640 dpi
    3296. 

  3296. 

  3297. \ **Note:** This method is implemented on Android, Linux (X11/Wayland), macOS and Windows. Returns ``72`` on unsupported platforms.
    3298. 

  3298. 

  3299. .. rst-class:: classref-item-separator
    3300. 

  3300. 

  3301. ----
    3302. 

  3302. 

  3303. .. _class_DisplayServer_method_screen_get_image:
    3304. 

  3304. 

  3305. .. rst-class:: classref-method
    3306. 

  3306. 

  3307. :ref:`Image<class_Image>` **screen_get_image**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_image>`
    3308. 

  3308. 

  3309. Returns screenshot of the ``screen``.
    3310. 

  3310. 

  3311. \ **Note:** This method is implemented on Linux (X11), macOS, and Windows.
    3312. 

  3312. 

  3313. \ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.
    3314. 

  3314. 

  3315. .. rst-class:: classref-item-separator
    3316. 

  3316. 

  3317. ----
    3318. 

  3318. 

  3319. .. _class_DisplayServer_method_screen_get_max_scale:
    3320. 

  3320. 

  3321. .. rst-class:: classref-method
    3322. 

  3322. 

  3323. :ref:`float<class_float>` **screen_get_max_scale**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_max_scale>`
    3324. 

  3324. 

  3325. Returns the greatest scale factor of all screens.
    3326. 

  3326. 

  3327. \ **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.
    3328. 

  3328. 

  3329. \ **Note:** This method is implemented only on macOS.
    3330. 

  3330. 

  3331. .. rst-class:: classref-item-separator
    3332. 

  3332. 

  3333. ----
    3334. 

  3334. 

  3335. .. _class_DisplayServer_method_screen_get_orientation:
    3336. 

  3336. 

  3337. .. rst-class:: classref-method
    3338. 

  3338. 

  3339. :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **screen_get_orientation**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_orientation>`
    3340. 

  3340. 

  3341. Returns the ``screen``'s current orientation. See also :ref:`screen_set_orientation<class_DisplayServer_method_screen_set_orientation>`.
    3342. 

  3342. 

  3343. \ **Note:** This method is implemented on Android and iOS.
    3344. 

  3344. 

  3345. .. rst-class:: classref-item-separator
    3346. 

  3346. 

  3347. ----
    3348. 

  3348. 

  3349. .. _class_DisplayServer_method_screen_get_pixel:
    3350. 

  3350. 

  3351. .. rst-class:: classref-method
    3352. 

  3352. 

  3353. :ref:`Color<class_Color>` **screen_get_pixel**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_pixel>`
    3354. 

  3354. 

  3355. Returns color of the display pixel at the ``position``.
    3356. 

  3356. 

  3357. \ **Note:** This method is implemented on Linux (X11), macOS, and Windows.
    3358. 

  3358. 

  3359. \ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.
    3360. 

  3360. 

  3361. .. rst-class:: classref-item-separator
    3362. 

  3362. 

  3363. ----
    3364. 

  3364. 

  3365. .. _class_DisplayServer_method_screen_get_position:
    3366. 

  3366. 

  3367. .. rst-class:: classref-method
    3368. 

  3368. 

  3369. :ref:`Vector2i<class_Vector2i>` **screen_get_position**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_position>`
    3370. 

  3370. 

  3371. 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:
    3372. 

  3372. 

  3373. .. code:: text
    3374. 

  3374. 

  3375.     * (0, 0)        +-------+
    3376. 

  3376.                     |       |
    3377. 

  3377.     +-------------+ |       |
    3378. 

  3378.     |             | |       |
    3379. 

  3379.     |             | |       |
    3380. 

  3380.     +-------------+ +-------+
    3381. 

  3381. 

  3382. See also :ref:`screen_get_size<class_DisplayServer_method_screen_get_size>`.
    3383. 

  3383. 

  3384. \ **Note:** On Linux (Wayland) this method always returns ``(0, 0)``.
    3385. 

  3385. 

  3386. .. rst-class:: classref-item-separator
    3387. 

  3387. 

  3388. ----
    3389. 

  3389. 

  3390. .. _class_DisplayServer_method_screen_get_refresh_rate:
    3391. 

  3391. 

  3392. .. rst-class:: classref-method
    3393. 

  3393. 

  3394. :ref:`float<class_float>` **screen_get_refresh_rate**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_refresh_rate>`
    3395. 

  3395. 

  3396. 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.
    3397. 

  3397. 

  3398. \ **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.
    3399. 

  3399. 

  3400. To fallback to a default refresh rate if the method fails, try:
    3401. 

  3401. 

  3402. ::
    3403. 

  3403. 

  3404.     var refresh_rate = DisplayServer.screen_get_refresh_rate()
    3405. 

  3405.     if refresh_rate < 0:
    3406. 

  3406.         refresh_rate = 60.0
    3407. 

  3407. 

  3408. .. rst-class:: classref-item-separator
    3409. 

  3409. 

  3410. ----
    3411. 

  3411. 

  3412. .. _class_DisplayServer_method_screen_get_scale:
    3413. 

  3413. 

  3414. .. rst-class:: classref-method
    3415. 

  3415. 

  3416. :ref:`float<class_float>` **screen_get_scale**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_scale>`
    3417. 

  3417. 

  3418. Returns the scale factor of the specified screen by index.
    3419. 

  3419. 

  3420. \ **Note:** On macOS, the returned value is ``2.0`` for hiDPI (Retina) screens, and ``1.0`` for all other cases.
    3421. 

  3421. 

  3422. \ **Note:** On Linux (Wayland), the returned value is accurate only when ``screen`` is :ref:`SCREEN_OF_MAIN_WINDOW<class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW>`. Due to API limitations, passing a direct index will return a rounded-up integer, if the screen has a fractional scale (e.g. ``1.25`` would get rounded up to ``2.0``).
    3423. 

  3423. 

  3424. \ **Note:** This method is implemented on Android, iOS, Web, macOS, and Linux (Wayland).
    3425. 

  3425. 

  3426. .. rst-class:: classref-item-separator
    3427. 

  3427. 

  3428. ----
    3429. 

  3429. 

  3430. .. _class_DisplayServer_method_screen_get_size:
    3431. 

  3431. 

  3432. .. rst-class:: classref-method
    3433. 

  3433. 

  3434. :ref:`Vector2i<class_Vector2i>` **screen_get_size**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_size>`
    3435. 

  3435. 

  3436. 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>`.
    3437. 

  3437. 

  3438. .. rst-class:: classref-item-separator
    3439. 

  3439. 

  3440. ----
    3441. 

  3441. 

  3442. .. _class_DisplayServer_method_screen_get_usable_rect:
    3443. 

  3443. 

  3444. .. rst-class:: classref-method
    3445. 

  3445. 

  3446. :ref:`Rect2i<class_Rect2i>` **screen_get_usable_rect**\ (\ screen\: :ref:`int<class_int>` = -1\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_get_usable_rect>`
    3447. 

  3447. 

  3448. 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>`.
    3449. 

  3449. 

  3450. .. rst-class:: classref-item-separator
    3451. 

  3451. 

  3452. ----
    3453. 

  3453. 

  3454. .. _class_DisplayServer_method_screen_is_kept_on:
    3455. 

  3455. 

  3456. .. rst-class:: classref-method
    3457. 

  3457. 

  3458. :ref:`bool<class_bool>` **screen_is_kept_on**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_screen_is_kept_on>`
    3459. 

  3459. 

  3460. 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>`.
    3461. 

  3461. 

  3462. .. rst-class:: classref-item-separator
    3463. 

  3463. 

  3464. ----
    3465. 

  3465. 

  3466. .. _class_DisplayServer_method_screen_set_keep_on:
    3467. 

  3467. 

  3468. .. rst-class:: classref-method
    3469. 

  3469. 

  3470. |void| **screen_set_keep_on**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_screen_set_keep_on>`
    3471. 

  3471. 

  3472. 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>`.
    3473. 

  3473. 

  3474. .. rst-class:: classref-item-separator
    3475. 

  3475. 

  3476. ----
    3477. 

  3477. 

  3478. .. _class_DisplayServer_method_screen_set_orientation:
    3479. 

  3479. 

  3480. .. rst-class:: classref-method
    3481. 

  3481. 

  3482. |void| **screen_set_orientation**\ (\ orientation\: :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>`, screen\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_screen_set_orientation>`
    3483. 

  3483. 

  3484. Sets the ``screen``'s ``orientation``. See also :ref:`screen_get_orientation<class_DisplayServer_method_screen_get_orientation>`.
    3485. 

  3485. 

  3486. \ **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>`.
    3487. 

  3487. 

  3488. .. rst-class:: classref-item-separator
    3489. 

  3489. 

  3490. ----
    3491. 

  3491. 

  3492. .. _class_DisplayServer_method_set_icon:
    3493. 

  3493. 

  3494. .. rst-class:: classref-method
    3495. 

  3495. 

  3496. |void| **set_icon**\ (\ image\: :ref:`Image<class_Image>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_set_icon>`
    3497. 

  3497. 

  3498. 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.
    3499. 

  3499. 

  3500. \ **Note:** Requires support for :ref:`FEATURE_ICON<class_DisplayServer_constant_FEATURE_ICON>`.
    3501. 

  3501. 

  3502. .. rst-class:: classref-item-separator
    3503. 

  3503. 

  3504. ----
    3505. 

  3505. 

  3506. .. _class_DisplayServer_method_set_native_icon:
    3507. 

  3507. 

  3508. .. rst-class:: classref-method
    3509. 

  3509. 

  3510. |void| **set_native_icon**\ (\ filename\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_set_native_icon>`
    3511. 

  3511. 

  3512. 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.
    3513. 

  3513. 

  3514. \ **Note:** Requires support for :ref:`FEATURE_NATIVE_ICON<class_DisplayServer_constant_FEATURE_NATIVE_ICON>`.
    3515. 

  3515. 

  3516. .. rst-class:: classref-item-separator
    3517. 

  3517. 

  3518. ----
    3519. 

  3519. 

  3520. .. _class_DisplayServer_method_set_system_theme_change_callback:
    3521. 

  3521. 

  3522. .. rst-class:: classref-method
    3523. 

  3523. 

  3524. |void| **set_system_theme_change_callback**\ (\ callable\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_set_system_theme_change_callback>`
    3525. 

  3525. 

  3526. Sets the ``callable`` that should be called when system theme settings are changed. Callback method should have zero arguments.
    3527. 

  3527. 

  3528. \ **Note:** This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
    3529. 

  3529. 

  3530. .. rst-class:: classref-item-separator
    3531. 

  3531. 

  3532. ----
    3533. 

  3533. 

  3534. .. _class_DisplayServer_method_status_indicator_get_rect:
    3535. 

  3535. 

  3536. .. rst-class:: classref-method
    3537. 

  3537. 

  3538. :ref:`Rect2<class_Rect2>` **status_indicator_get_rect**\ (\ id\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_status_indicator_get_rect>`
    3539. 

  3539. 

  3540. Returns the rectangle for the given status indicator ``id`` in screen coordinates. If the status indicator is not visible, returns an empty :ref:`Rect2<class_Rect2>`.
    3541. 

  3541. 

  3542. \ **Note:** This method is implemented on macOS and Windows.
    3543. 

  3543. 

  3544. .. rst-class:: classref-item-separator
    3545. 

  3545. 

  3546. ----
    3547. 

  3547. 

  3548. .. _class_DisplayServer_method_status_indicator_set_callback:
    3549. 

  3549. 

  3550. .. rst-class:: classref-method
    3551. 

  3551. 

  3552. |void| **status_indicator_set_callback**\ (\ id\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_status_indicator_set_callback>`
    3553. 

  3553. 

  3554. Sets the application status indicator activation callback. ``callback`` should take two arguments: :ref:`int<class_int>` mouse button index (one of :ref:`MouseButton<enum_@GlobalScope_MouseButton>` values) and :ref:`Vector2i<class_Vector2i>` click position in screen coordinates.
    3555. 

  3555. 

  3556. \ **Note:** This method is implemented on macOS and Windows.
    3557. 

  3557. 

  3558. .. rst-class:: classref-item-separator
    3559. 

  3559. 

  3560. ----
    3561. 

  3561. 

  3562. .. _class_DisplayServer_method_status_indicator_set_icon:
    3563. 

  3563. 

  3564. .. rst-class:: classref-method
    3565. 

  3565. 

  3566. |void| **status_indicator_set_icon**\ (\ id\: :ref:`int<class_int>`, icon\: :ref:`Texture2D<class_Texture2D>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_status_indicator_set_icon>`
    3567. 

  3567. 

  3568. Sets the application status indicator icon.
    3569. 

  3569. 

  3570. \ **Note:** This method is implemented on macOS and Windows.
    3571. 

  3571. 

  3572. .. rst-class:: classref-item-separator
    3573. 

  3573. 

  3574. ----
    3575. 

  3575. 

  3576. .. _class_DisplayServer_method_status_indicator_set_menu:
    3577. 

  3577. 

  3578. .. rst-class:: classref-method
    3579. 

  3579. 

  3580. |void| **status_indicator_set_menu**\ (\ id\: :ref:`int<class_int>`, menu_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_status_indicator_set_menu>`
    3581. 

  3581. 

  3582. Sets the application status indicator native popup menu.
    3583. 

  3583. 

  3584. \ **Note:** On macOS, the menu is activated by any mouse button. Its activation callback is *not* triggered.
    3585. 

  3585. 

  3586. \ **Note:** On Windows, the menu is activated by the right mouse button, selecting the status icon and pressing :kbd:`Shift + F10`, or the applications key. The menu's activation callback for the other mouse buttons is still triggered.
    3587. 

  3587. 

  3588. \ **Note:** Native popup is only supported if :ref:`NativeMenu<class_NativeMenu>` supports the :ref:`NativeMenu.FEATURE_POPUP_MENU<class_NativeMenu_constant_FEATURE_POPUP_MENU>` feature.
    3589. 

  3589. 

  3590. .. rst-class:: classref-item-separator
    3591. 

  3591. 

  3592. ----
    3593. 

  3593. 

  3594. .. _class_DisplayServer_method_status_indicator_set_tooltip:
    3595. 

  3595. 

  3596. .. rst-class:: classref-method
    3597. 

  3597. 

  3598. |void| **status_indicator_set_tooltip**\ (\ id\: :ref:`int<class_int>`, tooltip\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_status_indicator_set_tooltip>`
    3599. 

  3599. 

  3600. Sets the application status indicator tooltip.
    3601. 

  3601. 

  3602. \ **Note:** This method is implemented on macOS and Windows.
    3603. 

  3603. 

  3604. .. rst-class:: classref-item-separator
    3605. 

  3605. 

  3606. ----
    3607. 

  3607. 

  3608. .. _class_DisplayServer_method_tablet_get_current_driver:
    3609. 

  3609. 

  3610. .. rst-class:: classref-method
    3611. 

  3611. 

  3612. :ref:`String<class_String>` **tablet_get_current_driver**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tablet_get_current_driver>`
    3613. 

  3613. 

  3614. Returns current active tablet driver name.
    3615. 

  3615. 

  3616. \ **Note:** This method is implemented only on Windows.
    3617. 

  3617. 

  3618. .. rst-class:: classref-item-separator
    3619. 

  3619. 

  3620. ----
    3621. 

  3621. 

  3622. .. _class_DisplayServer_method_tablet_get_driver_count:
    3623. 

  3623. 

  3624. .. rst-class:: classref-method
    3625. 

  3625. 

  3626. :ref:`int<class_int>` **tablet_get_driver_count**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tablet_get_driver_count>`
    3627. 

  3627. 

  3628. Returns the total number of available tablet drivers.
    3629. 

  3629. 

  3630. \ **Note:** This method is implemented only on Windows.
    3631. 

  3631. 

  3632. .. rst-class:: classref-item-separator
    3633. 

  3633. 

  3634. ----
    3635. 

  3635. 

  3636. .. _class_DisplayServer_method_tablet_get_driver_name:
    3637. 

  3637. 

  3638. .. rst-class:: classref-method
    3639. 

  3639. 

  3640. :ref:`String<class_String>` **tablet_get_driver_name**\ (\ idx\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tablet_get_driver_name>`
    3641. 

  3641. 

  3642. Returns the tablet driver name for the given index.
    3643. 

  3643. 

  3644. \ **Note:** This method is implemented only on Windows.
    3645. 

  3645. 

  3646. .. rst-class:: classref-item-separator
    3647. 

  3647. 

  3648. ----
    3649. 

  3649. 

  3650. .. _class_DisplayServer_method_tablet_set_current_driver:
    3651. 

  3651. 

  3652. .. rst-class:: classref-method
    3653. 

  3653. 

  3654. |void| **tablet_set_current_driver**\ (\ name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tablet_set_current_driver>`
    3655. 

  3655. 

  3656. Set active tablet driver name.
    3657. 

  3657. 

  3658. Supported drivers:
    3659. 

  3659. 

  3660. - ``winink``: Windows Ink API, default (Windows 8.1+ required).
    3661. 

  3661. 

  3662. - ``wintab``: Wacom Wintab API (compatible device driver required).
    3663. 

  3663. 

  3664. - ``dummy``: Dummy driver, tablet input is disabled.
    3665. 

  3665. 

  3666. \ **Note:** This method is implemented only on Windows.
    3667. 

  3667. 

  3668. .. rst-class:: classref-item-separator
    3669. 

  3669. 

  3670. ----
    3671. 

  3671. 

  3672. .. _class_DisplayServer_method_tts_get_voices:
    3673. 

  3673. 

  3674. .. rst-class:: classref-method
    3675. 

  3675. 

  3676. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **tts_get_voices**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tts_get_voices>`
    3677. 

  3677. 

  3678. Returns an :ref:`Array<class_Array>` of voice information dictionaries.
    3679. 

  3679. 

  3680. Each :ref:`Dictionary<class_Dictionary>` contains two :ref:`String<class_String>` entries:
    3681. 

  3681. 

  3682. - ``name`` is voice name.
    3683. 

  3683. 

  3684. - ``id`` is voice identifier.
    3685. 

  3685. 

  3686. - ``language`` is language code in ``lang_Variant`` format. The ``lang`` part is a 2 or 3-letter code based on the ISO-639 standard, in lowercase. The ``Variant`` part is an engine-dependent string describing country, region or/and dialect.
    3687. 

  3687. 

  3688. 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.
    3689. 

  3689. 

  3690. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3691. 

  3691. 

  3692. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3693. 

  3693. 

  3694. .. rst-class:: classref-item-separator
    3695. 

  3695. 

  3696. ----
    3697. 

  3697. 

  3698. .. _class_DisplayServer_method_tts_get_voices_for_language:
    3699. 

  3699. 

  3700. .. rst-class:: classref-method
    3701. 

  3701. 

  3702. :ref:`PackedStringArray<class_PackedStringArray>` **tts_get_voices_for_language**\ (\ language\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tts_get_voices_for_language>`
    3703. 

  3703. 

  3704. Returns an :ref:`PackedStringArray<class_PackedStringArray>` of voice identifiers for the ``language``.
    3705. 

  3705. 

  3706. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3707. 

  3707. 

  3708. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3709. 

  3709. 

  3710. .. rst-class:: classref-item-separator
    3711. 

  3711. 

  3712. ----
    3713. 

  3713. 

  3714. .. _class_DisplayServer_method_tts_is_paused:
    3715. 

  3715. 

  3716. .. rst-class:: classref-method
    3717. 

  3717. 

  3718. :ref:`bool<class_bool>` **tts_is_paused**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tts_is_paused>`
    3719. 

  3719. 

  3720. Returns ``true`` if the synthesizer is in a paused state.
    3721. 

  3721. 

  3722. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3723. 

  3723. 

  3724. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3725. 

  3725. 

  3726. .. rst-class:: classref-item-separator
    3727. 

  3727. 

  3728. ----
    3729. 

  3729. 

  3730. .. _class_DisplayServer_method_tts_is_speaking:
    3731. 

  3731. 

  3732. .. rst-class:: classref-method
    3733. 

  3733. 

  3734. :ref:`bool<class_bool>` **tts_is_speaking**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_tts_is_speaking>`
    3735. 

  3735. 

  3736. Returns ``true`` if the synthesizer is generating speech, or have utterance waiting in the queue.
    3737. 

  3737. 

  3738. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3739. 

  3739. 

  3740. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3741. 

  3741. 

  3742. .. rst-class:: classref-item-separator
    3743. 

  3743. 

  3744. ----
    3745. 

  3745. 

  3746. .. _class_DisplayServer_method_tts_pause:
    3747. 

  3747. 

  3748. .. rst-class:: classref-method
    3749. 

  3749. 

  3750. |void| **tts_pause**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tts_pause>`
    3751. 

  3751. 

  3752. Puts the synthesizer into a paused state.
    3753. 

  3753. 

  3754. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3755. 

  3755. 

  3756. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3757. 

  3757. 

  3758. .. rst-class:: classref-item-separator
    3759. 

  3759. 

  3760. ----
    3761. 

  3761. 

  3762. .. _class_DisplayServer_method_tts_resume:
    3763. 

  3763. 

  3764. .. rst-class:: classref-method
    3765. 

  3765. 

  3766. |void| **tts_resume**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tts_resume>`
    3767. 

  3767. 

  3768. Resumes the synthesizer if it was paused.
    3769. 

  3769. 

  3770. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3771. 

  3771. 

  3772. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3773. 

  3773. 

  3774. .. rst-class:: classref-item-separator
    3775. 

  3775. 

  3776. ----
    3777. 

  3777. 

  3778. .. _class_DisplayServer_method_tts_set_utterance_callback:
    3779. 

  3779. 

  3780. .. rst-class:: classref-method
    3781. 

  3781. 

  3782. |void| **tts_set_utterance_callback**\ (\ event\: :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>`, callable\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tts_set_utterance_callback>`
    3783. 

  3783. 

  3784. Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary.
    3785. 

  3785. 

  3786. - :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.
    3787. 

  3787. 

  3788. - :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.
    3789. 

  3789. 

  3790. \ **Note:** The granularity of the boundary callbacks is engine dependent.
    3791. 

  3791. 

  3792. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3793. 

  3793. 

  3794. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3795. 

  3795. 

  3796. .. rst-class:: classref-item-separator
    3797. 

  3797. 

  3798. ----
    3799. 

  3799. 

  3800. .. _class_DisplayServer_method_tts_speak:
    3801. 

  3801. 

  3802. .. rst-class:: classref-method
    3803. 

  3803. 

  3804. |void| **tts_speak**\ (\ text\: :ref:`String<class_String>`, voice\: :ref:`String<class_String>`, volume\: :ref:`int<class_int>` = 50, pitch\: :ref:`float<class_float>` = 1.0, rate\: :ref:`float<class_float>` = 1.0, utterance_id\: :ref:`int<class_int>` = 0, interrupt\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tts_speak>`
    3805. 

  3805. 

  3806. Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is cleared first.
    3807. 

  3807. 

  3808. - ``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>`.
    3809. 

  3809. 

  3810. - ``volume`` ranges from ``0`` (lowest) to ``100`` (highest).
    3811. 

  3811. 

  3812. - ``pitch`` ranges from ``0.0`` (lowest) to ``2.0`` (highest), ``1.0`` is default pitch for the current voice.
    3813. 

  3813. 

  3814. - ``rate`` ranges from ``0.1`` (lowest) to ``10.0`` (highest), ``1.0`` is a normal speaking rate. Other values act as a percentage relative.
    3815. 

  3815. 

  3816. - ``utterance_id`` is passed as a parameter to the callback functions.
    3817. 

  3817. 

  3818. \ **Note:** On Windows and Linux (X11/Wayland), utterance ``text`` can use SSML markup. SSML support is engine and voice dependent. If the engine does not support SSML, you should strip out all XML markup before calling :ref:`tts_speak<class_DisplayServer_method_tts_speak>`.
    3819. 

  3819. 

  3820. \ **Note:** The granularity of pitch, rate, and volume is engine and voice dependent. Values may be truncated.
    3821. 

  3821. 

  3822. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
    3823. 

  3823. 

  3824. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3825. 

  3825. 

  3826. .. rst-class:: classref-item-separator
    3827. 

  3827. 

  3828. ----
    3829. 

  3829. 

  3830. .. _class_DisplayServer_method_tts_stop:
    3831. 

  3831. 

  3832. .. rst-class:: classref-method
    3833. 

  3833. 

  3834. |void| **tts_stop**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_tts_stop>`
    3835. 

  3835. 

  3836. Stops synthesis in progress and removes all utterances from the queue.
    3837. 

  3837. 

  3838. \ **Note:** This method is implemented on Android, iOS, Web, Linux (X11/Linux), macOS, and Windows.
    3839. 

  3839. 

  3840. \ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.
    3841. 

  3841. 

  3842. .. rst-class:: classref-item-separator
    3843. 

  3843. 

  3844. ----
    3845. 

  3845. 

  3846. .. _class_DisplayServer_method_unregister_additional_output:
    3847. 

  3847. 

  3848. .. rst-class:: classref-method
    3849. 

  3849. 

  3850. |void| **unregister_additional_output**\ (\ object\: :ref:`Object<class_Object>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_unregister_additional_output>`
    3851. 

  3851. 

  3852. Unregisters an :ref:`Object<class_Object>` representing an additional output, that was registered via :ref:`register_additional_output<class_DisplayServer_method_register_additional_output>`.
    3853. 

  3853. 

  3854. .. rst-class:: classref-item-separator
    3855. 

  3855. 

  3856. ----
    3857. 

  3857. 

  3858. .. _class_DisplayServer_method_virtual_keyboard_get_height:
    3859. 

  3859. 

  3860. .. rst-class:: classref-method
    3861. 

  3861. 

  3862. :ref:`int<class_int>` **virtual_keyboard_get_height**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_virtual_keyboard_get_height>`
    3863. 

  3863. 

  3864. Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.
    3865. 

  3865. 

  3866. .. rst-class:: classref-item-separator
    3867. 

  3867. 

  3868. ----
    3869. 

  3869. 

  3870. .. _class_DisplayServer_method_virtual_keyboard_hide:
    3871. 

  3871. 

  3872. .. rst-class:: classref-method
    3873. 

  3873. 

  3874. |void| **virtual_keyboard_hide**\ (\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_virtual_keyboard_hide>`
    3875. 

  3875. 

  3876. Hides the virtual keyboard if it is shown, does nothing otherwise.
    3877. 

  3877. 

  3878. .. rst-class:: classref-item-separator
    3879. 

  3879. 

  3880. ----
    3881. 

  3881. 

  3882. .. _class_DisplayServer_method_virtual_keyboard_show:
    3883. 

  3883. 

  3884. .. rst-class:: classref-method
    3885. 

  3885. 

  3886. |void| **virtual_keyboard_show**\ (\ existing_text\: :ref:`String<class_String>`, position\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0), type\: :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` = 0, max_length\: :ref:`int<class_int>` = -1, cursor_start\: :ref:`int<class_int>` = -1, cursor_end\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_virtual_keyboard_show>`
    3887. 

  3887. 

  3888. Shows the virtual keyboard if the platform has one.
    3889. 

  3889. 

  3890. \ ``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).
    3891. 

  3891. 

  3892. \ ``position`` parameter is the screen space :ref:`Rect2<class_Rect2>` of the edited text.
    3893. 

  3893. 

  3894. \ ``type`` parameter allows configuring which type of virtual keyboard to show.
    3895. 

  3895. 

  3896. \ ``max_length`` limits the number of characters that can be entered if different from ``-1``.
    3897. 

  3897. 

  3898. \ ``cursor_start`` can optionally define the current text cursor position if ``cursor_end`` is not set.
    3899. 

  3899. 

  3900. \ ``cursor_start`` and ``cursor_end`` can optionally define the current text selection.
    3901. 

  3901. 

  3902. \ **Note:** This method is implemented on Android, iOS and Web.
    3903. 

  3903. 

  3904. .. rst-class:: classref-item-separator
    3905. 

  3905. 

  3906. ----
    3907. 

  3907. 

  3908. .. _class_DisplayServer_method_warp_mouse:
    3909. 

  3909. 

  3910. .. rst-class:: classref-method
    3911. 

  3911. 

  3912. |void| **warp_mouse**\ (\ position\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_warp_mouse>`
    3913. 

  3913. 

  3914. 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.
    3915. 

  3915. 

  3916. \ **Note:** :ref:`warp_mouse<class_DisplayServer_method_warp_mouse>` is only supported on Windows, macOS, and Linux (X11/Wayland). It has no effect on Android, iOS, and Web.
    3917. 

  3917. 

  3918. .. rst-class:: classref-item-separator
    3919. 

  3919. 

  3920. ----
    3921. 

  3921. 

  3922. .. _class_DisplayServer_method_window_can_draw:
    3923. 

  3923. 

  3924. .. rst-class:: classref-method
    3925. 

  3925. 

  3926. :ref:`bool<class_bool>` **window_can_draw**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_can_draw>`
    3927. 

  3927. 

  3928. 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``.
    3929. 

  3929. 

  3930. .. rst-class:: classref-item-separator
    3931. 

  3931. 

  3932. ----
    3933. 

  3933. 

  3934. .. _class_DisplayServer_method_window_get_active_popup:
    3935. 

  3935. 

  3936. .. rst-class:: classref-method
    3937. 

  3937. 

  3938. :ref:`int<class_int>` **window_get_active_popup**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_active_popup>`
    3939. 

  3939. 

  3940. Returns ID of the active popup window, or :ref:`INVALID_WINDOW_ID<class_DisplayServer_constant_INVALID_WINDOW_ID>` if there is none.
    3941. 

  3941. 

  3942. .. rst-class:: classref-item-separator
    3943. 

  3943. 

  3944. ----
    3945. 

  3945. 

  3946. .. _class_DisplayServer_method_window_get_attached_instance_id:
    3947. 

  3947. 

  3948. .. rst-class:: classref-method
    3949. 

  3949. 

  3950. :ref:`int<class_int>` **window_get_attached_instance_id**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_attached_instance_id>`
    3951. 

  3951. 

  3952. 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.
    3953. 

  3953. 

  3954. .. rst-class:: classref-item-separator
    3955. 

  3955. 

  3956. ----
    3957. 

  3957. 

  3958. .. _class_DisplayServer_method_window_get_current_screen:
    3959. 

  3959. 

  3960. .. rst-class:: classref-method
    3961. 

  3961. 

  3962. :ref:`int<class_int>` **window_get_current_screen**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_current_screen>`
    3963. 

  3963. 

  3964. 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>`.
    3965. 

  3965. 

  3966. .. rst-class:: classref-item-separator
    3967. 

  3967. 

  3968. ----
    3969. 

  3969. 

  3970. .. _class_DisplayServer_method_window_get_flag:
    3971. 

  3971. 

  3972. .. rst-class:: classref-method
    3973. 

  3973. 

  3974. :ref:`bool<class_bool>` **window_get_flag**\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_flag>`
    3975. 

  3975. 

  3976. Returns the current value of the given window's ``flag``.
    3977. 

  3977. 

  3978. .. rst-class:: classref-item-separator
    3979. 

  3979. 

  3980. ----
    3981. 

  3981. 

  3982. .. _class_DisplayServer_method_window_get_max_size:
    3983. 

  3983. 

  3984. .. rst-class:: classref-method
    3985. 

  3985. 

  3986. :ref:`Vector2i<class_Vector2i>` **window_get_max_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_max_size>`
    3987. 

  3987. 

  3988. Returns the window's maximum size (in pixels). See also :ref:`window_set_max_size<class_DisplayServer_method_window_set_max_size>`.
    3989. 

  3989. 

  3990. .. rst-class:: classref-item-separator
    3991. 

  3991. 

  3992. ----
    3993. 

  3993. 

  3994. .. _class_DisplayServer_method_window_get_min_size:
    3995. 

  3995. 

  3996. .. rst-class:: classref-method
    3997. 

  3997. 

  3998. :ref:`Vector2i<class_Vector2i>` **window_get_min_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_min_size>`
    3999. 

  3999. 

  4000. Returns the window's minimum size (in pixels). See also :ref:`window_set_min_size<class_DisplayServer_method_window_set_min_size>`.
    4001. 

  4001. 

  4002. .. rst-class:: classref-item-separator
    4003. 

  4003. 

  4004. ----
    4005. 

  4005. 

  4006. .. _class_DisplayServer_method_window_get_mode:
    4007. 

  4007. 

  4008. .. rst-class:: classref-method
    4009. 

  4009. 

  4010. :ref:`WindowMode<enum_DisplayServer_WindowMode>` **window_get_mode**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_mode>`
    4011. 

  4011. 

  4012. Returns the mode of the given window.
    4013. 

  4013. 

  4014. .. rst-class:: classref-item-separator
    4015. 

  4015. 

  4016. ----
    4017. 

  4017. 

  4018. .. _class_DisplayServer_method_window_get_native_handle:
    4019. 

  4019. 

  4020. .. rst-class:: classref-method
    4021. 

  4021. 

  4022. :ref:`int<class_int>` **window_get_native_handle**\ (\ handle_type\: :ref:`HandleType<enum_DisplayServer_HandleType>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_native_handle>`
    4023. 

  4023. 

  4024. Returns internal structure pointers for use in plugins.
    4025. 

  4025. 

  4026. \ **Note:** This method is implemented on Android, Linux (X11/Wayland), macOS, and Windows.
    4027. 

  4027. 

  4028. .. rst-class:: classref-item-separator
    4029. 

  4029. 

  4030. ----
    4031. 

  4031. 

  4032. .. _class_DisplayServer_method_window_get_popup_safe_rect:
    4033. 

  4033. 

  4034. .. rst-class:: classref-method
    4035. 

  4035. 

  4036. :ref:`Rect2i<class_Rect2i>` **window_get_popup_safe_rect**\ (\ window\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_popup_safe_rect>`
    4037. 

  4037. 

  4038. Returns the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system.
    4039. 

  4039. 

  4040. .. rst-class:: classref-item-separator
    4041. 

  4041. 

  4042. ----
    4043. 

  4043. 

  4044. .. _class_DisplayServer_method_window_get_position:
    4045. 

  4045. 

  4046. .. rst-class:: classref-method
    4047. 

  4047. 

  4048. :ref:`Vector2i<class_Vector2i>` **window_get_position**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_position>`
    4049. 

  4049. 

  4050. Returns the position of the client area of the given window on the screen.
    4051. 

  4051. 

  4052. .. rst-class:: classref-item-separator
    4053. 

  4053. 

  4054. ----
    4055. 

  4055. 

  4056. .. _class_DisplayServer_method_window_get_position_with_decorations:
    4057. 

  4057. 

  4058. .. rst-class:: classref-method
    4059. 

  4059. 

  4060. :ref:`Vector2i<class_Vector2i>` **window_get_position_with_decorations**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_position_with_decorations>`
    4061. 

  4061. 

  4062. 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>`.
    4063. 

  4063. 

  4064. .. rst-class:: classref-item-separator
    4065. 

  4065. 

  4066. ----
    4067. 

  4067. 

  4068. .. _class_DisplayServer_method_window_get_safe_title_margins:
    4069. 

  4069. 

  4070. .. rst-class:: classref-method
    4071. 

  4071. 

  4072. :ref:`Vector3i<class_Vector3i>` **window_get_safe_title_margins**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_safe_title_margins>`
    4073. 

  4073. 

  4074. 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.
    4075. 

  4075. 

  4076. .. rst-class:: classref-item-separator
    4077. 

  4077. 

  4078. ----
    4079. 

  4079. 

  4080. .. _class_DisplayServer_method_window_get_size:
    4081. 

  4081. 

  4082. .. rst-class:: classref-method
    4083. 

  4083. 

  4084. :ref:`Vector2i<class_Vector2i>` **window_get_size**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_size>`
    4085. 

  4085. 

  4086. 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>`.
    4087. 

  4087. 

  4088. .. rst-class:: classref-item-separator
    4089. 

  4089. 

  4090. ----
    4091. 

  4091. 

  4092. .. _class_DisplayServer_method_window_get_size_with_decorations:
    4093. 

  4093. 

  4094. .. rst-class:: classref-method
    4095. 

  4095. 

  4096. :ref:`Vector2i<class_Vector2i>` **window_get_size_with_decorations**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_size_with_decorations>`
    4097. 

  4097. 

  4098. 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>`.
    4099. 

  4099. 

  4100. .. rst-class:: classref-item-separator
    4101. 

  4101. 

  4102. ----
    4103. 

  4103. 

  4104. .. _class_DisplayServer_method_window_get_title_size:
    4105. 

  4105. 

  4106. .. rst-class:: classref-method
    4107. 

  4107. 

  4108. :ref:`Vector2i<class_Vector2i>` **window_get_title_size**\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_title_size>`
    4109. 

  4109. 

  4110. Returns the estimated window title bar size (including text and window buttons) for the window specified by ``window_id`` (in pixels). This method does not change the window title.
    4111. 

  4111. 

  4112. \ **Note:** This method is implemented on macOS and Windows.
    4113. 

  4113. 

  4114. .. rst-class:: classref-item-separator
    4115. 

  4115. 

  4116. ----
    4117. 

  4117. 

  4118. .. _class_DisplayServer_method_window_get_vsync_mode:
    4119. 

  4119. 

  4120. .. rst-class:: classref-method
    4121. 

  4121. 

  4122. :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **window_get_vsync_mode**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_get_vsync_mode>`
    4123. 

  4123. 

  4124. Returns the V-Sync mode of the given window.
    4125. 

  4125. 

  4126. .. rst-class:: classref-item-separator
    4127. 

  4127. 

  4128. ----
    4129. 

  4129. 

  4130. .. _class_DisplayServer_method_window_is_focused:
    4131. 

  4131. 

  4132. .. rst-class:: classref-method
    4133. 

  4133. 

  4134. :ref:`bool<class_bool>` **window_is_focused**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_is_focused>`
    4135. 

  4135. 

  4136. Returns ``true`` if the window specified by ``window_id`` is focused.
    4137. 

  4137. 

  4138. .. rst-class:: classref-item-separator
    4139. 

  4139. 

  4140. ----
    4141. 

  4141. 

  4142. .. _class_DisplayServer_method_window_is_maximize_allowed:
    4143. 

  4143. 

  4144. .. rst-class:: classref-method
    4145. 

  4145. 

  4146. :ref:`bool<class_bool>` **window_is_maximize_allowed**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_is_maximize_allowed>`
    4147. 

  4147. 

  4148. Returns ``true`` if the given window can be maximized (the maximize button is enabled).
    4149. 

  4149. 

  4150. .. rst-class:: classref-item-separator
    4151. 

  4151. 

  4152. ----
    4153. 

  4153. 

  4154. .. _class_DisplayServer_method_window_maximize_on_title_dbl_click:
    4155. 

  4155. 

  4156. .. rst-class:: classref-method
    4157. 

  4157. 

  4158. :ref:`bool<class_bool>` **window_maximize_on_title_dbl_click**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_maximize_on_title_dbl_click>`
    4159. 

  4159. 

  4160. Returns ``true``, if double-click on a window title should maximize it.
    4161. 

  4161. 

  4162. \ **Note:** This method is implemented only on macOS.
    4163. 

  4163. 

  4164. .. rst-class:: classref-item-separator
    4165. 

  4165. 

  4166. ----
    4167. 

  4167. 

  4168. .. _class_DisplayServer_method_window_minimize_on_title_dbl_click:
    4169. 

  4169. 

  4170. .. rst-class:: classref-method
    4171. 

  4171. 

  4172. :ref:`bool<class_bool>` **window_minimize_on_title_dbl_click**\ (\ ) |const| :ref:`๐Ÿ”—<class_DisplayServer_method_window_minimize_on_title_dbl_click>`
    4173. 

  4173. 

  4174. Returns ``true``, if double-click on a window title should minimize it.
    4175. 

  4175. 

  4176. \ **Note:** This method is implemented only on macOS.
    4177. 

  4177. 

  4178. .. rst-class:: classref-item-separator
    4179. 

  4179. 

  4180. ----
    4181. 

  4181. 

  4182. .. _class_DisplayServer_method_window_move_to_foreground:
    4183. 

  4183. 

  4184. .. rst-class:: classref-method
    4185. 

  4185. 

  4186. |void| **window_move_to_foreground**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_move_to_foreground>`
    4187. 

  4187. 

  4188. Moves the window specified by ``window_id`` to the foreground, so that it is visible over other windows.
    4189. 

  4189. 

  4190. .. rst-class:: classref-item-separator
    4191. 

  4191. 

  4192. ----
    4193. 

  4193. 

  4194. .. _class_DisplayServer_method_window_request_attention:
    4195. 

  4195. 

  4196. .. rst-class:: classref-method
    4197. 

  4197. 

  4198. |void| **window_request_attention**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_request_attention>`
    4199. 

  4199. 

  4200. 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.
    4201. 

  4201. 

  4202. .. rst-class:: classref-item-separator
    4203. 

  4203. 

  4204. ----
    4205. 

  4205. 

  4206. .. _class_DisplayServer_method_window_set_current_screen:
    4207. 

  4207. 

  4208. .. rst-class:: classref-method
    4209. 

  4209. 

  4210. |void| **window_set_current_screen**\ (\ screen\: :ref:`int<class_int>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_current_screen>`
    4211. 

  4211. 

  4212. 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>`.
    4213. 

  4213. 

  4214. .. rst-class:: classref-item-separator
    4215. 

  4215. 

  4216. ----
    4217. 

  4217. 

  4218. .. _class_DisplayServer_method_window_set_drop_files_callback:
    4219. 

  4219. 

  4220. .. rst-class:: classref-method
    4221. 

  4221. 

  4222. |void| **window_set_drop_files_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_drop_files_callback>`
    4223. 

  4223. 

  4224. Sets the ``callback`` that should be called when files are dropped from the operating system's file manager to the window specified by ``window_id``. ``callback`` should take one :ref:`PackedStringArray<class_PackedStringArray>` argument, which is the list of dropped files.
    4225. 

  4225. 

  4226. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
    4227. 

  4227. 

  4228. \ **Note:** This method is implemented on Windows, macOS, Linux (X11/Wayland), and Web.
    4229. 

  4229. 

  4230. .. rst-class:: classref-item-separator
    4231. 

  4231. 

  4232. ----
    4233. 

  4233. 

  4234. .. _class_DisplayServer_method_window_set_exclusive:
    4235. 

  4235. 

  4236. .. rst-class:: classref-method
    4237. 

  4237. 

  4238. |void| **window_set_exclusive**\ (\ window_id\: :ref:`int<class_int>`, exclusive\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_exclusive>`
    4239. 

  4239. 

  4240. 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.
    4241. 

  4241. 

  4242. \ **Note:** On macOS, exclusive windows are confined to the same space (virtual desktop or screen) as the parent window.
    4243. 

  4243. 

  4244. \ **Note:** This method is implemented on macOS and Windows.
    4245. 

  4245. 

  4246. .. rst-class:: classref-item-separator
    4247. 

  4247. 

  4248. ----
    4249. 

  4249. 

  4250. .. _class_DisplayServer_method_window_set_flag:
    4251. 

  4251. 

  4252. .. rst-class:: classref-method
    4253. 

  4253. 

  4254. |void| **window_set_flag**\ (\ flag\: :ref:`WindowFlags<enum_DisplayServer_WindowFlags>`, enabled\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_flag>`
    4255. 

  4255. 

  4256. Enables or disables the given window's given ``flag``. See :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` for possible values and their behavior.
    4257. 

  4257. 

  4258. .. rst-class:: classref-item-separator
    4259. 

  4259. 

  4260. ----
    4261. 

  4261. 

  4262. .. _class_DisplayServer_method_window_set_ime_active:
    4263. 

  4263. 

  4264. .. rst-class:: classref-method
    4265. 

  4265. 

  4266. |void| **window_set_ime_active**\ (\ active\: :ref:`bool<class_bool>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_ime_active>`
    4267. 

  4267. 

  4268. 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>`.
    4269. 

  4269. 

  4270. .. rst-class:: classref-item-separator
    4271. 

  4271. 

  4272. ----
    4273. 

  4273. 

  4274. .. _class_DisplayServer_method_window_set_ime_position:
    4275. 

  4275. 

  4276. .. rst-class:: classref-method
    4277. 

  4277. 

  4278. |void| **window_set_ime_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_ime_position>`
    4279. 

  4279. 

  4280. 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``.
    4281. 

  4281. 

  4282. .. rst-class:: classref-item-separator
    4283. 

  4283. 

  4284. ----
    4285. 

  4285. 

  4286. .. _class_DisplayServer_method_window_set_input_event_callback:
    4287. 

  4287. 

  4288. .. rst-class:: classref-method
    4289. 

  4289. 

  4290. |void| **window_set_input_event_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_input_event_callback>`
    4291. 

  4291. 

  4292. Sets the ``callback`` that should be called when any :ref:`InputEvent<class_InputEvent>` is sent to the window specified by ``window_id``.
    4293. 

  4293. 

  4294. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
    4295. 

  4295. 

  4296. .. rst-class:: classref-item-separator
    4297. 

  4297. 

  4298. ----
    4299. 

  4299. 

  4300. .. _class_DisplayServer_method_window_set_input_text_callback:
    4301. 

  4301. 

  4302. .. rst-class:: classref-method
    4303. 

  4303. 

  4304. |void| **window_set_input_text_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_input_text_callback>`
    4305. 

  4305. 

  4306. Sets the ``callback`` that should be called when text is entered using the virtual keyboard to the window specified by ``window_id``.
    4307. 

  4307. 

  4308. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
    4309. 

  4309. 

  4310. .. rst-class:: classref-item-separator
    4311. 

  4311. 

  4312. ----
    4313. 

  4313. 

  4314. .. _class_DisplayServer_method_window_set_max_size:
    4315. 

  4315. 

  4316. .. rst-class:: classref-method
    4317. 

  4317. 

  4318. |void| **window_set_max_size**\ (\ max_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_max_size>`
    4319. 

  4319. 

  4320. Sets the maximum size of the window specified by ``window_id`` in pixels. Normally, the user will not be able to drag the window to make it larger than the specified size. See also :ref:`window_get_max_size<class_DisplayServer_method_window_get_max_size>`.
    4321. 

  4321. 

  4322. \ **Note:** It's recommended to change this value using :ref:`Window.max_size<class_Window_property_max_size>` instead.
    4323. 

  4323. 

  4324. \ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.
    4325. 

  4325. 

  4326. .. rst-class:: classref-item-separator
    4327. 

  4327. 

  4328. ----
    4329. 

  4329. 

  4330. .. _class_DisplayServer_method_window_set_min_size:
    4331. 

  4331. 

  4332. .. rst-class:: classref-method
    4333. 

  4333. 

  4334. |void| **window_set_min_size**\ (\ min_size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_min_size>`
    4335. 

  4335. 

  4336. Sets the minimum size for the given window to ``min_size`` in pixels. Normally, the user will not be able to drag the window to make it smaller than the specified size. See also :ref:`window_get_min_size<class_DisplayServer_method_window_get_min_size>`.
    4337. 

  4337. 

  4338. \ **Note:** It's recommended to change this value using :ref:`Window.min_size<class_Window_property_min_size>` instead.
    4339. 

  4339. 

  4340. \ **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.
    4341. 

  4341. 

  4342. \ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.
    4343. 

  4343. 

  4344. .. rst-class:: classref-item-separator
    4345. 

  4345. 

  4346. ----
    4347. 

  4347. 

  4348. .. _class_DisplayServer_method_window_set_mode:
    4349. 

  4349. 

  4350. .. rst-class:: classref-method
    4351. 

  4351. 

  4352. |void| **window_set_mode**\ (\ mode\: :ref:`WindowMode<enum_DisplayServer_WindowMode>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_mode>`
    4353. 

  4353. 

  4354. Sets window mode for the given window to ``mode``. See :ref:`WindowMode<enum_DisplayServer_WindowMode>` for possible values and how each mode behaves.
    4355. 

  4355. 

  4356. \ **Note:** On Android, setting it to :ref:`WINDOW_MODE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN>` or :ref:`WINDOW_MODE_EXCLUSIVE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN>` will enable immersive mode.
    4357. 

  4357. 

  4358. \ **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.
    4359. 

  4359. 

  4360. .. rst-class:: classref-item-separator
    4361. 

  4361. 

  4362. ----
    4363. 

  4363. 

  4364. .. _class_DisplayServer_method_window_set_mouse_passthrough:
    4365. 

  4365. 

  4366. .. rst-class:: classref-method
    4367. 

  4367. 

  4368. |void| **window_set_mouse_passthrough**\ (\ region\: :ref:`PackedVector2Array<class_PackedVector2Array>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_mouse_passthrough>`
    4369. 

  4369. 

  4370. Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through.
    4371. 

  4371. 

  4372. Passing an empty array will disable passthrough support (all mouse events will be intercepted by the window, which is the default behavior).
    4373. 

  4373. 

  4374. 

  4375. .. tabs::
    4376. 

  4376. 

  4377.  .. code-tab:: gdscript
    4378. 

  4378. 

  4379.     # Set region, using Path2D node.
    4380. 

  4380.     DisplayServer.window_set_mouse_passthrough($Path2D.curve.get_baked_points())
    4381. 

  4381.     
    4382. 

  4382.     # Set region, using Polygon2D node.
    4383. 

  4383.     DisplayServer.window_set_mouse_passthrough($Polygon2D.polygon)
    4384. 

  4384.     
    4385. 

  4385.     # Reset region to default.
    4386. 

  4386.     DisplayServer.window_set_mouse_passthrough([])
    4387. 

  4387. 

  4388.  .. code-tab:: csharp
    4389. 

  4389. 

  4390.     // Set region, using Path2D node.
    4391. 

  4391.     DisplayServer.WindowSetMousePassthrough(GetNode<Path2D>("Path2D").Curve.GetBakedPoints());
    4392. 

  4392.     
    4393. 

  4393.     // Set region, using Polygon2D node.
    4394. 

  4394.     DisplayServer.WindowSetMousePassthrough(GetNode<Polygon2D>("Polygon2D").Polygon);
    4395. 

  4395.     
    4396. 

  4396.     // Reset region to default.
    4397. 

  4397.     DisplayServer.WindowSetMousePassthrough(new Vector2[] {});
    4398. 

  4398. 

  4399. 

  4400. 

  4401. \ **Note:** On Windows, the portion of a window that lies outside the region is not drawn, while on Linux (X11) and macOS it is.
    4402. 

  4402. 

  4403. \ **Note:** This method is implemented on Linux (X11), macOS and Windows.
    4404. 

  4404. 

  4405. .. rst-class:: classref-item-separator
    4406. 

  4406. 

  4407. ----
    4408. 

  4408. 

  4409. .. _class_DisplayServer_method_window_set_popup_safe_rect:
    4410. 

  4410. 

  4411. .. rst-class:: classref-method
    4412. 

  4412. 

  4413. |void| **window_set_popup_safe_rect**\ (\ window\: :ref:`int<class_int>`, rect\: :ref:`Rect2i<class_Rect2i>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_popup_safe_rect>`
    4414. 

  4414. 

  4415. 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.
    4416. 

  4416. 

  4417. .. rst-class:: classref-item-separator
    4418. 

  4418. 

  4419. ----
    4420. 

  4420. 

  4421. .. _class_DisplayServer_method_window_set_position:
    4422. 

  4422. 

  4423. .. rst-class:: classref-method
    4424. 

  4424. 

  4425. |void| **window_set_position**\ (\ position\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_position>`
    4426. 

  4426. 

  4427. 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:
    4428. 

  4428. 

  4429. .. code:: text
    4430. 

  4430. 

  4431.     * (0, 0)        +-------+
    4432. 

  4432.                     |       |
    4433. 

  4433.     +-------------+ |       |
    4434. 

  4434.     |             | |       |
    4435. 

  4435.     |             | |       |
    4436. 

  4436.     +-------------+ +-------+
    4437. 

  4437. 

  4438. See also :ref:`window_get_position<class_DisplayServer_method_window_get_position>` and :ref:`window_set_size<class_DisplayServer_method_window_set_size>`.
    4439. 

  4439. 

  4440. \ **Note:** It's recommended to change this value using :ref:`Window.position<class_Window_property_position>` instead.
    4441. 

  4441. 

  4442. \ **Note:** On Linux (Wayland): this method is a no-op.
    4443. 

  4443. 

  4444. .. rst-class:: classref-item-separator
    4445. 

  4445. 

  4446. ----
    4447. 

  4447. 

  4448. .. _class_DisplayServer_method_window_set_rect_changed_callback:
    4449. 

  4449. 

  4450. .. rst-class:: classref-method
    4451. 

  4451. 

  4452. |void| **window_set_rect_changed_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_rect_changed_callback>`
    4453. 

  4453. 

  4454. Sets the ``callback`` that will be called when the window specified by ``window_id`` is moved or resized.
    4455. 

  4455. 

  4456. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
    4457. 

  4457. 

  4458. .. rst-class:: classref-item-separator
    4459. 

  4459. 

  4460. ----
    4461. 

  4461. 

  4462. .. _class_DisplayServer_method_window_set_size:
    4463. 

  4463. 

  4464. .. rst-class:: classref-method
    4465. 

  4465. 

  4466. |void| **window_set_size**\ (\ size\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_size>`
    4467. 

  4467. 

  4468. 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>`.
    4469. 

  4469. 

  4470. \ **Note:** It's recommended to change this value using :ref:`Window.size<class_Window_property_size>` instead.
    4471. 

  4471. 

  4472. .. rst-class:: classref-item-separator
    4473. 

  4473. 

  4474. ----
    4475. 

  4475. 

  4476. .. _class_DisplayServer_method_window_set_title:
    4477. 

  4477. 

  4478. .. rst-class:: classref-method
    4479. 

  4479. 

  4480. |void| **window_set_title**\ (\ title\: :ref:`String<class_String>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_title>`
    4481. 

  4481. 

  4482. Sets the title of the given window to ``title``.
    4483. 

  4483. 

  4484. \ **Note:** It's recommended to change this value using :ref:`Window.title<class_Window_property_title>` instead.
    4485. 

  4485. 

  4486. \ **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.
    4487. 

  4487. 

  4488. .. rst-class:: classref-item-separator
    4489. 

  4489. 

  4490. ----
    4491. 

  4491. 

  4492. .. _class_DisplayServer_method_window_set_transient:
    4493. 

  4493. 

  4494. .. rst-class:: classref-method
    4495. 

  4495. 

  4496. |void| **window_set_transient**\ (\ window_id\: :ref:`int<class_int>`, parent_window_id\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_transient>`
    4497. 

  4497. 

  4498. Sets window transient parent. Transient window will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can't enter full-screen mode.
    4499. 

  4499. 

  4500. \ **Note:** It's recommended to change this value using :ref:`Window.transient<class_Window_property_transient>` instead.
    4501. 

  4501. 

  4502. \ **Note:** The behavior might be different depending on the platform.
    4503. 

  4503. 

  4504. .. rst-class:: classref-item-separator
    4505. 

  4505. 

  4506. ----
    4507. 

  4507. 

  4508. .. _class_DisplayServer_method_window_set_vsync_mode:
    4509. 

  4509. 

  4510. .. rst-class:: classref-method
    4511. 

  4511. 

  4512. |void| **window_set_vsync_mode**\ (\ vsync_mode\: :ref:`VSyncMode<enum_DisplayServer_VSyncMode>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_vsync_mode>`
    4513. 

  4513. 

  4514. 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>`.
    4515. 

  4515. 

  4516. See :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` for possible values and how they affect the behavior of your application.
    4517. 

  4517. 

  4518. 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.
    4519. 

  4519. 

  4520. \ **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.
    4521. 

  4521. 

  4522. .. rst-class:: classref-item-separator
    4523. 

  4523. 

  4524. ----
    4525. 

  4525. 

  4526. .. _class_DisplayServer_method_window_set_window_buttons_offset:
    4527. 

  4527. 

  4528. .. rst-class:: classref-method
    4529. 

  4529. 

  4530. |void| **window_set_window_buttons_offset**\ (\ offset\: :ref:`Vector2i<class_Vector2i>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_window_buttons_offset>`
    4531. 

  4531. 

  4532. 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.
    4533. 

  4533. 

  4534. \ **Note:** This flag is implemented only on macOS.
    4535. 

  4535. 

  4536. .. rst-class:: classref-item-separator
    4537. 

  4537. 

  4538. ----
    4539. 

  4539. 

  4540. .. _class_DisplayServer_method_window_set_window_event_callback:
    4541. 

  4541. 

  4542. .. rst-class:: classref-method
    4543. 

  4543. 

  4544. |void| **window_set_window_event_callback**\ (\ callback\: :ref:`Callable<class_Callable>`, window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_set_window_event_callback>`
    4545. 

  4545. 

  4546. Sets the ``callback`` that will be called when an event occurs in the window specified by ``window_id``.
    4547. 

  4547. 

  4548. \ **Warning:** Advanced users only! Adding such a callback to a :ref:`Window<class_Window>` node will override its default implementation, which can introduce bugs.
    4549. 

  4549. 

  4550. .. rst-class:: classref-item-separator
    4551. 

  4551. 

  4552. ----
    4553. 

  4553. 

  4554. .. _class_DisplayServer_method_window_start_drag:
    4555. 

  4555. 

  4556. .. rst-class:: classref-method
    4557. 

  4557. 

  4558. |void| **window_start_drag**\ (\ window_id\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_DisplayServer_method_window_start_drag>`
    4559. 

  4559. 

  4560. Starts a drag operation on the window with the given ``window_id``, using the current mouse position. Call this method when handling a mouse button being pressed to simulate a pressed event on the window's title bar. Using this method allows the window to participate in space switching, tiling, and other system features.
    4561. 

  4561. 

  4562. \ **Note:** This method is implemented only on macOS.
    4563. 

  4563. 

  4564. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    4565. 

  4565. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    4566. 

  4566. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    4567. 

  4567. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    4568. 

  4568. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    4569. 

  4569. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    4570. 

  4570. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    4571. 

  4571. .. |void| replace:: :abbr:`void (No return value.)`
    4572.