Table of Contents

Class NoiseTexture2D

A 2D texture filled with noise generated by a Noise object.

Inheritance
NoiseTexture2D

Remarks

Uses the FastNoiseLite library or other noise generators to fill the texture data of your desired size. NoiseTexture2D can also generate normal map textures.

The class uses Threads to generate the texture data internally, so get_image may return null 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:

var texture = NoiseTexture2D.new()
texture.noise = FastNoiseLite.new()
await texture.changed
var image = texture.get_image()
var data = image.get_data()

Properties

as_normal_map

If true, the resulting texture contains a normal map created from the original noise interpreted as a bump map.

var as_normal_map : bool = false

Property Value

bool

Remarks

  • void set_as_normal_map(bool value)
  • bool is_normal_map

bump_strength

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.

var bump_strength : float = 8.0

Property Value

float

Remarks

  • void set_bump_strength(float value)
  • float get_bump_strength

color_ramp

A Gradient which is used to map the luminance of each pixel to a color value.

var color_ramp : Gradient

Property Value

Gradient

Remarks

generate_mipmaps

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.

Note: generate_mipmaps requires mipmap filtering to be enabled on the material using the NoiseTexture2D to have an effect.

var generate_mipmaps : bool = true

Property Value

bool

Remarks

  • void set_generate_mipmaps(bool value)
  • bool is_generating_mipmaps

height

Height of the generated texture (in pixels).

var height : int = 512

Property Value

int

Remarks

  • void set_height(int value)
  • int get_height

in_3d_space

Determines whether the noise image is calculated in 3D space. May result in reduced contrast.

var in_3d_space : bool = false

Property Value

bool

Remarks

  • void set_in_3d_space(bool value)
  • bool is_in_3d_space

invert

If true, inverts the noise texture. White becomes black, black becomes white.

var invert : bool = false

Property Value

bool

Remarks

  • void set_invert(bool value)
  • bool get_invert

noise

The instance of the Noise object.

var noise : Noise

Property Value

Noise

Remarks

normalize

If true, the noise image coming from the noise generator is normalized to the range 0.0 to 1.0.

Turning normalization off can affect the contrast and allows you to generate non repeating tileable noise textures.

var normalize : bool = true

Property Value

bool

Remarks

  • void set_normalize(bool value)
  • bool is_normalized

seamless

If true, a seamless texture is requested from the Noise resource.

Note: 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.

Note: The default FastNoiseLite implementation uses the fallback path for seamless generation. If using a width or height lower than the default, you may need to increase seamless_blend_skirt to make seamless blending more effective.

var seamless : bool = false

Property Value

bool

Remarks

  • void set_seamless(bool value)
  • bool get_seamless

seamless_blend_skirt

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.

Note: If using a width or height lower than the default, you may need to increase seamless_blend_skirt to make seamless blending more effective.

var seamless_blend_skirt : float = 0.1

Property Value

float

Remarks

  • void set_seamless_blend_skirt(float value)
  • float get_seamless_blend_skirt

width

Width of the generated texture (in pixels).

var width : int = 512

Property Value

int

Remarks

  • void set_width(int value)
  • int get_width