godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
classes/class_cameratexture.rst
View File

@@ -14,6 +14,8 @@ CameraTexture
Texture provided by a :ref:`CameraFeed<class_CameraFeed>`.
.. rst-class:: classref-introduction-group
Description
-----------
@@ -21,65 +23,77 @@ This texture gives access to the camera texture provided by a :ref:`CameraFeed<c
\ **Note:** Many cameras supply YCbCr images which need to be converted in a shader.
.. rst-class:: classref-reftable-group
Properties
----------
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`camera_feed_id<class_CameraTexture_property_camera_feed_id>` | ``0`` |
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`camera_is_active<class_CameraTexture_property_camera_is_active>` | ``false`` |
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | resource_local_to_scene | ``false`` (overrides :ref:`Resource<class_Resource_property_resource_local_to_scene>`) |
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`FeedImage<enum_CameraServer_FeedImage>` | :ref:`which_feed<class_CameraTexture_property_which_feed>` | ``0`` |
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
.. table::
:widths: auto
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`camera_feed_id<class_CameraTexture_property_camera_feed_id>` | ``0`` |
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`camera_is_active<class_CameraTexture_property_camera_is_active>` | ``false`` |
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | resource_local_to_scene | ``false`` (overrides :ref:`Resource<class_Resource_property_resource_local_to_scene>`) |
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`FeedImage<enum_CameraServer_FeedImage>` | :ref:`which_feed<class_CameraTexture_property_which_feed>` | ``0`` |
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_CameraTexture_property_camera_feed_id:
- :ref:`int<class_int>` **camera_feed_id**
.. rst-class:: classref-property
+-----------+---------------------------+
| *Default* | ``0`` |
+-----------+---------------------------+
| *Setter* | set_camera_feed_id(value) |
+-----------+---------------------------+
| *Getter* | get_camera_feed_id() |
+-----------+---------------------------+
:ref:`int<class_int>` **camera_feed_id** = ``0``
.. rst-class:: classref-property-setget
- void **set_camera_feed_id** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_camera_feed_id** **(** **)**
The ID of the :ref:`CameraFeed<class_CameraFeed>` for which we want to display the image.
.. rst-class:: classref-item-separator
----
.. _class_CameraTexture_property_camera_is_active:
- :ref:`bool<class_bool>` **camera_is_active**
.. rst-class:: classref-property
+-----------+--------------------------+
| *Default* | ``false`` |
+-----------+--------------------------+
| *Setter* | set_camera_active(value) |
+-----------+--------------------------+
| *Getter* | get_camera_active() |
+-----------+--------------------------+
:ref:`bool<class_bool>` **camera_is_active** = ``false``
.. rst-class:: classref-property-setget
- void **set_camera_active** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **get_camera_active** **(** **)**
Convenience property that gives access to the active property of the :ref:`CameraFeed<class_CameraFeed>`.
.. rst-class:: classref-item-separator
----
.. _class_CameraTexture_property_which_feed:
- :ref:`FeedImage<enum_CameraServer_FeedImage>` **which_feed**
.. rst-class:: classref-property
+-----------+-----------------------+
| *Default* | ``0`` |
+-----------+-----------------------+
| *Setter* | set_which_feed(value) |
+-----------+-----------------------+
| *Getter* | get_which_feed() |
+-----------+-----------------------+
:ref:`FeedImage<enum_CameraServer_FeedImage>` **which_feed** = ``0``
.. rst-class:: classref-property-setget
- void **set_which_feed** **(** :ref:`FeedImage<enum_CameraServer_FeedImage>` value **)**
- :ref:`FeedImage<enum_CameraServer_FeedImage>` **get_which_feed** **(** **)**
Which image within the :ref:`CameraFeed<class_CameraFeed>` we want access to, important if the camera image is split in a Y and CbCr component.