diff options
author | Ayke van Laethem <aykevanlaethem@gmail.com> | 2021-06-22 16:07:30 +0300 |
---|---|---|
committer | Ayke van Laethem <aykevanlaethem@gmail.com> | 2021-06-22 16:07:30 +0300 |
commit | 7b079f43ff78e3e1d50923eb18e181b51ab7ee84 (patch) | |
tree | 132de2741b3eeb663fc3a20ca7d9bb7459f37380 | |
parent | cfffa1351497425931fb9ef5bad0eeb7b0cf8645 (diff) |
Fix incorrectly calling perlin noise "Simplex Noise"
Simplex noise is something different and is not implemented by the
FastLED library (yet!). Therefore, don't confuse people by calling it
Simplex Noise.
-rw-r--r-- | examples/NoisePlusPalette/NoisePlusPalette.ino | 2 | ||||
-rw-r--r-- | src/noise.h | 6 |
2 files changed, 4 insertions, 4 deletions
diff --git a/examples/NoisePlusPalette/NoisePlusPalette.ino b/examples/NoisePlusPalette/NoisePlusPalette.ino index 4670cc38..aa360b7c 100644 --- a/examples/NoisePlusPalette/NoisePlusPalette.ino +++ b/examples/NoisePlusPalette/NoisePlusPalette.ino @@ -15,7 +15,7 @@ const bool kMatrixSerpentineLayout = true; // This example combines two features of FastLED to produce a remarkable range of // effects from a relatively small amount of code. This example combines FastLED's -// color palette lookup functions with FastLED's Perlin/simplex noise generator, and +// color palette lookup functions with FastLED's Perlin noise generator, and // the combination is extremely powerful. // // You might want to look at the "ColorPalette" and "Noise" examples separately diff --git a/src/noise.h b/src/noise.h index 7355e23e..8a0db3f4 100644 --- a/src/noise.h +++ b/src/noise.h @@ -9,11 +9,11 @@ FASTLED_NAMESPACE_BEGIN /// Noise functions provided by the library. ///@defgroup Noise Noise functions -///Simplex noise function definitions +///Perlin noise function definitions ///@{ /// @name scaled 16 bit noise functions ///@{ -/// 16 bit, fixed point implementation of perlin's Simplex Noise. Coordinates are +/// 16 bit, fixed point implementation of Perlin's noise. 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, and the function takes 1d, 2d, and 3d coordinate /// values. These functions are scaled to return 0-65535 @@ -34,7 +34,7 @@ extern int16_t inoise16_raw(uint32_t x); /// @name 8 bit scaled noise functions ///@{ -/// 8 bit, fixed point implementation of perlin's Simplex Noise. Coordinates are +/// 8 bit, fixed point implementation of Perlin's noise. 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, and the function takes 1d, 2d, and 3d coordinate /// values. These functions are scaled to return 0-255 |