virtualx-engine/modules/noise/doc_classes/NoiseTexture2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="NoiseTexture2D" inherits="Texture2D" version="4.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		A texture filled with noise generated by a [Noise] object.
	</brief_description>
	<description>
		Uses [FastNoiseLite] or other libraries to fill the texture data of your desired size. [NoiseTexture2D] can also generate normal map 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]
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="as_normal_map" type="bool" setter="set_as_normal_map" getter="is_normal_map" default="false">
			If [code]true[/code], the resulting texture contains a normal map created from the original noise interpreted as a bump map.
		</member>
		<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 in the distance, at the cost of increasing memory usage by roughly 33% and making the noise texture generation take longer.
			[b]Note:[/b] [member generate_mipmaps] requires mipmap filtering to be enabled on the material using the [NoiseTexture2D] to have an effect.
		</member>
		<member name="height" type="int" setter="set_height" getter="get_height" default="512">
			Height of the generated texture (in pixels).
		</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>
		<member name="noise" type="Noise" setter="set_noise" getter="get_noise">
			The instance of the [Noise] object.
		</member>
		<member name="normalize" type="bool" setter="set_normalize" getter="is_normalized" default="true">
			If [code]true[/code], the noise image coming from the noise generator is normalized to the range [code]0.0[/code] to [code]1.0[/code].
			Turning normalization off can affect the contrast and allows you to generate non repeating tileable noise textures.
		</member>
		<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene" overrides="Resource" default="false" />
		<member name="seamless" type="bool" setter="set_seamless" getter="get_seamless" default="false">
			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.
			[b]Note:[/b] The default [FastNoiseLite] implementation uses the fallback path for seamless generation. If using a [member width] or [member height] lower than the default, you may need to increase [member seamless_blend_skirt] to make seamless blending more effective.
		</member>
		<member name="seamless_blend_skirt" type="float" setter="set_seamless_blend_skirt" getter="get_seamless_blend_skirt" default="0.1">
			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.
			[b]Note:[/b] If using a [member width] or [member height] lower than the default, you may need to increase [member seamless_blend_skirt] to make seamless blending more effective.
		</member>
		<member name="width" type="int" setter="set_width" getter="get_width" default="512">
			Width of the generated texture (in pixels).
		</member>
	</members>
</class>