stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (76a1359)

Browse Source
This commit is contained in:
Godot Organization
2024-09-28 03:21:12 +00:00
parent f16608e044
commit 28d9cb75e9
47 changed files with 1073 additions and 171 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_camerafeed.rst
+76 -9
View File
@@ -36,6 +36,8 @@ Properties
+---------------------------------------+-----------------------------------------------------------------+------------------------------------+
| :ref:`Transform2D<class_Transform2D>` | :ref:`feed_transform<class_CameraFeed_property_feed_transform>` | ``Transform2D(1, 0, 0, -1, 0, 1)`` |
+---------------------------------------+-----------------------------------------------------------------+------------------------------------+
| :ref:`Array<class_Array>` | :ref:`formats<class_CameraFeed_property_formats>` | ``[]`` |
+---------------------------------------+-----------------------------------------------------------------+------------------------------------+
.. rst-class:: classref-reftable-group
@@ -45,15 +47,46 @@ Methods
.. table::
:widths: auto
+---------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`FeedDataType<enum_CameraFeed_FeedDataType>` | :ref:`get_datatype<class_CameraFeed_method_get_datatype>`\ (\ ) |const| |
+---------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_id<class_CameraFeed_method_get_id>`\ (\ ) |const| |
+---------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_name<class_CameraFeed_method_get_name>`\ (\ ) |const| |
+---------------------------------------------------+-------------------------------------------------------------------------+
| :ref:`FeedPosition<enum_CameraFeed_FeedPosition>` | :ref:`get_position<class_CameraFeed_method_get_position>`\ (\ ) |const| |
+---------------------------------------------------+-------------------------------------------------------------------------+
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`FeedDataType<enum_CameraFeed_FeedDataType>` | :ref:`get_datatype<class_CameraFeed_method_get_datatype>`\ (\ ) |const| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_id<class_CameraFeed_method_get_id>`\ (\ ) |const| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_name<class_CameraFeed_method_get_name>`\ (\ ) |const| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`FeedPosition<enum_CameraFeed_FeedPosition>` | :ref:`get_position<class_CameraFeed_method_get_position>`\ (\ ) |const| |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`set_format<class_CameraFeed_method_set_format>`\ (\ index\: :ref:`int<class_int>`, parameters\: :ref:`Dictionary<class_Dictionary>`\ ) |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Signals
-------
.. _class_CameraFeed_signal_format_changed:
.. rst-class:: classref-signal
**format_changed**\ (\ ) :ref:`🔗<class_CameraFeed_signal_format_changed>`
Emitted when the format has changed.
.. rst-class:: classref-item-separator
----
.. _class_CameraFeed_signal_frame_changed:
.. rst-class:: classref-signal
**frame_changed**\ (\ ) :ref:`🔗<class_CameraFeed_signal_frame_changed>`
Emitted when a new frame is available.
.. rst-class:: classref-section-separator
@@ -175,6 +208,22 @@ If ``true``, the feed is active.
The transform applied to the camera's image.
.. rst-class:: classref-item-separator
----
.. _class_CameraFeed_property_formats:
.. rst-class:: classref-property
:ref:`Array<class_Array>` **formats** = ``[]`` :ref:`🔗<class_CameraFeed_property_formats>`
.. rst-class:: classref-property-setget
- :ref:`Array<class_Array>` **get_formats**\ (\ )
Formats supported by the feed. Each entry is a :ref:`Dictionary<class_Dictionary>` describing format parameters.
.. rst-class:: classref-section-separator
----
@@ -228,6 +277,24 @@ Returns the camera's name.
Returns the position of camera on the device.
.. rst-class:: classref-item-separator
----
.. _class_CameraFeed_method_set_format:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **set_format**\ (\ index\: :ref:`int<class_int>`, parameters\: :ref:`Dictionary<class_Dictionary>`\ ) :ref:`🔗<class_CameraFeed_method_set_format>`
Sets the feed format parameters for the given index in the :ref:`formats<class_CameraFeed_property_formats>` array. Returns ``true`` on success. By default YUYV encoded stream is transformed to FEED_RGB. YUYV encoded stream output format can be changed with ``parameters``.output value:
\ ``separate`` will result in FEED_YCBCR_SEP
\ ``grayscale`` will result in desaturated FEED_RGB
\ ``copy`` will result in FEED_YCBCR
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`