virtualx-engine/doc/classes/CameraTexture.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CameraTexture" inherits="Texture2D" version="4.0">
	<brief_description>
		Texture provided by a [CameraFeed].
	</brief_description>
	<description>
		This texture gives access to the camera texture provided by a [CameraFeed].
		[b]Note:[/b] Many cameras supply YCbCr images which need to be converted in a shader.
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="camera_feed_id" type="int" setter="set_camera_feed_id" getter="get_camera_feed_id" default="0">
			The ID of the [CameraFeed] for which we want to display the image.
		</member>
		<member name="camera_is_active" type="bool" setter="set_camera_active" getter="get_camera_active" default="false">
			Convenience property that gives access to the active property of the [CameraFeed].
		</member>
		<member name="which_feed" type="int" setter="set_which_feed" getter="get_which_feed" enum="CameraServer.FeedImage" default="0">
			Which image within the [CameraFeed] we want access to, important if the camera image is split in a Y and CbCr component.
		</member>
	</members>
	<constants>
	</constants>
</class>
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 16:17:24 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer. 2020-02-12 09:59:06 +01:00			`<class name="CameraTexture" inherits="Texture2D" version="4.0">`
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 16:17:24 +02: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 11:14:14 +01:00			`Texture provided by a [CameraFeed].`
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 16:17:24 +02: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 11:14:14 +01:00			`This texture gives access to the camera texture provided by a [CameraFeed].`
			`[b]Note:[/b] Many cameras supply YCbCr images which need to be converted in a shader.`
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 16:17:24 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
			`</methods>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="camera_feed_id" type="int" setter="set_camera_feed_id" getter="get_camera_feed_id" default="0">`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-22 01:04:47 +02:00			`The ID of the [CameraFeed] for which we want to display the 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 16:17:24 +02:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="camera_is_active" type="bool" setter="set_camera_active" getter="get_camera_active" default="false">`
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 16:17:24 +02:00			`Convenience property that gives access to the active property of the [CameraFeed].`
			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="which_feed" type="int" setter="set_which_feed" getter="get_which_feed" enum="CameraServer.FeedImage" default="0">`
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 16:17:24 +02:00			`Which image within the [CameraFeed] we want access to, important if the camera image is split in a Y and CbCr component.`
			`</member>`
			`</members>`
			`<constants>`
			`</constants>`
			`</class>`