Attention: Here be dragons (unstable version)
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Redot.
Checking the stable version of the documentation...
Noise
Inherits: Resource < RefCounted < Object
Inherited By: FastNoiseLite
Abstract base class for noise generators.
Description
This class defines the interface for noise generation libraries to inherit from.
A default get_seamless_image implementation is provided for libraries that do not provide seamless noise. This function requests a larger image from the get_image method, reverses the quadrants of the image, then uses the strips of extra width to blend over the seams.
Inheriting noise classes can optionally override this function to provide a more optimal algorithm.
Methods
get_image(width: int, height: int, invert: bool = false, in_3d_space: bool = false, normalize: bool = true) const |
|
get_image_3d(width: int, height: int, depth: int, invert: bool = false, normalize: bool = true) const |
|
get_noise_1d(x: float) const |
|
get_noise_2d(x: float, y: float) const |
|
get_noise_2dv(v: Vector2) const |
|
get_noise_3d(x: float, y: float, z: float) const |
|
get_noise_3dv(v: Vector3) const |
|
get_seamless_image(width: int, height: int, invert: bool = false, in_3d_space: bool = false, skirt: float = 0.1, normalize: bool = true) const |
|
get_seamless_image_3d(width: int, height: int, depth: int, invert: bool = false, skirt: float = 0.1, normalize: bool = true) const |
Method Descriptions
Image get_image(width: int, height: int, invert: bool = false, in_3d_space: bool = false, normalize: bool = true) const 🔗
Returns an Image containing 2D noise values.
Note: With normalize set to false, the default implementation expects the noise generator to return values in the range -1.0 to 1.0.
Array[Image] get_image_3d(width: int, height: int, depth: int, invert: bool = false, normalize: bool = true) const 🔗
Returns an Array of Images containing 3D noise values for use with ImageTexture3D.create.
Note: With normalize set to false, the default implementation expects the noise generator to return values in the range -1.0 to 1.0.
float get_noise_1d(x: float) const 🔗
Returns the 1D noise value at the given (x) coordinate.
float get_noise_2d(x: float, y: float) const 🔗
Returns the 2D noise value at the given position.
float get_noise_2dv(v: Vector2) const 🔗
Returns the 2D noise value at the given position.
float get_noise_3d(x: float, y: float, z: float) const 🔗
Returns the 3D noise value at the given position.
float get_noise_3dv(v: Vector3) const 🔗
Returns the 3D noise value at the given position.
Image get_seamless_image(width: int, height: int, invert: bool = false, in_3d_space: bool = false, skirt: float = 0.1, normalize: bool = true) const 🔗
Returns an Image containing seamless 2D noise values.
Note: With normalize set to false, the default implementation expects the noise generator to return values in the range -1.0 to 1.0.
Array[Image] get_seamless_image_3d(width: int, height: int, depth: int, invert: bool = false, skirt: float = 0.1, normalize: bool = true) const 🔗
Returns an Array of Images containing seamless 3D noise values for use with ImageTexture3D.create.
Note: With normalize set to false, the default implementation expects the noise generator to return values in the range -1.0 to 1.0.