From 394d0584207378ecf330dad5cd3bd008ad535b47 Mon Sep 17 00:00:00 2001 From: Aaron Franke Date: Wed, 24 Aug 2022 18:08:09 -0500 Subject: Rename 2D NoiseTexture to NoiseTexture2D --- modules/noise/doc_classes/NoiseTexture.xml | 58 ---------------------------- modules/noise/doc_classes/NoiseTexture2D.xml | 58 ++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+), 58 deletions(-) delete mode 100644 modules/noise/doc_classes/NoiseTexture.xml create mode 100644 modules/noise/doc_classes/NoiseTexture2D.xml (limited to 'modules/noise/doc_classes') diff --git a/modules/noise/doc_classes/NoiseTexture.xml b/modules/noise/doc_classes/NoiseTexture.xml deleted file mode 100644 index 62a223b387..0000000000 --- a/modules/noise/doc_classes/NoiseTexture.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - A texture filled with noise generated by a [Noise] object. - - - Uses [FastNoiseLite] or other libraries to fill the texture data of your desired size. - NoiseTexture can also generate normalmap textures. - The class uses [Thread]s to generate the texture data internally, so [method Texture2D.get_image] 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 image and the generated byte data: - [codeblock] - var texture = NoiseTexture.new() - texture.noise = FastNoiseLite.new() - await texture.changed - var image = texture.get_image() - var data = image.get_data() - [/codeblock] - - - - - - If [code]true[/code], the resulting texture contains a normal map created from the original noise interpreted as a bump map. - - - Strength of the bump maps used in this texture. A higher value will make the bump maps appear larger while a lower value will make them appear softer. - - - A [Gradient] which is used to map the luminance of each pixel to a color value. - - - Determines whether mipmaps are generated for this texture. - Enabling this results in less texture aliasing, but the noise texture generation may take longer. - Requires (anisotropic) mipmap filtering to be enabled for a material to have an effect. - - - Height of the generated texture. - - - Determines whether the noise image is calculated in 3D space. May result in reduced contrast. - - - If [code]true[/code], inverts the noise texture. White becomes black, black becomes white. - - - The instance of the [Noise] object. - - - If [code]true[/code], a seamless texture is requested from the [Noise] resource. - [b]Note:[/b] Seamless noise textures may take longer to generate and/or can have a lower contrast compared to non-seamless noise depending on the used [Noise] resource. This is because some implementations use higher dimensions for generating seamless noise. - - - Used for the default/fallback implementation of the seamless texture generation. It determines the distance over which the seams are blended. High values may result in less details and contrast. See [Noise] for further details. - - - Width of the generated texture. - - - diff --git a/modules/noise/doc_classes/NoiseTexture2D.xml b/modules/noise/doc_classes/NoiseTexture2D.xml new file mode 100644 index 0000000000..9eea2738c5 --- /dev/null +++ b/modules/noise/doc_classes/NoiseTexture2D.xml @@ -0,0 +1,58 @@ + + + + A texture filled with noise generated by a [Noise] object. + + + Uses [FastNoiseLite] or other libraries to fill the texture data of your desired size. + NoiseTexture2D can also generate normalmap textures. + The class uses [Thread]s to generate the texture data internally, so [method Texture2D.get_image] 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 image and the generated byte data: + [codeblock] + var texture = NoiseTexture2D.new() + texture.noise = FastNoiseLite.new() + await texture.changed + var image = texture.get_image() + var data = image.get_data() + [/codeblock] + + + + + + If [code]true[/code], the resulting texture contains a normal map created from the original noise interpreted as a bump map. + + + Strength of the bump maps used in this texture. A higher value will make the bump maps appear larger while a lower value will make them appear softer. + + + A [Gradient] which is used to map the luminance of each pixel to a color value. + + + Determines whether mipmaps are generated for this texture. + Enabling this results in less texture aliasing, but the noise texture generation may take longer. + Requires (anisotropic) mipmap filtering to be enabled for a material to have an effect. + + + Height of the generated texture. + + + Determines whether the noise image is calculated in 3D space. May result in reduced contrast. + + + If [code]true[/code], inverts the noise texture. White becomes black, black becomes white. + + + The instance of the [Noise] object. + + + If [code]true[/code], a seamless texture is requested from the [Noise] resource. + [b]Note:[/b] Seamless noise textures may take longer to generate and/or can have a lower contrast compared to non-seamless noise depending on the used [Noise] resource. This is because some implementations use higher dimensions for generating seamless noise. + + + Used for the default/fallback implementation of the seamless texture generation. It determines the distance over which the seams are blended. High values may result in less details and contrast. See [Noise] for further details. + + + Width of the generated texture. + + + -- cgit v1.2.3