DisplayServer

public static Rid AccessibilityCreateElement(int windowId, DisplayServer.AccessibilityRole role);

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

public static Rid AccessibilityCreateSubElement(Rid parentRid, DisplayServer.AccessibilityRole role, int insertPos = -1);

Creates a new, empty accessibility sub-element resource. Sub-elements can be used to provide accessibility information for objects which are not Entitys, 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 DisplayServer.AccessibilityFreeElement method.

public static Rid AccessibilityCreateSubTextEditElements(Rid parentRid, Rid shapedText, float minHeight, int insertPos);

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 DisplayServer.AccessibilityFreeElement 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.

public static Rid AccessibilityCreateSubTextEditElements(Rid parentRid, Rid shapedText, float minHeight, int insertPos = -1, bool isLastLine = false);

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 DisplayServer.AccessibilityFreeElement 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.

public static Variant AccessibilityElementGetMeta(Rid id);

Returns the metadata of the accessibility element id.

public static void AccessibilityElementSetMeta(Rid id, Variant meta);

Sets the metadata of the accessibility element id to meta.

public static void AccessibilityFreeElement(Rid id);

Frees the accessibility element id created by DisplayServer.AccessibilityCreateElement, DisplayServer.AccessibilityCreateSubElement, or DisplayServer.AccessibilityCreateSubTextEditElements.

public static Rid AccessibilityGetWindowRoot(int windowId);

Returns the main accessibility element of the OS native window.

public static bool AccessibilityHasElement(Rid id);

Returns true if id is a valid accessibility element.

public static int AccessibilityScreenReaderActive();

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 Android, 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.

public static void AccessibilitySetWindowFocused(int windowId, 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.

public static void AccessibilitySetWindowRect(int windowId, Rect2 rectOut, Rect2 rectIn);

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.

public static int AccessibilityShouldIncreaseContrast();

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

public static int AccessibilityShouldReduceAnimation();

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 Android, macOS, and Windows.

public static int AccessibilityShouldReduceTransparency();

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.

public static void AccessibilityUpdateAddAction(Rid id, DisplayServer.AccessibilityAction 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.

public static void AccessibilityUpdateAddChild(Rid id, Rid childId);

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

public static void AccessibilityUpdateAddCustomAction(Rid id, int actionId, string actionDescription);

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

public static void AccessibilityUpdateAddRelatedControls(Rid id, Rid relatedId);

Adds an element that is controlled by this element.

public static void AccessibilityUpdateAddRelatedDescribedBy(Rid id, Rid relatedId);

Adds an element that describes this element.

public static void AccessibilityUpdateAddRelatedDetails(Rid id, Rid relatedId);

Adds an element that details this element.

public static void AccessibilityUpdateAddRelatedFlowTo(Rid id, Rid relatedId);

Adds an element that this element flow into.

public static void AccessibilityUpdateAddRelatedLabeledBy(Rid id, Rid relatedId);

Adds an element that labels this element.

public static void AccessibilityUpdateAddRelatedRadioGroup(Rid id, Rid relatedId);

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.

public static void AccessibilityUpdateSetActiveDescendant(Rid id, Rid otherId);

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

public static void AccessibilityUpdateSetBackgroundColor(Rid id, Color color);

Sets element background color.

public static void AccessibilityUpdateSetBounds(Rid id, Rect2 rect);

Sets element bounding box, relative to the node position.

public static void AccessibilityUpdateSetChecked(Rid id, bool checekd);

Sets element checked state.

public static void AccessibilityUpdateSetClassname(Rid id, string classname);

Sets element class name.

public static void AccessibilityUpdateSetColorValue(Rid id, Color color);

Sets element color value.

public static void AccessibilityUpdateSetDescription(Rid id, string description);

Sets element accessibility description.

public static void AccessibilityUpdateSetErrorMessage(Rid id, Rid otherId);

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

public static void AccessibilityUpdateSetExtraInfo(Rid id, string name);

Sets element accessibility extra information added to the element name.

public static void AccessibilityUpdateSetFlag(Rid id, DisplayServer.AccessibilityFlags flag, bool value);

Sets element flag.

public static void AccessibilityUpdateSetFocus(Rid id);

Sets currently focused element.

public static void AccessibilityUpdateSetForegroundColor(Rid id, Color color);

Sets element foreground color.

public static void AccessibilityUpdateSetInPageLinkTarget(Rid id, Rid otherId);

Sets target element for the link.

public static void AccessibilityUpdateSetLanguage(Rid id, string language);

Sets element text language.

public static void AccessibilityUpdateSetListItemCount(Rid id, int size);

Sets number of items in the list.

public static void AccessibilityUpdateSetListItemExpanded(Rid id, bool expanded);

Sets list/tree item expanded status.

public static void AccessibilityUpdateSetListItemIndex(Rid id, int index);

Sets the position of the element in the list.

public static void AccessibilityUpdateSetListItemLevel(Rid id, int level);

Sets the hierarchical level of the element in the list.

public static void AccessibilityUpdateSetListItemSelected(Rid id, bool selected);

Sets list/tree item selected status.

public static void AccessibilityUpdateSetListOrientation(Rid id, bool vertical);

Sets the orientation of the list elements.

public static void AccessibilityUpdateSetLive(Rid id, DisplayServer.AccessibilityLiveMode live);

Sets the priority of the live region updates.

public static void AccessibilityUpdateSetMemberOf(Rid id, Rid groupId);

Sets the element to be a member of the group.

public static void AccessibilityUpdateSetName(Rid id, string name);

Sets element accessibility name.

public static void AccessibilityUpdateSetNextOnLine(Rid id, Rid otherId);

Sets next element on the line.

public static void AccessibilityUpdateSetNumJump(Rid id, double jump);

Sets numeric value jump.

public static void AccessibilityUpdateSetNumRange(Rid id, double min, double max);

Sets numeric value range.

public static void AccessibilityUpdateSetNumStep(Rid id, double step);

Sets numeric value step.

public static void AccessibilityUpdateSetNumValue(Rid id, double position);

Sets numeric value.

public static void AccessibilityUpdateSetPlaceholder(Rid id, string placeholder);

Sets placeholder text.

public static void AccessibilityUpdateSetPopupType(Rid id, DisplayServer.AccessibilityPopupType popup);

Sets popup type for popup buttons.

public static void AccessibilityUpdateSetPreviousOnLine(Rid id, Rid otherId);

Sets previous element on the line.

public static void AccessibilityUpdateSetRole(Rid id, DisplayServer.AccessibilityRole role);

Sets element accessibility role.

public static void AccessibilityUpdateSetRoleDescription(Rid id, string description);

Sets element accessibility role description text.

public static void AccessibilityUpdateSetScrollX(Rid id, double position);

Sets scroll bar x position.

public static void AccessibilityUpdateSetScrollXRange(Rid id, double min, double max);

Sets scroll bar x range.

public static void AccessibilityUpdateSetScrollY(Rid id, double position);

Sets scroll bar y position.

public static void AccessibilityUpdateSetScrollYRange(Rid id, double min, double max);

Sets scroll bar y range.

public static void AccessibilityUpdateSetShortcut(Rid id, string shortcut);

Sets the list of keyboard shortcuts used by element.

public static void AccessibilityUpdateSetStateDescription(Rid id, string description);

Sets human-readable description of the current checked state.

public static void AccessibilityUpdateSetTableCellPosition(Rid id, int rowIndex, int columnIndex);

Sets cell position in the table.

public static void AccessibilityUpdateSetTableCellSpan(Rid id, int rowSpan, int columnSpan);

Sets cell row/column span.

public static void AccessibilityUpdateSetTableColumnCount(Rid id, int count);

Sets number of columns in the table.

public static void AccessibilityUpdateSetTableColumnIndex(Rid id, int index);

Sets position of the column.

public static void AccessibilityUpdateSetTableRowCount(Rid id, int count);

Sets number of rows in the table.

public static void AccessibilityUpdateSetTableRowIndex(Rid id, int index);

Sets position of the row in the table.

public static void AccessibilityUpdateSetTextAlign(Rid id, HorizontalAlignment align);

Sets element text alignment.

public static void AccessibilityUpdateSetTextDecorations(Rid id, bool underline, bool strikethrough, bool overline);

Sets text underline/overline/strikethrough.

public static void AccessibilityUpdateSetTextOrientation(Rid id, bool vertical);

Sets text orientation.

public static void AccessibilityUpdateSetTextSelection(Rid id, Rid textStartId, int startChar, Rid textEndId, int endChar);

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

public static void AccessibilityUpdateSetTooltip(Rid id, string tooltip);

Sets tooltip text.

public static void AccessibilityUpdateSetTransform(Rid id, Transform2D transform);

Sets element 2D transform.

public static void AccessibilityUpdateSetUrl(Rid id, string url);

Sets link URL.

public static void AccessibilityUpdateSetValue(Rid id, string value);

Sets element text value.

public static void Beep();

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.

public static string ClipboardGet();

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

public static Image ClipboardGetImage();

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.

public static string ClipboardGetPrimary();

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 [kbd]Ctrl + C[/kbd]. 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).

public static bool ClipboardHas();

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

public static bool ClipboardHasImage();

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

public static void ClipboardSet(string clipboard);

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

public static void ClipboardSetPrimary(string clipboardPrimary);

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 [kbd]Ctrl + C[/kbd]. 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).

public static bool ColorPicker(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 DisplayServer.Feature.NativeColorPicker feature. Note: This method is only implemented on Linux (X11/Wayland).

public static int CreateStatusIndicator(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).

public static DisplayServer.CursorShape CursorGetShape();

Returns the default mouse cursor shape set by DisplayServer.CursorSetShape.

public static void CursorSetCustomImage(Resource cursor, DisplayServer.CursorShape shape = DisplayServer.CursorShape.Arrow, Vector2? hotspot = default);

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 DisplayServer.CursorSetShape. Note: On Web, calling this method every frame can cause the cursor to flicker.

public static void CursorSetShape(DisplayServer.CursorShape shape);

Sets the default mouse cursor shape. The cursor's appearance will vary depending on the user's operating system and mouse cursor theme. See also DisplayServer.CursorGetShape and DisplayServer.CursorSetCustomImage.

public static void DeleteStatusIndicator(int id);

Removes the application status indicator.

public static Error DialogInputText(string title, string description, string existingText, 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 DisplayServer.Feature.NativeDialogInput feature. Supported platforms include macOS, Windows, and Android.

public static Error DialogShow(string title, string description, ReadOnlySpan<string> 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 DisplayServer.Feature.NativeDialog feature. Supported platforms include macOS, Windows, and Android.

public static Error DialogShow(string title, string description, string[] 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 DisplayServer.Feature.NativeDialog feature. Supported platforms include macOS, Windows, and Android.

public static void EnableForStealingFocus(long processId);

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.

public static Error FileDialogShow(string title, string currentDirectory, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, ReadOnlySpan<string> filters, Callable callback);

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 DisplayServer.Feature.NativeDialogFile 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.GetGrantedPermissions 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 DisplayServer.FileDialogMode.OpenDir, 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:

The persistable URI permission remains valid across app restarts as long as the directory is not moved, renamed, or deleted.

public static Error FileDialogShow(string title, string currentDirectory, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, ReadOnlySpan<string> filters, Callable callback, int parentWindowId);

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 DisplayServer.Feature.NativeDialogFile 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.GetGrantedPermissions 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 DisplayServer.FileDialogMode.OpenDir, 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:

The persistable URI permission remains valid across app restarts as long as the directory is not moved, renamed, or deleted.

public static Error FileDialogShow(string title, string currentDirectory, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, string[] filters, Callable callback);

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 DisplayServer.Feature.NativeDialogFile 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.GetGrantedPermissions 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 DisplayServer.FileDialogMode.OpenDir, 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:

The persistable URI permission remains valid across app restarts as long as the directory is not moved, renamed, or deleted.

public static Error FileDialogShow(string title, string currentDirectory, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, string[] filters, Callable callback, int parentWindowId = 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 DisplayServer.Feature.NativeDialogFile 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.GetGrantedPermissions 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 DisplayServer.FileDialogMode.OpenDir, 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:

The persistable URI permission remains valid across app restarts as long as the directory is not moved, renamed, or deleted.

public static Error FileDialogWithOptionsShow(string title, string currentDirectory, string root, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, ReadOnlySpan<string> filters, Reckfell.Collections.Array<Reckfell.Collections.Dictionary> options, Callable callback);

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 Reckfell.Collections.Dictionarys with the following keys:

• "name" - option's name string.
• "values" - string[] 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 DisplayServer.Feature.NativeDialogFileExtra 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.GetGrantedPermissions to get a list of saved bookmarks.

public static Error FileDialogWithOptionsShow(string title, string currentDirectory, string root, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, ReadOnlySpan<string> filters, Reckfell.Collections.Array<Reckfell.Collections.Dictionary> options, Callable callback, int parentWindowId);

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 Reckfell.Collections.Dictionarys with the following keys:

• "name" - option's name string.
• "values" - string[] 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 DisplayServer.Feature.NativeDialogFileExtra 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.GetGrantedPermissions to get a list of saved bookmarks.

public static Error FileDialogWithOptionsShow(string title, string currentDirectory, string root, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, string[] filters, Reckfell.Collections.Array<Reckfell.Collections.Dictionary> options, Callable callback);

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 Reckfell.Collections.Dictionarys with the following keys:

• "name" - option's name string.
• "values" - string[] 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 DisplayServer.Feature.NativeDialogFileExtra 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.GetGrantedPermissions to get a list of saved bookmarks.

public static Error FileDialogWithOptionsShow(string title, string currentDirectory, string root, string fileName, bool showHidden, DisplayServer.FileDialogMode mode, string[] filters, Reckfell.Collections.Array<Reckfell.Collections.Dictionary> options, Callable callback, int parentWindowId = 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 Reckfell.Collections.Dictionarys with the following keys:

• "name" - option's name string.
• "values" - string[] 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 DisplayServer.Feature.NativeDialogFileExtra 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.GetGrantedPermissions to get a list of saved bookmarks.

public static void ForceProcessAndDropEvents();

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

public static Color GetAccentColor();

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

public static Color GetBaseColor();

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.

public static Reckfell.Collections.Array<Rect2> GetDisplayCutouts();

Returns an Reckfell.Collections.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 DisplayServer.GetDisplaySafeArea. Note: The returned rectangles are relative to the physical screen and not the virtual desktop. Note: One of the following constants can be used as screen: DisplayServer.ScreenOfMainWindow, DisplayServer.ScreenPrimary, DisplayServer.ScreenWithMouseFocus, or DisplayServer.ScreenWithKeyboardFocus. Note: Currently only implemented on Android and macOS. Other platforms will return an empty array even if they do have display cutouts or notches.

public static Reckfell.Collections.Array<Rect2> GetDisplayCutouts(int screen = -1);

Returns an Reckfell.Collections.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 DisplayServer.GetDisplaySafeArea. Note: The returned rectangles are relative to the physical screen and not the virtual desktop. Note: One of the following constants can be used as screen: DisplayServer.ScreenOfMainWindow, DisplayServer.ScreenPrimary, DisplayServer.ScreenWithMouseFocus, or DisplayServer.ScreenWithKeyboardFocus. Note: Currently only implemented on Android and macOS. Other platforms will return an empty array even if they do have display cutouts or notches.

public static Rect2I GetDisplaySafeArea();

Returns the unobscured area of the display where interactive controls should be rendered. See also DisplayServer.GetDisplayCutouts. Note: The returned rectangle is relative to the physical screen and not the virtual desktop. Note: One of the following constants can be used as screen: DisplayServer.ScreenOfMainWindow, DisplayServer.ScreenPrimary, DisplayServer.ScreenWithMouseFocus, or DisplayServer.ScreenWithKeyboardFocus. Note: Currently only implemented on Android, iOS, and macOS. On other platforms, screen_get_usable_rect(SCREEN_OF_MAIN_WINDOW) will be returned as a fallback. See also DisplayServer.ScreenGetUsableRect.

public static Rect2I GetDisplaySafeArea(int screen = -1);

Returns the unobscured area of the display where interactive controls should be rendered. See also DisplayServer.GetDisplayCutouts. Note: The returned rectangle is relative to the physical screen and not the virtual desktop. Note: One of the following constants can be used as screen: DisplayServer.ScreenOfMainWindow, DisplayServer.ScreenPrimary, DisplayServer.ScreenWithMouseFocus, or DisplayServer.ScreenWithKeyboardFocus. Note: Currently only implemented on Android, iOS, and macOS. On other platforms, screen_get_usable_rect(SCREEN_OF_MAIN_WINDOW) will be returned as a fallback. See also DisplayServer.ScreenGetUsableRect.

public static int GetKeyboardFocusScreen();

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.

public static string GetName();

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

public static int GetPrimaryScreen();

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.

public static int GetScreenCount();

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.

public static int GetScreenFromRect(Rect2 rect);

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

public static bool GetSwapCancelOk();

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

public static int GetWindowAtScreenPosition(Vector2I position);

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)        ┌───────┐
                │       │
┌─────────────┐ │       │
│             │ │       │
│             │ │       │
└─────────────┘ └───────┘

public static int[] GetWindowList();

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

public static int GlobalMenuAddCheckItem(string menuRoot, string label, Callable callback = default, Callable keyCallback = default, Variant tag = default, Key accelerator = Key.None, int index = -1);

Adds a new checkable item with text label to the global menu with ID menu_root. Returns index of the inserted item, it's not guaranteed to be the same as index value. An accelerator can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The accelerator is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]). 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).

public static int GlobalMenuAddIconCheckItem(string menuRoot, Texture2D icon, string label, Callable callback = default, Callable keyCallback = default, Variant tag = default, Key accelerator = Key.None, int index = -1);

Adds a new checkable item with text label and icon icon to the global menu with ID menu_root. Returns index of the inserted item, it's not guaranteed to be the same as index value. An accelerator can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The accelerator is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]). 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).

public static int GlobalMenuAddIconItem(string menuRoot, Texture2D icon, string label, Callable callback = default, Callable keyCallback = default, Variant tag = default, Key accelerator = Key.None, int index = -1);

Adds a new item with text label and icon icon to the global menu with ID menu_root. Returns index of the inserted item, it's not guaranteed to be the same as index value. An accelerator can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The accelerator is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]). 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).

public static int GlobalMenuAddIconRadioCheckItem(string menuRoot, Texture2D icon, string label, Callable callback = default, Callable keyCallback = default, Variant tag = default, Key accelerator = Key.None, int index = -1);

Adds a new radio-checkable item with text label and icon icon to the global menu with ID menu_root. Returns index of the inserted item, it's not guaranteed to be the same as index value. An accelerator can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The accelerator is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]). Note: Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See DisplayServer.GlobalMenuSetItemChecked 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).

public static int GlobalMenuAddItem(string menuRoot, string label, Callable callback = default, Callable keyCallback = default, Variant tag = default, Key accelerator = Key.None, int index = -1);

Adds a new item with text label to the global menu with ID menu_root. Returns index of the inserted item, it's not guaranteed to be the same as index value. An accelerator can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The accelerator is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]). 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).

public static int GlobalMenuAddMultistateItem(string menuRoot, string label, int maxStates, int defaultState, Callable callback = default, Callable keyCallback = default, Variant tag = default, Key accelerator = Key.None, int index = -1);

Adds a new item with text label to the global menu with ID menu_root. Contrarily to normal binary items, multistate items can have more than two states, as defined by max_states. Each press or activate of the item will increase the state by one. The default value is defined by default_state. Returns index of the inserted item, it's not guaranteed to be the same as index value. An accelerator can optionally be defined, which is a keyboard shortcut that can be pressed to trigger the menu button even if it's not currently open. The accelerator is generally a combination of KeyModifierMasks and Keys using bitwise OR such as KEY_MASK_CTRL | KEY_A ([kbd]Ctrl + A[/kbd]). 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).