OpenSimplexNoise

Category: Core

Noise generator based on Open Simplex.

Properties

	get_image ( width, int height )
	get_noise_2d ( x, float y )
	get_noise_2dv ( pos )
float	( float x, y, float z )
	get_noise_3dv ( pos )
float	( float x, y, float z, w )
Image	( int size )

Description

This resource allows you to configure and sample a fractal noise space. Here is a brief usage example that configures an OpenSimplexNoise and gets samples at various positions and dimensions:

lacunarity

Difference in period between octaves.

octaves

Setter	set_octaves(value)
Getter	get_octaves()

float period

Period of the base octave. A lower period results in a higher-frequency noise (more value changes across the same distance).

persistence

Setter	set_persistence(value)
Getter	get_persistence()

Contribution factor of the different octaves. A value of 1 means all the octaves have the same contribution, a value of 0.5 means each octave contributes half as much as the previous one.

int seed

Seed used to generate random values, different seeds will generate different noise maps.

Method Descriptions

Generate a noise image with the requested width and height, based on the current noise parameters.

get_noise_2d ( float x, y )

float get_noise_2dv ( pos )

Returns the 2D noise value [-1,1] at the given position.

float get_noise_3d ( x, float y, z )

Returns the 3D noise value [-1,1] at the given position.

float get_noise_3dv ( pos )

Returns the 3D noise value at the given position.

float get_noise_4d ( x, float y, z, float w )

Returns the 4D noise value [-1,1] at the given position.