From bde6fc9c8217d59be0783dde8b404251e6239ea3 Mon Sep 17 00:00:00 2001
From: Hendrik Brucker <hendrik.brucker@mail.de>
Date: Tue, 19 Apr 2022 19:48:25 +0200
Subject: Restructure and refine the noise module

---
 modules/noise/doc_classes/FastNoiseLite.xml |  8 +-------
 modules/noise/doc_classes/Noise.xml         | 18 ++++++++++--------
 modules/noise/doc_classes/NoiseTexture.xml  | 11 +++++++++++
 3 files changed, 22 insertions(+), 15 deletions(-)

(limited to 'modules/noise/doc_classes')

diff --git a/modules/noise/doc_classes/FastNoiseLite.xml b/modules/noise/doc_classes/FastNoiseLite.xml
index b6d91850c4..6ca4ba2d46 100644
--- a/modules/noise/doc_classes/FastNoiseLite.xml
+++ b/modules/noise/doc_classes/FastNoiseLite.xml
@@ -16,12 +16,9 @@
 		<member name="cellular_jitter" type="float" setter="set_cellular_jitter" getter="get_cellular_jitter" default="0.45">
 			Maximum distance a point can move off of its grid position. Set to [code]0[/code] for an even grid.
 		</member>
-		<member name="cellular_return_type" type="int" setter="set_cellular_return_type" getter="get_cellular_return_type" enum="FastNoiseLite.CellularReturnType" default="0">
+		<member name="cellular_return_type" type="int" setter="set_cellular_return_type" getter="get_cellular_return_type" enum="FastNoiseLite.CellularReturnType" default="1">
 			Return type from cellular noise calculations. See [enum CellularReturnType].
 		</member>
-		<member name="color_ramp" type="Gradient" setter="set_color_ramp" getter="get_color_ramp">
-			A [Gradient] which is used to map the luminance of each pixel to a color value.
-		</member>
 		<member name="domain_warp_amplitude" type="float" setter="set_domain_warp_amplitude" getter="get_domain_warp_amplitude" default="30.0">
 			Sets the maximum warp distance from the origin.
 		</member>
@@ -69,9 +66,6 @@
 		<member name="frequency" type="float" setter="set_frequency" getter="get_frequency" default="0.01">
 			The frequency for all noise types. Low frequency results in smooth noise while high frequency results in rougher, more granular noise.
 		</member>
-		<member name="in_3d_space" type="bool" setter="set_in_3d_space" getter="is_in_3d_space" default="false">
-			Determines whether the noise image returned by [method Noise.get_image] is calculated in 3d space. May result in reduced contrast.
-		</member>
 		<member name="noise_type" type="int" setter="set_noise_type" getter="get_noise_type" enum="FastNoiseLite.NoiseType" default="1">
 			The noise algorithm used. See [enum NoiseType].
 		</member>
diff --git a/modules/noise/doc_classes/Noise.xml b/modules/noise/doc_classes/Noise.xml
index db0dec18d2..5af204575c 100644
--- a/modules/noise/doc_classes/Noise.xml
+++ b/modules/noise/doc_classes/Noise.xml
@@ -11,23 +11,24 @@
 	<tutorials>
 	</tutorials>
 	<methods>
-		<method name="get_image">
+		<method name="get_image" qualifiers="const">
 			<return type="Image" />
 			<argument index="0" name="width" type="int" />
 			<argument index="1" name="height" type="int" />
 			<argument index="2" name="invert" type="bool" default="false" />
+			<argument index="3" name="in_3d_space" type="bool" default="false" />
 			<description>
 				Returns a 2D [Image] noise image.
 			</description>
 		</method>
-		<method name="get_noise_1d">
+		<method name="get_noise_1d" qualifiers="const">
 			<return type="float" />
 			<argument index="0" name="x" type="float" />
 			<description>
 				Returns the 1D noise value at the given (x) coordinate.
 			</description>
 		</method>
-		<method name="get_noise_2d">
+		<method name="get_noise_2d" qualifiers="const">
 			<return type="float" />
 			<argument index="0" name="x" type="float" />
 			<argument index="1" name="y" type="float" />
@@ -35,14 +36,14 @@
 				Returns the 2D noise value at the given position.
 			</description>
 		</method>
-		<method name="get_noise_2dv">
+		<method name="get_noise_2dv" qualifiers="const">
 			<return type="float" />
 			<argument index="0" name="v" type="Vector2" />
 			<description>
 				Returns the 2D noise value at the given position.
 			</description>
 		</method>
-		<method name="get_noise_3d">
+		<method name="get_noise_3d" qualifiers="const">
 			<return type="float" />
 			<argument index="0" name="x" type="float" />
 			<argument index="1" name="y" type="float" />
@@ -51,19 +52,20 @@
 				Returns the 3D noise value at the given position.
 			</description>
 		</method>
-		<method name="get_noise_3dv">
+		<method name="get_noise_3dv" qualifiers="const">
 			<return type="float" />
 			<argument index="0" name="v" type="Vector3" />
 			<description>
 				Returns the 3D noise value at the given position.
 			</description>
 		</method>
-		<method name="get_seamless_image">
+		<method name="get_seamless_image" qualifiers="const">
 			<return type="Image" />
 			<argument index="0" name="width" type="int" />
 			<argument index="1" name="height" type="int" />
 			<argument index="2" name="invert" type="bool" default="false" />
-			<argument index="3" name="skirt" type="float" default="0.1" />
+			<argument index="3" name="in_3d_space" type="bool" default="false" />
+			<argument index="4" name="skirt" type="float" default="0.1" />
 			<description>
 				Returns a seamless 2D [Image] noise image.
 			</description>
diff --git a/modules/noise/doc_classes/NoiseTexture.xml b/modules/noise/doc_classes/NoiseTexture.xml
index 63630eccde..62a223b387 100644
--- a/modules/noise/doc_classes/NoiseTexture.xml
+++ b/modules/noise/doc_classes/NoiseTexture.xml
@@ -24,9 +24,20 @@
 		<member name="bump_strength" type="float" setter="set_bump_strength" getter="get_bump_strength" default="8.0">
 			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.
 		</member>
+		<member name="color_ramp" type="Gradient" setter="set_color_ramp" getter="get_color_ramp">
+			A [Gradient] which is used to map the luminance of each pixel to a color value.
+		</member>
+		<member name="generate_mipmaps" type="bool" setter="set_generate_mipmaps" getter="is_generating_mipmaps" default="true">
+			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.
+		</member>
 		<member name="height" type="int" setter="set_height" getter="get_height" default="512">
 			Height of the generated texture.
 		</member>
+		<member name="in_3d_space" type="bool" setter="set_in_3d_space" getter="is_in_3d_space" default="false">
+			Determines whether the noise image is calculated in 3D space. May result in reduced contrast.
+		</member>
 		<member name="invert" type="bool" setter="set_invert" getter="get_invert" default="false">
 			If [code]true[/code], inverts the noise texture. White becomes black, black becomes white.
 		</member>
-- 
cgit v1.2.3