Difference between revisions of "love.math.noise"

 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. The return value will always be the same, given the same arguments.

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.

 The return value might be constant if only integer arguments are used. Avoid solely passing in integers, to get varying return values.

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].

Examples

Fills a two-dimensional grid with simplex noise each time a key is pressed.

```local grid = {}

function love.draw()
for x = 1, #grid do
for y = 1, #grid[x] do
local f = 255 * grid[x][y]
love.graphics.setColor( f, f, f, 255 )
love.graphics.rectangle( 'fill', x * 8, y * 8, 7, 7 )
love.graphics.setColor( 255, 255, 255, 255 )
end
end
end

-- Fill each pixel in our grid with simplex noise.
local function noise()
for x = 1, 60 do
for y = 1, 60 do
grid[x] = grid[x] or {}
grid[x][y] = love.math.noise( x + love.math.random(), y + love.math.random() )
end
end
end

function love.keypressed()
noise()
end```