NoiseTexture2D

Inherits: Texture2D < Texture < Resource < RefCounted < Object

A texture filled with noise generated by a Noise object.

Description

Uses FastNoiseLite or other libraries to fill the texture data of your desired size.

NoiseTexture2D can also generate normalmap textures.

The class uses Threads to generate the texture data internally, so Texture2D.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

bool

as_normal_map

false

float

bump_strength

8.0

Gradient

color_ramp

bool

generate_mipmaps

true

int

height

512

bool

in_3d_space

false

bool

invert

false

Noise

noise

bool

resource_local_to_scene

false (overrides Resource)

bool

seamless

false

float

seamless_blend_skirt

0.1

int

width

512

Property Descriptions

  • bool as_normal_map

Default

false

Setter

set_as_normal_map(value)

Getter

is_normal_map()

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


Default

8.0

Setter

set_bump_strength(value)

Getter

get_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.


Setter

set_color_ramp(value)

Getter

get_color_ramp()

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


  • bool generate_mipmaps

Default

true

Setter

set_generate_mipmaps(value)

Getter

is_generating_mipmaps()

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.


Default

512

Setter

set_height(value)

Getter

get_height()

Height of the generated texture.


Default

false

Setter

set_in_3d_space(value)

Getter

is_in_3d_space()

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


Default

false

Setter

set_invert(value)

Getter

get_invert()

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


Setter

set_noise(value)

Getter

get_noise()

The instance of the Noise object.


Default

false

Setter

set_seamless(value)

Getter

get_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.


  • float seamless_blend_skirt

Default

0.1

Setter

set_seamless_blend_skirt(value)

Getter

get_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.


Default

512

Setter

set_width(value)

Getter

get_width()

Width of the generated texture.