mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
Sync classref with current source
This commit is contained in:
68
classes/class_cameratexture.rst
Normal file
68
classes/class_cameratexture.rst
Normal file
@@ -0,0 +1,68 @@
|
||||
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
||||
.. DO NOT EDIT THIS FILE, but the CameraTexture.xml source instead.
|
||||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||
|
||||
.. _class_CameraTexture:
|
||||
|
||||
CameraTexture
|
||||
=============
|
||||
|
||||
**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
This texture gives access to the camera texture provided by a :ref:`CameraFeed<class_CameraFeed>`. Note that many cameras supply YCbCr images which need to be converted in a shader.
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`camera_feed_id<class_CameraTexture_property_camera_feed_id>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`camera_is_active<class_CameraTexture_property_camera_is_active>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+
|
||||
| :ref:`FeedImage<enum_CameraServer_FeedImage>` | :ref:`which_feed<class_CameraTexture_property_which_feed>` |
|
||||
+-----------------------------------------------+------------------------------------------------------------------------+
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_CameraTexture_property_camera_feed_id:
|
||||
|
||||
- :ref:`int<class_int>` **camera_feed_id**
|
||||
|
||||
+----------+---------------------------+
|
||||
| *Setter* | set_camera_feed_id(value) |
|
||||
+----------+---------------------------+
|
||||
| *Getter* | get_camera_feed_id() |
|
||||
+----------+---------------------------+
|
||||
|
||||
Id of the :ref:`CameraFeed<class_CameraFeed>` for which we want to display the image.
|
||||
|
||||
.. _class_CameraTexture_property_camera_is_active:
|
||||
|
||||
- :ref:`bool<class_bool>` **camera_is_active**
|
||||
|
||||
+----------+--------------------------+
|
||||
| *Setter* | set_camera_active(value) |
|
||||
+----------+--------------------------+
|
||||
| *Getter* | get_camera_active() |
|
||||
+----------+--------------------------+
|
||||
|
||||
Convenience property that gives access to the active property of the :ref:`CameraFeed<class_CameraFeed>`.
|
||||
|
||||
.. _class_CameraTexture_property_which_feed:
|
||||
|
||||
- :ref:`FeedImage<enum_CameraServer_FeedImage>` **which_feed**
|
||||
|
||||
+----------+-----------------------+
|
||||
| *Setter* | set_which_feed(value) |
|
||||
+----------+-----------------------+
|
||||
| *Getter* | 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.
|
||||
|
||||
Reference in New Issue
Block a user