summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2020-01-26 10:22:26 +0100
committerGitHub <noreply@github.com>2020-01-26 10:22:26 +0100
commit139ff35e76662b753cc87b6829ca41347e639eeb (patch)
treeae13f4727340056ad46508070fd7ebee79094887
parentbd605a5701b44295f1a04bd56da699cbc0affe12 (diff)
parent5b1c6656d3e7ab43b3d560a0ebe1d6638d4ac241 (diff)
Merge pull request #35567 from Xrayez/doc-noise-null-data
Mention that `NoiseTexture` uses threads internally
-rw-r--r--modules/opensimplex/doc_classes/NoiseTexture.xml6
1 files changed, 6 insertions, 0 deletions
diff --git a/modules/opensimplex/doc_classes/NoiseTexture.xml b/modules/opensimplex/doc_classes/NoiseTexture.xml
index 8be037b5a2..280d67cd1b 100644
--- a/modules/opensimplex/doc_classes/NoiseTexture.xml
+++ b/modules/opensimplex/doc_classes/NoiseTexture.xml
@@ -6,6 +6,12 @@
<description>
Uses an [OpenSimplexNoise] to fill the texture data. You can specify the texture size but keep in mind that larger textures will take longer to generate and seamless noise only works with square sized textures.
NoiseTexture can also generate normalmap textures.
+ The class uses [Thread]s to generate the texture data internally, so [method Texture.get_data] may return [code]null[/code] if the generation process has not completed yet. In that case, you need to wait for the texture to be generated before accessing the data:
+ [codeblock]
+ var texture = preload("res://noise.tres")
+ yield(texture, "changed")
+ var image = texture.get_data()
+ [/codeblock]
</description>
<tutorials>
</tutorials>