Skip to content

Commit

Permalink
Merge pull request #60 from Redot-Engine/classref/sync-e7894c2
Browse files Browse the repository at this point in the history
classref: Sync with current master branch (e7894c2)
  • Loading branch information
Spartan322 authored Nov 12, 2024
2 parents 2666897 + 69e7b9b commit fd8af83
Show file tree
Hide file tree
Showing 16 changed files with 759 additions and 84 deletions.
36 changes: 36 additions & 0 deletions classes/class_camerafeed.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ Methods
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`FeedPosition<enum_CameraFeed_FeedPosition>` | :ref:`get_position<class_CameraFeed_method_get_position>`\ (\ ) |const| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_texture_tex_id<class_CameraFeed_method_get_texture_tex_id>`\ (\ feed_image_type\: :ref:`FeedImage<enum_CameraServer_FeedImage>`\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_external<class_CameraFeed_method_set_external>`\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`set_format<class_CameraFeed_method_set_format>`\ (\ index\: :ref:`int<class_int>`, parameters\: :ref:`Dictionary<class_Dictionary>`\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_name<class_CameraFeed_method_set_name>`\ (\ name\: :ref:`String<class_String>`\ ) |
Expand Down Expand Up @@ -143,6 +147,14 @@ Feed supplies YCbCr images that need to be converted to RGB.

Feed supplies separate Y and CbCr images that need to be combined and converted to RGB.

.. _class_CameraFeed_constant_FEED_EXTERNAL:

.. rst-class:: classref-enumeration-constant

:ref:`FeedDataType<enum_CameraFeed_FeedDataType>` **FEED_EXTERNAL** = ``4``

Feed supplies external image.

.. rst-class:: classref-item-separator

----
Expand Down Expand Up @@ -289,6 +301,30 @@ Returns the position of camera on the device.

----

.. _class_CameraFeed_method_get_texture_tex_id:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_texture_tex_id**\ (\ feed_image_type\: :ref:`FeedImage<enum_CameraServer_FeedImage>`\ ) :ref:`🔗<class_CameraFeed_method_get_texture_tex_id>`

Returns the texture backend ID (usable by some external libraries that need a handle to a texture to write data).

.. rst-class:: classref-item-separator

----

.. _class_CameraFeed_method_set_external:

.. rst-class:: classref-method

|void| **set_external**\ (\ width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CameraFeed_method_set_external>`

Sets the feed as external feed provided by another library.

.. rst-class:: classref-item-separator

----

.. _class_CameraFeed_method_set_format:

.. rst-class:: classref-method
Expand Down
6 changes: 3 additions & 3 deletions classes/class_classdb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Methods
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_instantiate<class_ClassDB_method_can_instantiate>`\ (\ class\: :ref:`StringName<class_StringName>`\ ) |const| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`class_call_static_method<class_ClassDB_method_class_call_static_method>`\ (\ class\: :ref:`StringName<class_StringName>`, method\: :ref:`StringName<class_StringName>`, ...\ ) |vararg| |
| :ref:`Variant<class_Variant>` | :ref:`class_call_static<class_ClassDB_method_class_call_static>`\ (\ class\: :ref:`StringName<class_StringName>`, method\: :ref:`StringName<class_StringName>`, ...\ ) |vararg| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`class_exists<class_ClassDB_method_class_exists>`\ (\ class\: :ref:`StringName<class_StringName>`\ ) |const| |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Expand Down Expand Up @@ -167,11 +167,11 @@ Returns ``true`` if objects can be instantiated from the specified ``class``, ot

----

.. _class_ClassDB_method_class_call_static_method:
.. _class_ClassDB_method_class_call_static:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **class_call_static_method**\ (\ class\: :ref:`StringName<class_StringName>`, method\: :ref:`StringName<class_StringName>`, ...\ ) |vararg| :ref:`🔗<class_ClassDB_method_class_call_static_method>`
:ref:`Variant<class_Variant>` **class_call_static**\ (\ class\: :ref:`StringName<class_StringName>`, method\: :ref:`StringName<class_StringName>`, ...\ ) |vararg| :ref:`🔗<class_ClassDB_method_class_call_static>`

Calls a static method on a class.

Expand Down
24 changes: 17 additions & 7 deletions classes/class_displayserver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -618,7 +618,15 @@ Display server supports spawning text input dialogs using the operating system's

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE** = ``25``

Display server supports spawning dialogs for selecting files or directories using the operating system's native look-and-feel. See :ref:`file_dialog_show<class_DisplayServer_method_file_dialog_show>` and :ref:`file_dialog_with_options_show<class_DisplayServer_method_file_dialog_with_options_show>`. **Windows, macOS, Linux (X11/Wayland)**
Display server supports spawning dialogs for selecting files or directories using the operating system's native look-and-feel. See :ref:`file_dialog_show<class_DisplayServer_method_file_dialog_show>`. **Windows, macOS, Linux (X11/Wayland), Android**

.. _class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE_EXTRA:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_DisplayServer_Feature>` **FEATURE_NATIVE_DIALOG_FILE_EXTRA** = ``26``

The display server supports all features of :ref:`FEATURE_NATIVE_DIALOG_FILE<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE>`, with the added functionality of Options and native dialog file access to ``res://`` and ``user://`` paths. See :ref:`file_dialog_show<class_DisplayServer_method_file_dialog_show>` and :ref:`file_dialog_with_options_show<class_DisplayServer_method_file_dialog_with_options_show>`. **Windows, macOS, Linux (X11/Wayland)**

.. rst-class:: classref-item-separator

Expand Down Expand Up @@ -1746,15 +1754,17 @@ Displays OS native dialog for selecting files or directories in the file system.

Each filter string in the ``filters`` array should be formatted like this: ``*.txt,*.doc;Text Files``. The description text of the filter is optional and can be omitted. See also :ref:`FileDialog.filters<class_FileDialog_property_filters>`.

Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int``.
Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int``. **On Android,** callback argument ``selected_filter_index`` is always zero.

\ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_FILE<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE>` feature. Supported platforms include Linux (X11/Wayland), Windows, and macOS.
\ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_FILE<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE>` feature. Supported platforms include Linux (X11/Wayland), Windows, macOS, and Android.

\ **Note:** ``current_directory`` might be ignored.

\ **Note:** On Linux, ``show_hidden`` is ignored.
\ **Note:** On Android, the filter strings in the ``filters`` array should be specified using MIME types, for example:``image/png, image/jpeg"``. Additionally, the ``mode`` :ref:`FILE_DIALOG_MODE_OPEN_ANY<class_DisplayServer_constant_FILE_DIALOG_MODE_OPEN_ANY>` is not supported on Android.

\ **Note:** On macOS, native file dialogs have no title.
\ **Note:** On Android and Linux, ``show_hidden`` is ignored.

\ **Note:** On Android and macOS, native file dialogs have no title.

\ **Note:** On macOS, sandboxed apps will save security-scoped bookmarks to retain access to the opened folders across multiple sessions. Use :ref:`OS.get_granted_permissions<class_OS_method_get_granted_permissions>` to get a list of saved bookmarks.

Expand Down Expand Up @@ -1782,7 +1792,7 @@ Each filter string in the ``filters`` array should be formatted like this: ``*.t

Callbacks have the following arguments: ``status: bool, selected_paths: PackedStringArray, selected_filter_index: int, selected_option: Dictionary``.

\ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_FILE<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE>` feature. Supported platforms include Linux (X11/Wayland), Windows, and macOS.
\ **Note:** This method is implemented if the display server has the :ref:`FEATURE_NATIVE_DIALOG_FILE_EXTRA<class_DisplayServer_constant_FEATURE_NATIVE_DIALOG_FILE_EXTRA>` feature. Supported platforms include Linux (X11/Wayland), Windows, and macOS.

\ **Note:** ``current_directory`` might be ignored.

Expand Down Expand Up @@ -1818,7 +1828,7 @@ Forces window manager processing while ignoring all :ref:`InputEvent<class_Input

Returns OS theme accent color. Returns ``Color(0, 0, 0, 0)``, if accent color is unknown.

\ **Note:** This method is implemented on macOS and Windows.
\ **Note:** This method is implemented on macOS, Windows, and Android.

.. rst-class:: classref-item-separator

Expand Down
10 changes: 9 additions & 1 deletion classes/class_editorfeatureprofile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,19 @@ The Import dock. If this feature is disabled, the Import dock won't be visible.

The History dock. If this feature is disabled, the History dock won't be visible.

.. _class_EditorFeatureProfile_constant_FEATURE_GAME:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_EditorFeatureProfile_Feature>` **FEATURE_GAME** = ``8``

The Game tab, which allows embedding the game window and selecting nodes by clicking inside of it. If this feature is disabled, the Game tab won't display.

.. _class_EditorFeatureProfile_constant_FEATURE_MAX:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_EditorFeatureProfile_Feature>` **FEATURE_MAX** = ``8``
:ref:`Feature<enum_EditorFeatureProfile_Feature>` **FEATURE_MAX** = ``9``

Represents the size of the :ref:`Feature<enum_EditorFeatureProfile_Feature>` enum.

Expand Down
6 changes: 5 additions & 1 deletion classes/class_filedialog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,8 @@ See also :ref:`filters<class_FileDialog_property_filters>`, which should be used

The available file type filters. Each filter string in the array should be formatted like this: ``*.txt,*.doc;Text Files``. The description text of the filter is optional and can be omitted.

\ **Note:** For android native dialog, MIME types are used like this: ``image/*, application/pdf``.

**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray<class_PackedStringArray>` for more details.

.. rst-class:: classref-item-separator
Expand Down Expand Up @@ -479,7 +481,7 @@ If non-empty, the given sub-folder will be "root" of this **FileDialog**, i.e. u

If ``true``, the dialog will show hidden files.

\ **Note:** This property is ignored by native file dialogs on Linux.
\ **Note:** This property is ignored by native file dialogs on Android and Linux.

.. rst-class:: classref-item-separator

Expand All @@ -498,6 +500,8 @@ If ``true``, the dialog will show hidden files.

If ``true``, and if supported by the current :ref:`DisplayServer<class_DisplayServer>`, OS native dialog will be used instead of custom one.

\ **Note:** On Android, it is only supported when using :ref:`ACCESS_FILESYSTEM<class_FileDialog_constant_ACCESS_FILESYSTEM>`. For access mode :ref:`ACCESS_RESOURCES<class_FileDialog_constant_ACCESS_RESOURCES>` and :ref:`ACCESS_USERDATA<class_FileDialog_constant_ACCESS_USERDATA>`, the system will fall back to custom FileDialog.

\ **Note:** On Linux and macOS, sandboxed apps always use native dialogs to access the host file system.

\ **Note:** On macOS, sandboxed apps will save security-scoped bookmarks to retain access to the opened folders across multiple sessions. Use :ref:`OS.get_granted_permissions<class_OS_method_get_granted_permissions>` to get a list of saved bookmarks.
Expand Down
Loading

0 comments on commit fd8af83

Please sign in to comment.