103 lines
4.6 KiB
ReStructuredText
103 lines
4.6 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/CameraTexture.xml.
|
|
|
|
.. _class_CameraTexture:
|
|
|
|
CameraTexture
|
|
=============
|
|
|
|
**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
Texture provided by a :ref:`CameraFeed<class_CameraFeed>`.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
This texture gives access to the camera texture provided by a :ref:`CameraFeed<class_CameraFeed>`.
|
|
|
|
\ **Note:** Many cameras supply YCbCr images which need to be converted in a shader.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. 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:`int<class_int>` | flags | ``0`` (overrides :ref:`Texture<class_Texture_property_flags>`) |
|
|
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------+
|
|
| :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:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
: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.
|
|
|
|
.. |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.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|