mirror of
https://github.com/godotengine/godot.git
synced 2024-11-27 09:16:35 +08:00
1156 lines
36 KiB
XML
1156 lines
36 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="DisplayServer" inherits="Object" version="4.0">
|
|
<brief_description>
|
|
</brief_description>
|
|
<description>
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="alert">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="text" type="String">
|
|
</argument>
|
|
<argument index="1" name="title" type="String" default=""Alert!"">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="clipboard_get" qualifiers="const">
|
|
<return type="String">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="clipboard_set">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="clipboard" type="String">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="console_set_visible">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="console_visible" type="bool">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="create_sub_window">
|
|
<return type="int">
|
|
</return>
|
|
<argument index="0" name="mode" type="int" enum="DisplayServer.WindowMode">
|
|
</argument>
|
|
<argument index="1" name="flags" type="int">
|
|
</argument>
|
|
<argument index="2" name="rect" type="Rect2i" default="Rect2i(0, 0, 0, 0)">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="cursor_get_shape" qualifiers="const">
|
|
<return type="int" enum="DisplayServer.CursorShape">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="cursor_set_custom_image">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="cursor" type="Resource">
|
|
</argument>
|
|
<argument index="1" name="shape" type="int" enum="DisplayServer.CursorShape" default="0">
|
|
</argument>
|
|
<argument index="2" name="hotspot" type="Vector2" default="Vector2(0, 0)">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="cursor_set_shape">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="shape" type="int" enum="DisplayServer.CursorShape">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="delete_sub_window">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="window_id" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="dialog_input_text">
|
|
<return type="int" enum="Error">
|
|
</return>
|
|
<argument index="0" name="title" type="String">
|
|
</argument>
|
|
<argument index="1" name="description" type="String">
|
|
</argument>
|
|
<argument index="2" name="existing_text" type="String">
|
|
</argument>
|
|
<argument index="3" name="callback" type="Callable">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="dialog_show">
|
|
<return type="int" enum="Error">
|
|
</return>
|
|
<argument index="0" name="title" type="String">
|
|
</argument>
|
|
<argument index="1" name="description" type="String">
|
|
</argument>
|
|
<argument index="2" name="buttons" type="PackedStringArray">
|
|
</argument>
|
|
<argument index="3" name="callback" type="Callable">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="enable_for_stealing_focus">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="process_id" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="force_process_and_drop_events">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_name" qualifiers="const">
|
|
<return type="String">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_screen_count" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_swap_cancel_ok">
|
|
<return type="bool">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_window_at_screen_position" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<argument index="0" name="position" type="Vector2i">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_window_list" qualifiers="const">
|
|
<return type="PackedInt32Array">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_add_check_item">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="label" type="String">
|
|
</argument>
|
|
<argument index="2" name="callback" type="Callable">
|
|
</argument>
|
|
<argument index="3" name="tag" type="Variant" default="null">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_add_item">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="label" type="String">
|
|
</argument>
|
|
<argument index="2" name="callback" type="Callable">
|
|
</argument>
|
|
<argument index="3" name="tag" type="Variant" default="null">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_add_separator">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_add_submenu_item">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="label" type="String">
|
|
</argument>
|
|
<argument index="2" name="submenu" type="String">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_clear">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_get_item_callback">
|
|
<return type="Callable">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="idx" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_get_item_submenu">
|
|
<return type="String">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="idx" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_get_item_tag">
|
|
<return type="Variant">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="idx" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_get_item_text">
|
|
<return type="String">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="idx" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_is_item_checkable" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="idx" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_is_item_checked" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="idx" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_remove_item">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="idx" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_set_item_callback">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="idx" type="int">
|
|
</argument>
|
|
<argument index="2" name="callback" type="Callable">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_set_item_checkable">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="idx" type="int">
|
|
</argument>
|
|
<argument index="2" name="checkable" type="bool">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_set_item_checked">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="idx" type="int">
|
|
</argument>
|
|
<argument index="2" name="checked" type="bool">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_set_item_submenu">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="idx" type="int">
|
|
</argument>
|
|
<argument index="2" name="submenu" type="String">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_set_item_tag">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="idx" type="int">
|
|
</argument>
|
|
<argument index="2" name="tag" type="Variant">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="global_menu_set_item_text">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="menu_root" type="String">
|
|
</argument>
|
|
<argument index="1" name="idx" type="int">
|
|
</argument>
|
|
<argument index="2" name="text" type="String">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="has_feature" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<argument index="0" name="feature" type="int" enum="DisplayServer.Feature">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="ime_get_selection" qualifiers="const">
|
|
<return type="Vector2i">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="ime_get_text" qualifiers="const">
|
|
<return type="String">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="is_console_visible" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="keyboard_get_current_layout" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<description>
|
|
Returns active keyboard layout index.
|
|
[b]Note:[/b] This method is implemented on Linux, macOS and Windows.
|
|
</description>
|
|
</method>
|
|
<method name="keyboard_get_layout_count" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<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">
|
|
<return type="String">
|
|
</return>
|
|
<argument index="0" name="index" type="int">
|
|
</argument>
|
|
<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">
|
|
<return type="String">
|
|
</return>
|
|
<argument index="0" name="index" type="int">
|
|
</argument>
|
|
<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">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="index" type="int">
|
|
</argument>
|
|
<description>
|
|
Sets active keyboard layout.
|
|
[b]Note:[/b] This method is implemented on Linux, macOS and Windows.
|
|
</description>
|
|
</method>
|
|
<method name="mouse_get_absolute_position" qualifiers="const">
|
|
<return type="Vector2i">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="mouse_get_button_state" qualifiers="const">
|
|
<return type="int" enum="MouseButton">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="mouse_get_mode" qualifiers="const">
|
|
<return type="int" enum="DisplayServer.MouseMode">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="mouse_get_position" qualifiers="const">
|
|
<return type="Vector2i">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="mouse_set_mode">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="mouse_mode" type="int" enum="DisplayServer.MouseMode">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="mouse_warp_to_position">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="position" type="Vector2i">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="process_events">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="screen_get_dpi" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<argument index="0" name="screen" type="int" default="-1">
|
|
</argument>
|
|
<description>
|
|
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.
|
|
</description>
|
|
</method>
|
|
<method name="screen_get_max_scale" qualifiers="const">
|
|
<return type="float">
|
|
</return>
|
|
<description>
|
|
Return the greatest scale factor of all screens.
|
|
[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>
|
|
<method name="screen_get_orientation" qualifiers="const">
|
|
<return type="int" enum="DisplayServer.ScreenOrientation">
|
|
</return>
|
|
<argument index="0" name="screen" type="int" default="-1">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="screen_get_position" qualifiers="const">
|
|
<return type="Vector2i">
|
|
</return>
|
|
<argument index="0" name="screen" type="int" default="-1">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="screen_get_scale" qualifiers="const">
|
|
<return type="float">
|
|
</return>
|
|
<argument index="0" name="screen" type="int" default="-1">
|
|
</argument>
|
|
<description>
|
|
Return the scale factor of the specified screen by index.
|
|
[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.
|
|
</description>
|
|
</method>
|
|
<method name="screen_get_size" qualifiers="const">
|
|
<return type="Vector2i">
|
|
</return>
|
|
<argument index="0" name="screen" type="int" default="-1">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="screen_get_usable_rect" qualifiers="const">
|
|
<return type="Rect2i">
|
|
</return>
|
|
<argument index="0" name="screen" type="int" default="-1">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="screen_is_kept_on" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="screen_is_touchscreen" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<argument index="0" name="screen" type="int" default="-1">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="screen_set_keep_on">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="enable" type="bool">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="screen_set_orientation">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="orientation" type="int" enum="DisplayServer.ScreenOrientation">
|
|
</argument>
|
|
<argument index="1" name="screen" type="int" default="-1">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_icon">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="image" type="Image">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="set_native_icon">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="filename" type="String">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="tablet_get_current_driver" qualifiers="const">
|
|
<return type="String">
|
|
</return>
|
|
<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">
|
|
<return type="int">
|
|
</return>
|
|
<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">
|
|
<return type="String">
|
|
</return>
|
|
<argument index="0" name="idx" type="int">
|
|
</argument>
|
|
<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">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="name" type="String">
|
|
</argument>
|
|
<description>
|
|
Set active tablet driver name.
|
|
[b]Note:[/b] This method is implemented on Windows.
|
|
</description>
|
|
</method>
|
|
<method name="virtual_keyboard_get_height" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<description>
|
|
Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden.
|
|
</description>
|
|
</method>
|
|
<method name="virtual_keyboard_hide">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
Hides the virtual keyboard if it is shown, does nothing otherwise.
|
|
</description>
|
|
</method>
|
|
<method name="virtual_keyboard_show">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="existing_text" type="String">
|
|
</argument>
|
|
<argument index="1" name="position" type="Rect2" default="Rect2i(0, 0, 0, 0)">
|
|
</argument>
|
|
<argument index="2" name="multiline" type="bool" default="false">
|
|
</argument>
|
|
<argument index="3" name="max_length" type="int" default="-1">
|
|
</argument>
|
|
<argument index="4" name="cursor_start" type="int" default="-1">
|
|
</argument>
|
|
<argument index="5" name="cursor_end" type="int" default="-1">
|
|
</argument>
|
|
<description>
|
|
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.
|
|
</description>
|
|
</method>
|
|
<method name="vsync_is_enabled" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="vsync_is_using_via_compositor" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="vsync_set_enabled">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="enabled" type="bool">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="vsync_set_use_via_compositor">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="enabled" type="bool">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_attach_instance_id">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="instance_id" type="int">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_can_draw" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<argument index="0" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_get_attached_instance_id" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<argument index="0" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_get_current_screen" qualifiers="const">
|
|
<return type="int">
|
|
</return>
|
|
<argument index="0" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_get_flag" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<argument index="0" name="flag" type="int" enum="DisplayServer.WindowFlags">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_get_max_size" qualifiers="const">
|
|
<return type="Vector2i">
|
|
</return>
|
|
<argument index="0" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_get_min_size" qualifiers="const">
|
|
<return type="Vector2i">
|
|
</return>
|
|
<argument index="0" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_get_mode" qualifiers="const">
|
|
<return type="int" enum="DisplayServer.WindowMode">
|
|
</return>
|
|
<argument index="0" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_get_position" qualifiers="const">
|
|
<return type="Vector2i">
|
|
</return>
|
|
<argument index="0" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_get_real_size" qualifiers="const">
|
|
<return type="Vector2i">
|
|
</return>
|
|
<argument index="0" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_get_size" qualifiers="const">
|
|
<return type="Vector2i">
|
|
</return>
|
|
<argument index="0" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_move_to_foreground">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_request_attention">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_current_screen">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="screen" type="int">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_drop_files_callback">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="callback" type="Callable">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_flag">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="flag" type="int" enum="DisplayServer.WindowFlags">
|
|
</argument>
|
|
<argument index="1" name="enabled" type="bool">
|
|
</argument>
|
|
<argument index="2" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_ime_active">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="active" type="bool">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_ime_position">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="position" type="Vector2i">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_input_event_callback">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="callback" type="Callable">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_input_text_callback">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="callback" type="Callable">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_max_size">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="max_size" type="Vector2i">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_min_size">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="min_size" type="Vector2i">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_mode">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="mode" type="int" enum="DisplayServer.WindowMode">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_mouse_passthrough">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="region" type="PackedVector2Array">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<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).
|
|
[codeblocks]
|
|
[gdscript]
|
|
# 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([])
|
|
[/gdscript]
|
|
[csharp]
|
|
// Set region, using Path2D node.
|
|
DisplayServer.WindowSetMousePassthrough(GetNode<Path2D>("Path2D").Curve.GetBakedPoints());
|
|
|
|
// Set region, using Polygon2D node.
|
|
DisplayServer.WindowSetMousePassthrough(GetNode<Polygon2D>("Polygon2D").Polygon);
|
|
|
|
// Reset region to default.
|
|
DisplayServer.WindowSetMousePassthrough(new Vector2[] {});
|
|
[/csharp]
|
|
[/codeblocks]
|
|
[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>
|
|
<method name="window_set_position">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="position" type="Vector2i">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_rect_changed_callback">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="callback" type="Callable">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_size">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="size" type="Vector2i">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_title">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="title" type="String">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_transient">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="window_id" type="int">
|
|
</argument>
|
|
<argument index="1" name="parent_window_id" type="int">
|
|
</argument>
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="window_set_window_event_callback">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="callback" type="Callable">
|
|
</argument>
|
|
<argument index="1" name="window_id" type="int" default="0">
|
|
</argument>
|
|
<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>
|
|
<constant name="FEATURE_NATIVE_DIALOG" value="9" enum="Feature">
|
|
</constant>
|
|
<constant name="FEATURE_CONSOLE_WINDOW" value="10" enum="Feature">
|
|
</constant>
|
|
<constant name="FEATURE_IME" value="11" enum="Feature">
|
|
</constant>
|
|
<constant name="FEATURE_WINDOW_TRANSPARENCY" value="12" enum="Feature">
|
|
</constant>
|
|
<constant name="FEATURE_HIDPI" value="13" enum="Feature">
|
|
</constant>
|
|
<constant name="FEATURE_ICON" value="14" enum="Feature">
|
|
</constant>
|
|
<constant name="FEATURE_NATIVE_ICON" value="15" enum="Feature">
|
|
</constant>
|
|
<constant name="FEATURE_ORIENTATION" value="16" enum="Feature">
|
|
</constant>
|
|
<constant name="FEATURE_SWAP_BUFFERS" value="17" enum="Feature">
|
|
</constant>
|
|
<constant name="MOUSE_MODE_VISIBLE" value="0" enum="MouseMode">
|
|
Makes the mouse cursor visible if it is hidden.
|
|
</constant>
|
|
<constant name="MOUSE_MODE_HIDDEN" value="1" enum="MouseMode">
|
|
Makes the mouse cursor hidden if it is visible.
|
|
</constant>
|
|
<constant name="MOUSE_MODE_CAPTURED" value="2" enum="MouseMode">
|
|
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].
|
|
</constant>
|
|
<constant name="MOUSE_MODE_CONFINED" value="3" enum="MouseMode">
|
|
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.
|
|
</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">
|
|
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.
|
|
Regardless of the platform, enabling fullscreen will change the window size to match the monitor's size. Therefore, make sure your project supports [url=https://docs.godotengine.org/en/latest/tutorials/rendering/multiple_resolutions.html]multiple resolutions[/url] when enabling fullscreen mode.
|
|
</constant>
|
|
<constant name="WINDOW_FLAG_RESIZE_DISABLED" value="0" enum="WindowFlags">
|
|
</constant>
|
|
<constant name="WINDOW_FLAG_BORDERLESS" value="1" enum="WindowFlags">
|
|
</constant>
|
|
<constant name="WINDOW_FLAG_ALWAYS_ON_TOP" value="2" enum="WindowFlags">
|
|
</constant>
|
|
<constant name="WINDOW_FLAG_TRANSPARENT" value="3" enum="WindowFlags">
|
|
</constant>
|
|
<constant name="WINDOW_FLAG_NO_FOCUS" value="4" enum="WindowFlags">
|
|
</constant>
|
|
<constant name="WINDOW_FLAG_MAX" value="5" enum="WindowFlags">
|
|
</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>
|
|
</constants>
|
|
</class>
|