Difference between revisions of "love.math.noise"

m (http://freespace.virgin.net/hugo.elias/models/m_perlin.htm does not describe perlin or simplex noise. perlin and simplex noise work with gradients, for comparsion see http://www.noisemachine.com/talk1)
m
Line 1: Line 1:
 
{{newin|[[0.9.0]]|090|type=function}}
 
{{newin|[[0.9.0]]|090|type=function}}
Generates a Simplex noise value in 1-4 dimensions.
+
Generates a Simplex or Perlin noise value in 1-4 dimensions.
  
 
[http://en.wikipedia.org/wiki/Simplex_noise Simplex noise] is closely related to [http://en.wikipedia.org/wiki/Perlin_noise Perlin noise]. It is widely used for procedural content generation.
 
[http://en.wikipedia.org/wiki/Simplex_noise Simplex noise] is closely related to [http://en.wikipedia.org/wiki/Perlin_noise Perlin noise]. It is widely used for procedural content generation.
Line 27: Line 27:
 
{{param|number|value|The noise value in the range of [0, 1].}}
 
{{param|number|value|The noise value in the range of [0, 1].}}
 
== Function ==
 
== Function ==
Generates Simplex noise from 3 dimensions.
+
Generates Perlin noise (Simplex noise in version [[0.9.2]] and older) from 3 dimensions.
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 39: Line 39:
 
{{param|number|value|The noise value in the range of [0, 1].}}
 
{{param|number|value|The noise value in the range of [0, 1].}}
 
== Function ==
 
== Function ==
Generates Simplex noise from 4 dimensions.
+
Generates Perlin noise (Simplex noise in version [[0.9.2]] and older) from 4 dimensions.
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">

Revision as of 02:55, 17 December 2015

Available since LÖVE 0.9.0
This function is not supported in earlier versions.

Generates a Simplex or Perlin noise value in 1-4 dimensions.

Simplex noise is closely related to Perlin noise. It is widely used for procedural content generation.

There are many webpages which discuss Perlin and Simplex noise in detail.

Function

Generates Simplex noise from 1 dimension.

Synopsis

value = love.math.noise( x )

Arguments

number x
The number used to generate the noise value.

Returns

number value
The noise value in the range of [0, 1].

Function

Generates Simplex noise from 2 dimensions.

Synopsis

value = love.math.noise( x, y )

Arguments

number x
The first value of the 2-dimensional vector used to generate the noise value.
number y
The second value of the 2-dimensional vector used to generate the noise value.

Returns

number value
The noise value in the range of [0, 1].

Function

Generates Perlin noise (Simplex noise in version 0.9.2 and older) from 3 dimensions.

Synopsis

value = love.math.noise( x, y, z )

Arguments

number x
The first value of the 3-dimensional vector used to generate the noise value.
number y
The second value of the 3-dimensional vector used to generate the noise value.
number z
The third value of the 3-dimensional vector used to generate the noise value.

Returns

number value
The noise value in the range of [0, 1].

Function

Generates Perlin noise (Simplex noise in version 0.9.2 and older) from 4 dimensions.

Synopsis

value = love.math.noise( x, y, z, w )

Arguments

number x
The first value of the 4-dimensional vector used to generate the noise value.
number y
The second value of the 4-dimensional vector used to generate the noise value.
number z
The third value of the 4-dimensional vector used to generate the noise value.
number w
The fourth value of the 4-dimensional vector used to generate the noise value.

Returns

number value
The noise value in the range of [0, 1].

See Also

Other Languages