summaryrefslogtreecommitdiff
path: root/modules/opensimplex/doc_classes
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2020-01-30 23:49:17 +0100
committerHugo Locurcio <hugo.locurcio@hugo.pro>2020-01-30 23:55:38 +0100
commit13622d40fc22e2b3be90d1b6f3c78e4b05f7ca1f (patch)
tree277199b9596b526cc6e9a00f9a1d241a28849db5 /modules/opensimplex/doc_classes
parent3c3ed67c3944a555d18fa8b68603f3a68416e27e (diff)
Increase the maximum number of octaves in OpenSimplexNoise to 9
An error message is now printed when trying to set the number of octaves above the maximum allowed value. The magic constant was also replaced with a define that can be easily changed. This closes #28714.
Diffstat (limited to 'modules/opensimplex/doc_classes')
-rw-r--r--modules/opensimplex/doc_classes/OpenSimplexNoise.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/modules/opensimplex/doc_classes/OpenSimplexNoise.xml b/modules/opensimplex/doc_classes/OpenSimplexNoise.xml
index f4f54901fb..f500925f75 100644
--- a/modules/opensimplex/doc_classes/OpenSimplexNoise.xml
+++ b/modules/opensimplex/doc_classes/OpenSimplexNoise.xml
@@ -117,7 +117,8 @@
Difference in period between [member octaves].
</member>
<member name="octaves" type="int" setter="set_octaves" getter="get_octaves" default="3">
- Number of OpenSimplex noise layers that are sampled to get the fractal noise.
+ Number of OpenSimplex noise layers that are sampled to get the fractal noise. Higher values result in more detailed noise but take more time to generate.
+ [b]Note:[/b] The maximum allowed value is 9.
</member>
<member name="period" type="float" setter="set_period" getter="get_period" default="64.0">
Period of the base octave. A lower period results in a higher-frequency noise (more value changes across the same distance).