Class reference

DisplayServer

Inherits Object

A server interface for low-level window management.

Description

DisplayServer handles everything related to window management. It 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

`RID accessibility_create_element(int window_id, int role)`

Creates a new, empty accessibility element resource. Note: An accessibility element is created and freed automatically for each Node. In general, this function should not be called manually.

`RID accessibility_create_sub_element(RID parent_rid, int role, int insert_pos = -1)`

Creates a new, empty accessibility sub-element resource. Sub-elements can be used to provide accessibility information for objects which are not Nodes, such as list items, table cells, or menu items. Sub-elements are freed automatically when the parent element is freed, or can be freed early using the accessibility_free_element() method.

`RID accessibility_create_sub_text_edit_elements(RID parent_rid, RID shaped_text, float min_height, int insert_pos = -1)`

Creates a new, empty accessibility sub-element from the shaped text buffer. Sub-elements are freed automatically when the parent element is freed, or can be freed early using the accessibility_free_element() method.

`Variant accessibility_element_get_meta(RID id) const`

Returns the metadata of the accessibility element.

`void accessibility_element_set_meta(RID id, Variant meta)`

Sets the metadata of the accessibility element.

`void accessibility_free_element(RID id)`

Frees an object created by accessibility_create_element(), accessibility_create_sub_element(), or accessibility_create_sub_text_edit_elements().

`RID accessibility_get_window_root(int window_id) const`

Returns the main accessibility element of the OS native window.

`bool accessibility_has_element(RID id) const`

Returns true if id is a valid accessibility element.

`int accessibility_screen_reader_active() const`

Returns 1 if a screen reader, Braille display or other assistive app is active, 0 otherwise. Returns -1 if status is unknown. Note: This method is implemented on Linux, macOS, and Windows. Note: Accessibility debugging tools, such as Accessibility Insights for Windows, macOS Accessibility Inspector, or AT-SPI Browser do not count as assistive apps and will not affect this value. To test your app with these tools, set ProjectSettings.accessibility/general/accessibility_support to 1.

`void accessibility_set_window_focused(int window_id, bool focused)`

Sets the window focused state for assistive apps. Note: This method is implemented on Linux, macOS, and Windows. Note: Advanced users only! Window objects call this method automatically.

`void accessibility_set_window_rect(int window_id, Rect2 rect_out, Rect2 rect_in)`

Sets window outer (with decorations) and inner (without decorations) bounds for assistive apps. Note: This method is implemented on Linux, macOS, and Windows. Note: Advanced users only! Window objects call this method automatically.

`int accessibility_should_increase_contrast() const`

Returns 1 if a high-contrast user interface theme should be used, 0 otherwise. Returns -1 if status is unknown. Note: This method is implemented on Linux (X11/Wayland, GNOME), macOS, and Windows.

`int accessibility_should_reduce_animation() const`

Returns 1 if flashing, blinking, and other moving content that can cause seizures in users with photosensitive epilepsy should be disabled, 0 otherwise. Returns -1 if status is unknown. Note: This method is implemented on macOS and Windows.

`int accessibility_should_reduce_transparency() const`

Returns 1 if background images, transparency, and other features that can reduce the contrast between the foreground and background should be disabled, 0 otherwise. Returns -1 if status is unknown. Note: This method is implemented on macOS and Windows.

`void accessibility_update_add_action(RID id, int action, Callable callable)`

Adds a callback for the accessibility action (action which can be performed by using a special screen reader command or buttons on the Braille display), and marks this action as supported. The action callback receives one Variant argument, which value depends on action type.

`void accessibility_update_add_child(RID id, RID child_id)`

Adds a child accessibility element. Note: Node children and sub-elements are added to the child list automatically.

`void accessibility_update_add_custom_action(RID id, int action_id, String action_description)`

Adds support for a custom accessibility action. action_id is passed as an argument to the callback of ACTION_CUSTOM action.

`void accessibility_update_add_related_controls(RID id, RID related_id)`

Adds an element that is controlled by this element.

`void accessibility_update_add_related_described_by(RID id, RID related_id)`

Adds an element that describes this element.

`void accessibility_update_add_related_details(RID id, RID related_id)`

Adds an element that details this element.

`void accessibility_update_add_related_flow_to(RID id, RID related_id)`

Adds an element that this element flow into.

`void accessibility_update_add_related_labeled_by(RID id, RID related_id)`

Adds an element that labels this element.

`void accessibility_update_add_related_radio_group(RID id, RID related_id)`

Adds an element that is part of the same radio group. Note: This method should be called on each element of the group, using all other elements as related_id.

`void accessibility_update_set_active_descendant(RID id, RID other_id)`

Adds an element that is an active descendant of this element.

`void accessibility_update_set_background_color(RID id, Color color)`

Sets element background color.

`void accessibility_update_set_bounds(RID id, Rect2 p_rect)`

Sets element bounding box, relative to the node position.

`void accessibility_update_set_checked(RID id, bool checekd)`

Sets element checked state.

`void accessibility_update_set_classname(RID id, String classname)`

Sets element class name.

`void accessibility_update_set_color_value(RID id, Color color)`

Sets element color value.

`void accessibility_update_set_description(RID id, String description)`

Sets element accessibility description.

`void accessibility_update_set_error_message(RID id, RID other_id)`

Sets an element which contains an error message for this element.

`void accessibility_update_set_extra_info(RID id, String name)`

Sets element accessibility extra information added to the element name.

`void accessibility_update_set_flag(RID id, int flag, bool value)`

Sets element flag.

`void accessibility_update_set_focus(RID id)`

Sets currently focused element.

`void accessibility_update_set_foreground_color(RID id, Color color)`

Sets element foreground color.

`void accessibility_update_set_in_page_link_target(RID id, RID other_id)`

Sets target element for the link.

`void accessibility_update_set_language(RID id, String language)`

Sets element text language.

`void accessibility_update_set_list_item_count(RID id, int size)`

Sets number of items in the list.

`void accessibility_update_set_list_item_expanded(RID id, bool expanded)`

Sets list/tree item expanded status.

`void accessibility_update_set_list_item_index(RID id, int index)`

Sets the position of the element in the list.

`void accessibility_update_set_list_item_level(RID id, int level)`

Sets the hierarchical level of the element in the list.

`void accessibility_update_set_list_item_selected(RID id, bool selected)`

Sets list/tree item selected status.

`void accessibility_update_set_list_orientation(RID id, bool vertical)`

Sets the orientation of the list elements.

`void accessibility_update_set_live(RID id, int live)`

Sets the priority of the live region updates.

`void accessibility_update_set_member_of(RID id, RID group_id)`

Sets the element to be a member of the group.

`void accessibility_update_set_name(RID id, String name)`

Sets element accessibility name.

`void accessibility_update_set_next_on_line(RID id, RID other_id)`

Sets next element on the line.

`void accessibility_update_set_num_jump(RID id, float jump)`

Sets numeric value jump.

`void accessibility_update_set_num_range(RID id, float min, float max)`

Sets numeric value range.

`void accessibility_update_set_num_step(RID id, float step)`

Sets numeric value step.

`void accessibility_update_set_num_value(RID id, float position)`

Sets numeric value.

`void accessibility_update_set_placeholder(RID id, String placeholder)`

Sets placeholder text.

`void accessibility_update_set_popup_type(RID id, int popup)`

Sets popup type for popup buttons.

`void accessibility_update_set_previous_on_line(RID id, RID other_id)`

Sets previous element on the line.

`void accessibility_update_set_role(RID id, int role)`

Sets element accessibility role.

`void accessibility_update_set_role_description(RID id, String description)`

Sets element accessibility role description text.

`void accessibility_update_set_scroll_x(RID id, float position)`

Sets scroll bar x position.

`void accessibility_update_set_scroll_x_range(RID id, float min, float max)`

Sets scroll bar x range.

`void accessibility_update_set_scroll_y(RID id, float position)`

Sets scroll bar y position.

`void accessibility_update_set_scroll_y_range(RID id, float min, float max)`

Sets scroll bar y range.

`void accessibility_update_set_shortcut(RID id, String shortcut)`

Sets the list of keyboard shortcuts used by element.

`void accessibility_update_set_state_description(RID id, String description)`

Sets human-readable description of the current checked state.

`void accessibility_update_set_table_cell_position(RID id, int row_index, int column_index)`

Sets cell position in the table.

`void accessibility_update_set_table_cell_span(RID id, int row_span, int column_span)`

Sets cell row/column span.

`void accessibility_update_set_table_column_count(RID id, int count)`

Sets number of columns in the table.

`void accessibility_update_set_table_column_index(RID id, int index)`

Sets position of the column.

`void accessibility_update_set_table_row_count(RID id, int count)`

Sets number of rows in the table.

`void accessibility_update_set_table_row_index(RID id, int index)`

Sets position of the row in the table.

`void accessibility_update_set_text_align(RID id, int align)`

Sets element text alignment.

`void accessibility_update_set_text_decorations(RID id, bool underline, bool strikethrough, bool overline)`

Sets text underline/overline/strikethrough.

`void accessibility_update_set_text_orientation(RID id, bool vertical)`

Sets text orientation.

`void accessibility_update_set_text_selection(RID id, RID text_start_id, int start_char, RID text_end_id, int end_char)`

Sets text selection to the text field. text_start_id and text_end_id should be elements created by accessibility_create_sub_text_edit_elements(). Character offsets are relative to the corresponding element.

`void accessibility_update_set_tooltip(RID id, String tooltip)`

Sets tooltip text.

`void accessibility_update_set_transform(RID id, Transform2D transform)`

Sets element 2D transform.

`void accessibility_update_set_url(RID id, String url)`

Sets link URL.

`void accessibility_update_set_value(RID id, String value)`

Sets element text value.

`void beep() const`

Plays the beep sound from the operative system, if possible. Because it comes from the OS, the beep sound will be audible even if the application is muted. It may also be disabled for the entire OS by the user. Note: This method is implemented on macOS, Linux (X11/Wayland), and Windows.

`String clipboard_get() const`

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

`Image clipboard_get_image() const`

Returns the user's clipboard as an image if possible. Note: This method uses the copied pixel data, e.g. from an image editing software or a web browser, not an image file copied from file explorer.

`String clipboard_get_primary() const`

Returns the user's primary 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 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/Wayland).

`bool clipboard_has() const`

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

`bool clipboard_has_image() const`

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

`void clipboard_set(String clipboard)`

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

`void clipboard_set_primary(String clipboard_primary)`

Sets the user's primary 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 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/Wayland).

`bool color_picker(Callable callback)`

Displays OS native color picker. Callbacks have the following arguments: status: bool, color: Color. Note: This method is implemented if the display server has the FEATURE_NATIVE_COLOR_PICKER feature. Note: This method is only implemented on Linux (X11/Wayland).

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

Creates a new application status indicator with the specified icon, tooltip, and activation callback. callback should take two arguments: the pressed mouse button (one of the MouseButton constants) and the click position in screen coordinates (a Vector2i).

`int cursor_get_shape() const`

Returns the default mouse cursor shape set by cursor_set_shape().

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

Sets a custom mouse cursor image for the given shape. This means the user's operating system and mouse cursor theme will no longer influence the mouse cursor's appearance. cursor can be either a Texture2D or an Image, and it should not be larger than 256×256 to display correctly. Optionally, hotspot can be set to offset the image's position relative to the click point. By default, hotspot is set to the top-left corner of the image. See also cursor_set_shape().

`void cursor_set_shape(int 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 cursor_get_shape() and cursor_set_custom_image().

`void delete_status_indicator(int id)`

Removes the application status indicator.

`int dialog_input_text(String title, String description, String existing_text, Callable callback)`

Shows a text input dialog which uses the operating system's native look-and-feel. callback should accept a single String parameter which contains the text field's contents. Note: This method is implemented if the display server has the FEATURE_NATIVE_DIALOG_INPUT feature. Supported platforms include macOS, Windows, and Android.

`int dialog_show(String title, String description, PackedStringArray buttons, Callable callback)`

Shows a text dialog which uses the operating system's native look-and-feel. callback should accept a single int parameter which corresponds to the index of the pressed button. Note: This method is implemented if the display server has the FEATURE_NATIVE_DIALOG feature. Supported platforms include macOS, Windows, and Android.

`void enable_for_stealing_focus(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.

`int file_dialog_show(String title, String current_directory, String filename, bool show_hidden, int mode, PackedStringArray filters, Callable callback, int parent_window_id = 0)`

Displays OS native dialog for selecting files or directories in the file system. Each filter string in the filters array should be formatted like this: *.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg. The description text of the filter is optional and can be omitted. It is recommended to set both file extension and MIME type. See also FileDialog.filters. Callbacks have the following arguments: status: bool, selected_paths: PackedStringArray, selected_filter_index: int. On Android, the third callback argument (selected_filter_index) is always 0. Note: This method is implemented if the display server has the FEATURE_NATIVE_DIALOG_FILE feature. Supported platforms include Linux (X11/Wayland), Windows, macOS, and Android (API level 29+). Note: current_directory might be ignored. Note: Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types. Note: On Android and Linux, show_hidden is ignored. Note: On Android and 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 OS.get_granted_permissions() to get a list of saved bookmarks.

`int file_dialog_with_options_show(String title, String current_directory, String root, String filename, bool show_hidden, int mode, PackedStringArray filters, Dictionary[] options, Callable callback, int parent_window_id = 0)`

Displays OS native dialog for selecting files or directories in the file system with additional user selectable options. Each filter string in the filters array should be formatted like this: *.png,*.jpg,*.jpeg;Image Files;image/png,image/jpeg. The description text of the filter is optional and can be omitted. It is recommended to set both file extension and MIME type. See also FileDialog.filters. options is array of Dictionarys with the following keys: - "name" - option's name String. - "values" - PackedStringArray of values. If empty, boolean option (check box) is used. - "default" - default selected option index (int) or default boolean value (bool). Callbacks have the following arguments: status: bool, selected_paths: PackedStringArray, selected_filter_index: int, selected_option: Dictionary. Note: This method is implemented if the display server has the FEATURE_NATIVE_DIALOG_FILE_EXTRA feature. Supported platforms include Linux (X11/Wayland), Windows, and macOS. Note: current_directory might be ignored. Note: Embedded file dialog and Windows file dialog support only file extensions, while Android, Linux, and macOS file dialogs also support MIME types. Note: On Linux (X11), 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 OS.get_granted_permissions() to get a list of saved bookmarks.

`void force_process_and_drop_events()`

Forces window manager processing while ignoring all InputEvents. See also process_events(). Note: This method is implemented on Windows and macOS.

`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, Windows, Android, and Linux (X11/Wayland).

`Color get_base_color() const`

Returns the OS theme base color (default control background). Returns Color(0, 0, 0, 0) if the base color is unknown. Note: This method is implemented on macOS, Windows, and Android.

`Rect2[] get_display_cutouts() const`

Returns an Array of 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 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.

`Rect2i get_display_safe_area() const`

Returns the unobscured area of the display where interactive controls should be rendered. See also get_display_cutouts(). Note: Currently only implemented on Android and iOS. On other platforms, screen_get_usable_rect(SCREEN_OF_MAIN_WINDOW) will be returned as a fallback. See also screen_get_usable_rect().

`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. Note: This method is implemented on Linux/X11, macOS, and Windows. On other platforms, this method always returns the primary screen.

`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 (currently X11 and Wayland). The names of built-in display servers are Windows, macOS, X11 (Linux), Wayland (Linux), Android, iOS, web (HTML5), and headless (when started with the --headless command line argument).

`int get_primary_screen() const`

Returns index of the primary screen. Note: This method is implemented on Linux/X11, macOS, and Windows. On other platforms, this method always returns 0.

`int get_screen_count() const`

Returns the number of displays available. Note: This method is implemented on Linux (X11 and Wayland), macOS, and Windows. On other platforms, this method always returns 1.

`int get_screen_from_rect(Rect2 rect) const`

Returns the index of the screen that overlaps the most with the given rectangle. Returns INVALID_SCREEN if the rectangle doesn't overlap with any screen or has no area.

`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 ProjectSettings.gui/common/swap_cancel_ok. Note: This doesn't affect native dialogs such as the ones spawned by DisplayServer.dialog_show().

`int get_window_at_screen_position(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)        +-------+
				                |       |
				+-------------+ |       |
				|             | |       |
				|             | |       |
				+-------------+ +-------+

`PackedInt32Array get_window_list() const`

Returns the list of Redot window IDs belonging to this process. Note: Native dialogs are not included in this list.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

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 KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (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).
				"_apple" - Apple menu (macOS, custom items added before "Services").
				"_window" - Window menu (macOS, custom items added after "Bring All to Front").
				"_help" - Help menu (macOS).

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

Deprecated.

Use NativeMenu or PopupMenu instead.

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 KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (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).
				"_apple" - Apple menu (macOS, custom items added before "Services").
				"_window" - Window menu (macOS, custom items added after "Bring All to Front").
				"_help" - Help menu (macOS).

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

Deprecated.

Use NativeMenu or PopupMenu instead.

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 KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (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).
				"_apple" - Apple menu (macOS, custom items added before "Services").
				"_window" - Window menu (macOS, custom items added after "Bring All to Front").
				"_help" - Help menu (macOS).

`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, int accelerator = 0, int index = -1)`

Deprecated.

Use NativeMenu or PopupMenu instead.

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 KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (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 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).
				"_apple" - Apple menu (macOS, custom items added before "Services").
				"_window" - Window menu (macOS, custom items added after "Bring All to Front").
				"_help" - Help menu (macOS).

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

Deprecated.

Use NativeMenu or PopupMenu instead.

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 KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (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).
				"_apple" - Apple menu (macOS, custom items added before "Services").
				"_window" - Window menu (macOS, custom items added after "Bring All to Front").
				"_help" - Help menu (macOS).

`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, int accelerator = 0, int index = -1)`

Deprecated.

Use NativeMenu or PopupMenu instead.

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 KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (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).
				"_apple" - Apple menu (macOS, custom items added before "Services").
				"_window" - Window menu (macOS, custom items added after "Bring All to Front").
				"_help" - Help menu (macOS).

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

Deprecated.

Use NativeMenu or PopupMenu instead.

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 KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (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 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).
				"_apple" - Apple menu (macOS, custom items added before "Services").
				"_window" - Window menu (macOS, custom items added after "Bring All to Front").
				"_help" - Help menu (macOS).

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

Deprecated.

Use NativeMenu or PopupMenu instead.

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).
				"_apple" - Apple menu (macOS, custom items added before "Services").
				"_window" - Window menu (macOS, custom items added after "Bring All to Front").
				"_help" - Help menu (macOS).

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

Deprecated.

Use NativeMenu or PopupMenu instead.

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).
				"_apple" - Apple menu (macOS, custom items added before "Services").
				"_window" - Window menu (macOS, custom items added after "Bring All to Front").
				"_help" - Help menu (macOS).

`void global_menu_clear(String menu_root)`

Deprecated.

Use NativeMenu or PopupMenu instead.

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).
				"_apple" - Apple menu (macOS, custom items added before "Services").
				"_window" - Window menu (macOS, custom items added after "Bring All to Front").
				"_help" - Help menu (macOS).

`int global_menu_get_item_accelerator(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

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.

`Callable global_menu_get_item_callback(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns the callback of the item at index idx. Note: This method is implemented only on macOS.

`int global_menu_get_item_count(String menu_root) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns number of items in the global menu with ID menu_root. Note: This method is implemented only on macOS.

`Texture2D global_menu_get_item_icon(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns the icon of the item at index idx. Note: This method is implemented only on macOS.

`int global_menu_get_item_indentation_level(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns the horizontal offset of the item at the given idx. Note: This method is implemented only on macOS.

`int global_menu_get_item_index_from_tag(String menu_root, Variant tag) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns the index of the item with the specified tag. Indices are automatically assigned to each item by the engine, and cannot be set manually. Note: This method is implemented only on macOS.

`int global_menu_get_item_index_from_text(String menu_root, String text) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns the index of the item with the specified text. Indices are automatically assigned to each item by the engine, and cannot be set manually. Note: This method is implemented only on macOS.

`Callable global_menu_get_item_key_callback(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns the callback of the item accelerator at index idx. Note: This method is implemented only on macOS.

`int global_menu_get_item_max_states(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns number of states of a multistate item. See global_menu_add_multistate_item() for details. Note: This method is implemented only on macOS.

`int global_menu_get_item_state(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns the state of a multistate item. See global_menu_add_multistate_item() for details. Note: This method is implemented only on macOS.

`String global_menu_get_item_submenu(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns the submenu ID of the item at index idx. See global_menu_add_submenu_item() for more info on how to add a submenu. Note: This method is implemented only on macOS.

`Variant global_menu_get_item_tag(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns the metadata of the specified item, which might be of any type. You can set it with global_menu_set_item_tag(), which provides a simple way of assigning context data to items. Note: This method is implemented only on macOS.

`String global_menu_get_item_text(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns the text of the item at index idx. Note: This method is implemented only on macOS.

`String global_menu_get_item_tooltip(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns the tooltip associated with the specified index idx. Note: This method is implemented only on macOS.

`Dictionary global_menu_get_system_menu_roots() const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns Dictionary of supported system menu IDs and names. Note: This method is implemented only on macOS.

`bool global_menu_is_item_checkable(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

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.

`bool global_menu_is_item_checked(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns true if the item at index idx is checked. Note: This method is implemented only on macOS.

`bool global_menu_is_item_disabled(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns true if the item at index idx is disabled. When it is disabled it can't be selected, or its action invoked. See global_menu_set_item_disabled() for more info on how to disable an item. Note: This method is implemented only on macOS.

`bool global_menu_is_item_hidden(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

Returns true if the item at index idx is hidden. See global_menu_set_item_hidden() for more info on how to hide an item. Note: This method is implemented only on macOS.

`bool global_menu_is_item_radio_checkable(String menu_root, int idx) const`

Deprecated.

Use NativeMenu or PopupMenu instead.

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.

`void global_menu_remove_item(String menu_root, int idx)`

Deprecated.

Use NativeMenu or PopupMenu instead.

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.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

Sets the accelerator of the item at index idx. keycode can be a single Key, or a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A (Ctrl + A). Note: This method is implemented only on macOS.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

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.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

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.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

Sets the checkstate status of the item at index idx. Note: This method is implemented only on macOS.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

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.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

Hides/shows the item at index idx. When it is hidden, an item does not appear in a menu and its action cannot be invoked. Note: This method is implemented only on macOS.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

Sets the callback of the item at index idx. The callback is emitted when an item is hovered. 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.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

Replaces the 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.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

Sets the horizontal offset of the item at the given idx. Note: This method is implemented only on macOS.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

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.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

Sets number of state of a multistate item. See global_menu_add_multistate_item() for details. Note: This method is implemented only on macOS.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

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.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

Sets the state of a multistate item. See global_menu_add_multistate_item() for details. Note: This method is implemented only on macOS.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

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.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

Sets the metadata of an item, which may be of any type. You can later get it with global_menu_get_item_tag(), which provides a simple way of assigning context data to items. Note: This method is implemented only on macOS.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

Sets the text of the item at index idx. Note: This method is implemented only on macOS.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

Sets the String tooltip of the item at the specified index idx. Note: This method is implemented only on macOS.

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

Deprecated.

Use NativeMenu or PopupMenu instead.

Registers callables to emit when the menu is respectively about to show or closed. Callback methods should have zero arguments.

`bool has_additional_outputs() const`

Returns true if any additional outputs have been registered via register_additional_output().

`bool has_feature(int feature) const`

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

`bool has_hardware_keyboard() const`

Returns true if a hardware keyboard is connected. Note: This method is implemented on Android and iOS. On other platforms, this method always returns true.

`void help_set_search_callbacks(Callable search_callback, Callable action_callback)`

Sets native help system search callbacks. search_callback has the following arguments: String search_string, int result_limit and return a Dictionary with "key, display name" pairs for the search results. Called when the user enters search terms in the Help menu. action_callback has the following arguments: String key. Called when the user selects a search result in the Help menu. Note: This method is implemented only on macOS.

`Vector2i ime_get_selection() const`

Returns the text selection in the Input Method Editor composition string, with the Vector2i's x component being the caret position and y being the length of the selection. Note: This method is implemented only on macOS.

`String ime_get_text() const`

Returns the composition string contained within the Input Method Editor window. Note: This method is implemented only on macOS.

`bool is_dark_mode() const`

Returns true if OS is using dark mode. Note: This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).

`bool is_dark_mode_supported() const`

Returns true if OS supports dark mode. Note: This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).

`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 ProjectSettings.input_devices/pointing/emulate_touch_from_mouse is true.

`bool is_window_transparency_available() const`

Returns true if the window background can be made transparent. This method returns false if ProjectSettings.display/window/per_pixel_transparency/allowed is set to false, or if transparency is not supported by the renderer or OS compositor.

`int keyboard_get_current_layout() const`

Returns active keyboard layout index. Note: This method is implemented on Linux (X11/Wayland), macOS, and Windows.

`int keyboard_get_keycode_from_physical(int keycode) const`

Converts a physical (US QWERTY) keycode to one in the active keyboard layout. Note: This method is implemented on Linux (X11/Wayland), macOS and Windows.

`int keyboard_get_label_from_physical(int 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/Wayland), macOS and Windows.

`int keyboard_get_layout_count() const`

Returns the number of keyboard layouts. Note: This method is implemented on Linux (X11/Wayland), macOS and Windows.

`String keyboard_get_layout_language(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/Wayland), macOS and Windows.

`String keyboard_get_layout_name(int index) const`

Returns the localized name of the keyboard layout at position index. Note: This method is implemented on Linux (X11/Wayland), macOS and Windows.

`void keyboard_set_current_layout(int index)`

Sets the active keyboard layout. Note: This method is implemented on Linux (X11/Wayland), macOS and Windows.

`int 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 Input.get_mouse_button_mask().

`int mouse_get_mode() const`

Returns the current mouse mode. See also mouse_set_mode().

`Vector2i mouse_get_position() const`

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

`void mouse_set_mode(int mouse_mode)`

Sets the current mouse mode. See also mouse_get_mode().

`void process_events()`

Perform window manager processing, including input flushing. See also force_process_and_drop_events(), Input.flush_buffered_events() and Input.use_accumulated_input.

`void register_additional_output(Object object)`

Registers an Object which represents an additional output that will be rendered too, beyond normal windows. The Object is only used as an identifier, which can be later passed to unregister_additional_output(). This can be used to prevent Redot from skipping rendering when no normal windows are visible.

`int screen_get_dpi(int screen = -1) const`

Returns the dots per inch density of the specified screen. Returns platform specific default value if screen is invalid. Note: One of the following constants can be used as screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS, or SCREEN_WITH_KEYBOARD_FOCUS. 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, iOS, Linux (X11/Wayland), macOS, Web, and Windows. On other platforms, this method always returns 72.

`Image screen_get_image(int screen = -1) const`

Returns a screenshot of the screen. Returns null if screen is invalid or the DisplayServer fails to capture screenshot. Note: One of the following constants can be used as screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS, or SCREEN_WITH_KEYBOARD_FOCUS. Note: This method is implemented on Linux (X11, excluding XWayland), macOS, and Windows. On other platforms, this method always returns null. Note: On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a screenshot that will not include other application windows or OS elements not related to the application.

`Image screen_get_image_rect(Rect2i rect) const`

Returns a screenshot of the screen region defined by rect. Returns null if rect is outside screen bounds or the DisplayServer fails to capture screenshot. Note: This method is implemented on macOS and Windows. On other platforms, this method always returns null. Note: On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a screenshot that will not include other application windows or OS elements not related to the application.

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

`int screen_get_orientation(int screen = -1) const`

Returns the screen's current orientation. See also screen_set_orientation(). Returns SCREEN_LANDSCAPE if screen is invalid. Note: One of the following constants can be used as screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS, or SCREEN_WITH_KEYBOARD_FOCUS. Note: This method is implemented on Android and iOS. On other platforms, this method always returns SCREEN_LANDSCAPE.

`Color screen_get_pixel(Vector2i position) const`

Returns color of the display pixel at the position. Note: This method is implemented on Linux (X11, excluding XWayland), macOS, and Windows. On other platforms, this method always returns Color. Note: On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a screenshot that will only contain the desktop wallpaper, the current application's window, and other related UI elements.

`Vector2i screen_get_position(int screen = -1) const`

Returns the screen's top-left corner position in pixels. Returns Vector2i.ZERO if screen is invalid. 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 might be located outside any display like this:

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

See also screen_get_size(). Note: One of the following constants can be used as screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS, or SCREEN_WITH_KEYBOARD_FOCUS.

`float screen_get_refresh_rate(int screen = -1) const`

Returns the current refresh rate of the specified screen. Returns -1.0 if screen is invalid or the DisplayServer fails to find the refresh rate for the specified screen. 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

Note: One of the following constants can be used as screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS, or SCREEN_WITH_KEYBOARD_FOCUS. Note: This method is implemented on Android, iOS, macOS, Linux (X11 and Wayland), and Windows. On other platforms, this method always returns -1.0.

`float screen_get_scale(int screen = -1) const`

Returns the scale factor of the specified screen by index. Returns 1.0 if screen is invalid. Note: One of the following constants can be used as screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS, or SCREEN_WITH_KEYBOARD_FOCUS. Note: On macOS, the returned value is 2.0 for hiDPI (Retina) screens, and 1.0 for all other cases. Note: On Linux (Wayland), the returned value is accurate only when screen is SCREEN_OF_MAIN_WINDOW. Due to API limitations, passing a direct index will return a rounded-up integer, if the screen has a fractional scale (e.g. 1.25 would get rounded up to 2.0). Note: This method is implemented on Android, iOS, Web, macOS, and Linux (Wayland). On other platforms, this method always returns 1.0.

`Vector2i screen_get_size(int screen = -1) const`

Returns the screen's size in pixels. See also screen_get_position() and screen_get_usable_rect(). Returns Vector2i.ZERO if screen is invalid. Note: One of the following constants can be used as screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS, or SCREEN_WITH_KEYBOARD_FOCUS.

`Rect2i screen_get_usable_rect(int screen = -1) const`

Returns the portion of the screen that is not obstructed by a status bar in pixels. See also screen_get_size(). Note: One of the following constants can be used as screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS, or SCREEN_WITH_KEYBOARD_FOCUS. Note: This method is implemented on Linux/X11, macOS, and Windows. On other platforms, this method always returns Rect2i(screen_get_position(screen), screen_get_size(screen)).

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

`void screen_set_keep_on(bool enable)`

Sets whether the screen should never be turned off by the operating system's power-saving measures. See also screen_is_kept_on().

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

Sets the screen's orientation. See also screen_get_orientation(). Note: One of the following constants can be used as screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS, or SCREEN_WITH_KEYBOARD_FOCUS. Note: This method is implemented on Android and iOS. Note: On iOS, this method has no effect if ProjectSettings.display/window/handheld/orientation is not set to SCREEN_SENSOR.

`void set_hardware_keyboard_connection_change_callback(Callable callable)`

Sets the callable that should be called when hardware keyboard is connected/disconnected. callable should accept a single bool parameter indicating whether the keyboard is connected (true) or disconnected (false). Note: This method is only implemented on Android.

`void set_icon(Image image)`

Sets the window icon (usually displayed in the top-left corner) with an Image. To use icons in the operating system's native format, use set_native_icon() instead. Note: Requires support for FEATURE_ICON.

`void set_native_icon(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, 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 set_icon() instead. Note: Requires support for FEATURE_NATIVE_ICON.

`void set_system_theme_change_callback(Callable callable)`

Sets the callable that should be called when system theme settings are changed. Callback method should have zero arguments. Note: This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).

`void show_emoji_and_symbol_picker() const`

Opens system emoji and symbol picker. Note: This method is implemented on macOS and Windows.

`Rect2 status_indicator_get_rect(int id) const`

Returns the rectangle for the given status indicator id in screen coordinates. If the status indicator is not visible, returns an empty Rect2. Note: This method is implemented on macOS and Windows.

`void status_indicator_set_callback(int id, Callable callback)`

Sets the application status indicator activation callback. callback should take two arguments: int mouse button index (one of MouseButton values) and Vector2i click position in screen coordinates. Note: This method is implemented on macOS and Windows.

`void status_indicator_set_icon(int id, Texture2D icon)`

Sets the application status indicator icon. Note: This method is implemented on macOS and Windows.

`void status_indicator_set_menu(int id, RID menu_rid)`

Sets the application status indicator native popup menu. Note: On macOS, the menu is activated by any mouse button. Its activation callback is not triggered. Note: On Windows, the menu is activated by the right mouse button, selecting the status icon and pressing Shift + F10, or the applications key. The menu's activation callback for the other mouse buttons is still triggered. Note: Native popup is only supported if NativeMenu supports the NativeMenu.FEATURE_POPUP_MENU feature.

`void status_indicator_set_tooltip(int id, String tooltip)`

Sets the application status indicator tooltip. Note: This method is implemented on macOS and Windows.

`String tablet_get_current_driver() const`

Returns current active tablet driver name. Note: This method is implemented only on Windows.

`int tablet_get_driver_count() const`

Returns the total number of available tablet drivers. Note: This method is implemented only on Windows.

`String tablet_get_driver_name(int idx) const`

Returns the tablet driver name for the given index. Note: This method is implemented only on Windows.

`void tablet_set_current_driver(String name)`

Set active tablet driver name. Supported drivers: - winink: Windows Ink API, default. - wintab: Wacom Wintab API (compatible device driver required). - dummy: Dummy driver, tablet input is disabled. Note: This method is implemented only on Windows.

`Dictionary[] tts_get_voices() const`

Returns an Array of voice information dictionaries. Each Dictionary contains two String entries: - name is voice name. - id is voice identifier. - language is language code in lang_Variant format. The lang part is a 2 or 3-letter code based on the ISO-639 standard, in lowercase. The [code skip-lint]Variant[/code] part is an engine-dependent string describing country, region or/and dialect. Note that Redot 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 Redot users on Linux, as well as end-users on Linux running Redot games that use text-to-speech. Note: This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.

`PackedStringArray tts_get_voices_for_language(String language) const`

Returns a PackedStringArray of voice identifiers for the language. Note: This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.

`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/Wayland), macOS, and Windows.

`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/Wayland), macOS, and Windows.

`void tts_pause()`

Puts the synthesizer into a paused state. Note: This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.

`void tts_resume()`

Resumes the synthesizer if it was paused. Note: This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.

`void tts_set_utterance_callback(int event, Callable callable)`

Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary. - TTS_UTTERANCE_STARTED, TTS_UTTERANCE_ENDED, and TTS_UTTERANCE_CANCELED callable's method should take one int parameter, the utterance ID. - TTS_UTTERANCE_BOUNDARY callable's method should take two 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/Wayland), macOS, and Windows.

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

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 tts_get_voices() or one of the values returned by 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/Wayland), utterance text can use SSML markup. SSML support is engine and voice dependent. If the engine does not support SSML, you should strip out all XML markup before calling 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/Wayland), macOS, and Windows.

`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/Wayland), macOS, and Windows.

`void unregister_additional_output(Object object)`

Unregisters an Object representing an additional output, that was registered via register_additional_output().

`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. Note: On Android 7 and 8, the keyboard height may return 0 the first time the keyboard is opened in non-immersive mode. This behavior does not occur in immersive mode.

`void virtual_keyboard_hide()`

Hides the virtual keyboard if it is shown, does nothing otherwise.

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

Shows the virtual keyboard if the platform has one. existing_text parameter is useful for implementing your own LineEdit or 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 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.

`void warp_mouse(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: warp_mouse() is only supported on Windows, macOS, and Linux (X11/Wayland). It has no effect on Android, iOS, and Web.

`bool window_can_draw(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.

`int window_get_active_popup() const`

Returns ID of the active popup window, or INVALID_WINDOW_ID if there is none.

`int window_get_attached_instance_id(int window_id = 0) const`

Returns the Object.get_instance_id() of the Window the window_id is attached to.

`int window_get_current_screen(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 window_set_current_screen(). Returns INVALID_SCREEN if window_id is invalid. Note: This method is implemented on Linux/X11, macOS, and Windows. On other platforms, this method always returns 0.

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

Returns the current value of the given window's flag.

`Vector2i window_get_max_size(int window_id = 0) const`

Returns the window's maximum size (in pixels). See also window_set_max_size().

`Vector2i window_get_min_size(int window_id = 0) const`

Returns the window's minimum size (in pixels). See also window_set_min_size().

`int window_get_mode(int window_id = 0) const`

Returns the mode of the given window.

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

Returns internal structure pointers for use in plugins. Note: This method is implemented on Android, Linux (X11/Wayland), macOS, and Windows.

`Rect2i window_get_popup_safe_rect(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.

`Vector2i window_get_position(int window_id = 0) const`

Returns the position of the client area of the given window on the screen.

`Vector2i window_get_position_with_decorations(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 window_get_position().

`Vector3i window_get_safe_title_margins(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 WINDOW_FLAG_EXTEND_TO_TITLE flag is set.

`Vector2i window_get_size(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 window_get_size_with_decorations(), window_set_size() and window_get_position().

`Vector2i window_get_size_with_decorations(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 window_get_size().

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

Returns the estimated window title bar size (including text and window buttons) for the window specified by window_id (in pixels). This method does not change the window title. Note: This method is implemented on macOS and Windows.

`int window_get_vsync_mode(int window_id = 0) const`

Returns the V-Sync mode of the given window.

`bool window_is_focused(int window_id = 0) const`

Returns true if the window specified by window_id is focused.

`bool window_is_maximize_allowed(int window_id = 0) const`

Returns true if the given window can be maximized (the maximize button is enabled).

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

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

`void window_move_to_foreground(int window_id = 0)`

Moves the window specified by window_id to the foreground, so that it is visible over other windows.

`void window_request_attention(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.

`void window_set_current_screen(int screen, int window_id = 0)`

Moves the window specified by window_id to the specified screen. See also window_get_current_screen(). Note: One of the following constants can be used as screen: SCREEN_OF_MAIN_WINDOW, SCREEN_PRIMARY, SCREEN_WITH_MOUSE_FOCUS, or SCREEN_WITH_KEYBOARD_FOCUS. Note: This method is implemented on Linux/X11, macOS, and Windows.

`void window_set_drop_files_callback(Callable callback, 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. callback should take one PackedStringArray argument, which is the list of dropped files. Warning: Advanced users only! Adding such a callback to a Window node will override its default implementation, which can introduce bugs. Note: This method is implemented on Windows, macOS, Linux (X11/Wayland), and Web.

`void window_set_exclusive(int window_id, 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.

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

Enables or disables the given window's given flag.

`void window_set_ime_active(bool active, int window_id = 0)`

Sets whether Input Method Editor should be enabled for the window specified by window_id. See also window_set_ime_position().

`void window_set_ime_position(Vector2i position, int window_id = 0)`

Sets the position of the Input Method Editor popup for the specified window_id. Only effective if window_set_ime_active() was set to true for the specified window_id.

`void window_set_input_event_callback(Callable callback, int window_id = 0)`

Sets the callback that should be called when any InputEvent is sent to the window specified by window_id. Warning: Advanced users only! Adding such a callback to a Window node will override its default implementation, which can introduce bugs.

`void window_set_input_text_callback(Callable callback, 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. Warning: Advanced users only! Adding such a callback to a Window node will override its default implementation, which can introduce bugs.

`void window_set_max_size(Vector2i max_size, 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 larger than the specified size. See also window_get_max_size(). Note: It's recommended to change this value using Window.max_size instead. Note: Using third-party tools, it is possible for users to disable window geometry restrictions and therefore bypass this limit.

`void window_set_min_size(Vector2i min_size, 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 smaller than the specified size. See also window_get_min_size(). Note: It's recommended to change this value using Window.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.

`void window_set_mode(int mode, int window_id = 0)`

Sets window mode for the given window to mode. Note: On Android, setting it to WINDOW_MODE_FULLSCREEN or WINDOW_MODE_EXCLUSIVE_FULLSCREEN will enable immersive mode. 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.

`void window_set_mouse_passthrough(PackedVector2Array region, 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).

				# 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([])

				// 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([]);

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.

`void window_set_popup_safe_rect(int window, 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.

`void window_set_position(Vector2i position, 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 window_get_position() and window_set_size(). Note: It's recommended to change this value using Window.position instead. Note: On Linux (Wayland): this method is a no-op.

`void window_set_rect_changed_callback(Callable callback, int window_id = 0)`

Sets the callback that will be called when the window specified by window_id is moved or resized. Warning: Advanced users only! Adding such a callback to a Window node will override its default implementation, which can introduce bugs.

`void window_set_size(Vector2i size, int window_id = 0)`

Sets the size of the given window to size (in pixels). See also window_get_size() and window_get_position(). Note: It's recommended to change this value using Window.size instead.

`void window_set_title(String title, int window_id = 0)`

Sets the title of the given window to title. Note: It's recommended to change this value using Window.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.

`void window_set_transient(int window_id, int parent_window_id)`

Sets window transient parent. Transient window will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can't enter full-screen mode. Note: It's recommended to change this value using Window.transient instead. Note: The behavior might be different depending on the platform.

`void window_set_vsync_mode(int vsync_mode, int window_id = 0)`

Sets the V-Sync mode of the given window. See also ProjectSettings.display/window/vsync/vsync_mode. Depending on the platform and used renderer, the engine will fall back to VSYNC_ENABLED if the desired mode is not supported. Note: V-Sync modes other than VSYNC_ENABLED are only supported in the Forward+ and Mobile rendering methods, not Compatibility.

`void window_set_window_buttons_offset(Vector2i offset, int window_id = 0)`

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

`void window_set_window_event_callback(Callable callback, int window_id = 0)`

Sets the callback that will be called when an event occurs in the window specified by window_id. Warning: Advanced users only! Adding such a callback to a Window node will override its default implementation, which can introduce bugs.

`void window_start_drag(int window_id = 0)`

Starts an interactive drag operation on the window with the given window_id, using the current mouse position. Call this method when handling a mouse button being pressed to simulate a pressed event on the window's title bar. Using this method allows the window to participate in space switching, tiling, and other system features. Note: This method is implemented on Linux (X11/Wayland), macOS, and Windows.

`void window_start_resize(int edge, int window_id = 0)`

Starts an interactive resize operation on the window with the given window_id, using the current mouse position. Call this method when handling a mouse button being pressed to simulate a pressed event on the window's edge. Note: This method is implemented on Linux (X11/Wayland), macOS, and Windows.

Constants

`FEATURE_GLOBAL_MENU = 0`

Enum: Feature

Deprecated.

Use NativeMenu or PopupMenu instead.

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

`FEATURE_SUBWINDOWS = 1`

Enum: Feature

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

`FEATURE_TOUCHSCREEN = 2`

Enum: Feature

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

`FEATURE_MOUSE = 3`

Enum: Feature

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

`FEATURE_MOUSE_WARP = 4`

Enum: Feature

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

`FEATURE_CLIPBOARD = 5`

Enum: Feature

Display server supports setting and getting clipboard data. See also FEATURE_CLIPBOARD_PRIMARY. Windows, macOS, Linux (X11/Wayland), Android, iOS, Web

`FEATURE_VIRTUAL_KEYBOARD = 6`

Enum: Feature

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

`FEATURE_CURSOR_SHAPE = 7`

Enum: Feature

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

`FEATURE_CUSTOM_CURSOR_SHAPE = 8`

Enum: Feature

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

`FEATURE_NATIVE_DIALOG = 9`

Enum: Feature

Display server supports spawning text dialogs using the operating system's native look-and-feel. See dialog_show(). Windows, macOS

`FEATURE_IME = 10`

Enum: Feature

Display server supports Input Method Editor, which is commonly used for inputting Chinese/Japanese/Korean text. This is handled by the operating system, rather than by Redot. Windows, macOS, Linux (X11)

`FEATURE_WINDOW_TRANSPARENCY = 11`

Enum: Feature

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

`FEATURE_HIDPI = 12`

Enum: Feature

Display server supports querying the operating system's display scale factor. This allows automatically detecting the hiDPI display reliably, instead of guessing based on the screen resolution and the display's reported DPI (which might be unreliable due to broken monitor EDID). Windows, Linux (Wayland), macOS

`FEATURE_ICON = 13`

Enum: Feature

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

`FEATURE_NATIVE_ICON = 14`

Enum: Feature

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

`FEATURE_ORIENTATION = 15`

Enum: Feature

Display server supports changing the screen orientation. Android, iOS

`FEATURE_SWAP_BUFFERS = 16`

Enum: Feature

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

`FEATURE_CLIPBOARD_PRIMARY = 18`

Enum: Feature

Display server supports Primary clipboard can be used. This is a different clipboard from FEATURE_CLIPBOARD. Linux (X11/Wayland)

`FEATURE_TEXT_TO_SPEECH = 19`

Enum: Feature

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

`FEATURE_EXTEND_TO_TITLE = 20`

Enum: Feature

Display server supports expanding window content to the title. See WINDOW_FLAG_EXTEND_TO_TITLE. macOS

`FEATURE_SCREEN_CAPTURE = 21`

Enum: Feature

Display server supports reading screen pixels. See screen_get_pixel().

`FEATURE_STATUS_INDICATOR = 22`

Enum: Feature

Display server supports application status indicators.

`FEATURE_NATIVE_HELP = 23`

Enum: Feature

Display server supports native help system search callbacks. See help_set_search_callbacks().

`FEATURE_NATIVE_DIALOG_INPUT = 24`

Enum: Feature

Display server supports spawning text input dialogs using the operating system's native look-and-feel. See dialog_input_text(). Windows, macOS

`FEATURE_NATIVE_DIALOG_FILE = 25`

Enum: Feature

Display server supports spawning dialogs for selecting files or directories using the operating system's native look-and-feel. See file_dialog_show(). Windows, macOS, Linux (X11/Wayland), Android

`FEATURE_NATIVE_DIALOG_FILE_EXTRA = 26`

Enum: Feature

The display server supports all features of FEATURE_NATIVE_DIALOG_FILE, with the added functionality of Options and native dialog file access to res:// and user:// paths. See file_dialog_show() and file_dialog_with_options_show(). Windows, macOS, Linux (X11/Wayland)

`FEATURE_WINDOW_DRAG = 27`

Enum: Feature

The display server supports initiating window drag and resize operations on demand. See window_start_drag() and window_start_resize().

`FEATURE_SCREEN_EXCLUDE_FROM_CAPTURE = 28`

Enum: Feature

Display server supports WINDOW_FLAG_EXCLUDE_FROM_CAPTURE window flag. Windows, macOS

`FEATURE_WINDOW_EMBEDDING = 29`

Enum: Feature

Display server supports embedding a window from another process. Windows, Linux (X11), macOS

`FEATURE_NATIVE_DIALOG_FILE_MIME = 30`

Enum: Feature

Native file selection dialog supports MIME types as filters.

`FEATURE_EMOJI_AND_SYMBOL_PICKER = 31`

Enum: Feature

Display server supports system emoji and symbol picker. Windows, macOS

`FEATURE_NATIVE_COLOR_PICKER = 32`

Enum: Feature

Display server supports native color picker. Linux (X11/Wayland)

`FEATURE_SELF_FITTING_WINDOWS = 33`

Enum: Feature

Display server automatically fits popups according to the screen boundaries. Window nodes should not attempt to do that themselves.

`FEATURE_ACCESSIBILITY_SCREEN_READER = 34`

Enum: Feature

Display server supports interaction with screen reader or Braille display. Linux (X11/Wayland), macOS, Windows

`ROLE_UNKNOWN = 0`

Enum: AccessibilityRole

Unknown or custom role.

`ROLE_DEFAULT_BUTTON = 1`

Enum: AccessibilityRole

Default dialog button element.

`ROLE_AUDIO = 2`

Enum: AccessibilityRole

Audio player element.

`ROLE_VIDEO = 3`

Enum: AccessibilityRole

Video player element.

`ROLE_STATIC_TEXT = 4`

Enum: AccessibilityRole

Non-editable text label.

`ROLE_CONTAINER = 5`

Enum: AccessibilityRole

Container element. Elements with this role are used for internal structure and ignored by screen readers.

`ROLE_PANEL = 6`

Enum: AccessibilityRole

Panel container element.

`ROLE_BUTTON = 7`

Enum: AccessibilityRole

Button element.

`ROLE_LINK = 8`

Enum: AccessibilityRole

Link element.

`ROLE_CHECK_BOX = 9`

Enum: AccessibilityRole

Check box element.

`ROLE_RADIO_BUTTON = 10`

Enum: AccessibilityRole

Radio button element.

`ROLE_CHECK_BUTTON = 11`

Enum: AccessibilityRole

Check button element.

`ROLE_SCROLL_BAR = 12`

Enum: AccessibilityRole

Scroll bar element.

`ROLE_SCROLL_VIEW = 13`

Enum: AccessibilityRole

Scroll container element.

`ROLE_SPLITTER = 14`

Enum: AccessibilityRole

Container splitter handle element.

`ROLE_SLIDER = 15`

Enum: AccessibilityRole

Slider element.

`ROLE_SPIN_BUTTON = 16`

Enum: AccessibilityRole

Spin box element.

`ROLE_PROGRESS_INDICATOR = 17`

Enum: AccessibilityRole

Progress indicator element.

`ROLE_TEXT_FIELD = 18`

Enum: AccessibilityRole

Editable text field element.

`ROLE_MULTILINE_TEXT_FIELD = 19`

Enum: AccessibilityRole

Multiline editable text field element.

`ROLE_COLOR_PICKER = 20`

Enum: AccessibilityRole

Color picker element.

`ROLE_TABLE = 21`

Enum: AccessibilityRole

Table element.

`ROLE_CELL = 22`

Enum: AccessibilityRole

Table/tree cell element.

`ROLE_ROW = 23`

Enum: AccessibilityRole

Table/tree row element.

`ROLE_ROW_GROUP = 24`

Enum: AccessibilityRole

Table/tree row group element.

`ROLE_ROW_HEADER = 25`

Enum: AccessibilityRole

Table/tree row header element.

`ROLE_COLUMN_HEADER = 26`

Enum: AccessibilityRole

Table/tree column header element.

`ROLE_TREE = 27`

Enum: AccessibilityRole

Tree view element.

`ROLE_TREE_ITEM = 28`

Enum: AccessibilityRole

Tree view item element.

`ROLE_LIST = 29`

Enum: AccessibilityRole

List element.

`ROLE_LIST_ITEM = 30`

Enum: AccessibilityRole

List item element.

`ROLE_LIST_BOX = 31`

Enum: AccessibilityRole

List view element.

`ROLE_LIST_BOX_OPTION = 32`

Enum: AccessibilityRole

List view item element.

`ROLE_TAB_BAR = 33`

Enum: AccessibilityRole

Tab bar element.

`ROLE_TAB = 34`

Enum: AccessibilityRole

Tab bar item element.

`ROLE_TAB_PANEL = 35`

Enum: AccessibilityRole

Tab panel element.

`ROLE_MENU_BAR = 36`

Enum: AccessibilityRole

Menu bar element.

`ROLE_MENU = 37`

Enum: AccessibilityRole

Popup menu element.

`ROLE_MENU_ITEM = 38`

Enum: AccessibilityRole

Popup menu item element.

`ROLE_MENU_ITEM_CHECK_BOX = 39`

Enum: AccessibilityRole

Popup menu check button item element.

`ROLE_MENU_ITEM_RADIO = 40`

Enum: AccessibilityRole

Popup menu radio button item element.

`ROLE_IMAGE = 41`

Enum: AccessibilityRole

Image element.

`ROLE_WINDOW = 42`

Enum: AccessibilityRole

Window element.

`ROLE_TITLE_BAR = 43`

Enum: AccessibilityRole

Embedded window title bar element.

`ROLE_DIALOG = 44`

Enum: AccessibilityRole

Dialog window element.

`ROLE_TOOLTIP = 45`

Enum: AccessibilityRole

Tooltip element.

`POPUP_MENU = 0`

Enum: AccessibilityPopupType

Popup menu.

`POPUP_LIST = 1`

Enum: AccessibilityPopupType

Popup list.

`POPUP_TREE = 2`

Enum: AccessibilityPopupType

Popup tree view.

`POPUP_DIALOG = 3`

Enum: AccessibilityPopupType

Popup dialog.

`FLAG_HIDDEN = 0`

Enum: AccessibilityFlags

Element is hidden for accessibility tools.

`FLAG_MULTISELECTABLE = 1`

Enum: AccessibilityFlags

Element is support multiple item selection.

`FLAG_REQUIRED = 2`

Enum: AccessibilityFlags

Element require user input.

`FLAG_VISITED = 3`

Enum: AccessibilityFlags

Element is a visited link.

`FLAG_BUSY = 4`

Enum: AccessibilityFlags

Element content is not ready (e.g. loading).

`FLAG_MODAL = 5`

Enum: AccessibilityFlags

Element is modal window.

`FLAG_TOUCH_PASSTHROUGH = 6`

Enum: AccessibilityFlags

Element allows touches to be passed through when a screen reader is in touch exploration mode.

`FLAG_READONLY = 7`

Enum: AccessibilityFlags

Element is text field with selectable but read-only text.

`FLAG_DISABLED = 8`

Enum: AccessibilityFlags

Element is disabled.

`FLAG_CLIPS_CHILDREN = 9`

Enum: AccessibilityFlags

Element clips children.

`ACTION_CLICK = 0`

Enum: AccessibilityAction

Single click action, callback argument is not set.

`ACTION_FOCUS = 1`

Enum: AccessibilityAction

Focus action, callback argument is not set.

`ACTION_BLUR = 2`

Enum: AccessibilityAction

Blur action, callback argument is not set.

`ACTION_COLLAPSE = 3`

Enum: AccessibilityAction

Collapse action, callback argument is not set.

`ACTION_EXPAND = 4`

Enum: AccessibilityAction

Expand action, callback argument is not set.

`ACTION_DECREMENT = 5`

Enum: AccessibilityAction

Decrement action, callback argument is not set.

`ACTION_INCREMENT = 6`

Enum: AccessibilityAction

Increment action, callback argument is not set.

`ACTION_HIDE_TOOLTIP = 7`

Enum: AccessibilityAction

Hide tooltip action, callback argument is not set.

`ACTION_SHOW_TOOLTIP = 8`

Enum: AccessibilityAction

Show tooltip action, callback argument is not set.

`ACTION_SET_TEXT_SELECTION = 9`

Enum: AccessibilityAction

Set text selection action, callback argument is set to Dictionary with the following keys: - "start_element" accessibility element of the selection start. - "start_char" character offset relative to the accessibility element of the selection start. - "end_element" accessibility element of the selection end. - "end_char" character offset relative to the accessibility element of the selection end.

`ACTION_REPLACE_SELECTED_TEXT = 10`

Enum: AccessibilityAction

Replace text action, callback argument is set to String with the replacement text.

`ACTION_SCROLL_BACKWARD = 11`

Enum: AccessibilityAction

Scroll backward action, callback argument is not set.

`ACTION_SCROLL_DOWN = 12`

Enum: AccessibilityAction

Scroll down action, callback argument is set to AccessibilityScrollUnit.

`ACTION_SCROLL_FORWARD = 13`

Enum: AccessibilityAction

Scroll forward action, callback argument is not set.

`ACTION_SCROLL_LEFT = 14`

Enum: AccessibilityAction

Scroll left action, callback argument is set to AccessibilityScrollUnit.

`ACTION_SCROLL_RIGHT = 15`

Enum: AccessibilityAction

Scroll right action, callback argument is set to AccessibilityScrollUnit.

`ACTION_SCROLL_UP = 16`

Enum: AccessibilityAction

Scroll up action, callback argument is set to AccessibilityScrollUnit.

`ACTION_SCROLL_INTO_VIEW = 17`

Enum: AccessibilityAction

Scroll into view action, callback argument is set to AccessibilityScrollHint.

`ACTION_SCROLL_TO_POINT = 18`

Enum: AccessibilityAction

Scroll to point action, callback argument is set to Vector2 with the relative point coordinates.

`ACTION_SET_SCROLL_OFFSET = 19`

Enum: AccessibilityAction

Set scroll offset action, callback argument is set to Vector2 with the scroll offset.

`ACTION_SET_VALUE = 20`

Enum: AccessibilityAction

Set value action, callback argument is set to String or number with the new value.

`ACTION_SHOW_CONTEXT_MENU = 21`

Enum: AccessibilityAction

Show context menu action, callback argument is not set.

`ACTION_CUSTOM = 22`

Enum: AccessibilityAction

Custom action, callback argument is set to the integer action ID.

`LIVE_OFF = 0`

Enum: AccessibilityLiveMode

Indicates that updates to the live region should not be presented.

`LIVE_POLITE = 1`

Enum: AccessibilityLiveMode

Indicates that updates to the live region should be presented at the next opportunity (for example at the end of speaking the current sentence).

`LIVE_ASSERTIVE = 2`

Enum: AccessibilityLiveMode

Indicates that updates to the live region have the highest priority and should be presented immediately.

`SCROLL_UNIT_ITEM = 0`

Enum: AccessibilityScrollUnit

The amount by which to scroll. A single item of a list, line of text.

`SCROLL_UNIT_PAGE = 1`

Enum: AccessibilityScrollUnit

The amount by which to scroll. A single page.

`SCROLL_HINT_TOP_LEFT = 0`

Enum: AccessibilityScrollHint

A preferred position for the node scrolled into view. Top-left edge of the scroll container.

`SCROLL_HINT_BOTTOM_RIGHT = 1`

Enum: AccessibilityScrollHint

A preferred position for the node scrolled into view. Bottom-right edge of the scroll container.

`SCROLL_HINT_TOP_EDGE = 2`

Enum: AccessibilityScrollHint

A preferred position for the node scrolled into view. Top edge of the scroll container.

`SCROLL_HINT_BOTTOM_EDGE = 3`

Enum: AccessibilityScrollHint

A preferred position for the node scrolled into view. Bottom edge of the scroll container.

`SCROLL_HINT_LEFT_EDGE = 4`

Enum: AccessibilityScrollHint

A preferred position for the node scrolled into view. Left edge of the scroll container.

`SCROLL_HINT_RIGHT_EDGE = 5`

Enum: AccessibilityScrollHint

A preferred position for the node scrolled into view. Right edge of the scroll container.

`MOUSE_MODE_VISIBLE = 0`

Enum: MouseMode

Makes the mouse cursor visible if it is hidden.

`MOUSE_MODE_HIDDEN = 1`

Enum: MouseMode

Makes the mouse cursor hidden if it is visible.

`MOUSE_MODE_CAPTURED = 2`

Enum: MouseMode

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 InputEventMouseMotion.relative.

`MOUSE_MODE_CONFINED = 3`

Enum: MouseMode

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

`MOUSE_MODE_CONFINED_HIDDEN = 4`

Enum: MouseMode

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

`MOUSE_MODE_MAX = 5`

Enum: MouseMode

Max value of the MouseMode.

`INVALID_SCREEN = -1`

The ID that refers to a screen that does not exist. This is returned by some DisplayServer methods if no screen matches the requested result.

`SCREEN_WITH_MOUSE_FOCUS = -4`

Represents the screen containing the mouse pointer. Note: On Android, iOS, Web, and Linux (Wayland), this constant always represents the screen at index 0.

`SCREEN_WITH_KEYBOARD_FOCUS = -3`

Represents the screen containing the window with the keyboard focus. Note: On Android, iOS, Web, and Linux (Wayland), this constant always represents the screen at index 0.

`SCREEN_PRIMARY = -2`

Represents the primary screen. Note: On Android, iOS, Web, and Linux (Wayland), this constant always represents the screen at index 0.

`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. Note: On Android, iOS, Web, and Linux (Wayland), this constant always represents the screen at index 0.

`MAIN_WINDOW_ID = 0`

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

`INVALID_WINDOW_ID = -1`

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

`INVALID_INDICATOR_ID = -1`

The ID that refers to a nonexistent application status indicator.

`SCREEN_LANDSCAPE = 0`

Enum: ScreenOrientation

Default landscape orientation.

`SCREEN_PORTRAIT = 1`

Enum: ScreenOrientation

Default portrait orientation.

`SCREEN_REVERSE_LANDSCAPE = 2`

Enum: ScreenOrientation

Reverse landscape orientation (upside down).

`SCREEN_REVERSE_PORTRAIT = 3`

Enum: ScreenOrientation

Reverse portrait orientation (upside down).

`SCREEN_SENSOR_LANDSCAPE = 4`

Enum: ScreenOrientation

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

`SCREEN_SENSOR_PORTRAIT = 5`

Enum: ScreenOrientation

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

`SCREEN_SENSOR = 6`

Enum: ScreenOrientation

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

`KEYBOARD_TYPE_DEFAULT = 0`

Enum: VirtualKeyboardType

Default text virtual keyboard.

`KEYBOARD_TYPE_MULTILINE = 1`

Enum: VirtualKeyboardType

Multiline virtual keyboard.

`KEYBOARD_TYPE_NUMBER = 2`

Enum: VirtualKeyboardType

Virtual number keypad, useful for PIN entry.

`KEYBOARD_TYPE_NUMBER_DECIMAL = 3`

Enum: VirtualKeyboardType

Virtual number keypad, useful for entering fractional numbers.

`KEYBOARD_TYPE_PHONE = 4`

Enum: VirtualKeyboardType

Virtual phone number keypad.

`KEYBOARD_TYPE_EMAIL_ADDRESS = 5`

Enum: VirtualKeyboardType

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

`KEYBOARD_TYPE_PASSWORD = 6`

Enum: VirtualKeyboardType

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

`KEYBOARD_TYPE_URL = 7`

Enum: VirtualKeyboardType

Virtual keyboard with additional keys to assist with typing URLs.

`CURSOR_ARROW = 0`

Enum: CursorShape

Arrow cursor shape. This is the default when not pointing anything that overrides the mouse cursor, such as a LineEdit or TextEdit.

`CURSOR_IBEAM = 1`

Enum: CursorShape

I-beam cursor shape. This is used by default when hovering a control that accepts text input, such as LineEdit or TextEdit.

`CURSOR_POINTING_HAND = 2`

Enum: CursorShape

Pointing hand cursor shape. This is used by default when hovering a LinkButton or a URL tag in a RichTextLabel.

`CURSOR_CROSS = 3`

Enum: CursorShape

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.

`CURSOR_WAIT = 4`

Enum: CursorShape

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

`CURSOR_BUSY = 5`

Enum: CursorShape

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

`CURSOR_DRAG = 6`

Enum: CursorShape

Dragging hand cursor. This is displayed during drag-and-drop operations. See also CURSOR_CAN_DROP.

`CURSOR_CAN_DROP = 7`

Enum: CursorShape

"Can drop" cursor. This is displayed during drag-and-drop operations if hovering over a 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 CURSOR_DRAG.

`CURSOR_FORBIDDEN = 8`

Enum: CursorShape

Forbidden cursor. This is displayed during drag-and-drop operations if the hovered Control can't accept the drag-and-drop event.

`CURSOR_VSIZE = 9`

Enum: CursorShape

Vertical resize cursor. Intended to be displayed when the hovered Control can be vertically resized using the mouse. See also CURSOR_VSPLIT.

`CURSOR_HSIZE = 10`

Enum: CursorShape

Horizontal resize cursor. Intended to be displayed when the hovered Control can be horizontally resized using the mouse. See also CURSOR_HSPLIT.

`CURSOR_BDIAGSIZE = 11`

Enum: CursorShape

Secondary diagonal resize cursor (top-right/bottom-left). Intended to be displayed when the hovered Control can be resized on both axes at once using the mouse.

`CURSOR_FDIAGSIZE = 12`

Enum: CursorShape

Main diagonal resize cursor (top-left/bottom-right). Intended to be displayed when the hovered Control can be resized on both axes at once using the mouse.

`CURSOR_MOVE = 13`

Enum: CursorShape

Move cursor. Intended to be displayed when the hovered Control can be moved using the mouse.

`CURSOR_VSPLIT = 14`

Enum: CursorShape

Vertical split cursor. This is displayed when hovering a Control with splits that can be vertically resized using the mouse, such as VSplitContainer. On some cursor themes, this cursor may have the same appearance as CURSOR_VSIZE.

`CURSOR_HSPLIT = 15`

Enum: CursorShape

Horizontal split cursor. This is displayed when hovering a Control with splits that can be horizontally resized using the mouse, such as HSplitContainer. On some cursor themes, this cursor may have the same appearance as CURSOR_HSIZE.

`CURSOR_HELP = 16`

Enum: CursorShape

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.

`CURSOR_MAX = 17`

Enum: CursorShape

Represents the size of the CursorShape enum.

`FILE_DIALOG_MODE_OPEN_FILE = 0`

Enum: FileDialogMode

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

`FILE_DIALOG_MODE_OPEN_FILES = 1`

Enum: FileDialogMode

The native file dialog allows selecting multiple files.

`FILE_DIALOG_MODE_OPEN_DIR = 2`

Enum: FileDialogMode

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

`FILE_DIALOG_MODE_OPEN_ANY = 3`

Enum: FileDialogMode

The native file dialog allows selecting one file or directory.

`FILE_DIALOG_MODE_SAVE_FILE = 4`

Enum: FileDialogMode

The native file dialog will warn when a file exists.

`WINDOW_MODE_WINDOWED = 0`

Enum: WindowMode

Windowed mode, i.e. Window doesn't occupy the whole screen (unless set to the size of the screen).

`WINDOW_MODE_MINIMIZED = 1`

Enum: WindowMode

Minimized window mode, i.e. Window is not visible and available on window manager's window list. Normally happens when the minimize button is pressed.

`WINDOW_MODE_MAXIMIZED = 2`

Enum: WindowMode

Maximized window mode, i.e. Window will occupy whole screen area except task bar and still display its borders. Normally happens when the maximize button is pressed.

`WINDOW_MODE_FULLSCREEN = 3`

Enum: WindowMode

Full screen mode with full multi-window support. Full screen window covers the entire display area of a screen and has no decorations. The display's video mode is not changed. On Android: This enables immersive mode. On macOS: A new desktop is used to display the running project. 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 multiple resolutions when enabling full screen mode.

`WINDOW_MODE_EXCLUSIVE_FULLSCREEN = 4`

Enum: WindowMode

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 covers the entire display area of a screen and has no border or decorations. The display's video mode is not changed. Note: This mode might not work with screen recording software. On Android: This enables immersive mode. On Windows: Depending on video driver, full screen transition might cause screens to go black for a moment. On macOS: A new desktop is used to display the running project. Exclusive full screen mode prevents Dock and Menu from showing up when the mouse pointer is hovering the edge of the screen. On Linux (X11): Exclusive full screen mode bypasses compositor. On Linux (Wayland): Equivalent to WINDOW_MODE_FULLSCREEN. 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 multiple resolutions when enabling full screen mode.

`WINDOW_FLAG_RESIZE_DISABLED = 0`

Enum: WindowFlags

The window can't be resized by dragging its resize grip. It's still possible to resize the window using window_set_size(). This flag is ignored for full screen windows.

`WINDOW_FLAG_BORDERLESS = 1`

Enum: WindowFlags

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

`WINDOW_FLAG_ALWAYS_ON_TOP = 2`

Enum: WindowFlags

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

`WINDOW_FLAG_TRANSPARENT = 3`

Enum: WindowFlags

The window background can be transparent. Note: This flag has no effect if is_window_transparency_available() returns false. Note: Transparency support is implemented on Linux (X11/Wayland), macOS, and Windows, but availability might vary depending on GPU driver, display manager, and compositor capabilities. Note: Transparency support is implemented on Android, but can only be enabled via ProjectSettings.display/window/per_pixel_transparency/allowed. This flag has no effect on Android.

`WINDOW_FLAG_NO_FOCUS = 4`

Enum: WindowFlags

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

`WINDOW_FLAG_POPUP = 5`

Enum: WindowFlags

Window is part of menu or 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 window_set_transient()).

`WINDOW_FLAG_EXTEND_TO_TITLE = 6`

Enum: WindowFlags

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 window_set_window_buttons_offset() to adjust minimize/maximize/close buttons offset. Use 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.

`WINDOW_FLAG_MOUSE_PASSTHROUGH = 7`

Enum: WindowFlags

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

`WINDOW_FLAG_SHARP_CORNERS = 8`

Enum: WindowFlags

Window style is overridden, forcing sharp corners. Note: This flag is implemented only on Windows (11).

`WINDOW_FLAG_EXCLUDE_FROM_CAPTURE = 9`

Enum: WindowFlags

Window is excluded from screenshots taken by screen_get_image(), screen_get_image_rect(), and screen_get_pixel(). Note: This flag is implemented on macOS and Windows (10, 20H1). Note: Setting this flag will prevent standard screenshot methods from capturing a window image, but does NOT guarantee that other apps won't be able to capture an image. It should not be used as a DRM or security measure.

`WINDOW_FLAG_POPUP_WM_HINT = 10`

Enum: WindowFlags

Signals the window manager that this window is supposed to be an implementation-defined "popup" (usually a floating, borderless, untileable and immovable child window).

`WINDOW_FLAG_MINIMIZE_DISABLED = 11`

Enum: WindowFlags

Window minimize button is disabled. Note: This flag is implemented on macOS and Windows.

`WINDOW_FLAG_MAXIMIZE_DISABLED = 12`

Enum: WindowFlags

Window maximize button is disabled. Note: This flag is implemented on macOS and Windows.

`WINDOW_FLAG_MAX = 13`

Enum: WindowFlags

Max value of the WindowFlags.

`WINDOW_EVENT_MOUSE_ENTER = 0`

Enum: WindowEvent

Sent when the mouse pointer enters the window.

`WINDOW_EVENT_MOUSE_EXIT = 1`

Enum: WindowEvent

Sent when the mouse pointer exits the window.

`WINDOW_EVENT_FOCUS_IN = 2`

Enum: WindowEvent

Sent when the window grabs focus.

`WINDOW_EVENT_FOCUS_OUT = 3`

Enum: WindowEvent

Sent when the window loses focus.

`WINDOW_EVENT_CLOSE_REQUEST = 4`

Enum: WindowEvent

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

`WINDOW_EVENT_GO_BACK_REQUEST = 5`

Enum: WindowEvent

Sent when the device "Back" button is pressed. Note: This event is implemented only on Android.

`WINDOW_EVENT_DPI_CHANGE = 6`

Enum: WindowEvent

Sent when the window is moved to the display with different DPI, or display DPI is changed. Note: This flag is implemented only on macOS and Linux (Wayland).

`WINDOW_EVENT_TITLEBAR_CHANGE = 7`

Enum: WindowEvent

Sent when the window title bar decoration is changed (e.g. WINDOW_FLAG_EXTEND_TO_TITLE is set or window entered/exited full screen mode). Note: This flag is implemented only on macOS.

`WINDOW_EVENT_FORCE_CLOSE = 8`

Enum: WindowEvent

Sent when the window has been forcibly closed by the Display Server. The window shall immediately hide and clean any internal rendering references. Note: This flag is implemented only on Linux (Wayland).

`WINDOW_EDGE_TOP_LEFT = 0`

Enum: WindowResizeEdge

Top-left edge of a window.

`WINDOW_EDGE_TOP = 1`

Enum: WindowResizeEdge

Top edge of a window.

`WINDOW_EDGE_TOP_RIGHT = 2`

Enum: WindowResizeEdge

Top-right edge of a window.

`WINDOW_EDGE_LEFT = 3`

Enum: WindowResizeEdge

Left edge of a window.

`WINDOW_EDGE_RIGHT = 4`

Enum: WindowResizeEdge

Right edge of a window.

`WINDOW_EDGE_BOTTOM_LEFT = 5`

Enum: WindowResizeEdge

Bottom-left edge of a window.

`WINDOW_EDGE_BOTTOM = 6`

Enum: WindowResizeEdge

Bottom edge of a window.

`WINDOW_EDGE_BOTTOM_RIGHT = 7`

Enum: WindowResizeEdge

Bottom-right edge of a window.

`WINDOW_EDGE_MAX = 8`

Enum: WindowResizeEdge

Represents the size of the WindowResizeEdge enum.

`VSYNC_DISABLED = 0`

Enum: VSyncMode

No vertical synchronization, which means the engine will display frames as fast as possible (tearing may be visible). Framerate is unlimited (regardless of Engine.max_fps).

`VSYNC_ENABLED = 1`

Enum: VSyncMode

Default vertical synchronization mode, the image is displayed only on vertical blanking intervals (no tearing is visible). Framerate is limited by the monitor refresh rate (regardless of Engine.max_fps).

`VSYNC_ADAPTIVE = 2`

Enum: VSyncMode

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

`VSYNC_MAILBOX = 3`

Enum: VSyncMode

Displays the most recent image in the queue on vertical blanking intervals, while rendering to the other images (no tearing is visible). Framerate is unlimited (regardless of Engine.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). VSYNC_MAILBOX works best when at least twice as many frames as the display refresh rate are rendered. Behaves like VSYNC_ENABLED when using the Compatibility rendering method.

`DISPLAY_HANDLE = 0`

Enum: HandleType

Display handle: - Linux (X11): X11::Display* for the display. - Linux (Wayland): wl_display for the display. - Android: EGLDisplay for the display.

`WINDOW_HANDLE = 1`

Enum: HandleType

Window handle: - Windows: HWND for the window. - Linux (X11): X11::Window* for the window. - Linux (Wayland): wl_surface for the window. - macOS: NSWindow* for the window. - iOS: UIViewController* for the view controller. - Android: jObject for the activity.

`WINDOW_VIEW = 2`

Enum: HandleType

Window view: - Windows: HDC for the window (only with the Compatibility renderer). - macOS: NSView* for the window main view. - iOS: UIView* for the window main view.

`OPENGL_CONTEXT = 3`

Enum: HandleType

OpenGL context (only with the Compatibility renderer): - Windows: HGLRC for the window (native GL), or EGLContext for the window (ANGLE). - Linux (X11): GLXContext* for the window. - Linux (Wayland): EGLContext for the window. - macOS: NSOpenGLContext* for the window (native GL), or EGLContext for the window (ANGLE). - Android: EGLContext for the window.

`EGL_DISPLAY = 4`

Enum: HandleType

- Windows: EGLDisplay for the window (ANGLE). - macOS: EGLDisplay for the window (ANGLE). - Linux (Wayland): EGLDisplay for the window.

`EGL_CONFIG = 5`

Enum: HandleType

- Windows: EGLConfig for the window (ANGLE). - macOS: EGLConfig for the window (ANGLE). - Linux (Wayland): EGLConfig for the window.

`TTS_UTTERANCE_STARTED = 0`

Enum: TTSUtteranceEvent

Utterance has begun to be spoken.

`TTS_UTTERANCE_ENDED = 1`

Enum: TTSUtteranceEvent

Utterance was successfully finished.

`TTS_UTTERANCE_CANCELED = 2`

Enum: TTSUtteranceEvent

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

`TTS_UTTERANCE_BOUNDARY = 3`

Enum: TTSUtteranceEvent

Utterance reached a word or sentence boundary.

Source revision 5592dc3a7a61