Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
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 ( int width, int height, bool invert=false, bool in_3d_space=false, bool normalize=true ) const |
|
get_image_3d ( int width, int height, int depth, bool invert=false, bool normalize=true ) const |
|
get_noise_1d ( float x ) const |
|
get_noise_2d ( float x, float y ) const |
|
get_noise_2dv ( Vector2 v ) const |
|
get_noise_3d ( float x, float y, float z ) const |
|
get_noise_3dv ( Vector3 v ) const |
|
get_seamless_image ( int width, int height, bool invert=false, bool in_3d_space=false, float skirt=0.1, bool normalize=true ) const |
|
get_seamless_image_3d ( int width, int height, int depth, bool invert=false, float skirt=0.1, bool normalize=true ) const |
Method Descriptions¶
Image get_image ( int width, int height, bool invert=false, bool in_3d_space=false, bool normalize=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.
Image[] get_image_3d ( int width, int height, int depth, bool invert=false, bool normalize=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 ( float x ) const
Returns the 1D noise value at the given (x) coordinate.
float get_noise_2d ( float x, float y ) const
Returns the 2D noise value at the given position.
float get_noise_2dv ( Vector2 v ) const
Returns the 2D noise value at the given position.
float get_noise_3d ( float x, float y, float z ) const
Returns the 3D noise value at the given position.
float get_noise_3dv (