godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/DisplayServer.xml

1455 lines
64 KiB
XML
Raw Normal View History

doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="DisplayServer" inherits="Object" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="clipboard_get" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
DisplayServer: Add multiple descriptions for methods. Added multiple descriptions for clipboard, mouse and window methods.
2021-10-06 20:52:52 +00:00
Returns the user's clipboard as a string if possible.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
Added primary clipboard for Linux
2021-10-12 07:43:50 +00:00
<method name="clipboard_get_primary" qualifiers="const">
<return type="String" />
<description>
Returns the user's primary clipboard as a string if possible.
[b]Note:[/b] This method is only implemented on Linux.
</description>
</method>
Add `DisplayServer.clipboard_has()` to check clipboard content
2022-01-19 13:04:52 +00:00
<method name="clipboard_has" qualifiers="const">
<return type="bool" />
<description>
Returns [code]true[/code] if there is content on the user's clipboard.
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="clipboard_set">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="clipboard" type="String" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
DisplayServer: Add multiple descriptions for methods. Added multiple descriptions for clipboard, mouse and window methods.
2021-10-06 20:52:52 +00:00
Sets the user's clipboard content to the given string.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
Added primary clipboard for Linux
2021-10-12 07:43:50 +00:00
<method name="clipboard_set_primary">
<return type="void" />
<argument index="0" name="clipboard_primary" type="String" />
<description>
Sets the user's primary clipboard content to the given string.
[b]Note:[/b] This method is only implemented on Linux.
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="create_sub_window">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
<argument index="0" name="mode" type="int" enum="DisplayServer.WindowMode" />
<argument index="1" name="vsync_mode" type="int" enum="DisplayServer.VSyncMode" />
<argument index="2" name="flags" type="int" />
<argument index="3" name="rect" type="Rect2i" default="Rect2i(0, 0, 0, 0)" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="cursor_get_shape" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="DisplayServer.CursorShape" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="cursor_set_custom_image">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="cursor" type="Resource" />
<argument index="1" name="shape" type="int" enum="DisplayServer.CursorShape" default="0" />
<argument index="2" name="hotspot" type="Vector2" default="Vector2(0, 0)" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="cursor_set_shape">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="shape" type="int" enum="DisplayServer.CursorShape" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="delete_sub_window">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="window_id" type="int" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="dialog_input_text">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="Error" />
<argument index="0" name="title" type="String" />
<argument index="1" name="description" type="String" />
<argument index="2" name="existing_text" type="String" />
<argument index="3" name="callback" type="Callable" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="dialog_show">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="Error" />
<argument index="0" name="title" type="String" />
<argument index="1" name="description" type="String" />
<argument index="2" name="buttons" type="PackedStringArray" />
<argument index="3" name="callback" type="Callable" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="enable_for_stealing_focus">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="process_id" type="int" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="force_process_and_drop_events">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
Add a method for obtaining display cutouts on Android
2022-04-24 19:12:22 +00:00
<method name="get_display_cutouts" qualifiers="const">
<return type="Array" />
<description>
Fix screen_get_usable_rect returning display safe area
2022-04-26 09:40:57 +00:00
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 [method get_display_safe_area].
Add a method for obtaining display cutouts on Android
2022-04-24 19:12:22 +00:00
[b]Note:[/b] Currently only implemented on Android. Other platforms will return an empty array even if they do have display cutouts or notches.
</description>
</method>
Fix screen_get_usable_rect returning display safe area
2022-04-26 09:40:57 +00:00
<method name="get_display_safe_area" qualifiers="const">
<return type="Rect2i" />
<description>
Returns the unobscured area of the display where interactive controls should be rendered. See also [method get_display_cutouts].
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="get_name" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="get_screen_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
Fix cancel/OK button order on macOS The macOS platform convention regarding button order is cancel on left, OK on right.
2020-07-08 23:02:38 +00:00
<method name="get_swap_cancel_ok">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="get_window_at_screen_position" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
<argument index="0" name="position" type="Vector2i" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="get_window_list" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="PackedInt32Array" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="global_menu_add_check_item">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="label" type="String" />
<argument index="2" name="callback" type="Callable" />
<argument index="3" name="tag" type="Variant" default="null" />
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
<argument index="4" name="accelerator" type="int" enum="Key" default="0" />
<argument index="5" name="index" type="int" default="-1" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Adds a new checkable item with text [code]label[/code] to the global menu with ID [code]menu_root[/code].
[b]Note:[/b] This method is implemented on macOS.
[b]Supported system menu IDs:[/b]
[codeblock]
"" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
[/codeblock]
</description>
</method>
<method name="global_menu_add_icon_check_item">
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="icon" type="Texture2D" />
<argument index="2" name="label" type="String" />
<argument index="3" name="callback" type="Callable" />
<argument index="4" name="tag" type="Variant" default="null" />
<argument index="5" name="accelerator" type="int" enum="Key" default="0" />
<argument index="6" name="index" type="int" default="-1" />
<description>
Adds a new checkable item with text [code]label[/code] and icon [code]icon[/code] to the global menu with ID [code]menu_root[/code].
[b]Note:[/b] This method is implemented on macOS.
[b]Supported system menu IDs:[/b]
[codeblock]
"" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
[/codeblock]
</description>
</method>
<method name="global_menu_add_icon_item">
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="icon" type="Texture2D" />
<argument index="2" name="label" type="String" />
<argument index="3" name="callback" type="Callable" />
<argument index="4" name="tag" type="Variant" default="null" />
<argument index="5" name="accelerator" type="int" enum="Key" default="0" />
<argument index="6" name="index" type="int" default="-1" />
<description>
Adds a new item with text [code]label[/code] and icon [code]icon[/code] to the global menu with ID [code]menu_root[/code].
[b]Note:[/b] This method is implemented on macOS.
[b]Supported system menu IDs:[/b]
[codeblock]
"" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
[/codeblock]
</description>
</method>
<method name="global_menu_add_icon_radio_check_item">
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="icon" type="Texture2D" />
<argument index="2" name="label" type="String" />
<argument index="3" name="callback" type="Callable" />
<argument index="4" name="tag" type="Variant" default="null" />
<argument index="5" name="accelerator" type="int" enum="Key" default="0" />
<argument index="6" name="index" type="int" default="-1" />
<description>
Adds a new radio-checkable item with text [code]label[/code] and icon [code]icon[/code] to the global menu with ID [code]menu_root[/code].
[b]Note:[/b] Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method global_menu_set_item_checked] for more info on how to control it.
[b]Note:[/b] This method is implemented on macOS.
[b]Supported system menu IDs:[/b]
[codeblock]
"" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
[/codeblock]
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="global_menu_add_item">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="label" type="String" />
<argument index="2" name="callback" type="Callable" />
<argument index="3" name="tag" type="Variant" default="null" />
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
<argument index="4" name="accelerator" type="int" enum="Key" default="0" />
<argument index="5" name="index" type="int" default="-1" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Adds a new item with text [code]label[/code] to the global menu with ID [code]menu_root[/code].
[b]Note:[/b] This method is implemented on macOS.
[b]Supported system menu IDs:[/b]
[codeblock]
"" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
[/codeblock]
</description>
</method>
<method name="global_menu_add_multistate_item">
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="labe" type="String" />
<argument index="2" name="max_states" type="int" />
<argument index="3" name="default_state" type="int" />
<argument index="4" name="callback" type="Callable" />
<argument index="5" name="tag" type="Variant" default="null" />
<argument index="6" name="accelerator" type="int" enum="Key" default="0" />
<argument index="7" name="index" type="int" default="-1" />
<description>
Adds a new item with text [code]label[/code] to the global menu with ID [code]menu_root[/code].
Contrarily to normal binary items, multistate items can have more than two states, as defined by [code]max_states[/code]. Each press or activate of the item will increase the state by one. The default value is defined by [code]default_state[/code].
[b]Note:[/b] This method is implemented on macOS.
[b]Supported system menu IDs:[/b]
[codeblock]
"" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
[/codeblock]
</description>
</method>
<method name="global_menu_add_radio_check_item">
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="label" type="String" />
<argument index="2" name="callback" type="Callable" />
<argument index="3" name="tag" type="Variant" default="null" />
<argument index="4" name="accelerator" type="int" enum="Key" default="0" />
<argument index="5" name="index" type="int" default="-1" />
<description>
Adds a new radio-checkable item with text [code]label[/code] to the global menu with ID [code]menu_root[/code].
[b]Note:[/b] Radio-checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. See [method global_menu_set_item_checked] for more info on how to control it.
[b]Note:[/b] This method is implemented on macOS.
[b]Supported system menu IDs:[/b]
[codeblock]
"" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
[/codeblock]
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="global_menu_add_separator">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="menu_root" type="String" />
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
<argument index="1" name="index" type="int" default="-1" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Adds a separator between items to the global menu with ID [code]menu_root[/code]. Separators also occupy an index.
[b]Note:[/b] This method is implemented on macOS.
[b]Supported system menu IDs:[/b]
[codeblock]
"" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
[/codeblock]
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="global_menu_add_submenu_item">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="label" type="String" />
<argument index="2" name="submenu" type="String" />
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
<argument index="3" name="index" type="int" default="-1" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Adds an item that will act as a submenu of the global menu [code]menu_root[/code]. The [code]submenu[/code] argument is the ID of the global menu root that will be shown when the item is clicked.
[b]Note:[/b] This method is implemented on macOS.
[b]Supported system menu IDs:[/b]
[codeblock]
"" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
[/codeblock]
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="global_menu_clear">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="menu_root" type="String" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Removes all items from the global menu with ID [code]menu_root[/code].
[b]Note:[/b] This method is implemented on macOS.
[b]Supported system menu IDs:[/b]
[codeblock]
"" - Main menu (macOS).
"_dock" - Dock popup menu (macOS).
[/codeblock]
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
<method name="global_menu_get_item_accelerator" qualifiers="const">
<return type="int" enum="Key" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<description>
Returns the accelerator of the item at index [code]idx[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused.
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
<method name="global_menu_get_item_callback" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Callable" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Returns the callback of the item at index [code]idx[/code].
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
<method name="global_menu_get_item_icon" qualifiers="const">
<return type="Texture2D" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<description>
Returns the icon of the item at index [code]idx[/code].
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
<method name="global_menu_get_item_index_from_tag" qualifiers="const">
<return type="int" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="tag" type="Variant" />
<description>
Returns the index of the item with the specified [code]tag[/code]. Index is automatically assigned to each item by the engine. Index can not be set manually.
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
<method name="global_menu_get_item_index_from_text" qualifiers="const">
<return type="int" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="text" type="String" />
<description>
Returns the index of the item with the specified [code]text[/code]. Index is automatically assigned to each item by the engine. Index can not be set manually.
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
<method name="global_menu_get_item_max_states" qualifiers="const">
<return type="int" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<description>
Returns number of states of an multistate item. See [method global_menu_add_multistate_item] for details.
[b]Note:[/b] This method is implemented on macOS.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
<method name="global_menu_get_item_state" qualifiers="const">
<return type="int" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<description>
Returns the state of an multistate item. See [method global_menu_add_multistate_item] for details.
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
<method name="global_menu_get_item_submenu" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Returns the submenu ID of the item at index [code]idx[/code]. See [method global_menu_add_submenu_item] for more info on how to add a submenu.
[b]Note:[/b] This method is implemented on macOS.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
<method name="global_menu_get_item_tag" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Variant" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Returns the metadata of the specified item, which might be of any type. You can set it with [method global_menu_set_item_tag], which provides a simple way of assigning context data to items.
[b]Note:[/b] This method is implemented on macOS.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
<method name="global_menu_get_item_text" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Returns the text of the item at index [code]idx[/code].
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
<method name="global_menu_get_item_tooltip" qualifiers="const">
<return type="String" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<description>
Returns the tooltip associated with the specified index index [code]idx[/code].
[b]Note:[/b] This method is implemented on macOS.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="global_menu_is_item_checkable" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Returns [code]true[/code] if the item at index [code]idx[/code] is checkable in some way, i.e. if it has a checkbox or radio button.
[b]Note:[/b] This method is implemented on macOS.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="global_menu_is_item_checked" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Returns [code]true[/code] if the item at index [code]idx[/code] is checked.
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
<method name="global_menu_is_item_disabled" qualifiers="const">
<return type="bool" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<description>
Returns [code]true[/code] if the item at index [code]idx[/code] is disabled. When it is disabled it can't be selected, or its action invoked.
See [method global_menu_set_item_disabled] for more info on how to disable an item.
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
<method name="global_menu_is_item_radio_checkable" qualifiers="const">
<return type="bool" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<description>
Returns [code]true[/code] if the item at index [code]idx[/code] has radio button-style checkability.
[b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
[b]Note:[/b] This method is implemented on macOS.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="global_menu_remove_item">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Removes the item at index [code]idx[/code] from the global menu [code]menu_root[/code].
[b]Note:[/b] The indices of items after the removed item will be shifted by one.
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
<method name="global_menu_set_item_accelerator">
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<argument index="2" name="keycode" type="int" enum="Key" />
<description>
Sets the accelerator of the item at index [code]idx[/code].
[b]Note:[/b] This method is implemented on macOS.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="global_menu_set_item_callback">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<argument index="2" name="callback" type="Callable" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Sets the callback of the item at index [code]idx[/code]. Callback is emitted when an item is pressed or its accelerator is activated.
[b]Note:[/b] This method is implemented on macOS.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="global_menu_set_item_checkable">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<argument index="2" name="checkable" type="bool" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Sets whether the item at index [code]idx[/code] has a checkbox. If [code]false[/code], sets the type of the item to plain text.
[b]Note:[/b] This method is implemented on macOS.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="global_menu_set_item_checked">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<argument index="2" name="checked" type="bool" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Sets the checkstate status of the item at index [code]idx[/code].
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
<method name="global_menu_set_item_disabled">
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<argument index="2" name="disabled" type="bool" />
<description>
Enables/disables the item at index [code]idx[/code]. When it is disabled, it can't be selected and its action can't be invoked.
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
<method name="global_menu_set_item_icon">
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<argument index="2" name="icon" type="Texture2D" />
<description>
Replaces the [Texture2D] icon of the specified [code]idx[/code].
[b]Note:[/b] This method is implemented on macOS.
[b]Note:[/b] This method is not supported by macOS "_dock" menu items.
</description>
</method>
<method name="global_menu_set_item_max_states">
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<argument index="2" name="max_states" type="int" />
<description>
Sets number of state of an multistate item. See [method global_menu_add_multistate_item] for details.
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
<method name="global_menu_set_item_radio_checkable">
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<argument index="2" name="checkable" type="bool" />
<description>
Sets the type of the item at the specified index [code]idx[/code] to radio button. If [code]false[/code], sets the type of the item to plain text
[b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups.
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
<method name="global_menu_set_item_state">
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<argument index="2" name="state" type="int" />
<description>
Sets the state of an multistate item. See [method global_menu_add_multistate_item] for details.
[b]Note:[/b] This method is implemented on macOS.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="global_menu_set_item_submenu">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<argument index="2" name="submenu" type="String" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Sets the submenu of the item at index [code]idx[/code]. The submenu is the ID of a global menu root that would be shown when the item is clicked.
[b]Note:[/b] This method is implemented on macOS.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="global_menu_set_item_tag">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<argument index="2" name="tag" type="Variant" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Sets the metadata of an item, which may be of any type. You can later get it with [method global_menu_get_item_tag], which provides a simple way of assigning context data to items.
[b]Note:[/b] This method is implemented on macOS.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="global_menu_set_item_text">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<argument index="2" name="text" type="String" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
[macOS] Add missing global menu features.
2022-03-22 09:26:36 +00:00
Sets the text of the item at index [code]idx[/code].
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
<method name="global_menu_set_item_tooltip">
<return type="void" />
<argument index="0" name="menu_root" type="String" />
<argument index="1" name="idx" type="int" />
<argument index="2" name="tooltip" type="String" />
<description>
Sets the [String] tooltip of the item at the specified index [code]idx[/code].
[b]Note:[/b] This method is implemented on macOS.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="has_feature" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="feature" type="int" enum="DisplayServer.Feature" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="ime_get_selection" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="ime_get_text" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
Add keyboard layout enumeration / set / get functions (macOS, Windows, Linux/X11), remove latin variant function.
2020-06-11 09:27:07 +00:00
<method name="keyboard_get_current_layout" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Add keyboard layout enumeration / set / get functions (macOS, Windows, Linux/X11), remove latin variant function.
2020-06-11 09:27:07 +00:00
<description>
Returns active keyboard layout index.
[b]Note:[/b] This method is implemented on Linux, macOS and Windows.
</description>
</method>
Allow for mapping keycodes to current layout
2021-09-17 01:07:59 +00:00
<method name="keyboard_get_keycode_from_physical" qualifiers="const">
<return type="int" enum="Key" />
<argument index="0" name="keycode" type="int" enum="Key" />
<description>
Converts a physical (US QWERTY) [code]keycode[/code] to one in the active keyboard layout.
[b]Note:[/b] This method is implemented on Linux, macOS and Windows.
</description>
</method>
Add keyboard layout enumeration / set / get functions (macOS, Windows, Linux/X11), remove latin variant function.
2020-06-11 09:27:07 +00:00
<method name="keyboard_get_layout_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Add keyboard layout enumeration / set / get functions (macOS, Windows, Linux/X11), remove latin variant function.
2020-06-11 09:27:07 +00:00
<description>
Returns the number of keyboard layouts.
[b]Note:[/b] This method is implemented on Linux, macOS and Windows.
</description>
</method>
<method name="keyboard_get_layout_language" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
<argument index="0" name="index" type="int" />
Add keyboard layout enumeration / set / get functions (macOS, Windows, Linux/X11), remove latin variant function.
2020-06-11 09:27:07 +00:00
<description>
Returns the ISO-639/BCP-47 language code of the keyboard layout at position [code]index[/code].
[b]Note:[/b] This method is implemented on Linux, macOS and Windows.
</description>
</method>
<method name="keyboard_get_layout_name" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
<argument index="0" name="index" type="int" />
Add keyboard layout enumeration / set / get functions (macOS, Windows, Linux/X11), remove latin variant function.
2020-06-11 09:27:07 +00:00
<description>
Returns the localized name of the keyboard layout at position [code]index[/code].
[b]Note:[/b] This method is implemented on Linux, macOS and Windows.
</description>
</method>
<method name="keyboard_set_current_layout">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="index" type="int" />
Add keyboard layout enumeration / set / get functions (macOS, Windows, Linux/X11), remove latin variant function.
2020-06-11 09:27:07 +00:00
<description>
Sets active keyboard layout.
[b]Note:[/b] This method is implemented on Linux, macOS and Windows.
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="mouse_get_button_state" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="MouseButton" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="mouse_get_mode" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="DisplayServer.MouseMode" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="mouse_get_position" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
DisplayServer: Add multiple descriptions for methods. Added multiple descriptions for clipboard, mouse and window methods.
2021-10-06 20:52:52 +00:00
Returns the mouse cursor's current position.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="mouse_set_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="mouse_mode" type="int" enum="DisplayServer.MouseMode" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="process_events">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="screen_get_dpi" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
<argument index="0" name="screen" type="int" default="-1" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Fix `screen_get_dpi` on macOS for non fractional display scales and restore documentation.
2020-10-01 19:52:20 +00:00
Returns the dots per inch density of the specified screen. If [code]screen[/code] is [/code]SCREEN_OF_MAIN_WINDOW[/code] (the default value), a screen with the main window will be used.
[b]Note:[/b] On macOS, returned value is inaccurate if fractional display scaling mode is used.
[b]Note:[/b] On Android devices, the actual screen densities are grouped into six generalized densities:
[codeblock]
ldpi - 120 dpi
mdpi - 160 dpi
hdpi - 240 dpi
xhdpi - 320 dpi
xxhdpi - 480 dpi
xxxhdpi - 640 dpi
[/codeblock]
[b]Note:[/b] This method is implemented on Android, Linux, macOS and Windows. Returns [code]72[/code] on unsupported platforms.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
[macOS] Implement seamless display scaling.
2020-07-03 10:06:03 +00:00
<method name="screen_get_max_scale" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
[macOS] Implement seamless display scaling.
2020-07-03 10:06:03 +00:00
<description>
Fix usage of "Return" in the docs
2022-01-02 17:32:49 +00:00
Returns the greatest scale factor of all screens.
[macOS] Implement seamless display scaling.
2020-07-03 10:06:03 +00:00
[b]Note:[/b] On macOS returned value is [code]2.0[/code] if there is at least one hiDPI (Retina) screen in the system, and [code]1.0[/code] in all other cases.
[b]Note:[/b] This method is implemented on macOS.
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="screen_get_orientation" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="DisplayServer.ScreenOrientation" />
<argument index="0" name="screen" type="int" default="-1" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="screen_get_position" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="screen" type="int" default="-1" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
Add screen_get_refresh_rate to DisplayServer
2022-01-27 19:46:57 +00:00
<method name="screen_get_refresh_rate" qualifiers="const">
<return type="float" />
<argument index="0" name="screen" type="int" default="-1" />
<description>
Change SCREEN_GET_REFRESH_RATE_FALLBACK to -1.0
2022-02-10 19:31:32 +00:00
Returns the current refresh rate of the specified screen. If [code]screen[/code] is [constant SCREEN_OF_MAIN_WINDOW] (the default value), a screen with the main window will be used.
[b]Note:[/b] Returns [code]-1.0[/code] if the DisplayServer fails to find the refresh rate for the specified screen. On HTML5, [method screen_get_refresh_rate] will always return [code]-1.0[/code] as there is no way to retrieve the refresh rate on that platform.
To fallback to a default refresh rate if the method fails, try:
[codeblock]
var refresh_rate = DisplayServer.screen_get_refresh_rate()
if refresh_rate &lt; 0:
refresh_rate = 60.0
[/codeblock]
Add screen_get_refresh_rate to DisplayServer
2022-01-27 19:46:57 +00:00
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="screen_get_scale" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
<argument index="0" name="screen" type="int" default="-1" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Fix usage of "Return" in the docs
2022-01-02 17:32:49 +00:00
Returns the scale factor of the specified screen by index.
[macOS] Implement seamless display scaling.
2020-07-03 10:06:03 +00:00
[b]Note:[/b] On macOS returned value is [code]2.0[/code] for hiDPI (Retina) screen, and [code]1.0[/code] for all other cases.
[b]Note:[/b] This method is implemented on macOS.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="screen_get_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="screen" type="int" default="-1" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="screen_get_usable_rect" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Rect2i" />
<argument index="0" name="screen" type="int" default="-1" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="screen_is_kept_on" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="screen_is_touchscreen" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="screen" type="int" default="-1" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="screen_set_keep_on">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="enable" type="bool" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="screen_set_orientation">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="orientation" type="int" enum="DisplayServer.ScreenOrientation" />
<argument index="1" name="screen" type="int" default="-1" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="set_icon">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="image" type="Image" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="set_native_icon">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="filename" type="String" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
Move tablet driver API from OS to DisplayServer.
2021-02-17 14:07:56 +00:00
<method name="tablet_get_current_driver" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
Move tablet driver API from OS to DisplayServer.
2021-02-17 14:07:56 +00:00
<description>
Returns current active tablet driver name.
[b]Note:[/b] This method is implemented on Windows.
</description>
</method>
<method name="tablet_get_driver_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Move tablet driver API from OS to DisplayServer.
2021-02-17 14:07:56 +00:00
<description>
Returns the total number of available tablet drivers.
[b]Note:[/b] This method is implemented on Windows.
</description>
</method>
<method name="tablet_get_driver_name" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
<argument index="0" name="idx" type="int" />
Move tablet driver API from OS to DisplayServer.
2021-02-17 14:07:56 +00:00
<description>
Returns the tablet driver name for the given index.
[b]Note:[/b] This method is implemented on Windows.
</description>
</method>
<method name="tablet_set_current_driver">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="name" type="String" />
Move tablet driver API from OS to DisplayServer.
2021-02-17 14:07:56 +00:00
<description>
Set active tablet driver name.
[b]Note:[/b] This method is implemented on Windows.
</description>
</method>
Implement text-to-speech support on Android, iOS, HTML5, Linux, macOS and Windows. Implement TextServer word break method.
2021-11-04 12:33:37 +00:00
<method name="tts_get_voices" qualifiers="const">
<return type="Array" />
<description>
Returns an [Array] of voice information dictionaries.
Each [Dictionary] contains two [String] entries:
- [code]name[/code] is voice name.
- [code]id[/code] is voice identifier.
- [code]language[/code] is language code in [code]lang_Variant[/code] format. [code]lang[/code] part is a 2 or 3-letter code based on the ISO-639 standard, in lowercase. And [code]Variant[/code] part is an engine dependent string describing country, region or/and dialect.
[b]Note:[/b] This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
</description>
</method>
<method name="tts_get_voices_for_language" qualifiers="const">
<return type="PackedStringArray" />
<argument index="0" name="language" type="String" />
<description>
Returns an [PackedStringArray] of voice identifiers for the [code]language[/code].
[b]Note:[/b] This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
</description>
</method>
<method name="tts_is_paused" qualifiers="const">
<return type="bool" />
<description>
Returns [code]true[/code] if the synthesizer is in a paused state.
[b]Note:[/b] This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
</description>
</method>
<method name="tts_is_speaking" qualifiers="const">
<return type="bool" />
<description>
Returns [code]true[/code] if the synthesizer is generating speech, or have utterance waiting in the queue.
[b]Note:[/b] This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
</description>
</method>
<method name="tts_pause">
<return type="void" />
<description>
Puts the synthesizer into a paused state.
[b]Note:[/b] This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
</description>
</method>
<method name="tts_resume">
<return type="void" />
<description>
Resumes the synthesizer if it was paused.
[b]Note:[/b] This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
</description>
</method>
<method name="tts_set_utterance_callback">
<return type="void" />
<argument index="0" name="event" type="int" enum="DisplayServer.TTSUtteranceEvent" />
<argument index="1" name="callable" type="Callable" />
<description>
Adds a callback, which is called when the utterance has started, finished, canceled or reached a text boundary.
- [code]TTS_UTTERANCE_STARTED[/code], [code]TTS_UTTERANCE_ENDED[/code], and [code]TTS_UTTERANCE_CANCELED[/code] callable's method should take one [int] parameter, the utterance id.
- [code]TTS_UTTERANCE_BOUNDARY[/code] callable's method should take two [int] parameters, the index of the character and the utterance id.
[b]Note:[/b] The granularity of the boundary callbacks is engine dependent.
[b]Note:[/b] This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
</description>
</method>
<method name="tts_speak">
<return type="void" />
<argument index="0" name="text" type="String" />
<argument index="1" name="voice" type="String" />
<argument index="2" name="volume" type="int" default="50" />
<argument index="3" name="pitch" type="float" default="1.0" />
<argument index="4" name="rate" type="float" default="1.0" />
<argument index="5" name="utterance_id" type="int" default="0" />
<argument index="6" name="interrupt" type="bool" default="false" />
<description>
Adds an utterance to the queue. If [code]interrupt[/code] is [code]true[/code], the queue is cleared first.
- [code]voice[/code] identifier is one of the [code]"id"[/code] values returned by [method tts_get_voices] or one of the values returned by [method tts_get_voices_for_language].
- [code]volume[/code] ranges from [code]0[/code] (lowest) to [code]100[/code] (highest).
- [code]pitch[/code] ranges from [code]0.0[/code] (lowest) to [code]2.0[/code] (highest), [code]1.0[/code] is default pitch for the current voice.
- [code]rate[/code] ranges from [code]0.1[/code] (lowest) to [code]10.0[/code] (highest), [code]1.0[/code] is a normal speaking rate. Other values act as a percentage relative.
- [code]utterance_id[/code] is passed as a parameter to the callback functions.
[b]Note:[/b] On Windows and Linux, utterance [code]text[/code] 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 [method tts_speak].
[b]Note:[/b] The granularity of pitch, rate, and volume is engine and voice dependent. Values may be truncated.
[b]Note:[/b] This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
</description>
</method>
<method name="tts_stop">
<return type="void" />
<description>
Stops synthesis in progress and removes all utterances from the queue.
[b]Note:[/b] This method is implemented on Android, iOS, HTML5, Linux, macOS, and Windows.
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="virtual_keyboard_get_height" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Fix Return key events in LineEdit & TextEdit on Android Depending on the device implementation, editor actions could be received with different action ids or not at all for multi-line. Added a parameter to virtual keyboards to properly handle single-line and multi-line cases in all situations. Single-line: Input type set to text without multiline to make sure actions are sent. IME options are set to DONE action to force action id consistency. Multi-line: Input type set to text and multiline to make sure enter triggers new lines. Actions are disabled by the multiline flag, so '\n' characters are handled in text changed callbacks.
2020-07-17 15:44:13 +00:00
Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="virtual_keyboard_hide">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Fix Return key events in LineEdit & TextEdit on Android Depending on the device implementation, editor actions could be received with different action ids or not at all for multi-line. Added a parameter to virtual keyboards to properly handle single-line and multi-line cases in all situations. Single-line: Input type set to text without multiline to make sure actions are sent. IME options are set to DONE action to force action id consistency. Multi-line: Input type set to text and multiline to make sure enter triggers new lines. Actions are disabled by the multiline flag, so '\n' characters are handled in text changed callbacks.
2020-07-17 15:44:13 +00:00
Hides the virtual keyboard if it is shown, does nothing otherwise.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="virtual_keyboard_show">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="existing_text" type="String" />
Fix default value for DisplayServer::virtual_keyboard_show Rect2 parameter
2022-02-18 08:31:55 +00:00
<argument index="1" name="position" type="Rect2" default="Rect2(0, 0, 0, 0)" />
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<argument index="2" name="multiline" type="bool" default="false" />
<argument index="3" name="max_length" type="int" default="-1" />
<argument index="4" name="cursor_start" type="int" default="-1" />
<argument index="5" name="cursor_end" type="int" default="-1" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Fix Return key events in LineEdit & TextEdit on Android Depending on the device implementation, editor actions could be received with different action ids or not at all for multi-line. Added a parameter to virtual keyboards to properly handle single-line and multi-line cases in all situations. Single-line: Input type set to text without multiline to make sure actions are sent. IME options are set to DONE action to force action id consistency. Multi-line: Input type set to text and multiline to make sure enter triggers new lines. Actions are disabled by the multiline flag, so '\n' characters are handled in text changed callbacks.
2020-07-17 15:44:13 +00:00
Shows the virtual keyboard if the platform has one.
[code]existing_text[/code] 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).
[code]position[/code] parameter is the screen space [Rect2] of the edited text.
[code]multiline[/code] parameter needs to be set to [code]true[/code] to be able to enter multiple lines of text, as in [TextEdit].
[code]max_length[/code] limits the number of characters that can be entered if different from [code]-1[/code].
[code]cursor_start[/code] can optionally define the current text cursor position if [code]cursor_end[/code] is not set.
[code]cursor_start[/code] and [code]cursor_end[/code] can optionally define the current text selection.
[b]Note:[/b] This method is implemented on Android, iOS and UWP.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
Rename warp mouse functions to warp_mouse
2022-03-27 09:17:36 +00:00
<method name="warp_mouse">
<return type="void" />
<argument index="0" name="position" type="Vector2i" />
<description>
Sets the mouse cursor position to the given [code]position[/code] relative to an origin at the upper left corner of the currently focused game Window Manager window.
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="window_attach_instance_id">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="instance_id" type="int" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="window_can_draw" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
Improve popup window handling. Add window FLAG_POPUP and a platform specific routines to control popup auto-hiding and event forwarding.
2022-02-24 09:21:23 +00:00
<method name="window_get_active_popup" qualifiers="const">
<return type="int" />
<description>
Returns ID of the active popup window, or [constant INVALID_WINDOW_ID] if there is none.
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="window_get_attached_instance_id" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
<argument index="0" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="window_get_current_screen" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
<argument index="0" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="window_get_flag" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="flag" type="int" enum="DisplayServer.WindowFlags" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
DisplayServer: Add multiple descriptions for methods. Added multiple descriptions for clipboard, mouse and window methods.
2021-10-06 20:52:52 +00:00
Returns the current value of the given window's [code]flag[/code].
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="window_get_max_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="window_get_min_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="window_get_mode" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="DisplayServer.WindowMode" />
<argument index="0" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
DisplayServer: Add multiple descriptions for methods. Added multiple descriptions for clipboard, mouse and window methods.
2021-10-06 20:52:52 +00:00
Returns the mode of the given window.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
Add support for getting native display, window, and view handles.
2022-01-14 10:41:04 +00:00
<method name="window_get_native_handle" qualifiers="const">
<return type="int" />
<argument index="0" name="handle_type" type="int" enum="DisplayServer.HandleType" />
<argument index="1" name="window_id" type="int" default="0" />
<description>
Returns internal structure pointers for use in plugins.
[b]Note:[/b] This method is implemented on Android, Linux, macOS and Windows.
</description>
</method>
Improve popup window handling. Add window FLAG_POPUP and a platform specific routines to control popup auto-hiding and event forwarding.
2022-02-24 09:21:23 +00:00
<method name="window_get_popup_safe_rect" qualifiers="const">
<return type="Rect2i" />
<argument index="0" name="window" type="int" />
<description>
Returns the bounding box of control, or menu item that was used to open the popup window, in the screen coordinate system.
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="window_get_position" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
DisplayServer: Add multiple descriptions for methods. Added multiple descriptions for clipboard, mouse and window methods.
2021-10-06 20:52:52 +00:00
Returns the position of the given window to on the screen.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="window_get_real_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="window_get_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2i" />
<argument index="0" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
Restructure and reimplement vsync options -Add a v-sync mode setting which allows to choose between DISABLED, ON, ADAPTIVE and MAILBOX -Removed the V-Sync via Compositor option
2021-06-19 15:44:59 +00:00
<method name="window_get_vsync_mode" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" enum="DisplayServer.VSyncMode" />
<argument index="0" name="window_id" type="int" default="0" />
Restructure and reimplement vsync options -Add a v-sync mode setting which allows to choose between DISABLED, ON, ADAPTIVE and MAILBOX -Removed the V-Sync via Compositor option
2021-06-19 15:44:59 +00:00
<description>
Returns the VSync mode of the given window.
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="window_move_to_foreground">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="window_request_attention">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="window_set_current_screen">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="screen" type="int" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="window_set_drop_files_callback">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="callback" type="Callable" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
Add exclusive window handling to DisplayServer (on macOS and Windows).
2022-01-19 12:04:05 +00:00
<method name="window_set_exclusive">
<return type="void" />
<argument index="0" name="window_id" type="int" />
<argument index="1" name="exclusive" type="bool" />
<description>
If set to [code]true[/code], this window will always stay on top of its parent window, parent window will ignore input while this window is opened.
[b]Note:[/b] On macOS, exclusive windows are confined to the same space (virtual desktop or screen) as the parent window.
[b]Note:[/b] This method is implemented on macOS and Windows.
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="window_set_flag">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="flag" type="int" enum="DisplayServer.WindowFlags" />
<argument index="1" name="enabled" type="bool" />
<argument index="2" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
DisplayServer: Add multiple descriptions for methods. Added multiple descriptions for clipboard, mouse and window methods.
2021-10-06 20:52:52 +00:00
Enables or disables the given window's given [code]flag[/code]. See [enum WindowFlags] for possible values and their behavior.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="window_set_ime_active">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="active" type="bool" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="window_set_ime_position">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="position" type="Vector2i" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="window_set_input_event_callback">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="callback" type="Callable" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="window_set_input_text_callback">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="callback" type="Callable" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="window_set_max_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="max_size" type="Vector2i" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="window_set_min_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="min_size" type="Vector2i" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Define a default minimum window size to workaround rendering issues The minimum window size can still be set to `Vector2(0, 0)` in a script if needed. This closes #37242.
2020-03-23 21:09:22 +00:00
Sets the minimum size for the given window to [code]min_size[/code] (in pixels).
[b]Note:[/b] By default, the main window has a minimum size of [code]Vector2i(64, 64)[/code]. This prevents issues that can arise when the window is resized to a near-zero size.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="window_set_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="mode" type="int" enum="DisplayServer.WindowMode" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
Describe how window mode setter and getter works
2021-10-04 23:23:54 +00:00
Sets window mode for the given window to [code]mode[/code]. See [enum WindowMode] for possible values and how each mode behaves.
[b]Note:[/b] Setting the window to fullscreen forcibly sets the borderless flag to [code]true[/code], so make sure to set it back to [code]false[/code] when not wanted.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
Add window click-through support.
2020-06-29 09:31:36 +00:00
<method name="window_set_mouse_passthrough">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="region" type="PackedVector2Array" />
<argument index="1" name="window_id" type="int" default="0" />
Add window click-through support.
2020-06-29 09:31:36 +00:00
<description>
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).
Port code examples to C# (D) Includes: * Decal * Dictionary * Directory * DisplayServer * DTLSServer * DynamicFont * EditorImportPlugin * EditorPlugin * EditorScenePostImport * EditorScript * EditorSettings * EditorTranslationParserPlugin * Engine * Expression Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-09-13 12:45:36 +00:00
[codeblocks]
[gdscript]
Add window click-through support.
2020-06-29 09:31:36 +00:00
# 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([])
Port code examples to C# (D) Includes: * Decal * Dictionary * Directory * DisplayServer * DTLSServer * DynamicFont * EditorImportPlugin * EditorPlugin * EditorScenePostImport * EditorScript * EditorSettings * EditorTranslationParserPlugin * Engine * Expression Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-09-13 12:45:36 +00:00
[/gdscript]
[csharp]
// Set region, using Path2D node.
DisplayServer.WindowSetMousePassthrough(GetNode&lt;Path2D&gt;("Path2D").Curve.GetBakedPoints());
// Set region, using Polygon2D node.
DisplayServer.WindowSetMousePassthrough(GetNode&lt;Polygon2D&gt;("Polygon2D").Polygon);
// Reset region to default.
DisplayServer.WindowSetMousePassthrough(new Vector2[] {});
[/csharp]
[/codeblocks]
Add window click-through support.
2020-06-29 09:31:36 +00:00
[b]Note:[/b] On Windows, the portion of a window that lies outside the region is not drawn, while on Linux and macOS it is.
[b]Note:[/b] This method is implemented on Linux, macOS and Windows.
</description>
</method>
Improve popup window handling. Add window FLAG_POPUP and a platform specific routines to control popup auto-hiding and event forwarding.
2022-02-24 09:21:23 +00:00
<method name="window_set_popup_safe_rect">
<return type="void" />
<argument index="0" name="window" type="int" />
<argument index="1" name="rect" type="Rect2i" />
<description>
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.
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="window_set_position">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="position" type="Vector2i" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
DisplayServer: Add multiple descriptions for methods. Added multiple descriptions for clipboard, mouse and window methods.
2021-10-06 20:52:52 +00:00
Sets the position of the given window to [code]position[/code].
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="window_set_rect_changed_callback">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="callback" type="Callable" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
<method name="window_set_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="size" type="Vector2i" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
DisplayServer: Add multiple descriptions for methods. Added multiple descriptions for clipboard, mouse and window methods.
2021-10-06 20:52:52 +00:00
Sets the size of the given window to [code]size[/code].
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="window_set_title">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="title" type="String" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
DisplayServer: Add multiple descriptions for methods. Added multiple descriptions for clipboard, mouse and window methods.
2021-10-06 20:52:52 +00:00
Sets the title of the given window to [code]title[/code].
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</description>
</method>
<method name="window_set_transient">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="window_id" type="int" />
<argument index="1" name="parent_window_id" type="int" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
Restructure and reimplement vsync options -Add a v-sync mode setting which allows to choose between DISABLED, ON, ADAPTIVE and MAILBOX -Removed the V-Sync via Compositor option
2021-06-19 15:44:59 +00:00
<method name="window_set_vsync_mode">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="vsync_mode" type="int" enum="DisplayServer.VSyncMode" />
<argument index="1" name="window_id" type="int" default="0" />
Restructure and reimplement vsync options -Add a v-sync mode setting which allows to choose between DISABLED, ON, ADAPTIVE and MAILBOX -Removed the V-Sync via Compositor option
2021-06-19 15:44:59 +00:00
<description>
Sets the VSync mode of the given window.
See [enum DisplayServer.VSyncMode] for possible values and how they affect the behavior of your application.
Depending on the platform and used renderer, the engine will fall back to [constant VSYNC_ENABLED], if the desired mode is not supported.
</description>
</method>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<method name="window_set_window_event_callback">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="callback" type="Callable" />
<argument index="1" name="window_id" type="int" default="0" />
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<description>
</description>
</method>
</methods>
<constants>
<constant name="FEATURE_GLOBAL_MENU" value="0" enum="Feature">
</constant>
<constant name="FEATURE_SUBWINDOWS" value="1" enum="Feature">
</constant>
<constant name="FEATURE_TOUCHSCREEN" value="2" enum="Feature">
</constant>
<constant name="FEATURE_MOUSE" value="3" enum="Feature">
</constant>
<constant name="FEATURE_MOUSE_WARP" value="4" enum="Feature">
</constant>
<constant name="FEATURE_CLIPBOARD" value="5" enum="Feature">
</constant>
<constant name="FEATURE_VIRTUAL_KEYBOARD" value="6" enum="Feature">
</constant>
<constant name="FEATURE_CURSOR_SHAPE" value="7" enum="Feature">
</constant>
<constant name="FEATURE_CUSTOM_CURSOR_SHAPE" value="8" enum="Feature">
</constant>
OS: Remove native video API only implemented on iOS See discussion in #43811, it was only implemented on iOS and even that implementation was fairly limited. This would best be provided as plugins for Android and iOS without cluttering the shared OS API.
2021-05-07 14:50:19 +00:00
<constant name="FEATURE_NATIVE_DIALOG" value="9" enum="Feature">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
[Windows] Improve console handling and execute/create_process. Always build with the GUI subsystem. Redirect stdout and stderr output to the parent process console. Use CreateProcessW for blocking `execute` calls with piped stdout and stderr (prevent console windows for popping up when used with the GUI subsystem build, and have more consistent behavior with `create_process`). Add `open_console` argument to the `execute` and `create_process` to open a new console window. Remove `interface/editor/hide_console_window` editor setting. Remove `Toggle System Console` menu option. Remove `set_console_visible` and `is_console_visible` functions.
2021-12-16 13:00:55 +00:00
<constant name="FEATURE_IME" value="10" enum="Feature">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
[Windows] Improve console handling and execute/create_process. Always build with the GUI subsystem. Redirect stdout and stderr output to the parent process console. Use CreateProcessW for blocking `execute` calls with piped stdout and stderr (prevent console windows for popping up when used with the GUI subsystem build, and have more consistent behavior with `create_process`). Add `open_console` argument to the `execute` and `create_process` to open a new console window. Remove `interface/editor/hide_console_window` editor setting. Remove `Toggle System Console` menu option. Remove `set_console_visible` and `is_console_visible` functions.
2021-12-16 13:00:55 +00:00
<constant name="FEATURE_WINDOW_TRANSPARENCY" value="11" enum="Feature">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
[Windows] Improve console handling and execute/create_process. Always build with the GUI subsystem. Redirect stdout and stderr output to the parent process console. Use CreateProcessW for blocking `execute` calls with piped stdout and stderr (prevent console windows for popping up when used with the GUI subsystem build, and have more consistent behavior with `create_process`). Add `open_console` argument to the `execute` and `create_process` to open a new console window. Remove `interface/editor/hide_console_window` editor setting. Remove `Toggle System Console` menu option. Remove `set_console_visible` and `is_console_visible` functions.
2021-12-16 13:00:55 +00:00
<constant name="FEATURE_HIDPI" value="12" enum="Feature">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
[Windows] Improve console handling and execute/create_process. Always build with the GUI subsystem. Redirect stdout and stderr output to the parent process console. Use CreateProcessW for blocking `execute` calls with piped stdout and stderr (prevent console windows for popping up when used with the GUI subsystem build, and have more consistent behavior with `create_process`). Add `open_console` argument to the `execute` and `create_process` to open a new console window. Remove `interface/editor/hide_console_window` editor setting. Remove `Toggle System Console` menu option. Remove `set_console_visible` and `is_console_visible` functions.
2021-12-16 13:00:55 +00:00
<constant name="FEATURE_ICON" value="13" enum="Feature">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
[Windows] Improve console handling and execute/create_process. Always build with the GUI subsystem. Redirect stdout and stderr output to the parent process console. Use CreateProcessW for blocking `execute` calls with piped stdout and stderr (prevent console windows for popping up when used with the GUI subsystem build, and have more consistent behavior with `create_process`). Add `open_console` argument to the `execute` and `create_process` to open a new console window. Remove `interface/editor/hide_console_window` editor setting. Remove `Toggle System Console` menu option. Remove `set_console_visible` and `is_console_visible` functions.
2021-12-16 13:00:55 +00:00
<constant name="FEATURE_NATIVE_ICON" value="14" enum="Feature">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
[Windows] Improve console handling and execute/create_process. Always build with the GUI subsystem. Redirect stdout and stderr output to the parent process console. Use CreateProcessW for blocking `execute` calls with piped stdout and stderr (prevent console windows for popping up when used with the GUI subsystem build, and have more consistent behavior with `create_process`). Add `open_console` argument to the `execute` and `create_process` to open a new console window. Remove `interface/editor/hide_console_window` editor setting. Remove `Toggle System Console` menu option. Remove `set_console_visible` and `is_console_visible` functions.
2021-12-16 13:00:55 +00:00
<constant name="FEATURE_ORIENTATION" value="15" enum="Feature">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
[Windows] Improve console handling and execute/create_process. Always build with the GUI subsystem. Redirect stdout and stderr output to the parent process console. Use CreateProcessW for blocking `execute` calls with piped stdout and stderr (prevent console windows for popping up when used with the GUI subsystem build, and have more consistent behavior with `create_process`). Add `open_console` argument to the `execute` and `create_process` to open a new console window. Remove `interface/editor/hide_console_window` editor setting. Remove `Toggle System Console` menu option. Remove `set_console_visible` and `is_console_visible` functions.
2021-12-16 13:00:55 +00:00
<constant name="FEATURE_SWAP_BUFFERS" value="16" enum="Feature">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
[Windows] Improve console handling and execute/create_process. Always build with the GUI subsystem. Redirect stdout and stderr output to the parent process console. Use CreateProcessW for blocking `execute` calls with piped stdout and stderr (prevent console windows for popping up when used with the GUI subsystem build, and have more consistent behavior with `create_process`). Add `open_console` argument to the `execute` and `create_process` to open a new console window. Remove `interface/editor/hide_console_window` editor setting. Remove `Toggle System Console` menu option. Remove `set_console_visible` and `is_console_visible` functions.
2021-12-16 13:00:55 +00:00
<constant name="FEATURE_CLIPBOARD_PRIMARY" value="18" enum="Feature">
Fix primary clipboard warning
2021-10-20 19:25:09 +00:00
</constant>
Implement text-to-speech support on Android, iOS, HTML5, Linux, macOS and Windows. Implement TextServer word break method.
2021-11-04 12:33:37 +00:00
<constant name="FEATURE_TEXT_TO_SPEECH" value="19" enum="Feature">
Display server supports text-to-speech. See [code]tts_*[/code] methods.
</constant>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
<constant name="MOUSE_MODE_VISIBLE" value="0" enum="MouseMode">
Add MOUSE_MODE_CONFINED_HIDDEN Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2021-03-30 22:35:08 +00:00
Makes the mouse cursor visible if it is hidden.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="MOUSE_MODE_HIDDEN" value="1" enum="MouseMode">
Add MOUSE_MODE_CONFINED_HIDDEN Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2021-03-30 22:35:08 +00:00
Makes the mouse cursor hidden if it is visible.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="MOUSE_MODE_CAPTURED" value="2" enum="MouseMode">
Add MOUSE_MODE_CONFINED_HIDDEN Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2021-03-30 22:35:08 +00:00
Captures the mouse. The mouse will be hidden and its position locked at the center of the screen.
[b]Note:[/b] If you want to process the mouse's movement in this mode, you need to use [member InputEventMouseMotion.relative].
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="MOUSE_MODE_CONFINED" value="3" enum="MouseMode">
Add MOUSE_MODE_CONFINED_HIDDEN Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2021-03-30 22:35:08 +00:00
Confines the mouse cursor to the game window, and make it visible.
</constant>
<constant name="MOUSE_MODE_CONFINED_HIDDEN" value="4" enum="MouseMode">
Confines the mouse cursor to the game window, and make it hidden.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="SCREEN_OF_MAIN_WINDOW" value="-1">
</constant>
<constant name="MAIN_WINDOW_ID" value="0">
</constant>
<constant name="INVALID_WINDOW_ID" value="-1">
</constant>
<constant name="SCREEN_LANDSCAPE" value="0" enum="ScreenOrientation">
</constant>
<constant name="SCREEN_PORTRAIT" value="1" enum="ScreenOrientation">
</constant>
<constant name="SCREEN_REVERSE_LANDSCAPE" value="2" enum="ScreenOrientation">
</constant>
<constant name="SCREEN_REVERSE_PORTRAIT" value="3" enum="ScreenOrientation">
</constant>
<constant name="SCREEN_SENSOR_LANDSCAPE" value="4" enum="ScreenOrientation">
</constant>
<constant name="SCREEN_SENSOR_PORTRAIT" value="5" enum="ScreenOrientation">
</constant>
<constant name="SCREEN_SENSOR" value="6" enum="ScreenOrientation">
</constant>
<constant name="CURSOR_ARROW" value="0" enum="CursorShape">
</constant>
<constant name="CURSOR_IBEAM" value="1" enum="CursorShape">
</constant>
<constant name="CURSOR_POINTING_HAND" value="2" enum="CursorShape">
</constant>
<constant name="CURSOR_CROSS" value="3" enum="CursorShape">
</constant>
<constant name="CURSOR_WAIT" value="4" enum="CursorShape">
</constant>
<constant name="CURSOR_BUSY" value="5" enum="CursorShape">
</constant>
<constant name="CURSOR_DRAG" value="6" enum="CursorShape">
</constant>
<constant name="CURSOR_CAN_DROP" value="7" enum="CursorShape">
</constant>
<constant name="CURSOR_FORBIDDEN" value="8" enum="CursorShape">
</constant>
<constant name="CURSOR_VSIZE" value="9" enum="CursorShape">
</constant>
<constant name="CURSOR_HSIZE" value="10" enum="CursorShape">
</constant>
<constant name="CURSOR_BDIAGSIZE" value="11" enum="CursorShape">
</constant>
<constant name="CURSOR_FDIAGSIZE" value="12" enum="CursorShape">
</constant>
<constant name="CURSOR_MOVE" value="13" enum="CursorShape">
</constant>
<constant name="CURSOR_VSPLIT" value="14" enum="CursorShape">
</constant>
<constant name="CURSOR_HSPLIT" value="15" enum="CursorShape">
</constant>
<constant name="CURSOR_HELP" value="16" enum="CursorShape">
</constant>
<constant name="CURSOR_MAX" value="17" enum="CursorShape">
</constant>
<constant name="WINDOW_MODE_WINDOWED" value="0" enum="WindowMode">
</constant>
<constant name="WINDOW_MODE_MINIMIZED" value="1" enum="WindowMode">
</constant>
<constant name="WINDOW_MODE_MAXIMIZED" value="2" enum="WindowMode">
</constant>
<constant name="WINDOW_MODE_FULLSCREEN" value="3" enum="WindowMode">
Improve the documentation related to fullscreen and borderless settings
2020-09-03 19:59:40 +00:00
Fullscreen window mode. Note that this is not [i]exclusive[/i] fullscreen. On Windows and Linux, a borderless window is used to emulate fullscreen. On macOS, a new desktop is used to display the running project.
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 09:43:07 +00:00
Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=$DOCS_URL/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode.
[Windows] Add WS_BORDER flag to windows in WINDOW_MODE_FULLSCREEN mode to allow multi-window interface in full-screen. [Windows] Add WINDOW_MODE_EXCLUSIVE_FULLSCREEN without WS_BORDER flag enabled (no multi-window support).
2022-01-28 09:19:53 +00:00
</constant>
<constant name="WINDOW_MODE_EXCLUSIVE_FULLSCREEN" value="4" enum="WindowMode">
Exclusive fullscreen window mode. This mode is implemented on Windows only. On other platforms, it is equivalent to [constant WINDOW_MODE_FULLSCREEN].
Only one window in exclusive fullscreen mode can be visible on a given screen at a time. If multiple windows are in exclusive fullscreen mode for the same screen, the last one being set to this mode takes precedence.
Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=$DOCS_URL/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="WINDOW_FLAG_RESIZE_DISABLED" value="0" enum="WindowFlags">
Improve popup window handling. Add window FLAG_POPUP and a platform specific routines to control popup auto-hiding and event forwarding.
2022-02-24 09:21:23 +00:00
Window can't be resizing by dragging its resize grip. It's still possible to resize the window using [method window_set_size]. This flag is ignored for full screen windows.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="WINDOW_FLAG_BORDERLESS" value="1" enum="WindowFlags">
Improve popup window handling. Add window FLAG_POPUP and a platform specific routines to control popup auto-hiding and event forwarding.
2022-02-24 09:21:23 +00:00
Window do not have native title bar and other decorations. This flag is ignored for full-screen windows.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="WINDOW_FLAG_ALWAYS_ON_TOP" value="2" enum="WindowFlags">
Improve popup window handling. Add window FLAG_POPUP and a platform specific routines to control popup auto-hiding and event forwarding.
2022-02-24 09:21:23 +00:00
Window is floating above other regular windows. This flag is ignored for full-screen windows.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="WINDOW_FLAG_TRANSPARENT" value="3" enum="WindowFlags">
Improve popup window handling. Add window FLAG_POPUP and a platform specific routines to control popup auto-hiding and event forwarding.
2022-02-24 09:21:23 +00:00
Window is will be destroyed with its transient parent and displayed on top of non-exclusive full-screen parent window. Transient windows can't enter full-screen mode.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="WINDOW_FLAG_NO_FOCUS" value="4" enum="WindowFlags">
Improve popup window handling. Add window FLAG_POPUP and a platform specific routines to control popup auto-hiding and event forwarding.
2022-02-24 09:21:23 +00:00
Window can't be focused. No-focus window will ignore all input, except mouse clicks.
</constant>
<constant name="WINDOW_FLAG_POPUP" value="5" enum="WindowFlags">
Fix typos with codespell Using codespell 2.2-dev from current git. Fix a couple incorrect uses of gendered pronouns.
2022-03-31 12:06:10 +00:00
Window is part of menu or [OptionButton] dropdown. This flag can't be changed when 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 [constant WINDOW_FLAG_TRANSPARENT] set.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
Improve popup window handling. Add window FLAG_POPUP and a platform specific routines to control popup auto-hiding and event forwarding.
2022-02-24 09:21:23 +00:00
<constant name="WINDOW_FLAG_MAX" value="6" enum="WindowFlags">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constant>
<constant name="WINDOW_EVENT_MOUSE_ENTER" value="0" enum="WindowEvent">
</constant>
<constant name="WINDOW_EVENT_MOUSE_EXIT" value="1" enum="WindowEvent">
</constant>
<constant name="WINDOW_EVENT_FOCUS_IN" value="2" enum="WindowEvent">
</constant>
<constant name="WINDOW_EVENT_FOCUS_OUT" value="3" enum="WindowEvent">
</constant>
<constant name="WINDOW_EVENT_CLOSE_REQUEST" value="4" enum="WindowEvent">
</constant>
<constant name="WINDOW_EVENT_GO_BACK_REQUEST" value="5" enum="WindowEvent">
</constant>
<constant name="WINDOW_EVENT_DPI_CHANGE" value="6" enum="WindowEvent">
</constant>
Restructure and reimplement vsync options -Add a v-sync mode setting which allows to choose between DISABLED, ON, ADAPTIVE and MAILBOX -Removed the V-Sync via Compositor option
2021-06-19 15:44:59 +00:00
<constant name="VSYNC_DISABLED" value="0" enum="VSyncMode">
No vertical synchronization, which means the engine will display frames as fast as possible (tearing may be visible).
</constant>
<constant name="VSYNC_ENABLED" value="1" enum="VSyncMode">
Default vertical synchronization mode, the image is displayed only on vertical blanking intervals (no tearing is visible).
</constant>
<constant name="VSYNC_ADAPTIVE" value="2" enum="VSyncMode">
Behaves like [constant 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.
</constant>
<constant name="VSYNC_MAILBOX" value="3" enum="VSyncMode">
Displays the most recent image in the queue on vertical blanking intervals, while rendering to the other images (no tearing is visible).
Although not guaranteed, the images can be rendered as fast as possible, which may reduce input lag.
</constant>
Add support for getting native display, window, and view handles.
2022-01-14 10:41:04 +00:00
<constant name="DISPLAY_HANDLE" value="0" enum="HandleType">
Display handle:
- Linux: [code]X11::Display*[/code] for the display.
</constant>
<constant name="WINDOW_HANDLE" value="1" enum="HandleType">
Window handle:
- Windows: [code]HWND[/code] for the window.
- Linux: [code]X11::Window*[/code] for the window.
- MacOS: [code]NSWindow*[/code] for the window.
- iOS: [code]UIViewController*[/code] for the view controller.
- Android: [code]jObject[/code] for the activity.
</constant>
<constant name="WINDOW_VIEW" value="2" enum="HandleType">
Window view:
- MacOS: [code]NSView*[/code] for the window main view.
- iOS: [code]UIView*[/code] for the window main view.
</constant>
Implement text-to-speech support on Android, iOS, HTML5, Linux, macOS and Windows. Implement TextServer word break method.
2021-11-04 12:33:37 +00:00
<constant name="TTS_UTTERANCE_STARTED" value="0" enum="TTSUtteranceEvent">
Utterance has begun to be spoken.
</constant>
<constant name="TTS_UTTERANCE_ENDED" value="1" enum="TTSUtteranceEvent">
Utterance was successfully finished.
</constant>
<constant name="TTS_UTTERANCE_CANCELED" value="2" enum="TTSUtteranceEvent">
Utterance was canceled, or TTS service was unable to process it.
</constant>
<constant name="TTS_UTTERANCE_BOUNDARY" value="3" enum="TTSUtteranceEvent">
Utterance reached a word or sentence boundary.
</constant>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 09:56:58 +00:00
</constants>
</class>