diff options
| author | JFonS <joan.fonssanchez@gmail.com> | 2018-08-25 00:25:06 +0200 |
|---|---|---|
| committer | JFonS <joan.fonssanchez@gmail.com> | 2018-09-14 15:24:34 +0200 |
| commit | f12a1b88636f6147d2445749d728ecd9585bc3c4 (patch) | |
| tree | 9c12a94df2870cfdf0f81087f88108cf414e0ec3 /modules/opensimplex/doc_classes/NoiseTexture.xml | |
| parent | 4d228e66b45a6a3859decde6b2452c78728f8958 (diff) | |
Add SimplexNoise and NoiseTexture as new resources
SimplexNoise can be used to generate parameterized fractal noise based on Open Simplex.
NoiseTexture uses SimplexNoise to generate noise textures for using in
shaders/visual effects.
Diffstat (limited to 'modules/opensimplex/doc_classes/NoiseTexture.xml')
| -rw-r--r-- | modules/opensimplex/doc_classes/NoiseTexture.xml | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/modules/opensimplex/doc_classes/NoiseTexture.xml b/modules/opensimplex/doc_classes/NoiseTexture.xml new file mode 100644 index 0000000000..c7dc373f59 --- /dev/null +++ b/modules/opensimplex/doc_classes/NoiseTexture.xml @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="NoiseTexture" inherits="Texture" category="Core" version="3.1"> + <brief_description> + [SimplexNoise] filled texture. + </brief_description> + <description> + Uses a [SimplexNoise] 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. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="set_height"> + <return type="void"> + </return> + <argument index="0" name="height" type="int"> + </argument> + <description> + Set texture height. + </description> + </method> + <method name="set_width"> + <return type="void"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <description> + Set texture width. + </description> + </method> + </methods> + <members> + <member name="as_normalmap" type="bool" setter="set_as_normalmap" getter="is_normalmap"> + If true, the resulting texture contains a normal map created from the original noise interpreted as a bump map. + </member> + <member name="noise" type="SimplexNoise" setter="set_noise" getter="get_noise"> + The [SimplexNoise] instance used to generate the noise. + </member> + <member name="seamless" type="bool" setter="set_seamless" getter="get_seamless"> + Whether the texture can be tiled without visible seams or not. Seamless textures take longer to generate. + </member> + <member name="size" type="Vector2" setter="set_size" getter="get_size"> + Size of the generated texture. + </member> + </members> + <constants> + </constants> +</class> |