mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
129 lines
4.3 KiB
ReStructuredText
129 lines
4.3 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the CameraFeed.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_CameraFeed:
|
|
|
|
CameraFeed
|
|
==========
|
|
|
|
**Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
A camera feed gives you access to a single physical camera attached to your device.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------------------+-----------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`feed_is_active<class_CameraFeed_property_feed_is_active>` |
|
|
+---------------------------------------+-----------------------------------------------------------------+
|
|
| :ref:`Transform2D<class_Transform2D>` | :ref:`feed_transform<class_CameraFeed_property_feed_transform>` |
|
|
+---------------------------------------+-----------------------------------------------------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
|
| :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 |
|
|
+---------------------------------------------------+-----------------------------------------------------------------------------+
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_CameraFeed_FeedDataType:
|
|
|
|
.. _class_CameraFeed_constant_FEED_NOIMAGE:
|
|
|
|
.. _class_CameraFeed_constant_FEED_RGB:
|
|
|
|
.. _class_CameraFeed_constant_FEED_YCbCr:
|
|
|
|
.. _class_CameraFeed_constant_FEED_YCbCr_Sep:
|
|
|
|
enum **FeedDataType**:
|
|
|
|
- **FEED_NOIMAGE** = **0** --- No image set for the feed.
|
|
|
|
- **FEED_RGB** = **1** --- Feed supplies RGB images.
|
|
|
|
- **FEED_YCbCr** = **2** --- Feed supplies YCbCr images that need to be converted to RGB.
|
|
|
|
- **FEED_YCbCr_Sep** = **3** --- Feed supplies separate Y and CbCr images that need to be combined and converted to RGB.
|
|
|
|
.. _enum_CameraFeed_FeedPosition:
|
|
|
|
.. _class_CameraFeed_constant_FEED_UNSPECIFIED:
|
|
|
|
.. _class_CameraFeed_constant_FEED_FRONT:
|
|
|
|
.. _class_CameraFeed_constant_FEED_BACK:
|
|
|
|
enum **FeedPosition**:
|
|
|
|
- **FEED_UNSPECIFIED** = **0** --- Unspecified position.
|
|
|
|
- **FEED_FRONT** = **1** --- Camera is mounted at the front of the device.
|
|
|
|
- **FEED_BACK** = **2** --- Camera is moutned at the back of the device.
|
|
|
|
Description
|
|
-----------
|
|
|
|
A camera feed gives you access to a single physical camera attached to your device.
|
|
|
|
When enabled Godot will start capturing frames from the camera which can then be used. Do note that many cameras will return YCbCr images which are split into two textures and need to be combined in a shader. Godot does this automatically for you if you set the environment to show the camera image in the background.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_CameraFeed_property_feed_is_active:
|
|
|
|
- :ref:`bool<class_bool>` **feed_is_active**
|
|
|
|
+----------+-------------------+
|
|
| *Setter* | set_active(value) |
|
|
+----------+-------------------+
|
|
| *Getter* | is_active() |
|
|
+----------+-------------------+
|
|
|
|
.. _class_CameraFeed_property_feed_transform:
|
|
|
|
- :ref:`Transform2D<class_Transform2D>` **feed_transform**
|
|
|
|
+----------+----------------------+
|
|
| *Setter* | set_transform(value) |
|
|
+----------+----------------------+
|
|
| *Getter* | get_transform() |
|
|
+----------+----------------------+
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_CameraFeed_method_get_id:
|
|
|
|
- :ref:`int<class_int>` **get_id** **(** **)** const
|
|
|
|
Get unique id for this feed
|
|
|
|
.. _class_CameraFeed_method_get_name:
|
|
|
|
- :ref:`String<class_String>` **get_name** **(** **)** const
|
|
|
|
Get name of the camera
|
|
|
|
.. _class_CameraFeed_method_get_position:
|
|
|
|
- :ref:`FeedPosition<enum_CameraFeed_FeedPosition>` **get_position** **(** **)** const
|
|
|
|
Position of camera on the device.
|
|
|