FastLED 3.9.3
Loading...
Searching...
No Matches
Noise Generation Functions

Detailed Description

Functions to generate noise.

16-Bit Scaled Noise Functions

uint16_t inoise16 (uint32_t x, uint32_t y, uint32_t z)
 16-bit, fixed point implementation of Perlin's noise.
 
uint16_t inoise16 (uint32_t x, uint32_t y)
 16-bit, fixed point implementation of Perlin's noise.
 
uint16_t inoise16 (uint32_t x)
 16-bit, fixed point implementation of Perlin's noise.
 

16-Bit Raw Noise Functions

int16_t inoise16_raw (uint32_t x, uint32_t y, uint32_t z)
 16-bit, fixed point implementation of Perlin's noise without scaling.
 
int16_t inoise16_raw (uint32_t x, uint32_t y)
 16-bit, fixed point implementation of Perlin's noise without scaling.
 
int16_t inoise16_raw (uint32_t x)
 16-bit, fixed point implementation of Perlin's noise without scaling.
 

8-Bit Scaled Noise Functions

uint8_t inoise8 (uint16_t x, uint16_t y, uint16_t z)
 8-Bit, fixed point implementation of Perlin's noise.
 
uint8_t inoise8 (uint16_t x, uint16_t y)
 8-Bit, fixed point implementation of Perlin's noise.
 
uint8_t inoise8 (uint16_t x)
 8-Bit, fixed point implementation of Perlin's noise.
 

8-Bit Raw Noise Functions

int8_t inoise8_raw (uint16_t x, uint16_t y, uint16_t z)
 8-bit, fixed point implementation of Perlin's noise without scaling.
 
int8_t inoise8_raw (uint16_t x, uint16_t y)
 8-bit, fixed point implementation of Perlin's noise without scaling.
 
int8_t inoise8_raw (uint16_t x)
 8-bit, fixed point implementation of Perlin's noise without scaling.
 

Function Documentation

◆ inoise16() [1/3]

uint16_t inoise16 ( uint32_t x)
extern

16-bit, fixed point implementation of Perlin's noise.

See also
inoise16_raw()
Returns
scaled noise value as an unsigned integer, 0-65535
Parameters
xx-axis coordinate on noise map (1D)

Definition at line 467 of file noise.cpp.

◆ inoise16() [2/3]

uint16_t inoise16 ( uint32_t x,
uint32_t y )
extern

16-bit, fixed point implementation of Perlin's noise.

See also
inoise16_raw()
Returns
scaled noise value as an unsigned integer, 0-65535
Parameters
xx-axis coordinate on noise map (1D)
yy-axis coordinate on noise map (2D)

Definition at line 427 of file noise.cpp.

◆ inoise16() [3/3]

uint16_t inoise16 ( uint32_t x,
uint32_t y,
uint32_t z )
extern

16-bit, fixed point implementation of Perlin's noise.

See also
inoise16_raw()
Returns
scaled noise value as an unsigned integer, 0-65535
Parameters
xx-axis coordinate on noise map (1D)
yy-axis coordinate on noise map (2D)
zz-axis coordinate on noise map (3D)

Definition at line 378 of file noise.cpp.

◆ inoise16_raw() [1/3]

int16_t inoise16_raw ( uint32_t x)
extern

16-bit, fixed point implementation of Perlin's noise without scaling.

Coordinates are 16.16 fixed point values, 32 bit integers with integral coordinates in the high 16-bits and fractional in the low 16-bits.

Returns
unscaled noise value as a signed integer, roughly -18k to 18k
Parameters
xx-axis coordinate on noise map (1D)

Definition at line 442 of file noise.cpp.

◆ inoise16_raw() [2/3]

int16_t inoise16_raw ( uint32_t x,
uint32_t y )
extern

16-bit, fixed point implementation of Perlin's noise without scaling.

Coordinates are 16.16 fixed point values, 32 bit integers with integral coordinates in the high 16-bits and fractional in the low 16-bits.

Returns
unscaled noise value as a signed integer, roughly -18k to 18k
Parameters
xx-axis coordinate on noise map (1D)
yy-axis coordinate on noise map (2D)

Definition at line 394 of file noise.cpp.

◆ inoise16_raw() [3/3]

int16_t inoise16_raw ( uint32_t x,
uint32_t y,
uint32_t z )
extern

16-bit, fixed point implementation of Perlin's noise without scaling.

Coordinates are 16.16 fixed point values, 32 bit integers with integral coordinates in the high 16-bits and fractional in the low 16-bits.

Returns
unscaled noise value as a signed integer, roughly -18k to 18k
Parameters
xx-axis coordinate on noise map (1D)
yy-axis coordinate on noise map (2D)
zz-axis coordinate on noise map (3D)

Definition at line 335 of file noise.cpp.

◆ inoise8() [1/3]

uint8_t inoise8 ( uint16_t x)
extern

8-Bit, fixed point implementation of Perlin's noise.

See also
inoise8_raw()
Returns
scaled noise value as an unsigned integer, 0-255
Parameters
xx-axis coordinate on noise map (1D)

Definition at line 590 of file noise.cpp.

◆ inoise8() [2/3]

uint8_t inoise8 ( uint16_t x,
uint16_t y )
extern

8-Bit, fixed point implementation of Perlin's noise.

See also
inoise8_raw()
Returns
scaled noise value as an unsigned integer, 0-255
Parameters
xx-axis coordinate on noise map (1D)
yy-axis coordinate on noise map (2D)

Definition at line 556 of file noise.cpp.

◆ inoise8() [3/3]

uint8_t inoise8 ( uint16_t x,
uint16_t y,
uint16_t z )
extern

8-Bit, fixed point implementation of Perlin's noise.

See also
inoise8_raw()
Returns
scaled noise value as an unsigned integer, 0-255
Parameters
xx-axis coordinate on noise map (1D)
yy-axis coordinate on noise map (2D)
zz-axis coordinate on noise map (3D)

Definition at line 512 of file noise.cpp.

◆ inoise8_raw() [1/3]

int8_t inoise8_raw ( uint16_t x)
extern

8-bit, fixed point implementation of Perlin's noise without scaling.

Coordinates are 8.8 fixed point values, 16-bit integers with integral coordinates in the high 8-bits and fractional in the low 8-bits.

Returns
unscaled noise value as a signed integer, roughly -70 to 70
Parameters
xx-axis coordinate on noise map (1D)

Definition at line 565 of file noise.cpp.

◆ inoise8_raw() [2/3]

int8_t inoise8_raw ( uint16_t x,
uint16_t y )
extern

8-bit, fixed point implementation of Perlin's noise without scaling.

Coordinates are 8.8 fixed point values, 16-bit integers with integral coordinates in the high 8-bits and fractional in the low 8-bits.

Returns
unscaled noise value as a signed integer, roughly -70 to 70
Parameters
xx-axis coordinate on noise map (1D)
yy-axis coordinate on noise map (2D)

Definition at line 520 of file noise.cpp.

◆ inoise8_raw() [3/3]

int8_t inoise8_raw ( uint16_t x,
uint16_t y,
uint16_t z )
extern

8-bit, fixed point implementation of Perlin's noise without scaling.

Coordinates are 8.8 fixed point values, 16-bit integers with integral coordinates in the high 8-bits and fractional in the low 8-bits.

Returns
unscaled noise value as a signed integer, roughly -70 to 70
Parameters
xx-axis coordinate on noise map (1D)
yy-axis coordinate on noise map (2D)
zz-axis coordinate on noise map (3D)

Definition at line 471 of file noise.cpp.