diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/EditorSettings.xml | 3 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 4 | ||||
| -rw-r--r-- | doc/classes/Window.xml | 7 |
3 files changed, 10 insertions, 4 deletions
diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index d63c71a351..4d82a32dae 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -719,7 +719,8 @@ [b]Note:[/b] If the editor was started with the [code]--debug-canvas-item-redraw[/code] [url=$DOCS_URL/tutorials/editor/command_line_tutorial.html]command line argument[/url], the update spinner will [i]never[/i] display regardless of this setting's value. This is to avoid confusion with what would cause redrawing in real world scenarios. </member> <member name="interface/editor/single_window_mode" type="bool" setter="" getter=""> - If [code]true[/code], embed modal windows such as docks inside the main editor window. When single-window mode is enabled, tooltips will also be embedded inside the main editor window, which means they can't be displayed outside of the editor window. + If [code]true[/code], embed modal windows such as docks inside the main editor window. When single-window mode is enabled, tooltips will also be embedded inside the main editor window, which means they can't be displayed outside of the editor window. Single-window mode can be faster as it does not need to create a separate window for every popup and tooltip, which can be a slow operation depending on the operating system and rendering method in use. + This is equivalent to [member ProjectSettings.display/window/subwindows/embed_subwindows] in the running project, except the setting's value is inverted. [b]Note:[/b] To query whether the editor can use multiple windows in an editor plugin, use [method EditorInterface.is_multi_window_enabled] instead of querying the value of this editor setting. </member> <member name="interface/editor/ui_layout_direction" type="int" setter="" getter=""> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 22c25dd5e5..b20b374382 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -913,7 +913,9 @@ [b]Note:[/b] When using integer scaling with a stretch mode, resizing the window to be smaller than the base viewport size will clip the contents. Consider preventing that by setting [member Window.min_size] to the same value as the base viewport size defined in [member display/window/size/viewport_width] and [member display/window/size/viewport_height]. </member> <member name="display/window/subwindows/embed_subwindows" type="bool" setter="" getter="" default="true"> - If [code]true[/code] subwindows are embedded in the main window. + If [code]true[/code], subwindows are embedded in the main window (this is also called single-window mode). Single-window mode can be faster as it does not need to create a separate window for every popup and tooltip, which can be a slow operation depending on the operating system and rendering method in use. + If [code]false[/code], subwindows are created as separate windows (this is also called multi-window mode). This allows them to be moved outside the main window and use native operating system window decorations. + This is equivalent to [member EditorSettings.interface/editor/single_window_mode] in the editor, except the setting's value is inverted. </member> <member name="display/window/vsync/vsync_mode" type="int" setter="" getter="" default="1"> Sets the V-Sync mode for the main game window. The editor's own V-Sync mode can be set using [member EditorSettings.interface/editor/vsync_mode]. diff --git a/doc/classes/Window.xml b/doc/classes/Window.xml index 286b35d642..ca155881c8 100644 --- a/doc/classes/Window.xml +++ b/doc/classes/Window.xml @@ -370,6 +370,9 @@ <param index="0" name="rect" type="Rect2i" default="Rect2i(0, 0, 0, 0)" /> <description> Shows the [Window] and makes it transient (see [member transient]). If [param rect] is provided, it will be set as the [Window]'s size. Fails if called on the main window. + If [member ProjectSettings.display/window/subwindows/embed_subwindows] is [code]true[/code] (single-window mode), [param rect]'s coordinates are global and relative to the main window's top-left corner (excluding window decorations). If [param rect]'s position coordinates are negative, the window will be located outside the main window and may not be visible as a result. + If [member ProjectSettings.display/window/subwindows/embed_subwindows] is [code]false[/code] (multi-window mode), [param rect]'s coordinates are global and relative to the top-left corner of the leftmost screen. If [param rect]'s position coordinates are negative, the window will be placed at the top-left corner of the screen. + [b]Note:[/b] [param rect] must be in global coordinates if specified. </description> </method> <method name="popup_centered"> @@ -380,7 +383,7 @@ [b]Note:[/b] Calling it with the default value of [param minsize] is equivalent to calling it with [member size]. </description> </method> - <method name="popup_centered_clamped"> + <method name="popup_centered_clamped" keywords="minsize"> <return type="void" /> <param index="0" name="minsize" type="Vector2i" default="Vector2i(0, 0)" /> <param index="1" name="fallback_ratio" type="float" default="0.75" /> @@ -415,7 +418,7 @@ See also [method set_unparent_when_invisible] and [method Node.get_last_exclusive_window]. </description> </method> - <method name="popup_exclusive_centered_clamped"> + <method name="popup_exclusive_centered_clamped" keywords="minsize"> <return type="void" /> <param index="0" name="from_node" type="Node" /> <param index="1" name="minsize" type="Vector2i" default="Vector2i(0, 0)" /> |