Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

DisplayServer

Inherits: Object

Singleton for window management functions.

Description

DisplayServer handles everything related to window management. This is separated from OS as a single operating system may support multiple display servers.

Headless mode: Starting the engine with the --headless command line argument disables all rendering and window management functions. Most functions from DisplayServer will return dummy values in this case.

Methods

String	clipboard_get ( ) const
String	clipboard_get_primary ( ) const
bool	clipboard_has ( ) const
void	clipboard_set ( String clipboard )
void	clipboard_set_primary ( String clipboard_primary )
CursorShape	cursor_get_shape ( ) const
void	cursor_set_custom_image ( Resource cursor, CursorShape shape=0, Vector2 hotspot=Vector2(0, 0) )
void	cursor_set_shape ( CursorShape shape )
Error	dialog_input_text ( String title, String description, String existing_text, Callable callback )
Error	dialog_show ( String title, String description, PackedStringArray buttons, Callable callback )
void	enable_for_stealing_focus ( int process_id )
void	force_process_and_drop_events ( )
Color	get_accent_color ( ) const
Rect2[]	get_display_cutouts ( ) const
Rect2i	get_display_safe_area ( ) const
int	get_keyboard_focus_screen ( ) const
String	get_name ( ) const
int	get_primary_screen ( ) const
int	get_screen_count ( ) const
int	get_screen_from_rect ( Rect2 rect ) const
bool	get_swap_cancel_ok ( )
int	get_window_at_screen_position ( Vector2i position ) const
PackedInt32Array	get_window_list ( ) const
int	global_menu_add_check_item ( String menu_root, String label, Callable callback, Callable key_callback, Variant tag=null, Key accelerator=0, int index=-1 )
int	global_menu_add_icon_check_item ( String menu_root, Texture2D icon, String label, Callable callback, Callable key_callback, Variant tag=null, Key accelerator=0, int index=-1 )
int	global_menu_add_icon_item ( String menu_root, Texture2D icon, String label, Callable callback, Callable key_callback, Variant tag=null, Key accelerator=0, int index=-1 )
int	global_menu_add_icon_radio_check_item ( String menu_root, Texture2D icon, String label, Callable callback, Callable key_callback, Variant tag=null, Key accelerator=0, int index=-1 )
int	global_menu_add_item ( String menu_root, String label, Callable callback, Callable key_callback, Variant tag=null, Key accelerator=0, int index=-1 )
int	global_menu_add_multistate_item ( String menu_root, String label, int max_states, int default_state, Callable callback, Callable key_callback, Variant tag=null, Key accelerator=0, int index=-1 )
int	global_menu_add_radio_check_item ( String menu_root, String label, Callable callback, Callable key_callback, Variant tag=null, Key accelerator=0, int index=-1 )
int	global_menu_add_separator ( String menu_root, int index=-1 )
int	global_menu_add_submenu_item ( String menu_root, String label, String submenu, int index=-1 )
void	global_menu_clear ( String menu_root )
Key	global_menu_get_item_accelerator ( String menu_root, int idx ) const
Callable	global_menu_get_item_callback ( String menu_root, int idx ) const
int	global_menu_get_item_count ( String menu_root ) const
Texture2D	global_menu_get_item_icon ( String menu_root, int idx ) const
int	global_menu_get_item_indentation_level ( String menu_root, int idx ) const
int	global_menu_get_item_index_from_tag ( String menu_root, Variant tag ) const
int	global_menu_get_item_index_from_text ( String menu_root, String text ) const
Callable	global_menu_get_item_key_callback ( String menu_root, int idx ) const
int	global_menu_get_item_max_states ( String menu_root, int idx ) const
int	global_menu_get_item_state ( String menu_root, int idx ) const
String	global_menu_get_item_submenu ( String menu_root, int idx ) const
Variant	global_menu_get_item_tag ( String menu_root, int idx ) const
String	global_menu_get_item_text ( String menu_root, int idx ) const
String	global_menu_get_item_tooltip ( String menu_root, int idx ) const
bool	global_menu_is_item_checkable ( String menu_root, int idx ) const
bool	global_menu_is_item_checked ( String menu_root, int idx ) const
bool	global_menu_is_item_disabled ( String menu_root, int idx ) const
bool	global_menu_is_item_radio_checkable ( String menu_root, int idx ) const
void	global_menu_remove_item ( String menu_root, int idx )
void	global_menu_set_item_accelerator ( String menu_root, int idx, Key keycode )
void	global_menu_set_item_callback ( String menu_root, int idx, Callable callback )
void	global_menu_set_item_checkable ( String menu_root, int idx, bool checkable )
void	global_menu_set_item_checked ( String menu_root, int idx, bool checked )
void	global_menu_set_item_disabled ( String menu_root, int idx, bool disabled )
void	global_menu_set_item_icon ( String menu_root, int idx, Texture2D icon )
void	global_menu_set_item_indentation_level ( String menu_root, int idx, int level )
void	global_menu_set_item_key_callback ( String menu_root, int idx, Callable key_callback )
void	global_menu_set_item_max_states ( String menu_root, int idx, int max_states )
void	global_menu_set_item_radio_checkable ( String menu_root, int idx, bool checkable )
void	global_menu_set_item_state ( String menu_root, int idx, int state )
void	global_menu_set_item_submenu ( String menu_root, int idx, String submenu )
void	global_menu_set_item_tag ( String menu_root, int idx, Variant tag )
void