浏览代码

Document seamless noise having a lower contrast than non-seamless noise

See #41787.

(cherry picked from commit 2e8e6e26a8042b69994bdf3d1d658483c2516b10)
Hugo Locurcio 4 年之前
父节点
当前提交
b3c01392fd

+ 1 - 0
modules/opensimplex/doc_classes/NoiseTexture.xml

@@ -33,6 +33,7 @@
 		</member>
 		</member>
 		<member name="seamless" type="bool" setter="set_seamless" getter="get_seamless" default="false">
 		<member name="seamless" type="bool" setter="set_seamless" getter="get_seamless" default="false">
 			Whether the texture can be tiled without visible seams or not. Seamless textures take longer to generate.
 			Whether the texture can be tiled without visible seams or not. Seamless textures take longer to generate.
+			[b]Note:[/b] Seamless noise has a lower contrast compared to non-seamless noise. This is due to the way noise uses higher dimensions for generating seamless noise.
 		</member>
 		</member>
 		<member name="width" type="int" setter="set_width" getter="get_width" default="512">
 		<member name="width" type="int" setter="set_width" getter="get_width" default="512">
 			Width of the generated texture.
 			Width of the generated texture.

+ 1 - 0
modules/opensimplex/doc_classes/OpenSimplexNoise.xml

@@ -109,6 +109,7 @@
 			</argument>
 			</argument>
 			<description>
 			<description>
 				Generate a tileable noise image in [constant Image.FORMAT_L8] format, based on the current noise parameters. Generated seamless images are always square ([code]size[/code] × [code]size[/code]).
 				Generate a tileable noise image in [constant Image.FORMAT_L8] format, based on the current noise parameters. Generated seamless images are always square ([code]size[/code] × [code]size[/code]).
+				[b]Note:[/b] Seamless noise has a lower contrast compared to non-seamless noise. This is due to the way noise uses higher dimensions for generating seamless noise.
 			</description>
 			</description>
 		</method>
 		</method>
 	</methods>
 	</methods>