A server interface for low-level window management.
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.
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.
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.
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.
If is_last_line is true, no trailing newline is appended to the text content. Set to true for the last line in multi-line text fields and for single-line text fields.
Frees the accessibility element id created by accessibility_create_element(), accessibility_create_sub_element(), or accessibility_create_sub_text_edit_elements().
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, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD), do not count as assistive apps and will not affect this value. To test your project with these tools, set ProjectSettings.accessibility/general/accessibility_support to 1.
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.
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.
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.
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.
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.
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.
Adds a child accessibility element.
Note: Node children and sub-elements are added to the child list automatically.
Adds support for a custom accessibility action. action_id is passed as an argument to the callback of ACTION_CUSTOM action.
Sets element flag.
Sets popup type for popup buttons.
Sets cell position in the table.
Sets text underline/overline/strikethrough.
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.
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.
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.
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).
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).
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).
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).
Returns the default mouse cursor shape set by cursor_set_shape().
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().
Note: On Web, calling this method every frame can cause the cursor to flicker.
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().
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.
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.
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.
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.
Note: current_directory might be ignored.
Note: Embedded file dialogs and Windows file dialogs 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.
Note: On Android, this method uses the Android Storage Access Framework (SAF).
The file picker returns a URI instead of a filesystem path. This URI can be passed directly to FileAccess to perform read/write operations.
When using FILE_DIALOG_MODE_OPEN_DIR, it returns a tree URI that grants full access to the selected directory. File operations inside this directory can be performed by passing a path on the form treeUri#relative/path/to/file to FileAccess.
To avoid opening the file picker again after each app restart, you can take persistable URI permission as follows:
val uri = "content://com.android..." # URI of the selected file or folder.
val persist = true # Set to false to release the persistable permission.
var android_runtime = Engine.get_singleton("AndroidRuntime")
android_runtime.updatePersistableUriPermission(uri, persist)The persistable URI permission remains valid across app restarts as long as the directory is not moved, renamed, or deleted.
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 dialogs and Windows file dialogs 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.
Forces window manager processing while ignoring all InputEvents. See also process_events().
Note: This method is implemented on Windows and macOS.
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).
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.
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.
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().
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.
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).
Returns the index of the primary screen.
Note: This method is implemented on Linux/X11, macOS, and Windows. On other platforms, this method always returns 0.
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.
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.
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 dialog_show().
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) +-------+
| |
+-------------+ | |
| | | |
| | | |
+-------------+ +-------+Returns the list of Godot window IDs belonging to this process.
Note: Native dialogs are not included in this list.
Returns true if any additional outputs have been registered via register_additional_output().
Returns true if the specified feature is supported by the current DisplayServer, false otherwise.
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.
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.
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.
Returns the composition string contained within the Input Method Editor window.
Note: This method is implemented only on macOS.
Returns true if OS is using dark mode.
Note: This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
Returns true if OS supports dark mode.
Note: This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
Returns true if the application is in picture-in-picture mode.
Note: This method is implemented on Android.
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.
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.
Returns active keyboard layout index.
Note: This method is implemented on Linux (X11/Wayland), macOS, and Windows.
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.
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.
Returns the number of keyboard layouts.
Note: This method is implemented on Linux (X11/Wayland), macOS and Windows.
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.
Returns the localized name of the keyboard layout at position index.
Note: This method is implemented on Linux (X11/Wayland), macOS and Windows.
Sets the active keyboard layout.
Note: This method is implemented on Linux (X11/Wayland), macOS and Windows.
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().
Returns the current mouse mode. See also mouse_set_mode().
Sets the current mouse mode. See also mouse_get_mode().
Specifies whether picture-in-picture mode should be entered automatically when the application goes in the background.
Note: This method is implemented on Android.
Perform window manager processing, including input flushing. See also force_process_and_drop_events(), Input.flush_buffered_events() and Input.use_accumulated_input.
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 Godot from skipping rendering when no normal windows are visible.
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 dpiNote: This method is implemented on Android, iOS, Linux (X11/Wayland), macOS, Web, and Windows. On other platforms, this method always returns 72.
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.
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.
Returns the greatest scale factor of all screens. See also screen_get_scale().
Note: On macOS, the returned value is 2.0 if there is at least one hiDPI (Retina) screen in the system, and 1.0 in all other cases.
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.
Returns the color of the pixel at the given screen position. On multi-monitor setups, the screen position is relative to the virtual desktop area.
Note: This method is implemented on Linux (X11, excluding XWayland), macOS, and Windows. On other platforms, this method always returns Color(0, 0, 0, 1).
Note: On macOS, this method requires the "Screen Recording" permission. If permission is not granted, this method returns a color from a screenshot that will not include other application windows or OS elements not related to the application.
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.
Returns the current refresh rate of the specified screen. When V-Sync is enabled, this returns the maximum framerate the project can effectively reach. 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.0Note: 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.
Returns the scale factor of the specified screen by index. Returns 1.0 if screen is invalid. See also screen_get_max_scale().
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.
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.
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)).
Returns true if the screen should never be turned off by the operating system's power-saving measures. See also screen_set_keep_on().
Sets whether the screen should never be turned off by the operating system's power-saving measures. See also screen_is_kept_on().
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.
Sets the callback that should be called when a hardware keyboard is connected or disconnected. callable should accept a single bool argument indicating whether the keyboard has been connected (true) or disconnected (false).
Note: This method is only implemented on Android.
Sets the application icon and icons of all windows with an Image. To use icons in the operating system's native format, use set_native_icon() instead.
Note: Requires support for FEATURE_ICON.
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.
Sets the callback that should be called when the system's theme settings are changed. callable should accept zero arguments.
Note: This method is implemented on Android, iOS, macOS, Windows, and Linux (X11/Wayland).
Opens system emoji and symbol picker.
Note: This method is implemented on macOS and Windows.
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.
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.
Sets the application status indicator tooltip.
Note: This method is implemented on macOS and Windows.
Returns the total number of available tablet drivers.
Note: This method is implemented only on Windows.
Returns the tablet driver name for the given index.
Note: This method is implemented only on Windows.
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.
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 Godot depends on system libraries for text-to-speech functionality. These libraries are installed by default on Windows and macOS, but not on all Linux distributions. If they are not present, this method will return an empty list. This applies to both Godot users on Linux, as well as end-users on Linux running Godot games that use text-to-speech.
Note: This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
Returns a PackedStringArray of voice identifiers for the language.
Note: This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
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.
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.
Puts the synthesizer into a paused state.
Note: This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
Resumes the synthesizer if it was paused.
Note: This method is implemented on Android, iOS, Web, Linux (X11/Wayland), macOS, and Windows.
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.
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.
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.
Unregisters an Object representing an additional output, that was registered via register_additional_output().
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.
Hides the virtual keyboard if it is shown, does nothing otherwise.
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.
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.
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.
Returns ID of the active popup window, or INVALID_WINDOW_ID if there is none.
Returns the Object.get_instance_id() of the Window the window_id is attached to.
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.
When window_is_hdr_output_enabled() returns true, this returns the current maximum luminance in nits (cd/m²) for HDR output by the window specified by window_id. If the maximum luminance is being automatically adjusted based on the screen's capabilities, this method will return that value. Otherwise, it will return the value set by window_set_hdr_output_max_luminance(). This maximum luminance value is used when calculating window_get_output_max_linear_value().
Note: This maximum luminance may not match the physical behavior of the screen, but will always be proportionally correct relative to window_get_hdr_output_current_reference_luminance().
When window_is_hdr_output_enabled() returns true, this returns the current reference white luminance in nits (cd/m²) for HDR output by the window specified by window_id. If the reference luminance is being automatically adjusted to match the operating system brightness, this will return that value. Otherwise, it will return the value set by window_set_hdr_output_reference_luminance(). This reference luminance value is used when calculating window_get_output_max_linear_value().
Note: This reference white luminance may not match the physical behavior of the screen, but will always be proportionally correct relative to window_get_hdr_output_current_max_luminance().
Returns the maximum luminance in nits (cd/m²) set for HDR output by the window specified by window_id. Negative values indicate that the value is being automatically adjusted based on the screen's capabilities. See also window_get_hdr_output_current_max_luminance().
Returns the reference white luminance in nits (cd/m²) set for HDR output by the window specified by window_id. Negative values indicate that the value is being automatically adjusted to match the operating system brightness. See also window_get_hdr_output_current_reference_luminance().
Returns the window's maximum size (in pixels). See also window_set_max_size().
Returns the window's minimum size (in pixels). See also window_set_min_size().
Returns internal structure pointers for use in plugins.
Note: This method is implemented on Android, Linux (X11/Wayland), macOS, and Windows.
Returns the maximum value for linear color components that can be displayed for the window specified by window_id, regardless of SDR or HDR output. Returns 1.0 if HDR is not enabled or not supported. When HDR output is enabled, this is calculated based on window_get_hdr_output_current_reference_luminance() and window_get_hdr_output_current_max_luminance(). The Window.output_max_linear_value_changed signal will be emitted whenever this value changes. This value is used by tonemapping and other Environment effects to ensure that bright colors are presented in the range that can be displayed by this window. Corresponds to Window.get_output_max_linear_value().
Returns the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system.
Returns the position of the given window on the screen including the borders drawn by the operating system. See also window_get_position().
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.
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().
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().
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.
Returns true if HDR output is currently enabled for the window specified by window_id. The returned value may change dynamically based on system settings, screen capabilities, and which screen the window is currently on.
Returns true if HDR output is requested for the window specified by window_id. Corresponds to Window.hdr_output_requested.
Returns true if the window specified by window_id supports HDR output. This depends on the platform, screen capabilities, system settings, and the screen the window is currently on.
Returns true if double-clicking on a window's title should maximize it.
Note: This method is implemented only on macOS.
Returns true if double-clicking on a window's title should minimize it.
Note: This method is implemented only on macOS.
Moves the window specified by window_id to the foreground, so that it is visible over other windows.
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.
If enable is true, HDR output is requested for the window specified by window_id. The window will automatically switch between HDR and SDR if it is moved between screens, screen capabilities change, or system settings are modified. This will internally force Viewport.use_hdr_2d to be enabled on the main Viewport. All other SubViewport of the Window must have their Viewport.use_hdr_2d property enabled to produce HDR output. Corresponds to Window.hdr_output_requested.
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.
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.
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.
Sets the maximum luminance in nits (cd/m²) for HDR output by the window specified by window_id. If max_luminance is negative, the window uses the screen's maximum luminance that is reported by the operating system. By default, this luminance is set to -1.0 for every window. Typically this property should be left at this default value, but may optionally be exposed through in-game settings to allow the player to correct an inaccurate maximum luminance reported by the operating system. See also window_get_hdr_output_current_max_luminance() and window_get_hdr_output_max_luminance().
Note: This method is only implemented on macOS and Windows. Other platforms will always use the screen's maximum luminance that is reported by the operating system.
Sets the reference white luminance in nits (cd/m²) for HDR output by the window specified by window_id. If reference_luminance is negative, the window automatically adjusts to the brightness set by the operating system. By default, this luminance is set to -1.0 for every window. Typically this property should be left at this default value, but may optionally be exposed as an "HDR Brightness" in-game setting to allow the player to adjust the brightness of their game, independently of their device settings. See also window_get_hdr_output_current_reference_luminance() and window_get_hdr_output_reference_luminance().
Note: This method is only implemented on Windows. Other platforms will always use the reference luminance that is reported by the operating system.
Sets the window icon (usually displayed in the top-left corner) for the window specified by window_id.
Note: This method is implemented on Linux and Windows.
Sets whether Input Method Editor should be enabled for the window specified by window_id. See also window_set_ime_position().
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.
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.
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.
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.
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.
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.
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([])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.
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.
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.
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.
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.
Sets the type and state of the progress bar on the taskbar/dock icon of the window specified by window_id. See ProgressState for possible values and how each mode behaves.
Note: This method is implemented only on Windows and macOS.
Note: On macOS, the progress bar is displayed only for the main window.
Creates a progress bar on the taskbar/dock icon of the window specified by window_id if it does not exist, sets the progress of the icon.
value acts as a relative percentage value, ranges from 0.0 (lowest) to 1.0 (highest).
Note: This method is implemented only on Windows and macOS.
Note: On macOS, the progress bar is displayed only for the main window.
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.
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.
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.
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.
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.
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.
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.
Emitted when the device orientation changes. orientation is the new orientation.
Returns 1 for portrait, 2 for landscape, and 0 if the orientation is undefined.
Note: This method is implemented on Android and iOS.
FEATURE_GLOBAL_MENU = 0Display server supports global menu. This allows the application to display its menu items in the operating system's top bar. macOS
FEATURE_SUBWINDOWS = 1Display server supports multiple windows that can be moved outside of the main window. Windows, macOS, Linux (X11)
FEATURE_TOUCHSCREEN = 2Display server supports touchscreen input. Windows, Linux (X11/Wayland), Android, iOS, Web
FEATURE_MOUSE = 3Display server supports mouse input. Windows, macOS, Linux (X11/Wayland), Android, Web
FEATURE_MOUSE_WARP = 4Display 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 = 5Display server supports setting and getting clipboard data. See also FEATURE_CLIPBOARD_PRIMARY. Windows, macOS, Linux (X11/Wayland), Android, iOS, Web
FEATURE_VIRTUAL_KEYBOARD = 6Display server supports popping up a virtual keyboard when requested to input text without a physical keyboard. Android, iOS, Web
FEATURE_CURSOR_SHAPE = 7Display server supports setting the mouse cursor shape to be different from the default. Windows, macOS, Linux (X11/Wayland), Android, Web
FEATURE_CUSTOM_CURSOR_SHAPE = 8Display server supports setting the mouse cursor shape to a custom image. Windows, macOS, Linux (X11/Wayland), Web
FEATURE_NATIVE_DIALOG = 9Display server supports spawning text dialogs using the operating system's native look-and-feel. See dialog_show(). Windows, macOS
FEATURE_IME = 10Display 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 Godot. Windows, macOS, Linux (X11)
FEATURE_WINDOW_TRANSPARENCY = 11Display 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 = 12Display 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 = 13Display server supports changing the window icon (usually displayed in the top-left corner). Windows, macOS, Linux (X11/Wayland)
Note: Use on Wayland requires the compositor to implement the xdg_toplevel_icon_v1 protocol, which not all compositors do. See xdg_toplevel_icon_v1#compositor-support for more information on individual compositor support.
FEATURE_NATIVE_ICON = 14Display server supports changing the window icon (usually displayed in the top-left corner). Windows, macOS
FEATURE_ORIENTATION = 15Display server supports changing the screen orientation. Android, iOS
FEATURE_SWAP_BUFFERS = 16Display 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 = 18Display server supports Primary clipboard can be used. This is a different clipboard from FEATURE_CLIPBOARD. Linux (X11/Wayland)
FEATURE_TEXT_TO_SPEECH = 19Display server supports text-to-speech. See tts_* methods. Windows, macOS, Linux (X11/Wayland), Android, iOS, Web
FEATURE_EXTEND_TO_TITLE = 20Display server supports expanding window content to the title. See WINDOW_FLAG_EXTEND_TO_TITLE. macOS
FEATURE_SCREEN_CAPTURE = 21Display server supports reading screen pixels. See screen_get_pixel().
FEATURE_STATUS_INDICATOR = 22Display server supports application status indicators.
FEATURE_NATIVE_HELP = 23Display server supports native help system search callbacks. See help_set_search_callbacks().
FEATURE_NATIVE_DIALOG_INPUT = 24Display 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 = 25Display 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 = 26The 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 = 27The display server supports initiating window drag and resize operations on demand. See window_start_drag() and window_start_resize().
FEATURE_SCREEN_EXCLUDE_FROM_CAPTURE = 28Display server supports WINDOW_FLAG_EXCLUDE_FROM_CAPTURE window flag. Windows, macOS
FEATURE_WINDOW_EMBEDDING = 29Display server supports embedding a window from another process. Windows, Linux (X11), macOS
FEATURE_NATIVE_DIALOG_FILE_MIME = 30Native file selection dialog supports MIME types as filters.
FEATURE_EMOJI_AND_SYMBOL_PICKER = 31Display server supports system emoji and symbol picker. Windows, macOS
FEATURE_NATIVE_COLOR_PICKER = 32Display server supports native color picker. Linux (X11/Wayland)
FEATURE_SELF_FITTING_WINDOWS = 33Display server automatically fits popups according to the screen boundaries. Window nodes should not attempt to do that themselves.
FEATURE_ACCESSIBILITY_SCREEN_READER = 34Display server supports interaction with screen reader or Braille display. Linux (X11/Wayland), macOS, Windows
FEATURE_HDR_OUTPUT = 35Display server supports HDR output. Linux (Wayland), macOS, iOS, visionOS, Windows
FEATURE_PIP_MODE = 36Display server supports putting the application in picture-in-picture mode. Android
ROLE_UNKNOWN = 0Unknown or custom role.
ROLE_DEFAULT_BUTTON = 1Default dialog button element.
ROLE_AUDIO = 2Audio player element.
ROLE_VIDEO = 3Video player element.
ROLE_STATIC_TEXT = 4Non-editable text label.
ROLE_CONTAINER = 5Container element. Elements with this role are used for internal structure and ignored by screen readers.
ROLE_PANEL = 6Panel container element.
ROLE_BUTTON = 7Button element.
ROLE_LINK = 8Link element.
ROLE_CHECK_BOX = 9Check box element.
ROLE_RADIO_BUTTON = 10Radio button element.
ROLE_CHECK_BUTTON = 11Check button element.
ROLE_SCROLL_BAR = 12Scroll bar element.
ROLE_SCROLL_VIEW = 13Scroll container element.
ROLE_SPLITTER = 14Container splitter handle element.
ROLE_SLIDER = 15Slider element.
ROLE_SPIN_BUTTON = 16Spin box element.
ROLE_PROGRESS_INDICATOR = 17Progress indicator element.
ROLE_TEXT_FIELD = 18Editable text field element.
ROLE_MULTILINE_TEXT_FIELD = 19Multiline editable text field element.
ROLE_COLOR_PICKER = 20Color picker element.
ROLE_TABLE = 21Table element.
ROLE_CELL = 22Table/tree cell element.
ROLE_ROW = 23Table/tree row element.
ROLE_ROW_GROUP = 24Table/tree row group element.
ROLE_ROW_HEADER = 25Table/tree row header element.
ROLE_COLUMN_HEADER = 26Table/tree column header element.
ROLE_TREE = 27Tree view element.
ROLE_TREE_ITEM = 28Tree view item element.
ROLE_LIST = 29List element.
ROLE_LIST_ITEM = 30List item element.
ROLE_LIST_BOX = 31List view element.
ROLE_LIST_BOX_OPTION = 32List view item element.
ROLE_TAB_BAR = 33Tab bar element.
ROLE_TAB = 34Tab bar item element.
ROLE_TAB_PANEL = 35Tab panel element.
ROLE_MENU_BAR = 36Menu bar element.
ROLE_MENU = 37Popup menu element.
ROLE_MENU_ITEM = 38Popup menu item element.
ROLE_MENU_ITEM_CHECK_BOX = 39Popup menu check button item element.
ROLE_MENU_ITEM_RADIO = 40Popup menu radio button item element.
ROLE_IMAGE = 41Image element.
ROLE_WINDOW = 42Window element.
ROLE_TITLE_BAR = 43Embedded window title bar element.
ROLE_DIALOG = 44Dialog window element.
ROLE_TOOLTIP = 45Tooltip element.
ROLE_REGION = 46Region/landmark element. Screen readers can navigate between regions using landmark navigation.
ROLE_TEXT_RUN = 47Unifor text run.
Note: This role is used for internal text elements, and should not be assigned to nodes.
POPUP_MENU = 0Popup menu.
POPUP_LIST = 1Popup list.
POPUP_TREE = 2Popup tree view.
POPUP_DIALOG = 3Popup dialog.
FLAG_HIDDEN = 0Element is hidden for accessibility tools.
FLAG_MULTISELECTABLE = 1Element supports multiple item selection.
FLAG_REQUIRED = 2Element require user input.
FLAG_VISITED = 3Element is a visited link.
FLAG_BUSY = 4Element content is not ready (e.g. loading).
FLAG_MODAL = 5Element is modal window.
FLAG_TOUCH_PASSTHROUGH = 6Element allows touches to be passed through when a screen reader is in touch exploration mode.
FLAG_READONLY = 7Element is text field with selectable but read-only text.
FLAG_DISABLED = 8Element is disabled.
FLAG_CLIPS_CHILDREN = 9Element clips children.
ACTION_CLICK = 0Single click action, callback argument is not set.
ACTION_FOCUS = 1Focus action, callback argument is not set.
ACTION_BLUR = 2Blur action, callback argument is not set.
ACTION_COLLAPSE = 3Collapse action, callback argument is not set.
ACTION_EXPAND = 4Expand action, callback argument is not set.
ACTION_DECREMENT = 5Decrement action, callback argument is not set.
ACTION_INCREMENT = 6Increment action, callback argument is not set.
ACTION_HIDE_TOOLTIP = 7Hide tooltip action, callback argument is not set.
ACTION_SHOW_TOOLTIP = 8Show tooltip action, callback argument is not set.
ACTION_SET_TEXT_SELECTION = 9Set 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 = 10Replace text action, callback argument is set to String with the replacement text.
ACTION_SCROLL_BACKWARD = 11Scroll backward action, callback argument is not set.
ACTION_SCROLL_DOWN = 12Scroll down action, callback argument is set to AccessibilityScrollUnit.
ACTION_SCROLL_FORWARD = 13Scroll forward action, callback argument is not set.
ACTION_SCROLL_LEFT = 14Scroll left action, callback argument is set to AccessibilityScrollUnit.
ACTION_SCROLL_RIGHT = 15Scroll right action, callback argument is set to AccessibilityScrollUnit.
ACTION_SCROLL_UP = 16Scroll up action, callback argument is set to AccessibilityScrollUnit.
ACTION_SCROLL_INTO_VIEW = 17Scroll into view action, callback argument is set to AccessibilityScrollHint.
ACTION_SCROLL_TO_POINT = 18Scroll to point action, callback argument is set to Vector2 with the relative point coordinates.
ACTION_SET_SCROLL_OFFSET = 19Set scroll offset action, callback argument is set to Vector2 with the scroll offset.
ACTION_SET_VALUE = 20Set value action, callback argument is set to String or number with the new value.
ACTION_SHOW_CONTEXT_MENU = 21Show context menu action, callback argument is not set.
ACTION_CUSTOM = 22Custom action, callback argument is set to the integer action ID.
LIVE_OFF = 0Indicates that updates to the live region should not be presented.
LIVE_POLITE = 1Indicates 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 = 2Indicates that updates to the live region have the highest priority and should be presented immediately.
SCROLL_UNIT_ITEM = 0The amount by which to scroll. A single item of a list, line of text.
SCROLL_UNIT_PAGE = 1The amount by which to scroll. A single page.
SCROLL_HINT_TOP_LEFT = 0A preferred position for the node scrolled into view. Top-left edge of the scroll container.
SCROLL_HINT_BOTTOM_RIGHT = 1A preferred position for the node scrolled into view. Bottom-right edge of the scroll container.
SCROLL_HINT_TOP_EDGE = 2A preferred position for the node scrolled into view. Top edge of the scroll container.
SCROLL_HINT_BOTTOM_EDGE = 3A preferred position for the node scrolled into view. Bottom edge of the scroll container.
SCROLL_HINT_LEFT_EDGE = 4A preferred position for the node scrolled into view. Left edge of the scroll container.
SCROLL_HINT_RIGHT_EDGE = 5A preferred position for the node scrolled into view. Right edge of the scroll container.
MOUSE_MODE_VISIBLE = 0Makes the mouse cursor visible if it is hidden.
MOUSE_MODE_HIDDEN = 1Makes the mouse cursor hidden if it is visible.
MOUSE_MODE_CAPTURED = 2Captures 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 = 3Confines the mouse cursor to the game window, and make it visible.
MOUSE_MODE_CONFINED_HIDDEN = 4Confines the mouse cursor to the game window, and make it hidden.
MOUSE_MODE_MAX = 5Max value of the MouseMode.
SCREEN_LANDSCAPE = 0Default landscape orientation.
SCREEN_PORTRAIT = 1Default portrait orientation.
SCREEN_REVERSE_LANDSCAPE = 2Reverse landscape orientation (upside down).
SCREEN_REVERSE_PORTRAIT = 3Reverse portrait orientation (upside down).
SCREEN_SENSOR_LANDSCAPE = 4Automatic landscape orientation (default or reverse depending on sensor).
SCREEN_SENSOR_PORTRAIT = 5Automatic portrait orientation (default or reverse depending on sensor).
SCREEN_SENSOR = 6Automatic landscape or portrait orientation (default or reverse depending on sensor).
KEYBOARD_TYPE_DEFAULT = 0Default text virtual keyboard.
KEYBOARD_TYPE_MULTILINE = 1Multiline virtual keyboard.
KEYBOARD_TYPE_NUMBER = 2Virtual number keypad, useful for PIN entry.
KEYBOARD_TYPE_NUMBER_DECIMAL = 3Virtual number keypad, useful for entering fractional numbers.
KEYBOARD_TYPE_PHONE = 4Virtual phone number keypad.
KEYBOARD_TYPE_EMAIL_ADDRESS = 5Virtual keyboard with additional keys to assist with typing email addresses.
KEYBOARD_TYPE_PASSWORD = 6Virtual 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 = 7Virtual keyboard with additional keys to assist with typing URLs.
CURSOR_ARROW = 0Arrow cursor shape. This is the default when not pointing anything that overrides the mouse cursor, such as a LineEdit or TextEdit.
CURSOR_IBEAM = 1I-beam cursor shape. This is used by default when hovering a control that accepts text input, such as LineEdit or TextEdit.
CURSOR_POINTING_HAND = 2Pointing hand cursor shape. This is used by default when hovering a LinkButton or a URL tag in a RichTextLabel.
CURSOR_CROSS = 3Crosshair 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 = 4Wait 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 = 5Wait 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 = 6Dragging hand cursor. This is displayed during drag-and-drop operations. See also CURSOR_CAN_DROP.
CURSOR_CAN_DROP = 7"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 = 8Forbidden cursor. This is displayed during drag-and-drop operations if the hovered Control can't accept the drag-and-drop event.
CURSOR_VSIZE = 9Vertical resize cursor. Intended to be displayed when the hovered Control can be vertically resized using the mouse. See also CURSOR_VSPLIT.
CURSOR_HSIZE = 10Horizontal resize cursor. Intended to be displayed when the hovered Control can be horizontally resized using the mouse. See also CURSOR_HSPLIT.
CURSOR_BDIAGSIZE = 11Secondary 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 = 12Main 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 = 13Move cursor. Intended to be displayed when the hovered Control can be moved using the mouse.
CURSOR_VSPLIT = 14Vertical 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 = 15Horizontal 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 = 16Help 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 = 17Represents the size of the CursorShape enum.
FILE_DIALOG_MODE_OPEN_FILE = 0The native file dialog allows selecting one, and only one file.
FILE_DIALOG_MODE_OPEN_FILES = 1The native file dialog allows selecting multiple files.
FILE_DIALOG_MODE_OPEN_DIR = 2The native file dialog only allows selecting a directory, disallowing the selection of any file.
FILE_DIALOG_MODE_OPEN_ANY = 3The native file dialog allows selecting one file or directory.
FILE_DIALOG_MODE_SAVE_FILE = 4The native file dialog will warn when a file exists.
WINDOW_MODE_WINDOWED = 0Windowed mode, i.e. Window doesn't occupy the whole screen (unless set to the size of the screen).
WINDOW_MODE_MINIMIZED = 1Minimized 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 = 2Maximized 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 = 3Full 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 = 4A 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.
PROGRESS_STATE_NOPROGRESS = 0Stops displaying progress and returns the button to its normal state.
PROGRESS_STATE_INDETERMINATE = 1The progress indicator shows an indeterminate progress.
On Windows, the progress indicator does not grow in size, but cycles repeatedly along the length of the taskbar button by default.
PROGRESS_STATE_NORMAL = 2The progress indicator shows progress normally.
PROGRESS_STATE_ERROR = 3The progress indicator shows that an error has occurred.
On Windows, the progress indicator turns red by default to show that an error has occurred in one of the windows that is broadcasting progress.
PROGRESS_STATE_PAUSED = 4The progress indicator shows it was paused.
On Windows, the progress indicator turns yellow by default to show that progress is currently stopped in one of the windows but can be resumed by the user.
WINDOW_FLAG_RESIZE_DISABLED = 0The 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.
Note: This flag is implemented on Linux (X11), macOS, and Windows.
WINDOW_FLAG_BORDERLESS = 1The window do not have native title bar and other decorations. This flag is ignored for full-screen windows.
Note: This flag is implemented on Linux (X11/Wayland), macOS, and Windows.
WINDOW_FLAG_ALWAYS_ON_TOP = 2The window is floating on top of all other windows. This flag is ignored for full-screen windows.
Note: This flag is implemented on Linux (X11), macOS, and Windows.
WINDOW_FLAG_TRANSPARENT = 3The 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 = 4The window can't be focused. No-focus window will ignore all input, except mouse clicks.
Note: This flag is implemented on Linux (X11), macOS, and Windows.
WINDOW_FLAG_POPUP = 5Window 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()).
Note: This flag is implemented on Linux (X11/Wayland), macOS, and Windows.
WINDOW_FLAG_EXTEND_TO_TITLE = 6Window 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 = 7All mouse events are passed to the underlying window of the same application.
Note: This flag is implemented on Linux (X11), macOS, and Windows.
WINDOW_FLAG_SHARP_CORNERS = 8Window style is overridden, forcing sharp corners.
Note: This flag is implemented only on Windows (11).
WINDOW_FLAG_EXCLUDE_FROM_CAPTURE = 9Window 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 = 10Signals the window manager that this window is supposed to be an implementation-defined "popup" (usually a floating, borderless, untileable and immovable child window).
Note: This flag is implemented on Linux (Wayland).
WINDOW_FLAG_MINIMIZE_DISABLED = 11Window minimize button is disabled.
Note: This flag is implemented on Linux (X11), macOS, and Windows.
WINDOW_FLAG_MAXIMIZE_DISABLED = 12Window maximize button is disabled.
Note: This flag is implemented on Linux (X11), macOS, and Windows.
WINDOW_FLAG_MAX = 13Represents the size of the WindowFlags enum.
WINDOW_EVENT_MOUSE_ENTER = 0Sent when the mouse pointer enters the window.
WINDOW_EVENT_MOUSE_EXIT = 1Sent when the mouse pointer exits the window.
WINDOW_EVENT_FOCUS_IN = 2Sent when the window grabs focus.
WINDOW_EVENT_FOCUS_OUT = 3Sent when the window loses focus.
WINDOW_EVENT_CLOSE_REQUEST = 4Sent when the user has attempted to close the window (e.g. close button is pressed).
WINDOW_EVENT_GO_BACK_REQUEST = 5Sent when the device "Back" button is pressed.
Note: This event is implemented only on Android.
WINDOW_EVENT_DPI_CHANGE = 6Sent 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 = 7Sent 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 = 8Sent when the window has been forcibly closed by the display server. The window will immediately hide and clean any internal rendering references.
Note: This flag is implemented only on Linux (Wayland).
WINDOW_EVENT_OUTPUT_MAX_LINEAR_VALUE_CHANGED = 9Sent when the output max linear value returned by Window.get_output_max_linear_value() has changed.
This occurs when HDR output is enabled or disabled and when any HDR output luminance values of the window have changed, such as when the player adjusts their screen brightness setting or moves the window to a different screen.
WINDOW_EDGE_TOP_LEFT = 0Top-left edge of a window.
WINDOW_EDGE_TOP = 1Top edge of a window.
WINDOW_EDGE_TOP_RIGHT = 2Top-right edge of a window.
WINDOW_EDGE_LEFT = 3Left edge of a window.
WINDOW_EDGE_RIGHT = 4Right edge of a window.
WINDOW_EDGE_BOTTOM_LEFT = 5Bottom-left edge of a window.
WINDOW_EDGE_BOTTOM = 6Bottom edge of a window.
WINDOW_EDGE_BOTTOM_RIGHT = 7Bottom-right edge of a window.
WINDOW_EDGE_MAX = 8Represents the size of the WindowResizeEdge enum.
VSYNC_DISABLED = 0No 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 = 1Default 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 = 2Behaves 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 = 3Displays 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 = 0Display handle:
- Linux (X11): X11::Display* for the display.
- Linux (Wayland): wl_display for the display.
- Android: EGLDisplay for the display.
WINDOW_HANDLE = 1Window 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 = 2Window 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 = 3OpenGL 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- Windows: EGLDisplay for the window (ANGLE).
- macOS: EGLDisplay for the window (ANGLE).
- Linux (Wayland): EGLDisplay for the window.
EGL_CONFIG = 5- Windows: EGLConfig for the window (ANGLE).
- macOS: EGLConfig for the window (ANGLE).
- Linux (Wayland): EGLConfig for the window.
GLX_VISUALID = 6The GLX VisualID for the window.
Note: Only available on Linux when using X11.
GLX_FBCONFIG = 7The GLXFBConfig for the window.
Note: Only available on Linux when using X11.
TTS_UTTERANCE_STARTED = 0Utterance has begun to be spoken.
TTS_UTTERANCE_ENDED = 1Utterance was successfully finished.
TTS_UTTERANCE_CANCELED = 2Utterance was canceled, or TTS service was unable to process it.
TTS_UTTERANCE_BOUNDARY = 3Utterance reached a word or sentence boundary.
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.
Represents the screen containing the mouse pointer.
Note: On Android, iOS, Web, and Linux (Wayland), this constant always represents the screen at index 0.
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.
Represents the primary screen.
Note: On Android, iOS, Web, and Linux (Wayland), this constant always represents the screen at index 0.
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.
The ID of the main window spawned by the engine, which can be passed to methods expecting a window_id.
The ID that refers to a nonexistent window. This is returned by some DisplayServer methods if no window matches the requested result.