diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-06-22 01:04:47 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-06-27 22:30:19 +0200 |
| commit | f7f6115f7627df24a08a9a0882b2f573cc838eb1 (patch) | |
| tree | 03fd75145084c88702dbbb7e54c42c7c02d54fa6 /doc/classes/CameraFeed.xml | |
| parent | 538c8eec15d72b67e102f47f9df7624c29d14607 (diff) | |
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/CameraFeed.xml')
| -rw-r--r-- | doc/classes/CameraFeed.xml | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/classes/CameraFeed.xml b/doc/classes/CameraFeed.xml index 4611b9c507..28280d688f 100644 --- a/doc/classes/CameraFeed.xml +++ b/doc/classes/CameraFeed.xml @@ -4,8 +4,8 @@ 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. Do note that 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. + 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. </description> <tutorials> </tutorials> @@ -14,14 +14,14 @@ <return type="int"> </return> <description> - Get unique id for this feed + Gets the unique ID for this feed. </description> </method> <method name="get_name" qualifiers="const"> <return type="String"> </return> <description> - Get name of the camera + Gets the camera's name. </description> </method> <method name="get_position" qualifiers="const"> @@ -58,7 +58,7 @@ Camera is mounted at the front of the device. </constant> <constant name="FEED_BACK" value="2" enum="FeedPosition"> - Camera is moutned at the back of the device. + Camera is mounted at the back of the device. </constant> </constants> </class> |