From 5b1c6656d3e7ab43b3d560a0ebe1d6638d4ac241 Mon Sep 17 00:00:00 2001 From: "Andrii Doroshenko (Xrayez)" Date: Sun, 26 Jan 2020 02:40:09 +0200 Subject: [PATCH] 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. --- modules/opensimplex/doc_classes/NoiseTexture.xml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/modules/opensimplex/doc_classes/NoiseTexture.xml b/modules/opensimplex/doc_classes/NoiseTexture.xml index 07d5eb27d61..92eb33bf18e 100644 --- a/modules/opensimplex/doc_classes/NoiseTexture.xml +++ b/modules/opensimplex/doc_classes/NoiseTexture.xml @@ -6,6 +6,12 @@ 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]