godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/CameraServer.xml

86 lines
2.3 KiB
XML
Raw Normal View History

Adding a new Camera Server implementation to Godot. This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server. Other parts of Godot can interact with this to obtain images from the camera as textures. This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2017-08-20 14:17:24 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Sync classref with 3.3 version bump
2021-03-23 12:40:34 +00:00
<class name="CameraServer" inherits="Object" version="3.3">
Adding a new Camera Server implementation to Godot. This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server. Other parts of Godot can interact with this to obtain images from the camera as textures. This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2017-08-20 14:17:24 +00:00
<brief_description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 10:14:14 +00:00
Server keeping track of different cameras accessible in Godot.
Adding a new Camera Server implementation to Godot. This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server. Other parts of Godot can interact with this to obtain images from the camera as textures. This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2017-08-20 14:17:24 +00:00
</brief_description>
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 10:14:14 +00:00
The [CameraServer] keeps track of different cameras accessible in Godot. These are external cameras such as webcams or the cameras on your phone.
It is notably used to provide AR modules with a video feed from the camera.
Adding a new Camera Server implementation to Godot. This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server. Other parts of Godot can interact with this to obtain images from the camera as textures. This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2017-08-20 14:17:24 +00:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_feed">
<return type="void">
</return>
<argument index="0" name="feed" type="CameraFeed">
</argument>
<description>
Adds a camera feed to the camera server.
</description>
</method>
<method name="feeds">
<return type="Array">
</return>
<description>
Returns an array of [CameraFeed]s.
</description>
</method>
<method name="get_feed">
<return type="CameraFeed">
</return>
<argument index="0" name="index" type="int">
</argument>
<description>
Returns the [CameraFeed] with this id.
</description>
</method>
<method name="get_feed_count">
<return type="int">
</return>
<description>
Returns the number of [CameraFeed]s registered.
</description>
</method>
<method name="remove_feed">
<return type="void">
</return>
<argument index="0" name="feed" type="CameraFeed">
</argument>
<description>
Removes a [CameraFeed].
</description>
</method>
</methods>
<signals>
<signal name="camera_feed_added">
<argument index="0" name="id" type="int">
</argument>
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 10:14:14 +00:00
Emitted when a [CameraFeed] is added (e.g. webcam is plugged in).
Adding a new Camera Server implementation to Godot. This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server. Other parts of Godot can interact with this to obtain images from the camera as textures. This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2017-08-20 14:17:24 +00:00
</description>
</signal>
<signal name="camera_feed_removed">
<argument index="0" name="id" type="int">
</argument>
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 10:14:14 +00:00
Emitted when a [CameraFeed] is removed (e.g. webcam is unplugged).
Adding a new Camera Server implementation to Godot. This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server. Other parts of Godot can interact with this to obtain images from the camera as textures. This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2017-08-20 14:17:24 +00:00
</description>
</signal>
</signals>
<constants>
<constant name="FEED_RGBA_IMAGE" value="0" enum="FeedImage">
The RGBA camera image.
</constant>
Made constants fully upper case in camera server
2019-06-19 12:21:13 +00:00
<constant name="FEED_YCBCR_IMAGE" value="0" enum="FeedImage">
Adding a new Camera Server implementation to Godot. This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server. Other parts of Godot can interact with this to obtain images from the camera as textures. This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2017-08-20 14:17:24 +00:00
The YCbCr camera image.
</constant>
<constant name="FEED_Y_IMAGE" value="0" enum="FeedImage">
doc: Sync classref with current source, fix formatting issues
2019-06-16 09:22:38 +00:00
The Y component camera image.
Adding a new Camera Server implementation to Godot. This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server. Other parts of Godot can interact with this to obtain images from the camera as textures. This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2017-08-20 14:17:24 +00:00
</constant>
Made constants fully upper case in camera server
2019-06-19 12:21:13 +00:00
<constant name="FEED_CBCR_IMAGE" value="1" enum="FeedImage">
Adding a new Camera Server implementation to Godot. This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server. Other parts of Godot can interact with this to obtain images from the camera as textures. This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2017-08-20 14:17:24 +00:00
The CbCr component camera image.
</constant>
</constants>
</class>