summaryrefslogtreecommitdiff
path: root/doc/classes/Sky.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/Sky.xml
parent538c8eec15d72b67e102f47f9df7624c29d14607 (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/Sky.xml')
-rw-r--r--doc/classes/Sky.xml17
1 files changed, 8 insertions, 9 deletions
diff --git a/doc/classes/Sky.xml b/doc/classes/Sky.xml
index a5e065203e..cc9d2dc0df 100644
--- a/doc/classes/Sky.xml
+++ b/doc/classes/Sky.xml
@@ -12,32 +12,31 @@
</methods>
<members>
<member name="radiance_size" type="int" setter="set_radiance_size" getter="get_radiance_size" enum="Sky.RadianceSize">
- The [Sky]'s radiance map size.
- The higher the radiance map size, the more detailed the lighting from the [Sky] will be.
+ The [Sky]'s radiance map size. The higher the radiance map size, the more detailed the lighting from the [Sky] will be.
See [enum RadianceSize] constants for values. Default size is [constant RADIANCE_SIZE_512].
</member>
</members>
<constants>
<constant name="RADIANCE_SIZE_32" value="0" enum="RadianceSize">
- Radiance texture size is 32x32 pixels.
+ Radiance texture size is 32×32 pixels.
</constant>
<constant name="RADIANCE_SIZE_64" value="1" enum="RadianceSize">
- Radiance texture size is 64x64 pixels.
+ Radiance texture size is 64×64 pixels.
</constant>
<constant name="RADIANCE_SIZE_128" value="2" enum="RadianceSize">
- Radiance texture size is 128x128 pixels.
+ Radiance texture size is 128×128 pixels.
</constant>
<constant name="RADIANCE_SIZE_256" value="3" enum="RadianceSize">
- Radiance texture size is 256x256 pixels.
+ Radiance texture size is 256×256 pixels.
</constant>
<constant name="RADIANCE_SIZE_512" value="4" enum="RadianceSize">
- Radiance texture size is 512x512 pixels.
+ Radiance texture size is 512×512 pixels.
</constant>
<constant name="RADIANCE_SIZE_1024" value="5" enum="RadianceSize">
- Radiance texture size is 1024x1024 pixels.
+ Radiance texture size is 1024×1024 pixels.
</constant>
<constant name="RADIANCE_SIZE_2048" value="6" enum="RadianceSize">
- Radiance texture size is 2048x2048 pixels.
+ Radiance texture size is 2048×2048 pixels.
</constant>
<constant name="RADIANCE_SIZE_MAX" value="7" enum="RadianceSize">
Represents the size of the [enum RadianceSize] enum.