godot-docs/classes/class_displayserver.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DisplayServer.xml.

.. _class_DisplayServer:

DisplayServer
=============

**Inherits:** :ref:`Object<class_Object>`

A server interface for low-level window management.

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

Description
-----------

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

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

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

Methods
-------

.. table::
   :widths: auto

   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                             | :ref:`clipboard_get<class_DisplayServer_method_clipboard_get>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Image<class_Image>`                                               | :ref:`clipboard_get_image<class_DisplayServer_method_clipboard_get_image>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                             | :ref:`clipboard_get_primary<class_DisplayServer_method_clipboard_get_primary>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`clipboard_has<class_DisplayServer_method_clipboard_has>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`clipboard_has_image<class_DisplayServer_method_clipboard_has_image>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`clipboard_set<class_DisplayServer_method_clipboard_set>` **(** :ref:`String<class_String>` clipboard **)**                                                                                                                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`clipboard_set_primary<class_DisplayServer_method_clipboard_set_primary>` **(** :ref:`String<class_String>` clipboard_primary **)**                                                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`CursorShape<enum_DisplayServer_CursorShape>`                      | :ref:`cursor_get_shape<class_DisplayServer_method_cursor_get_shape>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`cursor_set_custom_image<class_DisplayServer_method_cursor_set_custom_image>` **(** :ref:`Resource<class_Resource>` cursor, :ref:`CursorShape<enum_DisplayServer_CursorShape>` shape=0, :ref:`Vector2<class_Vector2>` hotspot=Vector2(0, 0) **)**                                                                                                                                                                                                                                                |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`cursor_set_shape<class_DisplayServer_method_cursor_set_shape>` **(** :ref:`CursorShape<enum_DisplayServer_CursorShape>` shape **)**                                                                                                                                                                                                                                                                                                                                                             |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`                                   | :ref:`dialog_input_text<class_DisplayServer_method_dialog_input_text>` **(** :ref:`String<class_String>` title, :ref:`String<class_String>` description, :ref:`String<class_String>` existing_text, :ref:`Callable<class_Callable>` callback **)**                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`                                   | :ref:`dialog_show<class_DisplayServer_method_dialog_show>` **(** :ref:`String<class_String>` title, :ref:`String<class_String>` description, :ref:`PackedStringArray<class_PackedStringArray>` buttons, :ref:`Callable<class_Callable>` callback **)**                                                                                                                                                                                                                                                |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`enable_for_stealing_focus<class_DisplayServer_method_enable_for_stealing_focus>` **(** :ref:`int<class_int>` process_id **)**                                                                                                                                                                                                                                                                                                                                                                   |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Error<enum_@GlobalScope_Error>`                                   | :ref:`file_dialog_show<class_DisplayServer_method_file_dialog_show>` **(** :ref:`String<class_String>` title, :ref:`String<class_String>` current_directory, :ref:`String<class_String>` filename, :ref:`bool<class_bool>` show_hidden, :ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` mode, :ref:`PackedStringArray<class_PackedStringArray>` filters, :ref:`Callable<class_Callable>` callback **)**                                                                                      |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`force_process_and_drop_events<class_DisplayServer_method_force_process_and_drop_events>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`                                               | :ref:`get_accent_color<class_DisplayServer_method_get_accent_color>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Rect2[]<class_Rect2>`                                             | :ref:`get_display_cutouts<class_DisplayServer_method_get_display_cutouts>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Rect2i<class_Rect2i>`                                             | :ref:`get_display_safe_area<class_DisplayServer_method_get_display_safe_area>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`get_keyboard_focus_screen<class_DisplayServer_method_get_keyboard_focus_screen>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                             | :ref:`get_name<class_DisplayServer_method_get_name>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`get_primary_screen<class_DisplayServer_method_get_primary_screen>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`get_screen_count<class_DisplayServer_method_get_screen_count>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`get_screen_from_rect<class_DisplayServer_method_get_screen_from_rect>` **(** :ref:`Rect2<class_Rect2>` rect **)** |const|                                                                                                                                                                                                                                                                                                                                                                       |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`get_swap_cancel_ok<class_DisplayServer_method_get_swap_cancel_ok>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`get_window_at_screen_position<class_DisplayServer_method_get_window_at_screen_position>` **(** :ref:`Vector2i<class_Vector2i>` position **)** |const|                                                                                                                                                                                                                                                                                                                                           |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedInt32Array<class_PackedInt32Array>`                         | :ref:`get_window_list<class_DisplayServer_method_get_window_list>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`global_menu_add_check_item<class_DisplayServer_method_global_menu_add_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback=Callable(), :ref:`Callable<class_Callable>` key_callback=Callable(), :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**                                                                                  |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`global_menu_add_icon_check_item<class_DisplayServer_method_global_menu_add_icon_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback=Callable(), :ref:`Callable<class_Callable>` key_callback=Callable(), :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**                                |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`global_menu_add_icon_item<class_DisplayServer_method_global_menu_add_icon_item>` **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback=Callable(), :ref:`Callable<class_Callable>` key_callback=Callable(), :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**                                            |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`global_menu_add_icon_radio_check_item<class_DisplayServer_method_global_menu_add_icon_radio_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`Texture2D<class_Texture2D>` icon, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback=Callable(), :ref:`Callable<class_Callable>` key_callback=Callable(), :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`global_menu_add_item<class_DisplayServer_method_global_menu_add_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback=Callable(), :ref:`Callable<class_Callable>` key_callback=Callable(), :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`int<class_int>` max_states, :ref:`int<class_int>` default_state, :ref:`Callable<class_Callable>` callback=Callable(), :ref:`Callable<class_Callable>` key_callback=Callable(), :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)** |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`global_menu_add_radio_check_item<class_DisplayServer_method_global_menu_add_radio_check_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`Callable<class_Callable>` callback=Callable(), :ref:`Callable<class_Callable>` key_callback=Callable(), :ref:`Variant<class_Variant>` tag=null, :ref:`Key<enum_@GlobalScope_Key>` accelerator=0, :ref:`int<class_int>` index=-1 **)**                                                                      |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`global_menu_add_separator<class_DisplayServer_method_global_menu_add_separator>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` index=-1 **)**                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`global_menu_add_submenu_item<class_DisplayServer_method_global_menu_add_submenu_item>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` label, :ref:`String<class_String>` submenu, :ref:`int<class_int>` index=-1 **)**                                                                                                                                                                                                                                                |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_clear<class_DisplayServer_method_global_menu_clear>` **(** :ref:`String<class_String>` menu_root **)**                                                                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Key<enum_@GlobalScope_Key>`                                       | :ref:`global_menu_get_item_accelerator<class_DisplayServer_method_global_menu_get_item_accelerator>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                             |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Callable<class_Callable>`                                         | :ref:`global_menu_get_item_callback<class_DisplayServer_method_global_menu_get_item_callback>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                                   |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`global_menu_get_item_count<class_DisplayServer_method_global_menu_get_item_count>` **(** :ref:`String<class_String>` menu_root **)** |const|                                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Texture2D<class_Texture2D>`                                       | :ref:`global_menu_get_item_icon<class_DisplayServer_method_global_menu_get_item_icon>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                                           |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`global_menu_get_item_indentation_level<class_DisplayServer_method_global_menu_get_item_indentation_level>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                 |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`global_menu_get_item_index_from_tag<class_DisplayServer_method_global_menu_get_item_index_from_tag>` **(** :ref:`String<class_String>` menu_root, :ref:`Variant<class_Variant>` tag **)** |const|                                                                                                                                                                                                                                                                                               |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`global_menu_get_item_index_from_text<class_DisplayServer_method_global_menu_get_item_index_from_text>` **(** :ref:`String<class_String>` menu_root, :ref:`String<class_String>` text **)** |const|                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Callable<class_Callable>`                                         | :ref:`global_menu_get_item_key_callback<class_DisplayServer_method_global_menu_get_item_key_callback>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                           |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`global_menu_get_item_max_states<class_DisplayServer_method_global_menu_get_item_max_states>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                               |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`global_menu_get_item_state<class_DisplayServer_method_global_menu_get_item_state>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                                         |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                             | :ref:`global_menu_get_item_submenu<class_DisplayServer_method_global_menu_get_item_submenu>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                                     |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                                           | :ref:`global_menu_get_item_tag<class_DisplayServer_method_global_menu_get_item_tag>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                                             |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                             | :ref:`global_menu_get_item_text<class_DisplayServer_method_global_menu_get_item_text>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                                           |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                             | :ref:`global_menu_get_item_tooltip<class_DisplayServer_method_global_menu_get_item_tooltip>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                                     |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`global_menu_is_item_checkable<class_DisplayServer_method_global_menu_is_item_checkable>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                                   |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`global_menu_is_item_checked<class_DisplayServer_method_global_menu_is_item_checked>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                                       |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`global_menu_is_item_disabled<class_DisplayServer_method_global_menu_is_item_disabled>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                                     |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`global_menu_is_item_radio_checkable<class_DisplayServer_method_global_menu_is_item_radio_checkable>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                       |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_remove_item<class_DisplayServer_method_global_menu_remove_item>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)**                                                                                                                                                                                                                                                                                                                                       |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_set_item_accelerator<class_DisplayServer_method_global_menu_set_item_accelerator>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Key<enum_@GlobalScope_Key>` keycode **)**                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_set_item_callback<class_DisplayServer_method_global_menu_set_item_callback>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Callable<class_Callable>` callback **)**                                                                                                                                                                                                                                                                                 |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_set_item_checkable<class_DisplayServer_method_global_menu_set_item_checkable>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checkable **)**                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_set_item_checked<class_DisplayServer_method_global_menu_set_item_checked>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checked **)**                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_set_item_disabled<class_DisplayServer_method_global_menu_set_item_disabled>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` disabled **)**                                                                                                                                                                                                                                                                                         |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_set_item_icon<class_DisplayServer_method_global_menu_set_item_icon>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Texture2D<class_Texture2D>` icon **)**                                                                                                                                                                                                                                                                                           |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_set_item_indentation_level<class_DisplayServer_method_global_menu_set_item_indentation_level>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` level **)**                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_set_item_key_callback<class_DisplayServer_method_global_menu_set_item_key_callback>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Callable<class_Callable>` key_callback **)**                                                                                                                                                                                                                                                                     |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_set_item_max_states<class_DisplayServer_method_global_menu_set_item_max_states>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` max_states **)**                                                                                                                                                                                                                                                                                     |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_set_item_radio_checkable<class_DisplayServer_method_global_menu_set_item_radio_checkable>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`bool<class_bool>` checkable **)**                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_set_item_state<class_DisplayServer_method_global_menu_set_item_state>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` state **)**                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_set_item_submenu<class_DisplayServer_method_global_menu_set_item_submenu>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`String<class_String>` submenu **)**                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_set_item_tag<class_DisplayServer_method_global_menu_set_item_tag>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`Variant<class_Variant>` tag **)**                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_set_item_text<class_DisplayServer_method_global_menu_set_item_text>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`String<class_String>` text **)**                                                                                                                                                                                                                                                                                                 |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`global_menu_set_item_tooltip<class_DisplayServer_method_global_menu_set_item_tooltip>` **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`String<class_String>` tooltip **)**                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`has_feature<class_DisplayServer_method_has_feature>` **(** :ref:`Feature<enum_DisplayServer_Feature>` feature **)** |const|                                                                                                                                                                                                                                                                                                                                                                     |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`ime_get_selection<class_DisplayServer_method_ime_get_selection>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                             | :ref:`ime_get_text<class_DisplayServer_method_ime_get_text>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`is_dark_mode<class_DisplayServer_method_is_dark_mode>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`is_dark_mode_supported<class_DisplayServer_method_is_dark_mode_supported>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`is_touchscreen_available<class_DisplayServer_method_is_touchscreen_available>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`keyboard_get_current_layout<class_DisplayServer_method_keyboard_get_current_layout>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Key<enum_@GlobalScope_Key>`                                       | :ref:`keyboard_get_keycode_from_physical<class_DisplayServer_method_keyboard_get_keycode_from_physical>` **(** :ref:`Key<enum_@GlobalScope_Key>` keycode **)** |const|                                                                                                                                                                                                                                                                                                                                |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Key<enum_@GlobalScope_Key>`                                       | :ref:`keyboard_get_label_from_physical<class_DisplayServer_method_keyboard_get_label_from_physical>` **(** :ref:`Key<enum_@GlobalScope_Key>` keycode **)** |const|                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`keyboard_get_layout_count<class_DisplayServer_method_keyboard_get_layout_count>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                             | :ref:`keyboard_get_layout_language<class_DisplayServer_method_keyboard_get_layout_language>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                             | :ref:`keyboard_get_layout_name<class_DisplayServer_method_keyboard_get_layout_name>` **(** :ref:`int<class_int>` index **)** |const|                                                                                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`keyboard_set_current_layout<class_DisplayServer_method_keyboard_set_current_layout>` **(** :ref:`int<class_int>` index **)**                                                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |bitfield|\<:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>`\> | :ref:`mouse_get_button_state<class_DisplayServer_method_mouse_get_button_state>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`MouseMode<enum_DisplayServer_MouseMode>`                          | :ref:`mouse_get_mode<class_DisplayServer_method_mouse_get_mode>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`mouse_get_position<class_DisplayServer_method_mouse_get_position>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`mouse_set_mode<class_DisplayServer_method_mouse_set_mode>` **(** :ref:`MouseMode<enum_DisplayServer_MouseMode>` mouse_mode **)**                                                                                                                                                                                                                                                                                                                                                                |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`process_events<class_DisplayServer_method_process_events>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`screen_get_dpi<class_DisplayServer_method_screen_get_dpi>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Image<class_Image>`                                               | :ref:`screen_get_image<class_DisplayServer_method_screen_get_image>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                                               | :ref:`screen_get_max_scale<class_DisplayServer_method_screen_get_max_scale>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>`          | :ref:`screen_get_orientation<class_DisplayServer_method_screen_get_orientation>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`                                               | :ref:`screen_get_pixel<class_DisplayServer_method_screen_get_pixel>` **(** :ref:`Vector2i<class_Vector2i>` position **)** |const|                                                                                                                                                                                                                                                                                                                                                                     |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`screen_get_position<class_DisplayServer_method_screen_get_position>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                                               | :ref:`screen_get_refresh_rate<class_DisplayServer_method_screen_get_refresh_rate>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                                                |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                                               | :ref:`screen_get_scale<class_DisplayServer_method_screen_get_scale>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`screen_get_size<class_DisplayServer_method_screen_get_size>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                                                                |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Rect2i<class_Rect2i>`                                             | :ref:`screen_get_usable_rect<class_DisplayServer_method_screen_get_usable_rect>` **(** :ref:`int<class_int>` screen=-1 **)** |const|                                                                                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`screen_is_kept_on<class_DisplayServer_method_screen_is_kept_on>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`screen_set_keep_on<class_DisplayServer_method_screen_set_keep_on>` **(** :ref:`bool<class_bool>` enable **)**                                                                                                                                                                                                                                                                                                                                                                                   |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`screen_set_orientation<class_DisplayServer_method_screen_set_orientation>` **(** :ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` orientation, :ref:`int<class_int>` screen=-1 **)**                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`set_icon<class_DisplayServer_method_set_icon>` **(** :ref:`Image<class_Image>` image **)**                                                                                                                                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`set_native_icon<class_DisplayServer_method_set_native_icon>` **(** :ref:`String<class_String>` filename **)**                                                                                                                                                                                                                                                                                                                                                                                   |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                             | :ref:`tablet_get_current_driver<class_DisplayServer_method_tablet_get_current_driver>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`tablet_get_driver_count<class_DisplayServer_method_tablet_get_driver_count>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                             | :ref:`tablet_get_driver_name<class_DisplayServer_method_tablet_get_driver_name>` **(** :ref:`int<class_int>` idx **)** |const|                                                                                                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`tablet_set_current_driver<class_DisplayServer_method_tablet_set_current_driver>` **(** :ref:`String<class_String>` name **)**                                                                                                                                                                                                                                                                                                                                                                   |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Dictionary[]<class_Dictionary>`                                   | :ref:`tts_get_voices<class_DisplayServer_method_tts_get_voices>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedStringArray<class_PackedStringArray>`                       | :ref:`tts_get_voices_for_language<class_DisplayServer_method_tts_get_voices_for_language>` **(** :ref:`String<class_String>` language **)** |const|                                                                                                                                                                                                                                                                                                                                                   |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`tts_is_paused<class_DisplayServer_method_tts_is_paused>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`tts_is_speaking<class_DisplayServer_method_tts_is_speaking>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                                |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`tts_pause<class_DisplayServer_method_tts_pause>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`tts_resume<class_DisplayServer_method_tts_resume>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`tts_set_utterance_callback<class_DisplayServer_method_tts_set_utterance_callback>` **(** :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` event, :ref:`Callable<class_Callable>` callable **)**                                                                                                                                                                                                                                                                                   |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`tts_speak<class_DisplayServer_method_tts_speak>` **(** :ref:`String<class_String>` text, :ref:`String<class_String>` voice, :ref:`int<class_int>` volume=50, :ref:`float<class_float>` pitch=1.0, :ref:`float<class_float>` rate=1.0, :ref:`int<class_int>` utterance_id=0, :ref:`bool<class_bool>` interrupt=false **)**                                                                                                                                                                       |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`tts_stop<class_DisplayServer_method_tts_stop>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`virtual_keyboard_get_height<class_DisplayServer_method_virtual_keyboard_get_height>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`virtual_keyboard_hide<class_DisplayServer_method_virtual_keyboard_hide>` **(** **)**                                                                                                                                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`virtual_keyboard_show<class_DisplayServer_method_virtual_keyboard_show>` **(** :ref:`String<class_String>` existing_text, :ref:`Rect2<class_Rect2>` position=Rect2(0, 0, 0, 0), :ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` type=0, :ref:`int<class_int>` max_length=-1, :ref:`int<class_int>` cursor_start=-1, :ref:`int<class_int>` cursor_end=-1 **)**                                                                                                                |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`warp_mouse<class_DisplayServer_method_warp_mouse>` **(** :ref:`Vector2i<class_Vector2i>` position **)**                                                                                                                                                                                                                                                                                                                                                                                         |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`window_can_draw<class_DisplayServer_method_window_can_draw>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`window_get_active_popup<class_DisplayServer_method_window_get_active_popup>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                                                |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`window_get_attached_instance_id<class_DisplayServer_method_window_get_attached_instance_id>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`window_get_current_screen<class_DisplayServer_method_window_get_current_screen>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`window_get_flag<class_DisplayServer_method_window_get_flag>` **(** :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` flag, :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                     |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`window_get_max_size<class_DisplayServer_method_window_get_max_size>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`window_get_min_size<class_DisplayServer_method_window_get_min_size>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`WindowMode<enum_DisplayServer_WindowMode>`                        | :ref:`window_get_mode<class_DisplayServer_method_window_get_mode>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                                   | :ref:`window_get_native_handle<class_DisplayServer_method_window_get_native_handle>` **(** :ref:`HandleType<enum_DisplayServer_HandleType>` handle_type, :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Rect2i<class_Rect2i>`                                             | :ref:`window_get_popup_safe_rect<class_DisplayServer_method_window_get_popup_safe_rect>` **(** :ref:`int<class_int>` window **)** |const|                                                                                                                                                                                                                                                                                                                                                             |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`window_get_position<class_DisplayServer_method_window_get_position>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`window_get_position_with_decorations<class_DisplayServer_method_window_get_position_with_decorations>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector3i<class_Vector3i>`                                         | :ref:`window_get_safe_title_margins<class_DisplayServer_method_window_get_safe_title_margins>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`window_get_size<class_DisplayServer_method_window_get_size>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2i<class_Vector2i>`                                         | :ref:`window_get_size_with_decorations<class_DisplayServer_method_window_get_size_with_decorations>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`VSyncMode<enum_DisplayServer_VSyncMode>`                          | :ref:`window_get_vsync_mode<class_DisplayServer_method_window_get_vsync_mode>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`window_is_focused<class_DisplayServer_method_window_is_focused>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`window_is_maximize_allowed<class_DisplayServer_method_window_is_maximize_allowed>` **(** :ref:`int<class_int>` window_id=0 **)** |const|                                                                                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`window_maximize_on_title_dbl_click<class_DisplayServer_method_window_maximize_on_title_dbl_click>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                                 | :ref:`window_minimize_on_title_dbl_click<class_DisplayServer_method_window_minimize_on_title_dbl_click>` **(** **)** |const|                                                                                                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_move_to_foreground<class_DisplayServer_method_window_move_to_foreground>` **(** :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_request_attention<class_DisplayServer_method_window_request_attention>` **(** :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_current_screen<class_DisplayServer_method_window_set_current_screen>` **(** :ref:`int<class_int>` screen, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_drop_files_callback<class_DisplayServer_method_window_set_drop_files_callback>` **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_exclusive<class_DisplayServer_method_window_set_exclusive>` **(** :ref:`int<class_int>` window_id, :ref:`bool<class_bool>` exclusive **)**                                                                                                                                                                                                                                                                                                                                           |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_flag<class_DisplayServer_method_window_set_flag>` **(** :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` flag, :ref:`bool<class_bool>` enabled, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_ime_active<class_DisplayServer_method_window_set_ime_active>` **(** :ref:`bool<class_bool>` active, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_ime_position<class_DisplayServer_method_window_set_ime_position>` **(** :ref:`Vector2i<class_Vector2i>` position, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_input_event_callback<class_DisplayServer_method_window_set_input_event_callback>` **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_input_text_callback<class_DisplayServer_method_window_set_input_text_callback>` **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_max_size<class_DisplayServer_method_window_set_max_size>` **(** :ref:`Vector2i<class_Vector2i>` max_size, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_min_size<class_DisplayServer_method_window_set_min_size>` **(** :ref:`Vector2i<class_Vector2i>` min_size, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_mode<class_DisplayServer_method_window_set_mode>` **(** :ref:`WindowMode<enum_DisplayServer_WindowMode>` mode, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                               |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_mouse_passthrough<class_DisplayServer_method_window_set_mouse_passthrough>` **(** :ref:`PackedVector2Array<class_PackedVector2Array>` region, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_popup_safe_rect<class_DisplayServer_method_window_set_popup_safe_rect>` **(** :ref:`int<class_int>` window, :ref:`Rect2i<class_Rect2i>` rect **)**                                                                                                                                                                                                                                                                                                                                   |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_position<class_DisplayServer_method_window_set_position>` **(** :ref:`Vector2i<class_Vector2i>` position, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                                    |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_rect_changed_callback<class_DisplayServer_method_window_set_rect_changed_callback>` **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_size<class_DisplayServer_method_window_set_size>` **(** :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                                                |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_title<class_DisplayServer_method_window_set_title>` **(** :ref:`String<class_String>` title, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                                                                 |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_transient<class_DisplayServer_method_window_set_transient>` **(** :ref:`int<class_int>` window_id, :ref:`int<class_int>` parent_window_id **)**                                                                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_vsync_mode<class_DisplayServer_method_window_set_vsync_mode>` **(** :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` vsync_mode, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                               |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_window_buttons_offset<class_DisplayServer_method_window_set_window_buttons_offset>` **(** :ref:`Vector2i<class_Vector2i>` offset, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                                                    | :ref:`window_set_window_event_callback<class_DisplayServer_method_window_set_window_event_callback>` **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**                                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

----

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

Enumerations
------------

.. _enum_DisplayServer_Feature:

.. rst-class:: classref-enumeration

enum **Feature**:

.. _class_DisplayServer_constant_FEATURE_GLOBAL_MENU:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_GLOBAL_MENU** = ``0``

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

.. _class_DisplayServer_constant_FEATURE_SUBWINDOWS:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SUBWINDOWS** = ``1``

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

.. _class_DisplayServer_constant_FEATURE_TOUCHSCREEN:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TOUCHSCREEN** = ``2``

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

.. _class_DisplayServer_constant_FEATURE_MOUSE:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE** = ``3``

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

.. _class_DisplayServer_constant_FEATURE_MOUSE_WARP:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_MOUSE_WARP** = ``4``

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)**

.. _class_DisplayServer_constant_FEATURE_CLIPBOARD:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD** = ``5``

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

.. _class_DisplayServer_constant_FEATURE_VIRTUAL_KEYBOARD:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_VIRTUAL_KEYBOARD** = ``6``

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

.. _class_DisplayServer_constant_FEATURE_CURSOR_SHAPE:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CURSOR_SHAPE** = ``7``

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

.. _class_DisplayServer_constant_FEATURE_CUSTOM_CURSOR_SHAPE:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CUSTOM_CURSOR_SHAPE** = ``8``

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

.. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG** = ``9``

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

.. _class_DisplayServer_constant_FEATURE_IME:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_IME** = ``10``

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)**

.. _class_DisplayServer_constant_FEATURE_WINDOW_TRANSPARENCY:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_WINDOW_TRANSPARENCY** = ``11``

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

.. _class_DisplayServer_constant_FEATURE_HIDPI:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_HIDPI** = ``12``

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

.. _class_DisplayServer_constant_FEATURE_ICON:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ICON** = ``13``

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

.. _class_DisplayServer_constant_FEATURE_NATIVE_ICON:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_ICON** = ``14``

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

.. _class_DisplayServer_constant_FEATURE_ORIENTATION:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_ORIENTATION** = ``15``

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

.. _class_DisplayServer_constant_FEATURE_SWAP_BUFFERS:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SWAP_BUFFERS** = ``16``

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)**

.. _class_DisplayServer_constant_FEATURE_CLIPBOARD_PRIMARY:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_CLIPBOARD_PRIMARY** = ``18``

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

.. _class_DisplayServer_constant_FEATURE_TEXT_TO_SPEECH:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_TEXT_TO_SPEECH** = ``19``

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

.. _class_DisplayServer_constant_FEATURE_EXTEND_TO_TITLE:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_EXTEND_TO_TITLE** = ``20``

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**

.. _class_DisplayServer_constant_FEATURE_SCREEN_CAPTURE:

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

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_SCREEN_CAPTURE** = ``21``

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

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

----

.. _enum_DisplayServer_MouseMode:

.. rst-class:: classref-enumeration

enum **MouseMode**:

.. _class_DisplayServer_constant_MOUSE_MODE_VISIBLE:

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

:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_VISIBLE** = ``0``

Makes the mouse cursor visible if it is hidden.

.. _class_DisplayServer_constant_MOUSE_MODE_HIDDEN:

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

:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_HIDDEN** = ``1``

Makes the mouse cursor hidden if it is visible.

.. _class_DisplayServer_constant_MOUSE_MODE_CAPTURED:

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

:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CAPTURED** = ``2``

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

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

.. _class_DisplayServer_constant_MOUSE_MODE_CONFINED:

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

:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED** = ``3``

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

.. _class_DisplayServer_constant_MOUSE_MODE_CONFINED_HIDDEN:

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

:ref:`MouseMode<enum_DisplayServer_MouseMode>` **MOUSE_MODE_CONFINED_HIDDEN** = ``4``

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

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

----

.. _enum_DisplayServer_ScreenOrientation:

.. rst-class:: classref-enumeration

enum **ScreenOrientation**:

.. _class_DisplayServer_constant_SCREEN_LANDSCAPE:

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

:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_LANDSCAPE** = ``0``

Default landscape orientation.

.. _class_DisplayServer_constant_SCREEN_PORTRAIT:

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

:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_PORTRAIT** = ``1``

Default portrait orientation.

.. _class_DisplayServer_constant_SCREEN_REVERSE_LANDSCAPE:

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

:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_LANDSCAPE** = ``2``

Reverse landscape orientation (upside down).

.. _class_DisplayServer_constant_SCREEN_REVERSE_PORTRAIT:

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

:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_REVERSE_PORTRAIT** = ``3``

Reverse portrait orientation (upside down).

.. _class_DisplayServer_constant_SCREEN_SENSOR_LANDSCAPE:

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

:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_LANDSCAPE** = ``4``

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

.. _class_DisplayServer_constant_SCREEN_SENSOR_PORTRAIT:

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

:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR_PORTRAIT** = ``5``

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

.. _class_DisplayServer_constant_SCREEN_SENSOR:

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

:ref:`ScreenOrientation<enum_DisplayServer_ScreenOrientation>` **SCREEN_SENSOR** = ``6``

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

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

----

.. _enum_DisplayServer_VirtualKeyboardType:

.. rst-class:: classref-enumeration

enum **VirtualKeyboardType**:

.. _class_DisplayServer_constant_KEYBOARD_TYPE_DEFAULT:

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

:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_DEFAULT** = ``0``

Default text virtual keyboard.

.. _class_DisplayServer_constant_KEYBOARD_TYPE_MULTILINE:

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

:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_MULTILINE** = ``1``

Multiline virtual keyboard.

.. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER:

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

:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER** = ``2``

Virtual number keypad, useful for PIN entry.

.. _class_DisplayServer_constant_KEYBOARD_TYPE_NUMBER_DECIMAL:

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

:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_NUMBER_DECIMAL** = ``3``

Virtual number keypad, useful for entering fractional numbers.

.. _class_DisplayServer_constant_KEYBOARD_TYPE_PHONE:

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

:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PHONE** = ``4``

Virtual phone number keypad.

.. _class_DisplayServer_constant_KEYBOARD_TYPE_EMAIL_ADDRESS:

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

:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_EMAIL_ADDRESS** = ``5``

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

.. _class_DisplayServer_constant_KEYBOARD_TYPE_PASSWORD:

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

:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_PASSWORD** = ``6``

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

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

.. _class_DisplayServer_constant_KEYBOARD_TYPE_URL:

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

:ref:`VirtualKeyboardType<enum_DisplayServer_VirtualKeyboardType>` **KEYBOARD_TYPE_URL** = ``7``

Virtual keyboard with additional keys to assist with typing URLs.

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

----

.. _enum_DisplayServer_CursorShape:

.. rst-class:: classref-enumeration

enum **CursorShape**:

.. _class_DisplayServer_constant_CURSOR_ARROW:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_ARROW** = ``0``

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

.. _class_DisplayServer_constant_CURSOR_IBEAM:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_IBEAM** = ``1``

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

.. _class_DisplayServer_constant_CURSOR_POINTING_HAND:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_POINTING_HAND** = ``2``

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

.. _class_DisplayServer_constant_CURSOR_CROSS:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CROSS** = ``3``

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.

.. _class_DisplayServer_constant_CURSOR_WAIT:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_WAIT** = ``4``

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

.. _class_DisplayServer_constant_CURSOR_BUSY:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BUSY** = ``5``

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

.. _class_DisplayServer_constant_CURSOR_DRAG:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_DRAG** = ``6``

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

.. _class_DisplayServer_constant_CURSOR_CAN_DROP:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_CAN_DROP** = ``7``

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

.. _class_DisplayServer_constant_CURSOR_FORBIDDEN:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FORBIDDEN** = ``8``

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.

.. _class_DisplayServer_constant_CURSOR_VSIZE:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSIZE** = ``9``

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

.. _class_DisplayServer_constant_CURSOR_HSIZE:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSIZE** = ``10``

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

.. _class_DisplayServer_constant_CURSOR_BDIAGSIZE:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_BDIAGSIZE** = ``11``

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.

.. _class_DisplayServer_constant_CURSOR_FDIAGSIZE:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_FDIAGSIZE** = ``12``

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.

.. _class_DisplayServer_constant_CURSOR_MOVE:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MOVE** = ``13``

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

.. _class_DisplayServer_constant_CURSOR_VSPLIT:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_VSPLIT** = ``14``

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

.. _class_DisplayServer_constant_CURSOR_HSPLIT:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HSPLIT** = ``15``

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

.. _class_DisplayServer_constant_CURSOR_HELP:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_HELP** = ``16``

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.

.. _class_DisplayServer_constant_CURSOR_MAX:

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

:ref:`CursorShape<enum_DisplayServer_CursorShape>` **CURSOR_MAX** = ``17``

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

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

----

.. _enum_DisplayServer_FileDialogMode:

.. rst-class:: classref-enumeration

enum **FileDialogMode**:

.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILE:

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

:ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILE** = ``0``

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

.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_FILES:

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

:ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_FILES** = ``1``

The native file dialog allows selecting multiple files.

.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_DIR:

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

:ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_DIR** = ``2``

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

.. _class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_ANY:

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

:ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_OPEN_ANY** = ``3``

The native file dialog allows selecting one file or directory.

.. _class_DisplayServer_constant_FILE_DIALOG_MODE_SAVE_FILE:

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

:ref:`FileDialogMode<enum_DisplayServer_FileDialogMode>` **FILE_DIALOG_MODE_SAVE_FILE** = ``4``

The native file dialog will warn when a file exists.

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

----

.. _enum_DisplayServer_WindowMode:

.. rst-class:: classref-enumeration

enum **WindowMode**:

.. _class_DisplayServer_constant_WINDOW_MODE_WINDOWED:

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

:ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_WINDOWED** = ``0``

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

.. _class_DisplayServer_constant_WINDOW_MODE_MINIMIZED:

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

:ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MINIMIZED** = ``1``

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.

.. _class_DisplayServer_constant_WINDOW_MODE_MAXIMIZED:

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

:ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_MAXIMIZED** = ``2``

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.

.. _class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN:

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

:ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_FULLSCREEN** = ``3``

Full screen mode with full multi-window support.

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

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

.. _class_DisplayServer_constant_WINDOW_MODE_EXCLUSIVE_FULLSCREEN:

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

:ref:`WindowMode<enum_DisplayServer_WindowMode>` **WINDOW_MODE_EXCLUSIVE_FULLSCREEN** = ``4``

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

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

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

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

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

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

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

----

.. _enum_DisplayServer_WindowFlags:

.. rst-class:: classref-enumeration

enum **WindowFlags**:

.. _class_DisplayServer_constant_WINDOW_FLAG_RESIZE_DISABLED:

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

:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_RESIZE_DISABLED** = ``0``

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.

.. _class_DisplayServer_constant_WINDOW_FLAG_BORDERLESS:

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

:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_BORDERLESS** = ``1``

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

.. _class_DisplayServer_constant_WINDOW_FLAG_ALWAYS_ON_TOP:

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

:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_ALWAYS_ON_TOP** = ``2``

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

.. _class_DisplayServer_constant_WINDOW_FLAG_TRANSPARENT:

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

:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_TRANSPARENT** = ``3``

The window background can be transparent.

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

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

.. _class_DisplayServer_constant_WINDOW_FLAG_NO_FOCUS:

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

:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_NO_FOCUS** = ``4``

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

.. _class_DisplayServer_constant_WINDOW_FLAG_POPUP:

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

:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_POPUP** = ``5``

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

.. _class_DisplayServer_constant_WINDOW_FLAG_EXTEND_TO_TITLE:

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

:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_EXTEND_TO_TITLE** = ``6``

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.

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

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.

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

.. _class_DisplayServer_constant_WINDOW_FLAG_MOUSE_PASSTHROUGH:

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

:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MOUSE_PASSTHROUGH** = ``7``

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

.. _class_DisplayServer_constant_WINDOW_FLAG_MAX:

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

:ref:`WindowFlags<enum_DisplayServer_WindowFlags>` **WINDOW_FLAG_MAX** = ``8``

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

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

----

.. _enum_DisplayServer_WindowEvent:

.. rst-class:: classref-enumeration

enum **WindowEvent**:

.. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_ENTER:

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

:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_ENTER** = ``0``

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

.. _class_DisplayServer_constant_WINDOW_EVENT_MOUSE_EXIT:

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

:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_MOUSE_EXIT** = ``1``

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

.. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_IN:

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

:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_IN** = ``2``

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

.. _class_DisplayServer_constant_WINDOW_EVENT_FOCUS_OUT:

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

:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_FOCUS_OUT** = ``3``

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

.. _class_DisplayServer_constant_WINDOW_EVENT_CLOSE_REQUEST:

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

:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_CLOSE_REQUEST** = ``4``

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

.. _class_DisplayServer_constant_WINDOW_EVENT_GO_BACK_REQUEST:

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

:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_GO_BACK_REQUEST** = ``5``

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

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

.. _class_DisplayServer_constant_WINDOW_EVENT_DPI_CHANGE:

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

:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_DPI_CHANGE** = ``6``

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

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

.. _class_DisplayServer_constant_WINDOW_EVENT_TITLEBAR_CHANGE:

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

:ref:`WindowEvent<enum_DisplayServer_WindowEvent>` **WINDOW_EVENT_TITLEBAR_CHANGE** = ``7``

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

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

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

----

.. _enum_DisplayServer_VSyncMode:

.. rst-class:: classref-enumeration

enum **VSyncMode**:

.. _class_DisplayServer_constant_VSYNC_DISABLED:

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

:ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_DISABLED** = ``0``

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

.. _class_DisplayServer_constant_VSYNC_ENABLED:

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

:ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ENABLED** = ``1``

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

.. _class_DisplayServer_constant_VSYNC_ADAPTIVE:

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

:ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_ADAPTIVE** = ``2``

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 (notwithstanding :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.

.. _class_DisplayServer_constant_VSYNC_MAILBOX:

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

:ref:`VSyncMode<enum_DisplayServer_VSyncMode>` **VSYNC_MAILBOX** = ``3``

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

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.

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

----

.. _enum_DisplayServer_HandleType:

.. rst-class:: classref-enumeration

enum **HandleType**:

.. _class_DisplayServer_constant_DISPLAY_HANDLE:

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

:ref:`HandleType<enum_DisplayServer_HandleType>` **DISPLAY_HANDLE** = ``0``

Display handle:

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

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

.. _class_DisplayServer_constant_WINDOW_HANDLE:

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

:ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_HANDLE** = ``1``

Window handle:

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

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

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

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

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

.. _class_DisplayServer_constant_WINDOW_VIEW:

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

:ref:`HandleType<enum_DisplayServer_HandleType>` **WINDOW_VIEW** = ``2``

Window view:

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

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

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

.. _class_DisplayServer_constant_OPENGL_CONTEXT:

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

:ref:`HandleType<enum_DisplayServer_HandleType>` **OPENGL_CONTEXT** = ``3``

OpenGL context (only with the GL Compatibility renderer):

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

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

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

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

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

----

.. _enum_DisplayServer_TTSUtteranceEvent:

.. rst-class:: classref-enumeration

enum **TTSUtteranceEvent**:

.. _class_DisplayServer_constant_TTS_UTTERANCE_STARTED:

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

:ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_STARTED** = ``0``

Utterance has begun to be spoken.

.. _class_DisplayServer_constant_TTS_UTTERANCE_ENDED:

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

:ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_ENDED** = ``1``

Utterance was successfully finished.

.. _class_DisplayServer_constant_TTS_UTTERANCE_CANCELED:

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

:ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_CANCELED** = ``2``

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

.. _class_DisplayServer_constant_TTS_UTTERANCE_BOUNDARY:

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

:ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` **TTS_UTTERANCE_BOUNDARY** = ``3``

Utterance reached a word or sentence boundary.

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

----

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

Constants
---------

.. _class_DisplayServer_constant_SCREEN_WITH_MOUSE_FOCUS:

.. rst-class:: classref-constant

**SCREEN_WITH_MOUSE_FOCUS** = ``-4``

Represents the screen containing the mouse pointer.

.. _class_DisplayServer_constant_SCREEN_WITH_KEYBOARD_FOCUS:

.. rst-class:: classref-constant

**SCREEN_WITH_KEYBOARD_FOCUS** = ``-3``

Represents the screen containing the window with the keyboard focus.

.. _class_DisplayServer_constant_SCREEN_PRIMARY:

.. rst-class:: classref-constant

**SCREEN_PRIMARY** = ``-2``

Represents the primary screen.

.. _class_DisplayServer_constant_SCREEN_OF_MAIN_WINDOW:

.. rst-class:: classref-constant

**SCREEN_OF_MAIN_WINDOW** = ``-1``

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

.. _class_DisplayServer_constant_MAIN_WINDOW_ID:

.. rst-class:: classref-constant

**MAIN_WINDOW_ID** = ``0``

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

.. _class_DisplayServer_constant_INVALID_WINDOW_ID:

.. rst-class:: classref-constant

**INVALID_WINDOW_ID** = ``-1``

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

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

----

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

Method Descriptions
-------------------

.. _class_DisplayServer_method_clipboard_get:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_clipboard_get_image:

.. rst-class:: classref-method

:ref:`Image<class_Image>` **clipboard_get_image** **(** **)** |const|

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

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

----

.. _class_DisplayServer_method_clipboard_get_primary:

.. rst-class:: classref-method

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

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.

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

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

----

.. _class_DisplayServer_method_clipboard_has:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_clipboard_has_image:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **clipboard_has_image** **(** **)** |const|

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

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

----

.. _class_DisplayServer_method_clipboard_set:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_clipboard_set_primary:

.. rst-class:: classref-method

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

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.

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

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

----

.. _class_DisplayServer_method_cursor_get_shape:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_cursor_set_custom_image:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_cursor_set_shape:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_dialog_input_text:

.. rst-class:: classref-method

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

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

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

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

----

.. _class_DisplayServer_method_dialog_show:

.. rst-class:: classref-method

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

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

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

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

----

.. _class_DisplayServer_method_enable_for_stealing_focus:

.. rst-class:: classref-method

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

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.

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

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

----

.. _class_DisplayServer_method_file_dialog_show:

.. rst-class:: classref-method

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

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

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

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

\ **Note:** This method is implemented on Linux, Windows and macOS.

\ **Note:** ``current_directory`` might be ignored.

\ **Note:** On Linux, ``show_hidden`` is ignored.

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

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

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

----

.. _class_DisplayServer_method_force_process_and_drop_events:

.. rst-class:: classref-method

void **force_process_and_drop_events** **(** **)**

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

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

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

----

.. _class_DisplayServer_method_get_accent_color:

.. rst-class:: classref-method

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

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

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

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

----

.. _class_DisplayServer_method_get_display_cutouts:

.. rst-class:: classref-method

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

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

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

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

----

.. _class_DisplayServer_method_get_display_safe_area:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_get_keyboard_focus_screen:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_get_name:

.. rst-class:: classref-method

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

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

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

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

----

.. _class_DisplayServer_method_get_primary_screen:

.. rst-class:: classref-method

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

Returns index of the primary screen.

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

----

.. _class_DisplayServer_method_get_screen_count:

.. rst-class:: classref-method

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

Returns the number of displays available.

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

----

.. _class_DisplayServer_method_get_screen_from_rect:

.. rst-class:: classref-method

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

Returns index of the screen which contains specified rectangle.

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

----

.. _class_DisplayServer_method_get_swap_cancel_ok:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **get_swap_cancel_ok** **(** **)**

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

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

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

----

.. _class_DisplayServer_method_get_window_at_screen_position:

.. rst-class:: classref-method

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

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:

::

    * (0, 0)        +-------+
                    |       |
    +-------------+ |       |
    |             | |       |
    |             | |       |
    +-------------+ +-------+

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

----

.. _class_DisplayServer_method_get_window_list:

.. rst-class:: classref-method

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

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

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

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

----

.. _class_DisplayServer_method_global_menu_add_check_item:

.. rst-class:: classref-method

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

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

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

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

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

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

\ **Supported system menu IDs:**\ 

::

    "_main" - Main menu (macOS).
    "_dock" - Dock popup menu (macOS).

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

----

.. _class_DisplayServer_method_global_menu_add_icon_check_item:

.. rst-class:: classref-method

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

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

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

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

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

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

\ **Supported system menu IDs:**\ 

::

    "_main" - Main menu (macOS).
    "_dock" - Dock popup menu (macOS).

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

----

.. _class_DisplayServer_method_global_menu_add_icon_item:

.. rst-class:: classref-method

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

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

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

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

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

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

\ **Supported system menu IDs:**\ 

::

    "_main" - Main menu (macOS).
    "_dock" - Dock popup menu (macOS).

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

----

.. _class_DisplayServer_method_global_menu_add_icon_radio_check_item:

.. rst-class:: classref-method

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

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

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

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

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

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

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

\ **Supported system menu IDs:**\ 

::

    "_main" - Main menu (macOS).
    "_dock" - Dock popup menu (macOS).

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

----

.. _class_DisplayServer_method_global_menu_add_item:

.. rst-class:: classref-method

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

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

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

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

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

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

\ **Supported system menu IDs:**\ 

::

    "_main" - Main menu (macOS).
    "_dock" - Dock popup menu (macOS).

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

----

.. _class_DisplayServer_method_global_menu_add_multistate_item:

.. rst-class:: classref-method

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

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

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

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

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

\ **Note:** By default, there's no indication of the current item state, it should be changed manually.

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

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

\ **Supported system menu IDs:**\ 

::

    "_main" - Main menu (macOS).
    "_dock" - Dock popup menu (macOS).

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

----

.. _class_DisplayServer_method_global_menu_add_radio_check_item:

.. rst-class:: classref-method

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

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

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

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

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

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

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

\ **Supported system menu IDs:**\ 

::

    "_main" - Main menu (macOS).
    "_dock" - Dock popup menu (macOS).

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

----

.. _class_DisplayServer_method_global_menu_add_separator:

.. rst-class:: classref-method

:ref:`int<class_int>` **global_menu_add_separator** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` index=-1 **)**

Adds a separator between items to the global menu with ID ``menu_root``. Separators also occupy an index.

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

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

\ **Supported system menu IDs:**\ 

::

    "_main" - Main menu (macOS).
    "_dock" - Dock popup menu (macOS).

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

----

.. _class_DisplayServer_method_global_menu_add_submenu_item:

.. rst-class:: classref-method

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

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.

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

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

\ **Supported system menu IDs:**\ 

::

    "_main" - Main menu (macOS).
    "_dock" - Dock popup menu (macOS).

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

----

.. _class_DisplayServer_method_global_menu_clear:

.. rst-class:: classref-method

void **global_menu_clear** **(** :ref:`String<class_String>` menu_root **)**

Removes all items from the global menu with ID ``menu_root``.

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

\ **Supported system menu IDs:**\ 

::

    "_main" - Main menu (macOS).
    "_dock" - Dock popup menu (macOS).

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

----

.. _class_DisplayServer_method_global_menu_get_item_accelerator:

.. rst-class:: classref-method

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

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.

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

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

----

.. _class_DisplayServer_method_global_menu_get_item_callback:

.. rst-class:: classref-method

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

Returns the callback of the item at index ``idx``.

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

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

----

.. _class_DisplayServer_method_global_menu_get_item_count:

.. rst-class:: classref-method

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

Returns number of items in the global menu with ID ``menu_root``.

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

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

----

.. _class_DisplayServer_method_global_menu_get_item_icon:

.. rst-class:: classref-method

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

Returns the icon of the item at index ``idx``.

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

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

----

.. _class_DisplayServer_method_global_menu_get_item_indentation_level:

.. rst-class:: classref-method

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

Returns the horizontal offset of the item at the given ``idx``.

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

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

----

.. _class_DisplayServer_method_global_menu_get_item_index_from_tag:

.. rst-class:: classref-method

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

Returns the index of the item with the specified ``tag``. Index is automatically assigned to each item by the engine. Index can not be set manually.

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

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

----

.. _class_DisplayServer_method_global_menu_get_item_index_from_text:

.. rst-class:: classref-method

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

Returns the index of the item with the specified ``text``. Index is automatically assigned to each item by the engine. Index can not be set manually.

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

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

----

.. _class_DisplayServer_method_global_menu_get_item_key_callback:

.. rst-class:: classref-method

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

Returns the callback of the item accelerator at index ``idx``.

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

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

----

.. _class_DisplayServer_method_global_menu_get_item_max_states:

.. rst-class:: classref-method

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

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.

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

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

----

.. _class_DisplayServer_method_global_menu_get_item_state:

.. rst-class:: classref-method

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

Returns the state of a multistate item. See :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` for details.

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

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

----

.. _class_DisplayServer_method_global_menu_get_item_submenu:

.. rst-class:: classref-method

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

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.

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

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

----

.. _class_DisplayServer_method_global_menu_get_item_tag:

.. rst-class:: classref-method

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

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.

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

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

----

.. _class_DisplayServer_method_global_menu_get_item_text:

.. rst-class:: classref-method

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

Returns the text of the item at index ``idx``.

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

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

----

.. _class_DisplayServer_method_global_menu_get_item_tooltip:

.. rst-class:: classref-method

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

Returns the tooltip associated with the specified index ``idx``.

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

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

----

.. _class_DisplayServer_method_global_menu_is_item_checkable:

.. rst-class:: classref-method

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

Returns ``true`` if the item at index ``idx`` is checkable in some way, i.e. if it has a checkbox or radio button.

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

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

----

.. _class_DisplayServer_method_global_menu_is_item_checked:

.. rst-class:: classref-method

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

Returns ``true`` if the item at index ``idx`` is checked.

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

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

----

.. _class_DisplayServer_method_global_menu_is_item_disabled:

.. rst-class:: classref-method

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

Returns ``true`` if the item at index ``idx`` is disabled. When it is disabled it can't be selected, or its action invoked.

See :ref:`global_menu_set_item_disabled<class_DisplayServer_method_global_menu_set_item_disabled>` for more info on how to disable an item.

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

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

----

.. _class_DisplayServer_method_global_menu_is_item_radio_checkable:

.. rst-class:: classref-method

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

Returns ``true`` if the item at index ``idx`` has radio button-style checkability.

\ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.

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

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

----

.. _class_DisplayServer_method_global_menu_remove_item:

.. rst-class:: classref-method

void **global_menu_remove_item** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx **)**

Removes the item at index ``idx`` from the global menu ``menu_root``.

\ **Note:** The indices of items after the removed item will be shifted by one.

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

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

----

.. _class_DisplayServer_method_global_menu_set_item_accelerator:

.. rst-class:: classref-method

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

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

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

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

----

.. _class_DisplayServer_method_global_menu_set_item_callback:

.. rst-class:: classref-method

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

Sets the callback of the item at index ``idx``. Callback is emitted when an item is pressed.

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

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

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

----

.. _class_DisplayServer_method_global_menu_set_item_checkable:

.. rst-class:: classref-method

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

Sets whether the item at index ``idx`` has a checkbox. If ``false``, sets the type of the item to plain text.

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

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

----

.. _class_DisplayServer_method_global_menu_set_item_checked:

.. rst-class:: classref-method

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

Sets the checkstate status of the item at index ``idx``.

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

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

----

.. _class_DisplayServer_method_global_menu_set_item_disabled:

.. rst-class:: classref-method

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

Enables/disables the item at index ``idx``. When it is disabled, it can't be selected and its action can't be invoked.

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

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

----

.. _class_DisplayServer_method_global_menu_set_item_icon:

.. rst-class:: classref-method

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

Replaces the :ref:`Texture2D<class_Texture2D>` icon of the specified ``idx``.

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

\ **Note:** This method is not supported by macOS "_dock" menu items.

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

----

.. _class_DisplayServer_method_global_menu_set_item_indentation_level:

.. rst-class:: classref-method

void **global_menu_set_item_indentation_level** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` level **)**

Sets the horizontal offset of the item at the given ``idx``.

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

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

----

.. _class_DisplayServer_method_global_menu_set_item_key_callback:

.. rst-class:: classref-method

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

Sets the callback of the item at index ``idx``. Callback is emitted when its accelerator is activated.

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

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

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

----

.. _class_DisplayServer_method_global_menu_set_item_max_states:

.. rst-class:: classref-method

void **global_menu_set_item_max_states** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` max_states **)**

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.

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

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

----

.. _class_DisplayServer_method_global_menu_set_item_radio_checkable:

.. rst-class:: classref-method

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

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.

\ **Note:** This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.

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

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

----

.. _class_DisplayServer_method_global_menu_set_item_state:

.. rst-class:: classref-method

void **global_menu_set_item_state** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`int<class_int>` state **)**

Sets the state of a multistate item. See :ref:`global_menu_add_multistate_item<class_DisplayServer_method_global_menu_add_multistate_item>` for details.

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

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

----

.. _class_DisplayServer_method_global_menu_set_item_submenu:

.. rst-class:: classref-method

void **global_menu_set_item_submenu** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`String<class_String>` submenu **)**

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.

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

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

----

.. _class_DisplayServer_method_global_menu_set_item_tag:

.. rst-class:: classref-method

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

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.

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

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

----

.. _class_DisplayServer_method_global_menu_set_item_text:

.. rst-class:: classref-method

void **global_menu_set_item_text** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`String<class_String>` text **)**

Sets the text of the item at index ``idx``.

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

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

----

.. _class_DisplayServer_method_global_menu_set_item_tooltip:

.. rst-class:: classref-method

void **global_menu_set_item_tooltip** **(** :ref:`String<class_String>` menu_root, :ref:`int<class_int>` idx, :ref:`String<class_String>` tooltip **)**

Sets the :ref:`String<class_String>` tooltip of the item at the specified index ``idx``.

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

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

----

.. _class_DisplayServer_method_has_feature:

.. rst-class:: classref-method

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

Returns ``true`` if the specified ``feature`` is supported by the current **DisplayServer**, ``false`` otherwise.

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

----

.. _class_DisplayServer_method_ime_get_selection:

.. rst-class:: classref-method

:ref:`Vector2i<class_Vector2i>` **ime_get_selection** **(** **)** |const|

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.

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

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

----

.. _class_DisplayServer_method_ime_get_text:

.. rst-class:: classref-method

:ref:`String<class_String>` **ime_get_text** **(** **)** |const|

Returns the composition string contained within the `Input Method Editor <https://en.wikipedia.org/wiki/Input_method>`__ window.

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

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

----

.. _class_DisplayServer_method_is_dark_mode:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_dark_mode** **(** **)** |const|

Returns ``true`` if OS is using dark mode.

\ **Note:** This method is implemented on macOS, Windows and Linux (X11).

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

----

.. _class_DisplayServer_method_is_dark_mode_supported:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_dark_mode_supported** **(** **)** |const|

Returns ``true`` if OS supports dark mode.

\ **Note:** This method is implemented on macOS, Windows and Linux (X11).

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

----

.. _class_DisplayServer_method_is_touchscreen_available:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_touchscreen_available** **(** **)** |const|

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

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

----

.. _class_DisplayServer_method_keyboard_get_current_layout:

.. rst-class:: classref-method

:ref:`int<class_int>` **keyboard_get_current_layout** **(** **)** |const|

Returns active keyboard layout index.

\ **Note:** This method is implemented on Linux (X11), macOS and Windows.

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

----

.. _class_DisplayServer_method_keyboard_get_keycode_from_physical:

.. rst-class:: classref-method

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

Converts a physical (US QWERTY) ``keycode`` to one in the active keyboard layout.

\ **Note:** This method is implemented on Linux (X11), macOS and Windows.

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

----

.. _class_DisplayServer_method_keyboard_get_label_from_physical:

.. rst-class:: classref-method

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

Converts a physical (US QWERTY) ``keycode`` to localized label printed on the key in the active keyboard layout.

\ **Note:** This method is implemented on Linux (X11), macOS and Windows.

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

----

.. _class_DisplayServer_method_keyboard_get_layout_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **keyboard_get_layout_count** **(** **)** |const|

Returns the number of keyboard layouts.

\ **Note:** This method is implemented on Linux (X11), macOS and Windows.

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

----

.. _class_DisplayServer_method_keyboard_get_layout_language:

.. rst-class:: classref-method

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

Returns the ISO-639/BCP-47 language code of the keyboard layout at position ``index``.

\ **Note:** This method is implemented on Linux (X11), macOS and Windows.

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

----

.. _class_DisplayServer_method_keyboard_get_layout_name:

.. rst-class:: classref-method

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

Returns the localized name of the keyboard layout at position ``index``.

\ **Note:** This method is implemented on Linux (X11), macOS and Windows.

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

----

.. _class_DisplayServer_method_keyboard_set_current_layout:

.. rst-class:: classref-method

void **keyboard_set_current_layout** **(** :ref:`int<class_int>` index **)**

Sets the active keyboard layout.

\ **Note:** This method is implemented on Linux (X11), macOS and Windows.

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

----

.. _class_DisplayServer_method_mouse_get_button_state:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_mouse_get_mode:

.. rst-class:: classref-method

:ref:`MouseMode<enum_DisplayServer_MouseMode>` **mouse_get_mode** **(** **)** |const|

Returns the current mouse mode. See also :ref:`mouse_set_mode<class_DisplayServer_method_mouse_set_mode>`.

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

----

.. _class_DisplayServer_method_mouse_get_position:

.. rst-class:: classref-method

:ref:`Vector2i<class_Vector2i>` **mouse_get_position** **(** **)** |const|

Returns the mouse cursor's current position in screen coordinates.

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

----

.. _class_DisplayServer_method_mouse_set_mode:

.. rst-class:: classref-method

void **mouse_set_mode** **(** :ref:`MouseMode<enum_DisplayServer_MouseMode>` mouse_mode **)**

Sets the current mouse mode. See also :ref:`mouse_get_mode<class_DisplayServer_method_mouse_get_mode>`.

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

----

.. _class_DisplayServer_method_process_events:

.. rst-class:: classref-method

void **process_events** **(** **)**

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

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

----

.. _class_DisplayServer_method_screen_get_dpi:

.. rst-class:: classref-method

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

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.

\ **Note:** On macOS, returned value is inaccurate if fractional display scaling mode is used.

\ **Note:** On Android devices, the actual screen densities are grouped into six generalized densities:

::

       ldpi - 120 dpi
       mdpi - 160 dpi
       hdpi - 240 dpi
      xhdpi - 320 dpi
     xxhdpi - 480 dpi
    xxxhdpi - 640 dpi

\ **Note:** This method is implemented on Android, Linux (X11), macOS and Windows. Returns ``72`` on unsupported platforms.

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

----

.. _class_DisplayServer_method_screen_get_image:

.. rst-class:: classref-method

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

Returns screenshot of the ``screen``.

\ **Note:** This method is implemented on Linux (X11), macOS, and Windows.

\ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.

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

----

.. _class_DisplayServer_method_screen_get_max_scale:

.. rst-class:: classref-method

:ref:`float<class_float>` **screen_get_max_scale** **(** **)** |const|

Returns the greatest scale factor of all screens.

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

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

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

----

.. _class_DisplayServer_method_screen_get_orientation:

.. rst-class:: classref-method

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

Returns the ``screen``'s current orientation. See also :ref:`screen_set_orientation<class_DisplayServer_method_screen_set_orientation>`.

\ **Note:** This method is implemented on Android and iOS.

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

----

.. _class_DisplayServer_method_screen_get_pixel:

.. rst-class:: classref-method

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

Returns color of the display pixel at the ``position``.

\ **Note:** This method is implemented on Linux (X11), macOS, and Windows.

\ **Note:** On macOS, this method requires "Screen Recording" permission, if permission is not granted it will return desktop wallpaper color.

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

----

.. _class_DisplayServer_method_screen_get_position:

.. rst-class:: classref-method

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

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:

::

    * (0, 0)        +-------+
                    |       |
    +-------------+ |       |
    |             | |       |
    |             | |       |
    +-------------+ +-------+

See also :ref:`screen_get_size<class_DisplayServer_method_screen_get_size>`.

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

----

.. _class_DisplayServer_method_screen_get_refresh_rate:

.. rst-class:: classref-method

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

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.

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

To fallback to a default refresh rate if the method fails, try:

::

    var refresh_rate = DisplayServer.screen_get_refresh_rate()
    if refresh_rate < 0:
        refresh_rate = 60.0

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

----

.. _class_DisplayServer_method_screen_get_scale:

.. rst-class:: classref-method

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

Returns the scale factor of the specified screen by index.

\ **Note:** On macOS returned value is ``2.0`` for hiDPI (Retina) screen, and ``1.0`` for all other cases.

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

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

----

.. _class_DisplayServer_method_screen_get_size:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_screen_get_usable_rect:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_screen_is_kept_on:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **screen_is_kept_on** **(** **)** |const|

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

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

----

.. _class_DisplayServer_method_screen_set_keep_on:

.. rst-class:: classref-method

void **screen_set_keep_on** **(** :ref:`bool<class_bool>` enable **)**

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

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

----

.. _class_DisplayServer_method_screen_set_orientation:

.. rst-class:: classref-method

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

Sets the ``screen``'s ``orientation``. See also :ref:`screen_get_orientation<class_DisplayServer_method_screen_get_orientation>`.

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

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

----

.. _class_DisplayServer_method_set_icon:

.. rst-class:: classref-method

void **set_icon** **(** :ref:`Image<class_Image>` image **)**

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.

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

----

.. _class_DisplayServer_method_set_native_icon:

.. rst-class:: classref-method

void **set_native_icon** **(** :ref:`String<class_String>` filename **)**

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.

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

----

.. _class_DisplayServer_method_tablet_get_current_driver:

.. rst-class:: classref-method

:ref:`String<class_String>` **tablet_get_current_driver** **(** **)** |const|

Returns current active tablet driver name.

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

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

----

.. _class_DisplayServer_method_tablet_get_driver_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **tablet_get_driver_count** **(** **)** |const|

Returns the total number of available tablet drivers.

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

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

----

.. _class_DisplayServer_method_tablet_get_driver_name:

.. rst-class:: classref-method

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

Returns the tablet driver name for the given index.

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

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

----

.. _class_DisplayServer_method_tablet_set_current_driver:

.. rst-class:: classref-method

void **tablet_set_current_driver** **(** :ref:`String<class_String>` name **)**

Set active tablet driver name.

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

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

----

.. _class_DisplayServer_method_tts_get_voices:

.. rst-class:: classref-method

:ref:`Dictionary[]<class_Dictionary>` **tts_get_voices** **(** **)** |const|

Returns an :ref:`Array<class_Array>` of voice information dictionaries.

Each :ref:`Dictionary<class_Dictionary>` contains two :ref:`String<class_String>` entries:

- ``name`` is voice name.

- ``id`` is voice identifier.

- ``language`` is language code in ``lang_Variant`` format. ``lang`` part is a 2 or 3-letter code based on the ISO-639 standard, in lowercase. And ``Variant`` part is an engine dependent string describing country, region or/and dialect.

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.

\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.

\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.

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

----

.. _class_DisplayServer_method_tts_get_voices_for_language:

.. rst-class:: classref-method

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

Returns an :ref:`PackedStringArray<class_PackedStringArray>` of voice identifiers for the ``language``.

\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.

\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.

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

----

.. _class_DisplayServer_method_tts_is_paused:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **tts_is_paused** **(** **)** |const|

Returns ``true`` if the synthesizer is in a paused state.

\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.

\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.

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

----

.. _class_DisplayServer_method_tts_is_speaking:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **tts_is_speaking** **(** **)** |const|

Returns ``true`` if the synthesizer is generating speech, or have utterance waiting in the queue.

\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.

\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.

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

----

.. _class_DisplayServer_method_tts_pause:

.. rst-class:: classref-method

void **tts_pause** **(** **)**

Puts the synthesizer into a paused state.

\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.

\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.

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

----

.. _class_DisplayServer_method_tts_resume:

.. rst-class:: classref-method

void **tts_resume** **(** **)**

Resumes the synthesizer if it was paused.

\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.

\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.

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

----

.. _class_DisplayServer_method_tts_set_utterance_callback:

.. rst-class:: classref-method

void **tts_set_utterance_callback** **(** :ref:`TTSUtteranceEvent<enum_DisplayServer_TTSUtteranceEvent>` event, :ref:`Callable<class_Callable>` callable **)**

Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary.

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

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

\ **Note:** The granularity of the boundary callbacks is engine dependent.

\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.

\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.

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

----

.. _class_DisplayServer_method_tts_speak:

.. rst-class:: classref-method

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

Adds an utterance to the queue. If ``interrupt`` is ``true``, the queue is cleared first.

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

- ``volume`` ranges from ``0`` (lowest) to ``100`` (highest).

- ``pitch`` ranges from ``0.0`` (lowest) to ``2.0`` (highest), ``1.0`` is default pitch for the current voice.

- ``rate`` ranges from ``0.1`` (lowest) to ``10.0`` (highest), ``1.0`` is a normal speaking rate. Other values act as a percentage relative.

- ``utterance_id`` is passed as a parameter to the callback functions.

\ **Note:** On Windows and Linux (X11), utterance ``text`` can use SSML markup. SSML support is engine and voice dependent. If the engine does not support SSML, you should strip out all XML markup before calling :ref:`tts_speak<class_DisplayServer_method_tts_speak>`.

\ **Note:** The granularity of pitch, rate, and volume is engine and voice dependent. Values may be truncated.

\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.

\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.

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

----

.. _class_DisplayServer_method_tts_stop:

.. rst-class:: classref-method

void **tts_stop** **(** **)**

Stops synthesis in progress and removes all utterances from the queue.

\ **Note:** This method is implemented on Android, iOS, Web, Linux (X11), macOS, and Windows.

\ **Note:** :ref:`ProjectSettings.audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` should be ``true`` to use text-to-speech.

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

----

.. _class_DisplayServer_method_virtual_keyboard_get_height:

.. rst-class:: classref-method

:ref:`int<class_int>` **virtual_keyboard_get_height** **(** **)** |const|

Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.

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

----

.. _class_DisplayServer_method_virtual_keyboard_hide:

.. rst-class:: classref-method

void **virtual_keyboard_hide** **(** **)**

Hides the virtual keyboard if it is shown, does nothing otherwise.

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

----

.. _class_DisplayServer_method_virtual_keyboard_show:

.. rst-class:: classref-method

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

Shows the virtual keyboard if the platform has one.

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

\ ``position`` parameter is the screen space :ref:`Rect2<class_Rect2>` of the edited text.

\ ``type`` parameter allows configuring which type of virtual keyboard to show.

\ ``max_length`` limits the number of characters that can be entered if different from ``-1``.

\ ``cursor_start`` can optionally define the current text cursor position if ``cursor_end`` is not set.

\ ``cursor_start`` and ``cursor_end`` can optionally define the current text selection.

\ **Note:** This method is implemented on Android, iOS and Web.

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

----

.. _class_DisplayServer_method_warp_mouse:

.. rst-class:: classref-method

void **warp_mouse** **(** :ref:`Vector2i<class_Vector2i>` position **)**

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.

\ **Note:** :ref:`warp_mouse<class_DisplayServer_method_warp_mouse>` is only supported on Windows, macOS and Linux. It has no effect on Android, iOS and Web.

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

----

.. _class_DisplayServer_method_window_can_draw:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_window_get_active_popup:

.. rst-class:: classref-method

:ref:`int<class_int>` **window_get_active_popup** **(** **)** |const|

Returns ID of the active popup window, or :ref:`INVALID_WINDOW_ID<class_DisplayServer_constant_INVALID_WINDOW_ID>` if there is none.

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

----

.. _class_DisplayServer_method_window_get_attached_instance_id:

.. rst-class:: classref-method

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

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.

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

----

.. _class_DisplayServer_method_window_get_current_screen:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_window_get_flag:

.. rst-class:: classref-method

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

Returns the current value of the given window's ``flag``.

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

----

.. _class_DisplayServer_method_window_get_max_size:

.. rst-class:: classref-method

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

Returns the window's maximum size (in pixels). See also :ref:`window_set_max_size<class_DisplayServer_method_window_set_max_size>`.

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

----

.. _class_DisplayServer_method_window_get_min_size:

.. rst-class:: classref-method

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

Returns the window's minimum size (in pixels). See also :ref:`window_set_min_size<class_DisplayServer_method_window_set_min_size>`.

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

----

.. _class_DisplayServer_method_window_get_mode:

.. rst-class:: classref-method

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

Returns the mode of the given window.

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

----

.. _class_DisplayServer_method_window_get_native_handle:

.. rst-class:: classref-method

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

Returns internal structure pointers for use in plugins.

\ **Note:** This method is implemented on Android, Linux (X11), macOS and Windows.

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

----

.. _class_DisplayServer_method_window_get_popup_safe_rect:

.. rst-class:: classref-method

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

Returns the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system.

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

----

.. _class_DisplayServer_method_window_get_position:

.. rst-class:: classref-method

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

Returns the position of the client area of the given window on the screen.

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

----

.. _class_DisplayServer_method_window_get_position_with_decorations:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_window_get_safe_title_margins:

.. rst-class:: classref-method

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

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.

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

----

.. _class_DisplayServer_method_window_get_size:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_window_get_size_with_decorations:

.. rst-class:: classref-method

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

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

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

----

.. _class_DisplayServer_method_window_get_vsync_mode:

.. rst-class:: classref-method

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

Returns the V-Sync mode of the given window.

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

----

.. _class_DisplayServer_method_window_is_focused:

.. rst-class:: classref-method

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

Returns ``true`` if the window specified by ``window_id`` is focused.

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

----

.. _class_DisplayServer_method_window_is_maximize_allowed:

.. rst-class:: classref-method

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

Returns ``true`` if the given window can be maximized (the maximize button is enabled).

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

----

.. _class_DisplayServer_method_window_maximize_on_title_dbl_click:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **window_maximize_on_title_dbl_click** **(** **)** |const|

Returns ``true``, if double-click on a window title should maximize it.

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

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

----

.. _class_DisplayServer_method_window_minimize_on_title_dbl_click:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **window_minimize_on_title_dbl_click** **(** **)** |const|

Returns ``true``, if double-click on a window title should minimize it.

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

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

----

.. _class_DisplayServer_method_window_move_to_foreground:

.. rst-class:: classref-method

void **window_move_to_foreground** **(** :ref:`int<class_int>` window_id=0 **)**

Moves the window specified by ``window_id`` to the foreground, so that it is visible over other windows.

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

----

.. _class_DisplayServer_method_window_request_attention:

.. rst-class:: classref-method

void **window_request_attention** **(** :ref:`int<class_int>` window_id=0 **)**

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.

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

----

.. _class_DisplayServer_method_window_set_current_screen:

.. rst-class:: classref-method

void **window_set_current_screen** **(** :ref:`int<class_int>` screen, :ref:`int<class_int>` window_id=0 **)**

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

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

----

.. _class_DisplayServer_method_window_set_drop_files_callback:

.. rst-class:: classref-method

void **window_set_drop_files_callback** **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**

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

\ **Note:** This method is implemented on Windows, macOS, Linux (X11) and Web.

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

----

.. _class_DisplayServer_method_window_set_exclusive:

.. rst-class:: classref-method

void **window_set_exclusive** **(** :ref:`int<class_int>` window_id, :ref:`bool<class_bool>` exclusive **)**

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.

\ **Note:** On macOS, exclusive windows are confined to the same space (virtual desktop or screen) as the parent window.

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

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

----

.. _class_DisplayServer_method_window_set_flag:

.. rst-class:: classref-method

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

Enables or disables the given window's given ``flag``. See :ref:`WindowFlags<enum_DisplayServer_WindowFlags>` for possible values and their behavior.

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

----

.. _class_DisplayServer_method_window_set_ime_active:

.. rst-class:: classref-method

void **window_set_ime_active** **(** :ref:`bool<class_bool>` active, :ref:`int<class_int>` window_id=0 **)**

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

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

----

.. _class_DisplayServer_method_window_set_ime_position:

.. rst-class:: classref-method

void **window_set_ime_position** **(** :ref:`Vector2i<class_Vector2i>` position, :ref:`int<class_int>` window_id=0 **)**

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

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

----

.. _class_DisplayServer_method_window_set_input_event_callback:

.. rst-class:: classref-method

void **window_set_input_event_callback** **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**

Sets the ``callback`` that should be called when any :ref:`InputEvent<class_InputEvent>` is sent to the window specified by ``window_id``.

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

----

.. _class_DisplayServer_method_window_set_input_text_callback:

.. rst-class:: classref-method

void **window_set_input_text_callback** **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**

Sets the ``callback`` that should be called when text is entered using the virtual keyboard to the window specified by ``window_id``.

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

----

.. _class_DisplayServer_method_window_set_max_size:

.. rst-class:: classref-method

void **window_set_max_size** **(** :ref:`Vector2i<class_Vector2i>` max_size, :ref:`int<class_int>` window_id=0 **)**

Sets the maximum size of the window specified by ``window_id`` in pixels. Normally, the user will not be able to drag the window to make it smaller than the specified size. See also :ref:`window_get_max_size<class_DisplayServer_method_window_get_max_size>`.

\ **Note:** It's recommended to change this value using :ref:`Window.max_size<class_Window_property_max_size>` instead.

\ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.

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

----

.. _class_DisplayServer_method_window_set_min_size:

.. rst-class:: classref-method

void **window_set_min_size** **(** :ref:`Vector2i<class_Vector2i>` min_size, :ref:`int<class_int>` window_id=0 **)**

Sets the minimum size for the given window to ``min_size`` (in pixels). Normally, the user will not be able to drag the window to make it larger than the specified size. See also :ref:`window_get_min_size<class_DisplayServer_method_window_get_min_size>`.

\ **Note:** It's recommended to change this value using :ref:`Window.min_size<class_Window_property_min_size>` instead.

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

\ **Note:** Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.

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

----

.. _class_DisplayServer_method_window_set_mode:

.. rst-class:: classref-method

void **window_set_mode** **(** :ref:`WindowMode<enum_DisplayServer_WindowMode>` mode, :ref:`int<class_int>` window_id=0 **)**

Sets window mode for the given window to ``mode``. See :ref:`WindowMode<enum_DisplayServer_WindowMode>` for possible values and how each mode behaves.

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

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

----

.. _class_DisplayServer_method_window_set_mouse_passthrough:

.. rst-class:: classref-method

void **window_set_mouse_passthrough** **(** :ref:`PackedVector2Array<class_PackedVector2Array>` region, :ref:`int<class_int>` window_id=0 **)**

Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through.

Passing an empty array will disable passthrough support (all mouse events will be intercepted by the window, which is the default behavior).


.. tabs::

 .. code-tab:: gdscript

    # Set region, using Path2D node.
    DisplayServer.window_set_mouse_passthrough($Path2D.curve.get_baked_points())
    
    # Set region, using Polygon2D node.
    DisplayServer.window_set_mouse_passthrough($Polygon2D.polygon)
    
    # Reset region to default.
    DisplayServer.window_set_mouse_passthrough([])

 .. code-tab:: csharp

    // Set region, using Path2D node.
    DisplayServer.WindowSetMousePassthrough(GetNode<Path2D>("Path2D").Curve.GetBakedPoints());
    
    // Set region, using Polygon2D node.
    DisplayServer.WindowSetMousePassthrough(GetNode<Polygon2D>("Polygon2D").Polygon);
    
    // Reset region to default.
    DisplayServer.WindowSetMousePassthrough(new Vector2[] {});



\ **Note:** On Windows, the portion of a window that lies outside the region is not drawn, while on Linux (X11) and macOS it is.

\ **Note:** This method is implemented on Linux (X11), macOS and Windows.

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

----

.. _class_DisplayServer_method_window_set_popup_safe_rect:

.. rst-class:: classref-method

void **window_set_popup_safe_rect** **(** :ref:`int<class_int>` window, :ref:`Rect2i<class_Rect2i>` rect **)**

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.

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

----

.. _class_DisplayServer_method_window_set_position:

.. rst-class:: classref-method

void **window_set_position** **(** :ref:`Vector2i<class_Vector2i>` position, :ref:`int<class_int>` window_id=0 **)**

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:

::

    * (0, 0)        +-------+
                    |       |
    +-------------+ |       |
    |             | |       |
    |             | |       |
    +-------------+ +-------+

See also :ref:`window_get_position<class_DisplayServer_method_window_get_position>` and :ref:`window_set_size<class_DisplayServer_method_window_set_size>`.

\ **Note:** It's recommended to change this value using :ref:`Window.position<class_Window_property_position>` instead.

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

----

.. _class_DisplayServer_method_window_set_rect_changed_callback:

.. rst-class:: classref-method

void **window_set_rect_changed_callback** **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**

Sets the ``callback`` that will be called when the window specified by ``window_id`` is moved or resized.

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

----

.. _class_DisplayServer_method_window_set_size:

.. rst-class:: classref-method

void **window_set_size** **(** :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` window_id=0 **)**

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

\ **Note:** It's recommended to change this value using :ref:`Window.size<class_Window_property_size>` instead.

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

----

.. _class_DisplayServer_method_window_set_title:

.. rst-class:: classref-method

void **window_set_title** **(** :ref:`String<class_String>` title, :ref:`int<class_int>` window_id=0 **)**

Sets the title of the given window to ``title``.

\ **Note:** It's recommended to change this value using :ref:`Window.title<class_Window_property_title>` instead.

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

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

----

.. _class_DisplayServer_method_window_set_transient:

.. rst-class:: classref-method

void **window_set_transient** **(** :ref:`int<class_int>` window_id, :ref:`int<class_int>` parent_window_id **)**

Sets window transient parent. Transient window is will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can't enter full-screen mode.

\ **Note:** It's recommended to change this value using :ref:`Window.transient<class_Window_property_transient>` instead.

\ **Note:** The behavior might be different depending on the platform.

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

----

.. _class_DisplayServer_method_window_set_vsync_mode:

.. rst-class:: classref-method

void **window_set_vsync_mode** **(** :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` vsync_mode, :ref:`int<class_int>` window_id=0 **)**

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

See :ref:`VSyncMode<enum_DisplayServer_VSyncMode>` for possible values and how they affect the behavior of your application.

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.

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

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

----

.. _class_DisplayServer_method_window_set_window_buttons_offset:

.. rst-class:: classref-method

void **window_set_window_buttons_offset** **(** :ref:`Vector2i<class_Vector2i>` offset, :ref:`int<class_int>` window_id=0 **)**

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.

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

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

----

.. _class_DisplayServer_method_window_set_window_event_callback:

.. rst-class:: classref-method

void **window_set_window_event_callback** **(** :ref:`Callable<class_Callable>` callback, :ref:`int<class_int>` window_id=0 **)**

Sets the ``callback`` that will be called when an event occurs in the window specified by ``window_id``.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`