Browse Source

Merge pull request #37689 from Calinou/doc-improve-cameraserver

Improve the CameraServer and CameraFeed class documentations
Rémi Verschelde 5 years ago
parent
commit
b3310a0074
2 changed files with 8 additions and 7 deletions
  1. 1 1
      doc/classes/CameraFeed.xml
  2. 7 6
      doc/classes/CameraServer.xml

+ 1 - 1
doc/classes/CameraFeed.xml

@@ -4,7 +4,7 @@
 		A camera feed gives you access to a single physical camera attached to your device.
 	</brief_description>
 	<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.
+		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 [CameraServer].
 		[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.
 	</description>
 	<tutorials>

+ 7 - 6
doc/classes/CameraServer.xml

@@ -6,6 +6,7 @@
 	<description>
 		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.
+		[b]Note:[/b] This class is currently only implemented on macOS and iOS. On other platforms, no [CameraFeed]s will be available.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -16,7 +17,7 @@
 			<argument index="0" name="feed" type="CameraFeed">
 			</argument>
 			<description>
-				Adds a camera feed to the camera server.
+				Adds the camera [code]feed[/code] to the camera server.
 			</description>
 		</method>
 		<method name="feeds">
@@ -32,7 +33,7 @@
 			<argument index="0" name="index" type="int">
 			</argument>
 			<description>
-				Returns the [CameraFeed] with this id.
+				Returns the [CameraFeed] corresponding to the camera with the given [code]index[/code].
 			</description>
 		</method>
 		<method name="get_feed_count">
@@ -48,7 +49,7 @@
 			<argument index="0" name="feed" type="CameraFeed">
 			</argument>
 			<description>
-				Removes a [CameraFeed].
+				Removes the specified camera [code]feed[/code].
 			</description>
 		</method>
 	</methods>
@@ -57,14 +58,14 @@
 			<argument index="0" name="id" type="int">
 			</argument>
 			<description>
-				Emitted when a [CameraFeed] is added (e.g. webcam is plugged in).
+				Emitted when a [CameraFeed] is added (e.g. a webcam is plugged in).
 			</description>
 		</signal>
 		<signal name="camera_feed_removed">
 			<argument index="0" name="id" type="int">
 			</argument>
 			<description>
-				Emitted when a [CameraFeed] is removed (e.g. webcam is unplugged).
+				Emitted when a [CameraFeed] is removed (e.g. a webcam is unplugged).
 			</description>
 		</signal>
 	</signals>
@@ -73,7 +74,7 @@
 			The RGBA camera image.
 		</constant>
 		<constant name="FEED_YCBCR_IMAGE" value="0" enum="FeedImage">
-			The YCbCr camera image.
+			The [url=https://en.wikipedia.org/wiki/YCbCr]YCbCr[/url] camera image.
 		</constant>
 		<constant name="FEED_Y_IMAGE" value="0" enum="FeedImage">
 			The Y component camera image.