: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/CameraFeed.xml. .. _class_CameraFeed: CameraFeed ========== **Inherits:** :ref:`Reference` **<** :ref:`Object` A camera feed gives you access to a single physical camera attached to your device. .. rst-class:: classref-introduction-group 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. See also :ref:`CameraServer`. \ **Note:** 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. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------+-----------------------------------------------------------------+--------------------------------------+ | :ref:`bool` | :ref:`feed_is_active` | ``false`` | +---------------------------------------+-----------------------------------------------------------------+--------------------------------------+ | :ref:`Transform2D` | :ref:`feed_transform` | ``Transform2D( 1, 0, 0, -1, 0, 1 )`` | +---------------------------------------+-----------------------------------------------------------------+--------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_id` **(** **)** |const| | +---------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_name` **(** **)** |const| | +---------------------------------------------------+-------------------------------------------------------------------------------+ | :ref:`FeedPosition` | :ref:`get_position` **(** **)** |const| | +---------------------------------------------------+-------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_CameraFeed_FeedDataType: .. rst-class:: classref-enumeration enum **FeedDataType**: .. _class_CameraFeed_constant_FEED_NOIMAGE: .. rst-class:: classref-enumeration-constant :ref:`FeedDataType` **FEED_NOIMAGE** = ``0`` No image set for the feed. .. _class_CameraFeed_constant_FEED_RGB: .. rst-class:: classref-enumeration-constant :ref:`FeedDataType` **FEED_RGB** = ``1`` Feed supplies RGB images. .. _class_CameraFeed_constant_FEED_YCBCR: .. rst-class:: classref-enumeration-constant :ref:`FeedDataType` **FEED_YCBCR** = ``2`` Feed supplies YCbCr images that need to be converted to RGB. .. _class_CameraFeed_constant_FEED_YCBCR_SEP: .. rst-class:: classref-enumeration-constant :ref:`FeedDataType` **FEED_YCBCR_SEP** = ``3`` Feed supplies separate Y and CbCr images that need to be combined and converted to RGB. .. rst-class:: classref-item-separator ---- .. _enum_CameraFeed_FeedPosition: .. rst-class:: classref-enumeration enum **FeedPosition**: .. _class_CameraFeed_constant_FEED_UNSPECIFIED: .. rst-class:: classref-enumeration-constant :ref:`FeedPosition` **FEED_UNSPECIFIED** = ``0`` Unspecified position. .. _class_CameraFeed_constant_FEED_FRONT: .. rst-class:: classref-enumeration-constant :ref:`FeedPosition` **FEED_FRONT** = ``1`` Camera is mounted at the front of the device. .. _class_CameraFeed_constant_FEED_BACK: .. rst-class:: classref-enumeration-constant :ref:`FeedPosition` **FEED_BACK** = ``2`` Camera is mounted at the back of the device. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_CameraFeed_property_feed_is_active: .. rst-class:: classref-property :ref:`bool` **feed_is_active** = ``false`` .. rst-class:: classref-property-setget - void **set_active** **(** :ref:`bool` value **)** - :ref:`bool` **is_active** **(** **)** If ``true``, the feed is active. .. rst-class:: classref-item-separator ---- .. _class_CameraFeed_property_feed_transform: .. rst-class:: classref-property :ref:`Transform2D` **feed_transform** = ``Transform2D( 1, 0, 0, -1, 0, 1 )`` .. rst-class:: classref-property-setget - void **set_transform** **(** :ref:`Transform2D` value **)** - :ref:`Transform2D` **get_transform** **(** **)** The transform applied to the camera's image. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_CameraFeed_method_get_id: .. rst-class:: classref-method :ref:`int` **get_id** **(** **)** |const| Returns the unique ID for this feed. .. rst-class:: classref-item-separator ---- .. _class_CameraFeed_method_get_name: .. rst-class:: classref-method :ref:`String` **get_name** **(** **)** |const| Returns the camera's name. .. rst-class:: classref-item-separator ---- .. _class_CameraFeed_method_get_position: .. rst-class:: classref-method :ref:`FeedPosition` **get_position** **(** **)** |const| Returns the position of camera on the device. .. |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.)`