2017-08-20 16:17:24 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name= "CameraFeed" inherits= "Reference" category= "Core" version= "3.2" >
<brief_description >
A camera feed gives you access to a single physical camera attached to your device.
</brief_description>
<description >
2019-06-22 01:04:47 +02:00
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.
[b]Note:[/b] 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.
2017-08-20 16:17:24 +02:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "get_id" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2019-06-22 01:04:47 +02:00
Gets the unique ID for this feed.
2017-08-20 16:17:24 +02:00
</description>
</method>
<method name= "get_name" qualifiers= "const" >
<return type= "String" >
</return>
<description >
2019-06-22 01:04:47 +02:00
Gets the camera's name.
2017-08-20 16:17:24 +02:00
</description>
</method>
<method name= "get_position" qualifiers= "const" >
<return type= "int" enum= "CameraFeed.FeedPosition" >
</return>
<description >
Position of camera on the device.
</description>
</method>
</methods>
<members >
<member name= "feed_is_active" type= "bool" setter= "set_active" getter= "is_active" >
</member>
<member name= "feed_transform" type= "Transform2D" setter= "set_transform" getter= "get_transform" >
</member>
</members>
<constants >
<constant name= "FEED_NOIMAGE" value= "0" enum= "FeedDataType" >
No image set for the feed.
</constant>
<constant name= "FEED_RGB" value= "1" enum= "FeedDataType" >
Feed supplies RGB images.
</constant>
2019-06-19 14:21:13 +02:00
<constant name= "FEED_YCBCR" value= "2" enum= "FeedDataType" >
2017-08-20 16:17:24 +02:00
Feed supplies YCbCr images that need to be converted to RGB.
</constant>
2019-06-19 14:21:13 +02:00
<constant name= "FEED_YCBCR_SEP" value= "3" enum= "FeedDataType" >
2017-08-20 16:17:24 +02:00
Feed supplies separate Y and CbCr images that need to be combined and converted to RGB.
</constant>
<constant name= "FEED_UNSPECIFIED" value= "0" enum= "FeedPosition" >
Unspecified position.
</constant>
<constant name= "FEED_FRONT" value= "1" enum= "FeedPosition" >
Camera is mounted at the front of the device.
</constant>
<constant name= "FEED_BACK" value= "2" enum= "FeedPosition" >
2019-06-22 01:04:47 +02:00
Camera is mounted at the back of the device.
2017-08-20 16:17:24 +02:00
</constant>
</constants>
</class>