Noise Fill Functions

Detailed Description

Functions to fill a buffer with noise data.

Raw Fill Functions
Fill a 1D or 2D array with generated noise.
void	fill_raw_noise8 (uint8_t *pData, uint8_t num_points, uint8_t octaves, uint16_t x, int scalex, uint16_t time)
	Fill a 1D 8-bit buffer with noise, using inoise8()
void	fill_raw_noise16into8 (uint8_t *pData, uint8_t num_points, uint8_t octaves, uint32_t x, int scalex, uint32_t time)
	Fill a 1D 8-bit buffer with noise, using inoise16()
void	fill_raw_2dnoise8 (uint8_t *pData, int width, int height, uint8_t octaves, q44 freq44, fract8 amplitude, int skip, uint16_t x, int16_t scalex, uint16_t y, int16_t scaley, uint16_t time)
	Fill a 2D 8-bit buffer with noise, using inoise8()
void	fill_raw_2dnoise8 (uint8_t *pData, int width, int height, uint8_t octaves, uint16_t x, int scalex, uint16_t y, int scaley, uint16_t time)
void	fill_raw_2dnoise8 (uint8_t *pData, int width, int height, uint8_t octaves, uint16_t x, int16_t scalex, uint16_t y, int16_t scaley, uint16_t time)
	Fill a 2D 8-bit buffer with noise, using inoise8()
void	fill_raw_2dnoise16into8 (uint8_t *pData, int width, int height, uint8_t octaves, uint32_t x, int32_t scalex, uint32_t y, int32_t scaley, uint32_t time)
	Fill a 2D 8-bit buffer with noise, using inoise16()
void	fill_raw_2dnoise16 (uint16_t *pData, int width, int height, uint8_t octaves, q88 freq88, fract16 amplitude, int skip, uint32_t x, int32_t scalex, uint32_t y, int32_t scaley, uint32_t time)
	Fill a 2D 16-bit buffer with noise, using inoise16()
void	fill_raw_2dnoise16into8 (uint8_t *pData, int width, int height, uint8_t octaves, q44 freq44, fract8 amplitude, int skip, uint32_t x, int32_t scalex, uint32_t y, int32_t scaley, uint32_t time)
	Fill a 2D 8-bit buffer with noise, using inoise16()

Fill Functions
Fill an LED array with colors based on noise. Colors are calculated using noisemaps, randomly selecting hue and value (brightness) points with full saturation (255).
void	fill_noise8 (CRGB *leds, int num_leds, uint8_t octaves, uint16_t x, int scale, uint8_t hue_octaves, uint16_t hue_x, int hue_scale, uint16_t time)
	Fill an LED array with random colors, using 8-bit noise.
void	fill_noise16 (CRGB *leds, int num_leds, uint8_t octaves, uint16_t x, int scale, uint8_t hue_octaves, uint16_t hue_x, int hue_scale, uint16_t time, uint8_t hue_shift=0)
	Fill an LED array with random colors, using 16-bit noise.
void	fill_2dnoise8 (CRGB *leds, int width, int height, bool serpentine, uint8_t octaves, uint16_t x, int xscale, uint16_t y, int yscale, uint16_t time, uint8_t hue_octaves, uint16_t hue_x, int hue_xscale, uint16_t hue_y, uint16_t hue_yscale, uint16_t hue_time, bool blend)
	Fill an LED matrix with random colors, using 8-bit noise.
void	fill_2dnoise16 (CRGB *leds, int width, int height, bool serpentine, uint8_t octaves, uint32_t x, int xscale, uint32_t y, int yscale, uint32_t time, uint8_t hue_octaves, uint16_t hue_x, int hue_xscale, uint16_t hue_y, uint16_t hue_yscale, uint16_t hue_time, bool blend, uint16_t hue_shift=0)
	Fill an LED matrix with random colors, using 16-bit noise.

Function Documentation

fill_2dnoise16()

void fill_2dnoise16	(	CRGB *	leds,
		int	width,
		int	height,
		bool	serpentine,
		uint8_t	octaves,
		uint32_t	x,
		int	xscale,
		uint32_t	y,
		int	yscale,
		uint32_t	time,
		uint8_t	hue_octaves,
		uint16_t	hue_x,
		int	hue_xscale,
		uint16_t	hue_y,
		uint16_t	hue_yscale,
		uint16_t	hue_time,
		bool	blend,
		uint16_t	hue_shift = 0 )

Fill an LED matrix with random colors, using 16-bit noise.

Parameters

leds	pointer to LED array
width	the width of the LED matrix
height	the height of the LED matrix
serpentine	whether the matrix is laid out in a serpentine pattern (alternating left/right directions per row)
octaves	the number of octaves to use for value (brightness) noise
x	x-axis coordinate on noise map for value (brightness) noise
xscale	the scale (distance) between x points when filling in value (brightness) noise
y	y-axis coordinate on noise map for value (brightness) noise
yscale	the scale (distance) between y points when filling in value (brightness) noise
time	the time position for the value (brightness) noise field
hue_octaves	the number of octaves to use for color hue noise
hue_x	x-axis coordinate on noise map for color hue noise
hue_xscale	the scale (distance) between x points when filling in color hue noise
hue_y	y-axis coordinate on noise map for color hue noise.
hue_yscale	the scale (distance) between y points when filling in color hue noise
hue_time	the time position for the color hue noise field
blend	if true, will blend the newly generated LED values into the array. If false, will overwrite the array values directly.
hue_shift	how much to shift the final hues by for every LED

Definition at line 860 of file noise.cpp.

fill_2dnoise8()

void fill_2dnoise8	(	CRGB *	leds,
		int	width,
		int	height,
		bool	serpentine,
		uint8_t	octaves,
		uint16_t	x,
		int	xscale,
		uint16_t	y,
		int	yscale,
		uint16_t	time,
		uint8_t	hue_octaves,
		uint16_t	hue_x,
		int	hue_xscale,
		uint16_t	hue_y,
		uint16_t	hue_yscale,
		uint16_t	hue_time,
		bool	blend )

Fill an LED matrix with random colors, using 8-bit noise.

Parameters

leds	pointer to LED array
width	the width of the LED matrix
height	the height of the LED matrix
serpentine	whether the matrix is laid out in a serpentine pattern (alternating left/right directions per row)
octaves	the number of octaves to use for value (brightness) noise
x	x-axis coordinate on noise map for value (brightness) noise
xscale	the scale (distance) between x points when filling in value (brightness) noise
y	y-axis coordinate on noise map for value (brightness) noise
yscale	the scale (distance) between y points when filling in value (brightness) noise
time	the time position for the value (brightness) noise field
hue_octaves	the number of octaves to use for color hue noise
hue_x	x-axis coordinate on noise map for color hue noise
hue_xscale	the scale (distance) between x points when filling in color hue noise
hue_y	y-axis coordinate on noise map for color hue noise.
hue_yscale	the scale (distance) between y points when filling in color hue noise
hue_time	the time position for the color hue noise field
blend	if true, will blend the newly generated LED values into the array. If false, will overwrite the array values directly.

Definition at line 820 of file noise.cpp.

fill_noise16()

void fill_noise16	(	CRGB *	leds,
		int	num_leds,
		uint8_t	octaves,
		uint16_t	x,
		int	scale,
		uint8_t	hue_octaves,
		uint16_t	hue_x,
		int	hue_scale,
		uint16_t	time,
		uint8_t	hue_shift = 0 )

Fill an LED array with random colors, using 16-bit noise.

Parameters

leds	pointer to LED array
num_leds	the number of LEDs to fill
octaves	the number of octaves to use for value (brightness) noise
x	x-axis coordinate on noise map for value (brightness) noise
scale	the scale (distance) between x points when filling in value (brightness) noise
hue_octaves	the number of octaves to use for color hue noise
hue_x	x-axis coordinate on noise map for color hue noise
hue_scale	the scale (distance) between x points when filling in color hue noise
time	the time position for the noise field
hue_shift	how much to shift the final hues by for every LED

Definition at line 794 of file noise.cpp.

fill_noise8()

void fill_noise8	(	CRGB *	leds,
		int	num_leds,
		uint8_t	octaves,
		uint16_t	x,
		int	scale,
		uint8_t	hue_octaves,
		uint16_t	hue_x,
		int	hue_scale,
		uint16_t	time )

Fill an LED array with random colors, using 8-bit noise.

Parameters

leds	pointer to LED array
num_leds	the number of LEDs to fill
octaves	the number of octaves to use for value (brightness) noise
x	x-axis coordinate on noise map for value (brightness) noise
scale	the scale (distance) between x points when filling in value (brightness) noise
hue_octaves	the number of octaves to use for color hue noise
hue_x	x-axis coordinate on noise map for color hue noise
hue_scale	the scale (distance) between x points when filling in color hue noise
time	the time position for the noise field

Definition at line 767 of file noise.cpp.

fill_raw_2dnoise16()

void fill_raw_2dnoise16	(	uint16_t *	pData,
		int	width,
		int	height,
		uint8_t	octaves,
		q88	freq88,
		fract16	amplitude,
		int	skip,
		uint32_t	x,
		int32_t	scalex,
		uint32_t	y,
		int32_t	scaley,
		uint32_t	time )

Fill a 2D 16-bit buffer with noise, using inoise16()

Parameters

pData	the array of data to fill with noise values
width	the width of the 2D buffer
height	the height of the 2D buffer
octaves	the number of octaves to use for noise. More octaves = more noise.
x	x-axis coordinate on noise map (1D)
scalex	the scale (distance) between x points when filling in noise
y	y-axis coordinate on noise map (2D)
scaley	the scale (distance) between y points when filling in noise
time	the time position for the noise field
freq88	starting octave frequency
amplitude	noise amplitude
skip	how many noise maps to skip over, incremented recursively per octave

Definition at line 692 of file noise.cpp.

fill_raw_2dnoise16into8() [1/2]

void fill_raw_2dnoise16into8	(	uint8_t *	pData,
		int	width,
		int	height,
		uint8_t	octaves,
		q44	freq44,
		fract8	amplitude,
		int	skip,
		uint32_t	x,
		int32_t	scalex,
		uint32_t	y,
		int32_t	scaley,
		uint32_t	time )

Fill a 2D 8-bit buffer with noise, using inoise16()

Parameters

pData	the array of data to fill with noise values
width	the width of the 2D buffer
height	the height of the 2D buffer
octaves	the number of octaves to use for noise. More octaves = more noise.
x	x-axis coordinate on noise map (1D)
scalex	the scale (distance) between x points when filling in noise
y	y-axis coordinate on noise map (2D)
scaley	the scale (distance) between y points when filling in noise
time	the time position for the noise field
freq44	starting octave frequency
amplitude	noise amplitude
skip	how many noise maps to skip over, incremented recursively per octave

Definition at line 730 of file noise.cpp.

fill_raw_2dnoise16into8() [2/2]

void fill_raw_2dnoise16into8	(	uint8_t *	pData,
		int	width,
		int	height,
		uint8_t	octaves,
		uint32_t	x,
		int32_t	scalex,
		uint32_t	y,
		int32_t	scaley,
		uint32_t	time )

Fill a 2D 8-bit buffer with noise, using inoise16()

Parameters

pData	the array of data to fill with noise values
width	the width of the 2D buffer
height	the height of the 2D buffer
octaves	the number of octaves to use for noise. More octaves = more noise.
x	x-axis coordinate on noise map (1D)
scalex	the scale (distance) between x points when filling in noise
y	y-axis coordinate on noise map (2D)
scaley	the scale (distance) between y points when filling in noise
time	the time position for the noise field

fill_raw_2dnoise8() [1/3]

void fill_raw_2dnoise8	(	uint8_t *	pData,
		int	width,
		int	height,
		uint8_t	octaves,
		q44	freq44,
		fract8	amplitude,
		int	skip,
		uint16_t	x,
		int16_t	scalex,
		uint16_t	y,
		int16_t	scaley,
		uint16_t	time )

Fill a 2D 8-bit buffer with noise, using inoise8()

Parameters

pData	the array of data to fill with noise values
width	the width of the 2D buffer
height	the height of the 2D buffer
octaves	the number of octaves to use for noise. More octaves = more noise.
freq44	starting octave frequency
amplitude	noise amplitude
skip	how many noise maps to skip over, incremented recursively per octave
x	x-axis coordinate on noise map (1D)
scalex	the scale (distance) between x points when filling in noise
y	y-axis coordinate on noise map (2D)
scaley	the scale (distance) between y points when filling in noise
time	the time position for the noise field
pData	the array of data to fill with noise values
width	the width of the 2D buffer
height	the height of the 2D buffer
octaves	the number of octaves to use for noise. More octaves = more noise.
freq44	starting octave frequency
amplitude	noise amplitude
skip	how many noise maps to skip over, incremented recursively per octave
x	x-axis coordinate on noise map (1D)
scalex	the scale (distance) between x points when filling in noise
y	y-axis coordinate on noise map (2D)
scaley	the scale (distance) between y points when filling in noise
time	the time position for the noise field

Todo

Why isn't this declared in the header (noise.h)?

Definition at line 654 of file noise.cpp.

fill_raw_2dnoise8() [2/3]

void fill_raw_2dnoise8	(	uint8_t *	pData,
		int	width,
		int	height,
		uint8_t	octaves,
		uint16_t	x,
		int	scalex,
		uint16_t	y,
		int	scaley,
		uint16_t	time )

Definition at line 688 of file noise.cpp.

fill_raw_2dnoise8() [3/3]

void fill_raw_2dnoise8	(	uint8_t *	pData,
		int	width,
		int	height,
		uint8_t	octaves,
		uint16_t	x,
		int16_t	scalex,
		uint16_t	y,
		int16_t	scaley,
		uint16_t	time )

Fill a 2D 8-bit buffer with noise, using inoise8()

Parameters

pData	the array of data to fill with noise values
width	the width of the 2D buffer
height	the height of the 2D buffer
octaves	the number of octaves to use for noise. More octaves = more noise.
x	x-axis coordinate on noise map (1D)
scalex	the scale (distance) between x points when filling in noise
y	y-axis coordinate on noise map (2D)
scaley	the scale (distance) between y points when filling in noise
time	the time position for the noise field

fill_raw_noise16into8()

void fill_raw_noise16into8	(	uint8_t *	pData,
		uint8_t	num_points,
		uint8_t	octaves,
		uint32_t	x,
		int	scalex,
		uint32_t	time )

Fill a 1D 8-bit buffer with noise, using inoise16()

Parameters

pData	the array of data to fill with noise values
num_points	the number of points of noise to compute
octaves	the number of octaves to use for noise. More octaves = more noise.
x	x-axis coordinate on noise map (1D)
scalex	the scale (distance) between x points when filling in noise
time	the time position for the noise field

Definition at line 624 of file noise.cpp.

fill_raw_noise8()

void fill_raw_noise8	(	uint8_t *	pData,
		uint8_t	num_points,
		uint8_t	octaves,
		uint16_t	x,
		int	scalex,
		uint16_t	time )

Fill a 1D 8-bit buffer with noise, using inoise8()

Parameters

pData	the array of data to fill with noise values
num_points	the number of points of noise to compute
octaves	the number of octaves to use for noise. More octaves = more noise.
x	x-axis coordinate on noise map (1D)
scalex	the scale (distance) between x points when filling in noise
time	the time position for the noise field

Definition at line 611 of file noise.cpp.