DisplayServer

Inherits: Object

There is currently no description for this class. Please help us by contributing one!

Methods

String

clipboard_get ( ) const

Image

clipboard_get_image ( ) const

String

clipboard_get_primary ( ) const

bool

clipboard_has ( ) const

bool

clipboard_has_image ( ) const

void

clipboard_set ( String clipboard )

void

clipboard_set_primary ( String clipboard_primary )

int

create_status_indicator ( Texture2D icon, String tooltip, Callable callback )

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 )

void

delete_status_indicator ( int id )

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 )

Error

file_dialog_show ( String title, String current_directory, String filename, bool show_hidden, FileDialogMode mode, PackedStringArray filters, Callable callback )

Error

file_dialog_with_options_show ( String title, String current_directory, String root, String filename, bool show_hidden, FileDialogMode mode, PackedStringArray filters, Dictionary[] options, Callable callback )

void

force_process_and_drop_events ( )

Color

get_accent_color ( ) const

Color

get_base_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(), Callable key_callback=Callable(), 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(), Callable key_callback=Callable(), 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(), Callable key_callback=Callable(), 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(), Callable key_callback=Callable(), Variant tag=null, Key accelerator=0, int index=-1 )

int

global_menu_add_item ( String menu_root, String label, Callable callback=Callable(), Callable key_callback=Callable(), 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(), Callable key_callback=Callable(), Variant tag=null, Key accelerator=0, int index=-1 )

int

global_menu_add_radio_check_item ( String menu_root, String label, Callable callback=Callable(), Callable key_callback=Callable(), 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

Dictionary

global_menu_get_system_menu_roots ( ) 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_hidden ( 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_hidden ( String menu_root, int idx, bool hidden )

void

global_menu_set_item_hover_callbacks ( String menu_root, int idx, Callable callback )

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

global_menu_set_item_text ( String menu_root, int idx, String text )

void

global_menu_set_item_tooltip ( String menu_root, int idx, String tooltip )

void

global_menu_set_popup_callbacks ( String menu_root, Callable open_callback, Callable close_callback )

bool

has_additional_outputs ( ) const

bool

has_feature ( Feature feature ) const

void

help_set_search_callbacks ( Callable search_callback, Callable action_callback )

Vector2i

ime_get_selection ( ) const

String

ime_get_text ( ) const

bool

is_dark_mode ( ) const

bool

is_dark_mode_supported ( ) const

bool

is_touchscreen_available ( ) const

bool

is_window_transparency_available ( ) const

int

keyboard_get_current_layout ( ) const

Key

keyboard_get_keycode_from_physical ( Key keycode ) const

Key

keyboard_get_label_from_physical ( Key keycode ) const

int

keyboard_get_layout_count ( ) const

String

keyboard_get_layout_language ( int index ) const

String

keyboard_get_layout_name ( int index ) const

void

keyboard_set_current_layout ( int index )

BitField<MouseButtonMask>

mouse_get_button_state ( ) const

MouseMode

mouse_get_mode ( ) const

Vector2i

mouse_get_position ( ) const

void

mouse_set_mode ( MouseMode mouse_mode )

void

process_events ( )

void

register_additional_output ( Object object )

int

screen_get_dpi ( int screen=-1 ) const

Image

screen_get_image ( int screen=-1 ) const

float

screen_get_max_scale ( ) const

ScreenOrientation

screen_get_orientation ( int screen=-1 ) const

Color

screen_get_pixel ( Vector2i position ) const

Vector2i

screen_get_position ( int screen=-1 ) const

float

screen_get_refresh_rate ( int screen=-1 ) const

float

screen_get_scale ( int screen=-1 ) const

Vector2i

screen_get_size ( int screen=-1 ) const

Rect2i

screen_get_usable_rect ( int screen=-1 ) const

bool

screen_is_kept_on ( ) const

void

screen_set_keep_on ( bool enable )

void

screen_set_orientation ( ScreenOrientation orientation, int screen=-1 )

void

set_icon ( Image image )

void

set_native_icon ( String filename )

void

set_system_theme_change_callback ( Callable callable )

Rect2

status_indicator_get_rect ( int id ) const

void

status_indicator_set_callback ( int id, Callable callback )

void

status_indicator_set_icon ( int id, Texture2D icon )

void

status_indicator_set_menu ( int id, RID menu_rid )

void

status_indicator_set_tooltip ( int id, String tooltip )

String

tablet_get_current_driver ( ) const

int

tablet_get_driver_count ( ) const

String

tablet_get_driver_name ( int idx ) const

void

tablet_set_current_driver ( String name )

Dictionary[]

tts_get_voices ( ) const

PackedStringArray

tts_get_voices_for_language ( String language ) const

bool

tts_is_paused ( ) const

bool

tts_is_speaking ( ) const

void

tts_pause ( )

void

tts_resume ( )

void

tts_set_utterance_callback ( TTSUtteranceEvent event, Callable callable )

void

tts_speak ( String text, String voice, int volume=50, float pitch=1.0, float rate=1.0, int utterance_id=0, bool interrupt=false )

void

tts_stop ( )

void

unregister_additional_output ( Object object )

int

virtual_keyboard_get_height ( ) const

void

virtual_keyboard_hide ( )

void

virtual_keyboard_show ( String existing_text, Rect2 position=Rect2(0, 0, 0, 0), VirtualKeyboardType type=0, int max_length=-1, int cursor_start=-1, int cursor_end=-1 )

void

warp_mouse ( Vector2i position )

bool

window_can_draw ( int window_id=0 ) const

int

window_get_active_popup ( ) const

int

window_get_attached_instance_id ( int window_id=0 ) const

int

window_get_current_screen ( int window_id=0 ) const

bool

window_get_flag ( WindowFlags flag, int window_id=0 ) const

Vector2i

window_get_max_size ( int window_id=0 ) const

Vector2i

window_get_min_size ( int window_id=0 ) const

WindowMode

window_get_mode ( int window_id=0 ) const

int

window_get_native_handle ( HandleType handle_type, int window_id=0 ) const

Rect2i

window_get_popup_safe_rect ( int window ) const

Vector2i

window_get_position ( int window_id=0 ) const

Vector2i

window_get_position_with_decorations ( int window_id=0 ) const

Vector3i

window_get_safe_title_margins ( int window_id=0 ) const

Vector2i

window_get_size ( int window_id=0 ) const

Vector2i

window_get_size_with_decorations ( int window_id=0 ) const

Vector2i

window_get_title_size ( String title, int window_id=0 ) const

VSyncMode

window_get_vsync_mode ( int window_id=0 ) const

bool

window_is_focused ( int window_id=0 ) const

bool

window_is_maximize_allowed ( int window_id=0 ) const

bool

window_maximize_on_title_dbl_click ( ) const

bool

window_minimize_on_title_dbl_click ( ) const

void

window_move_to_foreground ( int window_id=0 )

void

window_request_attention ( int window_id=0 )

void

window_set_current_screen ( int screen, int window_id=0 )

void

window_set_drop_files_callback ( Callable callback, int window_id=0 )

void

window_set_exclusive ( int window_id, bool exclusive )

void

window_set_flag ( WindowFlags flag, bool enabled, int window_id=0 )

void

window_set_ime_active ( bool active, int window_id=0 )

void

window_set_ime_position ( Vector2i position, int window_id=0 )

void

window_set_input_event_callback ( Callable callback, int window_id=0 )

void

window_set_input_text_callback ( Callable callback, int window_id=0 )

void

window_set_max_size ( Vector2i max_size, int window_id=0 )

void

window_set_min_size ( Vector2i min_size, int window_id=0 )

void

window_set_mode ( WindowMode mode, int window_id=0 )

void

window_set_mouse_passthrough ( PackedVector2Array region, int window_id=0 )

void

window_set_popup_safe_rect ( int window, Rect2i rect )

void

window_set_position ( Vector2i position, int window_id=0 )

void

window_set_rect_changed_callback ( Callable callback, int window_id=0 )

void

window_set_size ( Vector2i size, int window_id=0 )

void

window_set_title ( String title, int window_id=0 )

void

window_set_transient ( int window_id, int parent_window_id )

void

window_set_vsync_mode ( VSyncMode vsync_mode, int window_id=0 )

void

window_set_window_buttons_offset ( Vector2i offset, int window_id=0 )

void

window_set_window_event_callback ( Callable callback, int window_id=0 )


Enumerations

enum Feature:

Feature FEATURE_GLOBAL_MENU = 0

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_SUBWINDOWS = 1

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_TOUCHSCREEN = 2

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_MOUSE = 3

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_MOUSE_WARP = 4

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_CLIPBOARD = 5

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_VIRTUAL_KEYBOARD = 6

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_CURSOR_SHAPE = 7

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_CUSTOM_CURSOR_SHAPE = 8

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_NATIVE_DIALOG = 9

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_IME = 10

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_WINDOW_TRANSPARENCY = 11

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_HIDPI = 12

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_ICON = 13

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_NATIVE_ICON = 14

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_ORIENTATION = 15

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_SWAP_BUFFERS = 16

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_CLIPBOARD_PRIMARY = 18

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_TEXT_TO_SPEECH = 19

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_EXTEND_TO_TITLE = 20

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_SCREEN_CAPTURE = 21

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_STATUS_INDICATOR = 22

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_NATIVE_HELP = 23

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_NATIVE_DIALOG_INPUT = 24

There is currently no description for this enum. Please help us by contributing one!

Feature FEATURE_NATIVE_DIALOG_FILE = 25

There is currently no description for this enum. Please help us by contributing one!


enum MouseMode:

MouseMode MOUSE_MODE_VISIBLE = 0

There is currently no description for this enum. Please help us by contributing one!

MouseMode MOUSE_MODE_HIDDEN = 1

There is currently no description for this enum. Please help us by contributing one!

MouseMode MOUSE_MODE_CAPTURED = 2

There is currently no description for this enum. Please help us by contributing one!

MouseMode MOUSE_MODE_CONFINED = 3

There is currently no description for this enum. Please help us by contributing one!

MouseMode MOUSE_MODE_CONFINED_HIDDEN = 4

There is currently no description for this enum. Please help us by contributing one!


enum ScreenOrientation:

ScreenOrientation SCREEN_LANDSCAPE = 0

There is currently no description for this enum. Please help us by contributing one!

ScreenOrientation SCREEN_PORTRAIT = 1

There is currently no description for this enum. Please help us by contributing one!

ScreenOrientation SCREEN_REVERSE_LANDSCAPE = 2

There is currently no description for this enum. Please help us by contributing one!

ScreenOrientation SCREEN_REVERSE_PORTRAIT = 3

There is currently no description for this enum. Please help us by contributing one!

ScreenOrientation SCREEN_SENSOR_LANDSCAPE = 4

There is currently no description for this enum. Please help us by contributing one!

ScreenOrientation SCREEN_SENSOR_PORTRAIT = 5

There is currently no description for this enum. Please help us by contributing one!

ScreenOrientation SCREEN_SENSOR = 6

There is currently no description for this enum. Please help us by contributing one!


enum VirtualKeyboardType:

VirtualKeyboardType KEYBOARD_TYPE_DEFAULT = 0

There is currently no description for this enum. Please help us by contributing one!

VirtualKeyboardType KEYBOARD_TYPE_MULTILINE = 1

There is currently no description for this enum. Please help us by contributing one!

VirtualKeyboardType KEYBOARD_TYPE_NUMBER = 2

There is currently no description for this enum. Please help us by contributing one!

VirtualKeyboardType KEYBOARD_TYPE_NUMBER_DECIMAL = 3

There is currently no description for this enum. Please help us by contributing one!

VirtualKeyboardType KEYBOARD_TYPE_PHONE = 4

There is currently no description for this enum. Please help us by contributing one!

VirtualKeyboardType KEYBOARD_TYPE_EMAIL_ADDRESS = 5

There is currently no description for this enum. Please help us by contributing one!

VirtualKeyboardType KEYBOARD_TYPE_PASSWORD = 6

There is currently no description for this enum. Please help us by contributing one!

VirtualKeyboardType KEYBOARD_TYPE_URL = 7

There is currently no description for this enum. Please help us by contributing one!


enum CursorShape:

CursorShape CURSOR_ARROW = 0

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_IBEAM = 1

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_POINTING_HAND = 2

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_CROSS = 3

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_WAIT = 4

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_BUSY = 5

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_DRAG = 6

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_CAN_DROP = 7

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_FORBIDDEN = 8

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_VSIZE = 9

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_HSIZE = 10

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_BDIAGSIZE = 11

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_FDIAGSIZE = 12

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_MOVE = 13

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_VSPLIT = 14

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_HSPLIT = 15

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_HELP = 16

There is currently no description for this enum. Please help us by contributing one!

CursorShape CURSOR_MAX = 17

There is currently no description for this enum. Please help us by contributing one!


enum FileDialogMode:

FileDialogMode FILE_DIALOG_MODE_OPEN_FILE = 0

There is currently no description for this enum. Please help us by contributing one!

FileDialogMode FILE_DIALOG_MODE_OPEN_FILES = 1

There is currently no description for this enum. Please help us by contributing one!

FileDialogMode FILE_DIALOG_MODE_OPEN_DIR = 2

There is currently no description for this enum. Please help us by contributing one!

FileDialogMode FILE_DIALOG_MODE_OPEN_ANY = 3

There is currently no description for this enum. Please help us by contributing one!

FileDialogMode FILE_DIALOG_MODE_SAVE_FILE = 4

There is currently no description for this enum. Please help us by contributing one!


enum WindowMode:

WindowMode WINDOW_MODE_WINDOWED = 0

There is currently no description for this enum. Please help us by contributing one!

WindowMode WINDOW_MODE_MINIMIZED = 1

There is currently no description for this enum. Please help us by contributing one!

WindowMode WINDOW_MODE_MAXIMIZED = 2

There is currently no description for this enum. Please help us by contributing one!

WindowMode WINDOW_MODE_FULLSCREEN = 3

There is currently no description for this enum. Please help us by contributing one!

WindowMode WINDOW_MODE_EXCLUSIVE_FULLSCREEN = 4

There is currently no description for this enum. Please help us by contributing one!


enum WindowFlags:

WindowFlags WINDOW_FLAG_RESIZE_DISABLED = 0

There is currently no description for this enum. Please help us by contributing one!

WindowFlags WINDOW_FLAG_BORDERLESS = 1

There is currently no description for this enum. Please help us by contributing one!

WindowFlags WINDOW_FLAG_ALWAYS_ON_TOP = 2

There is currently no description for this enum. Please help us by contributing one!

WindowFlags WINDOW_FLAG_TRANSPARENT = 3

There is currently no description for this enum. Please help us by contributing one!

WindowFlags WINDOW_FLAG_NO_FOCUS = 4

There is currently no description for this enum. Please help us by contributing one!

WindowFlags WINDOW_FLAG_POPUP = 5

There is currently no description for this enum. Please help us by contributing one!

WindowFlags WINDOW_FLAG_EXTEND_TO_TITLE = 6

There is currently no description for this enum. Please help us by contributing one!

WindowFlags WINDOW_FLAG_MOUSE_PASSTHROUGH = 7

There is currently no description for this enum. Please help us by contributing one!

WindowFlags WINDOW_FLAG_MAX = 8

There is currently no description for this enum. Please help us by contributing one!


enum WindowEvent:

WindowEvent WINDOW_EVENT_MOUSE_ENTER = 0

There is currently no description for this enum. Please help us by contributing one!

WindowEvent WINDOW_EVENT_MOUSE_EXIT = 1

There is currently no description for this enum. Please help us by contributing one!

WindowEvent WINDOW_EVENT_FOCUS_IN = 2

There is currently no description for this enum. Please help us by contributing one!

WindowEvent WINDOW_EVENT_FOCUS_OUT = 3

There is currently no description for this enum. Please help us by contributing one!

WindowEvent WINDOW_EVENT_CLOSE_REQUEST = 4

There is currently no description for this enum. Please help us by contributing one!

WindowEvent WINDOW_EVENT_GO_BACK_REQUEST = 5

There is currently no description for this enum. Please help us by contributing one!

WindowEvent WINDOW_EVENT_DPI_CHANGE = 6

There is currently no description for this enum. Please help us by contributing one!

WindowEvent WINDOW_EVENT_TITLEBAR_CHANGE = 7

There is currently no description for this enum. Please help us by contributing one!


enum VSyncMode:

VSyncMode VSYNC_DISABLED = 0

There is currently no description for this enum. Please help us by contributing one!

VSyncMode VSYNC_ENABLED = 1

There is currently no description for this enum. Please help us by contributing one!

VSyncMode VSYNC_ADAPTIVE = 2

There is currently no description for this enum. Please help us by contributing one!

VSyncMode VSYNC_MAILBOX = 3

There is currently no description for this enum. Please help us by contributing one!


enum HandleType:

HandleType DISPLAY_HANDLE = 0

There is currently no description for this enum. Please help us by contributing one!

HandleType WINDOW_HANDLE = 1

There is currently no description for this enum. Please help us by contributing one!

HandleType WINDOW_VIEW = 2

There is currently no description for this enum. Please help us by contributing one!

HandleType OPENGL_CONTEXT = 3

There is currently no description for this enum. Please help us by contributing one!


enum TTSUtteranceEvent:

TTSUtteranceEvent TTS_UTTERANCE_STARTED = 0

There is currently no description for this enum. Please help us by contributing one!

TTSUtteranceEvent TTS_UTTERANCE_ENDED = 1

There is currently no description for this enum. Please help us by contributing one!

TTSUtteranceEvent TTS_UTTERANCE_CANCELED = 2

There is currently no description for this enum. Please help us by contributing one!

TTSUtteranceEvent TTS_UTTERANCE_BOUNDARY = 3

There is currently no description for this enum. Please help us by contributing one!


Constants

SCREEN_WITH_MOUSE_FOCUS = -4

There is currently no description for this constant. Please help us by contributing one!

SCREEN_WITH_KEYBOARD_FOCUS = -3

There is currently no description for this constant. Please help us by contributing one!

SCREEN_PRIMARY = -2

There is currently no description for this constant. Please help us by contributing one!

SCREEN_OF_MAIN_WINDOW = -1

There is currently no description for this constant. Please help us by contributing one!

MAIN_WINDOW_ID = 0

There is currently no description for this constant. Please help us by contributing one!

INVALID_WINDOW_ID = -1

There is currently no description for this constant. Please help us by contributing one!

INVALID_INDICATOR_ID = -1

There is currently no description for this constant. Please help us by contributing one!


Method Descriptions

String clipboard_get ( ) const

There is currently no description for this method. Please help us by contributing one!


Image clipboard_get_image ( ) const

There is currently no description for this method. Please help us by contributing one!


String clipboard_get_primary ( ) const

There is currently no description for this method. Please help us by contributing one!


bool clipboard_has ( ) const

There is currently no description for this method. Please help us by contributing one!


bool clipboard_has_image ( ) const

There is currently no description for this method. Please help us by contributing one!


void clipboard_set ( String clipboard )

There is currently no description for this method. Please help us by contributing one!


void clipboard_set_primary ( String clipboard_primary )

There is currently no description for this method. Please help us by contributing one!


int create_status_indicator ( Texture2D icon, String tooltip, Callable callback )

There is currently no description for this method. Please help us by contributing one!


CursorShape cursor_get_shape ( ) const

There is currently no description for this method. Please help us by contributing one!


void cursor_set_custom_image ( Resource cursor, CursorShape shape=0, Vector2 hotspot=Vector2(0, 0) )

There is currently no description for this method. Please help us by contributing one!


void cursor_set_shape ( CursorShape shape )

There is currently no description for this method. Please help us by contributing one!


void delete_status_indicator ( int id )

There is currently no description for this method. Please help us by contributing one!


Error dialog_input_text ( String title, String description, String existing_text, Callable callback )

There is currently no description for this method. Please help us by contributing one!


Error dialog_show ( String title, String description, PackedStringArray buttons, Callable callback )

There is currently no description for this method. Please help us by contributing one!


void enable_for_stealing_focus ( int process_id )

There is currently no description for this method. Please help us by contributing one!


Error file_dialog_show ( String title, String current_directory, String filename, bool show_hidden, FileDialogMode mode, PackedStringArray filters, Callable callback )

There is currently no description for this method. Please help us by contributing one!


Error file_dialog_with_options_show ( String title, String current_directory, String root, String filename, bool show_hidden, FileDialogMode mode, PackedStringArray filters, Dictionary[] options, Callable callback )

There is currently no description for this method. Please help us by contributing one!


void force_process_and_drop_events ( )

There is currently no description for this method. Please help us by contributing one!


Color get_accent_color ( ) const

There is currently no description for this method. Please help us by contributing one!


Color get_base_color ( ) const

There is currently no description for this method. Please help us by contributing one!


Rect2[] get_display_cutouts ( ) const

There is currently no description for this method. Please help us by contributing one!


Rect2i get_display_safe_area ( ) const

There is currently no description for this method. Please help us by contributing one!


int get_keyboard_focus_screen ( ) const

There is currently no description for this method. Please help us by contributing one!


String get_name ( ) const

There is currently no description for this method. Please help us by contributing one!


int get_primary_screen ( ) const

There is currently no description for this method. Please help us by contributing one!


int get_screen_count ( ) const

There is currently no description for this method. Please help us by contributing one!


int get_screen_from_rect ( Rect2 rect ) const

There is currently no description for this method. Please help us by contributing one!


bool get_swap_cancel_ok ( )

There is currently no description for this method. Please help us by contributing one!


int get_window_at_screen_position ( Vector2i position ) const

There is currently no description for this method. Please help us by contributing one!


PackedInt32Array get_window_list ( ) const

There is currently no description for this method. Please help us by contributing one!


int global_menu_add_check_item ( String menu_root, String label, Callable callback=Callable(), Callable key_callback=Callable(), Variant tag=null, Key accelerator=0, int index=-1 )

There is currently no description for this method. Please help us by contributing one!


int global_menu_add_icon_check_item ( String menu_root, Texture2D icon, String label, Callable callback=Callable(), Callable key_callback=Callable(), Variant tag=null, Key accelerator=0, int index=-1 )

There is currently no description for this method. Please help us by contributing one!


int global_menu_add_icon_item ( String menu_root, Texture2D icon, String label, Callable callback=Callable(), Callable key_callback=Callable(), Variant tag=null, Key accelerator=0, int index=-1 )

There is currently no description for this method. Please help us by contributing one!


int global_menu_add_icon_radio_check_item ( String menu_root, Texture2D icon, String label, Callable callback=Callable(), Callable key_callback=Callable(), Variant tag=null, Key accelerator=0, int index=-1 )

There is currently no description for this method. Please help us by contributing one!


int global_menu_add_item ( String menu_root, String label, Callable callback=Callable(), Callable key_callback=Callable(), Variant tag=null, Key accelerator=0, int index=-1 )

There is currently no description for this method. Please help us by contributing one!


int global_menu_add_multistate_item ( String menu_root, String label, int max_states, int default_state, Callable callback=Callable(), Callable key_callback=Callable(), Variant tag=null, Key accelerator=0, int index=-1 )

There is currently no description for this method. Please help us by contributing one!


int global_menu_add_radio_check_item ( String menu_root, String label, Callable callback=Callable(), Callable key_callback=Callable(), Variant tag=null, Key accelerator=0, int index=-1 )

There is currently no description for this method. Please help us by contributing one!


int global_menu_add_separator ( String menu_root, int index=-1 )

There is currently no description for this method. Please help us by contributing one!


int global_menu_add_submenu_item ( String menu_root, String label, String submenu, int index=-1 )

There is currently no description for this method. Please help us by contributing one!


void global_menu_clear ( String menu_root )

There is currently no description for this method. Please help us by contributing one!


Key global_menu_get_item_accelerator ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


Callable global_menu_get_item_callback ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


int global_menu_get_item_count ( String menu_root ) const

There is currently no description for this method. Please help us by contributing one!


Texture2D global_menu_get_item_icon ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


int global_menu_get_item_indentation_level ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


int global_menu_get_item_index_from_tag ( String menu_root, Variant tag ) const

There is currently no description for this method. Please help us by contributing one!


int global_menu_get_item_index_from_text ( String menu_root, String text ) const

There is currently no description for this method. Please help us by contributing one!


Callable global_menu_get_item_key_callback ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


int global_menu_get_item_max_states ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


int global_menu_get_item_state ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


String global_menu_get_item_submenu ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


Variant global_menu_get_item_tag ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


String global_menu_get_item_text ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


String global_menu_get_item_tooltip ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


Dictionary global_menu_get_system_menu_roots ( ) const

There is currently no description for this method. Please help us by contributing one!


bool global_menu_is_item_checkable ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


bool global_menu_is_item_checked ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


bool global_menu_is_item_disabled ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


bool global_menu_is_item_hidden ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


bool global_menu_is_item_radio_checkable ( String menu_root, int idx ) const

There is currently no description for this method. Please help us by contributing one!


void global_menu_remove_item ( String menu_root, int idx )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_accelerator ( String menu_root, int idx, Key keycode )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_callback ( String menu_root, int idx, Callable callback )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_checkable ( String menu_root, int idx, bool checkable )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_checked ( String menu_root, int idx, bool checked )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_disabled ( String menu_root, int idx, bool disabled )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_hidden ( String menu_root, int idx, bool hidden )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_hover_callbacks ( String menu_root, int idx, Callable callback )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_icon ( String menu_root, int idx, Texture2D icon )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_indentation_level ( String menu_root, int idx, int level )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_key_callback ( String menu_root, int idx, Callable key_callback )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_max_states ( String menu_root, int idx, int max_states )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_radio_checkable ( String menu_root, int idx, bool checkable )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_state ( String menu_root, int idx, int state )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_submenu ( String menu_root, int idx, String submenu )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_tag ( String menu_root, int idx, Variant tag )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_text ( String menu_root, int idx, String text )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_item_tooltip ( String menu_root, int idx, String tooltip )

There is currently no description for this method. Please help us by contributing one!


void global_menu_set_popup_callbacks ( String menu_root, Callable open_callback, Callable close_callback )

There is currently no description for this method. Please help us by contributing one!


bool has_additional_outputs ( ) const

There is currently no description for this method. Please help us by contributing one!


bool has_feature ( Feature feature ) const

There is currently no description for this method. Please help us by contributing one!


void help_set_search_callbacks ( Callable search_callback, Callable action_callback )

There is currently no description for this method. Please help us by contributing one!


Vector2i ime_get_selection ( ) const

There is currently no description for this method. Please help us by contributing one!


String ime_get_text ( ) const

There is currently no description for this method. Please help us by contributing one!


bool is_dark_mode ( ) const

There is currently no description for this method. Please help us by contributing one!


bool is_dark_mode_supported ( ) const

There is currently no description for this method. Please help us by contributing one!


bool is_touchscreen_available ( ) const

There is currently no description for this method. Please help us by contributing one!


bool is_window_transparency_available ( ) const

There is currently no description for this method. Please help us by contributing one!


int keyboard_get_current_layout ( ) const

There is currently no description for this method. Please help us by contributing one!


Key keyboard_get_keycode_from_physical ( Key keycode ) const

There is currently no description for this method. Please help us by contributing one!


Key keyboard_get_label_from_physical ( Key keycode ) const

There is currently no description for this method. Please help us by contributing one!


int keyboard_get_layout_count ( ) const

There is currently no description for this method. Please help us by contributing one!


String keyboard_get_layout_language ( int index ) const

There is currently no description for this method. Please help us by contributing one!


String keyboard_get_layout_name ( int index ) const

There is currently no description for this method. Please help us by contributing one!


void keyboard_set_current_layout ( int index )

There is currently no description for this method. Please help us by contributing one!


BitField<MouseButtonMask> mouse_get_button_state ( ) const

There is currently no description for this method. Please help us by contributing one!


MouseMode mouse_get_mode ( ) const

There is currently no description for this method. Please help us by contributing one!


Vector2i mouse_get_position ( ) const

There is currently no description for this method. Please help us by contributing one!


void mouse_set_mode ( MouseMode mouse_mode )

There is currently no description for this method. Please help us by contributing one!


void process_events ( )

There is currently no description for this method. Please help us by contributing one!


void register_additional_output ( Object object )

There is currently no description for this method. Please help us by contributing one!


int screen_get_dpi ( int screen=-1 ) const

There is currently no description for this method. Please help us by contributing one!


Image screen_get_image ( int screen=-1 ) const

There is currently no description for this method. Please help us by contributing one!


float screen_get_max_scale ( ) const

There is currently no description for this method. Please help us by contributing one!


ScreenOrientation screen_get_orientation ( int screen=-1 ) const

There is currently no description for this method. Please help us by contributing one!


Color screen_get_pixel ( Vector2i position ) const

There is currently no description for this method. Please help us by contributing one!


Vector2i screen_get_position ( int screen=-1 ) const

There is currently no description for this method. Please help us by contributing one!


float screen_get_refresh_rate ( int screen=-1 ) const

There is currently no description for this method. Please help us by contributing one!


float screen_get_scale ( int screen=-1 ) const

There is currently no description for this method. Please help us by contributing one!


Vector2i screen_get_size ( int screen=-1 ) const

There is currently no description for this method. Please help us by contributing one!


Rect2i screen_get_usable_rect ( int screen=-1 ) const

There is currently no description for this method. Please help us by contributing one!


bool screen_is_kept_on ( ) const

There is currently no description for this method. Please help us by contributing one!


void screen_set_keep_on ( bool enable )

There is currently no description for this method. Please help us by contributing one!


void screen_set_orientation ( ScreenOrientation orientation, int screen=-1 )

There is currently no description for this method. Please help us by contributing one!


void set_icon ( Image image )

There is currently no description for this method. Please help us by contributing one!


void set_native_icon ( String filename )

There is currently no description for this method. Please help us by contributing one!


void set_system_theme_change_callback ( Callable callable )

There is currently no description for this method. Please help us by contributing one!


Rect2 status_indicator_get_rect ( int id ) const

There is currently no description for this method. Please help us by contributing one!


void status_indicator_set_callback ( int id, Callable callback )

There is currently no description for this method. Please help us by contributing one!


void status_indicator_set_icon ( int id, Texture2D icon )

There is currently no description for this method. Please help us by contributing one!


void status_indicator_set_menu ( int id, RID menu_rid )

There is currently no description for this method. Please help us by contributing one!


void status_indicator_set_tooltip ( int id, String tooltip )

There is currently no description for this method. Please help us by contributing one!


String tablet_get_current_driver ( ) const

There is currently no description for this method. Please help us by contributing one!


int tablet_get_driver_count ( ) const

There is currently no description for this method. Please help us by contributing one!


String tablet_get_driver_name ( int idx ) const

There is currently no description for this method. Please help us by contributing one!


void tablet_set_current_driver ( String name )

There is currently no description for this method. Please help us by contributing one!


Dictionary[] tts_get_voices ( ) const

There is currently no description for this method. Please help us by contributing one!


PackedStringArray tts_get_voices_for_language ( String language ) const

There is currently no description for this method. Please help us by contributing one!


bool tts_is_paused ( ) const

There is currently no description for this method. Please help us by contributing one!


bool tts_is_speaking ( ) const

There is currently no description for this method. Please help us by contributing one!


void tts_pause ( )

There is currently no description for this method. Please help us by contributing one!


void tts_resume ( )

There is currently no description for this method. Please help us by contributing one!


void tts_set_utterance_callback ( TTSUtteranceEvent event, Callable callable )

There is currently no description for this method. Please help us by contributing one!


void tts_speak ( String text, String voice, int volume=50, float pitch=1.0, float rate=1.0, int utterance_id=0, bool interrupt=false )

There is currently no description for this method. Please help us by contributing one!


void tts_stop ( )

There is currently no description for this method. Please help us by contributing one!


void unregister_additional_output ( Object object )

There is currently no description for this method. Please help us by contributing one!


int virtual_keyboard_get_height ( ) const

There is currently no description for this method. Please help us by contributing one!


void virtual_keyboard_hide ( )

There is currently no description for this method. Please help us by contributing one!


void virtual_keyboard_show ( String existing_text, Rect2 position=Rect2(0, 0, 0, 0), VirtualKeyboardType type=0, int max_length=-1, int cursor_start=-1, int cursor_end=-1 )

There is currently no description for this method. Please help us by contributing one!


void warp_mouse ( Vector2i position )

There is currently no description for this method. Please help us by contributing one!


bool window_can_draw ( int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


int window_get_active_popup ( ) const

There is currently no description for this method. Please help us by contributing one!


int window_get_attached_instance_id ( int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


int window_get_current_screen ( int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


bool window_get_flag ( WindowFlags flag, int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


Vector2i window_get_max_size ( int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


Vector2i window_get_min_size ( int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


WindowMode window_get_mode ( int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


int window_get_native_handle ( HandleType handle_type, int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


Rect2i window_get_popup_safe_rect ( int window ) const

There is currently no description for this method. Please help us by contributing one!


Vector2i window_get_position ( int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


Vector2i window_get_position_with_decorations ( int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


Vector3i window_get_safe_title_margins ( int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


Vector2i window_get_size ( int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


Vector2i window_get_size_with_decorations ( int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


Vector2i window_get_title_size ( String title, int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


VSyncMode window_get_vsync_mode ( int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


bool window_is_focused ( int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


bool window_is_maximize_allowed ( int window_id=0 ) const

There is currently no description for this method. Please help us by contributing one!


bool window_maximize_on_title_dbl_click ( ) const

There is currently no description for this method. Please help us by contributing one!


bool window_minimize_on_title_dbl_click ( ) const

There is currently no description for this method. Please help us by contributing one!


void window_move_to_foreground ( int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_request_attention ( int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_current_screen ( int screen, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_drop_files_callback ( Callable callback, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_exclusive ( int window_id, bool exclusive )

There is currently no description for this method. Please help us by contributing one!


void window_set_flag ( WindowFlags flag, bool enabled, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_ime_active ( bool active, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_ime_position ( Vector2i position, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_input_event_callback ( Callable callback, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_input_text_callback ( Callable callback, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_max_size ( Vector2i max_size, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_min_size ( Vector2i min_size, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_mode ( WindowMode mode, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_mouse_passthrough ( PackedVector2Array region, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_popup_safe_rect ( int window, Rect2i rect )

There is currently no description for this method. Please help us by contributing one!


void window_set_position ( Vector2i position, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_rect_changed_callback ( Callable callback, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_size ( Vector2i size, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_title ( String title, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_transient ( int window_id, int parent_window_id )

There is currently no description for this method. Please help us by contributing one!


void window_set_vsync_mode ( VSyncMode vsync_mode, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_window_buttons_offset ( Vector2i offset, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!


void window_set_window_event_callback ( Callable callback, int window_id=0 )

There is currently no description for this method. Please help us by contributing one!