summaryrefslogtreecommitdiffstats
path: root/doc/classes/CameraTexture.xml
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2019-06-22 01:04:47 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2019-06-27 22:30:19 +0200
commitf7f6115f7627df24a08a9a0882b2f573cc838eb1 (patch)
tree03fd75145084c88702dbbb7e54c42c7c02d54fa6 /doc/classes/CameraTexture.xml
parent538c8eec15d72b67e102f47f9df7624c29d14607 (diff)
downloadredot-engine-f7f6115f7627df24a08a9a0882b2f573cc838eb1.tar.gz
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
Diffstat (limited to 'doc/classes/CameraTexture.xml')
-rw-r--r--doc/classes/CameraTexture.xml5
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/CameraTexture.xml b/doc/classes/CameraTexture.xml
index 02f7f8bf58..5017df7a32 100644
--- a/doc/classes/CameraTexture.xml
+++ b/doc/classes/CameraTexture.xml
@@ -1,7 +1,8 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CameraTexture" inherits="Texture" category="Core" version="3.2">
<brief_description>
- This texture gives access to the camera texture provided by a [CameraFeed]. Note that many cameras supply YCbCr images which need to be converted in a shader.
+ 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.
</brief_description>
<description>
</description>
@@ -11,7 +12,7 @@
</methods>
<members>
<member name="camera_feed_id" type="int" setter="set_camera_feed_id" getter="get_camera_feed_id">
- Id of the [CameraFeed] for which we want to display the image.
+ 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">
Convenience property that gives access to the active property of the [CameraFeed].