diff options
| author | Andrii Doroshenko (Xrayez) <xrayez@gmail.com> | 2020-01-26 02:40:09 +0200 |
|---|---|---|
| committer | Andrii Doroshenko (Xrayez) <xrayez@gmail.com> | 2020-01-26 02:40:09 +0200 |
| commit | 5b1c6656d3e7ab43b3d560a0ebe1d6638d4ac241 (patch) | |
| tree | 375b2e8a1dfb9da0065f0fe34fd59b0e885c156a /modules/opensimplex | |
| parent | be1bc53d42577c02cbdf32fff5e2a60234e6270a (diff) | |
| download | redot-engine-5b1c6656d3e7ab43b3d560a0ebe1d6638d4ac241.tar.gz | |
Mention that `NoiseTexture` uses threads internally
Provided a snippet on how to properly retrieve the noise texture data
given that it's generated in a thread.
Diffstat (limited to 'modules/opensimplex')
| -rw-r--r-- | modules/opensimplex/doc_classes/NoiseTexture.xml | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/modules/opensimplex/doc_classes/NoiseTexture.xml b/modules/opensimplex/doc_classes/NoiseTexture.xml index 07d5eb27d6..92eb33bf18 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> |