Class NoiseTexture3D

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

Inheritance

Texture3D

Texture

Resource

RefCounted

Object

NoiseTexture3D

Remarks

Uses the FastNoiseLite library or other noise generators to fill the texture data of your desired size.

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

var texture = NoiseTexture3D.new()
texture.noise = FastNoiseLite.new()
await texture.changed
var data = texture.get_data()

Properties

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

• void set_color_ramp(Gradient value)
• Gradient get_color_ramp

depth

Depth of the generated texture (in pixels).

var depth : int = 64

Property Value

int

Remarks

• void set_depth(int value)
• int get_depth

height

Height of the generated texture (in pixels).

var height : int = 64

Property Value

int

Remarks

• void set_height(int value)
• int get_height

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

• void set_noise(Noise value)
• Noise get_noise

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, height or depth 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, height or depth 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 = 64

Property Value

int

Remarks

• void set_width(int value)
• int get_width