asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Mention that NoiseTexture uses threads internally

Browse source 
Provided a snippet on how to properly retrieve the noise texture data
given that it's generated in a thread.
This commit is contained in:
Andrii Doroshenko (Xrayez) 2020-01-26 02:40:09 +02:00
parent be1bc53d42
commit 5b1c6656d3
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
modules/opensimplex/doc_classes/NoiseTexture.xml
View file

@ -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>