//---------------------------------------------------------------------------------------- // // siv::PerlinNoise // Perlin noise library for modern C++ // // Copyright (C) 2013-2021 Ryo Suzuki // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files(the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and / or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions : // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN // THE SOFTWARE. // //---------------------------------------------------------------------------------------- # pragma once # include # include # include # include # include # include # include # if __has_include() && defined(__cpp_concepts) # include # endif // Library major version # define SIVPERLIN_VERSION_MAJOR 3 // Library minor version # define SIVPERLIN_VERSION_MINOR 0 // Library revision version # define SIVPERLIN_VERSION_REVISION 0 // Library version # define SIVPERLIN_VERSION ((SIVPERLIN_VERSION_MAJOR * 100 * 100) + (SIVPERLIN_VERSION_MINOR * 100) + (SIVPERLIN_VERSION_REVISION)) // [[nodiscard]] for constructors # if (201907L <= __has_cpp_attribute(nodiscard)) # define SIVPERLIN_NODISCARD_CXX20 [[nodiscard]] # else # define SIVPERLIN_NODISCARD_CXX20 # endif // std::uniform_random_bit_generator concept # if __cpp_lib_concepts # define SIVPERLIN_CONCEPT_URBG template # define SIVPERLIN_CONCEPT_URBG_ template # else # define SIVPERLIN_CONCEPT_URBG template , std::is_unsigned>>>* = nullptr> # define SIVPERLIN_CONCEPT_URBG_ template , std::is_unsigned>>>*> # endif // arbitrary value for increasing entropy # ifndef SIVPERLIN_DEFAULT_Y # define SIVPERLIN_DEFAULT_Y (0.12345) # endif // arbitrary value for increasing entropy # ifndef SIVPERLIN_DEFAULT_Z # define SIVPERLIN_DEFAULT_Z (0.34567) # endif namespace app { template class BasicPerlinNoise { public: static_assert(std::is_floating_point_v); /////////////////////////////////////// // // Typedefs // using state_type = std::array; using value_type = Float; using default_random_engine = std::mt19937; using seed_type = typename default_random_engine::result_type; /////////////////////////////////////// // // Constructors // SIVPERLIN_NODISCARD_CXX20 constexpr BasicPerlinNoise() noexcept; SIVPERLIN_NODISCARD_CXX20 explicit BasicPerlinNoise(seed_type seed); SIVPERLIN_CONCEPT_URBG SIVPERLIN_NODISCARD_CXX20 explicit BasicPerlinNoise(URBG&& urbg); /////////////////////////////////////// // // Reseed // void reseed(seed_type seed); SIVPERLIN_CONCEPT_URBG void reseed(URBG&& urbg); /////////////////////////////////////// // // Serialization // [[nodiscard]] constexpr const state_type& serialize() const noexcept; constexpr void deserialize(const state_type& state) noexcept; /////////////////////////////////////// // // Noise (The result is in the range [-1, 1]) // [[nodiscard]] value_type noise1D(value_type x) const noexcept; [[nodiscard]] value_type noise2D(value_type x, value_type y) const noexcept; [[nodiscard]] value_type noise3D(value_type x, value_type y, value_type z) const noexcept; /////////////////////////////////////// // // Noise (The result is remapped to the range [0, 1]) // [[nodiscard]] value_type noise1D_01(value_type x) const noexcept; [[nodiscard]] value_type noise2D_01(value_type x, value_type y) const noexcept; [[nodiscard]] value_type noise3D_01(value_type x, value_type y, value_type z) const noexcept; /////////////////////////////////////// // // Octave noise (The result can be out of the range [-1, 1]) // [[nodiscard]] value_type octave1D(value_type x, std::int32_t octaves, value_type persistence = value_type(0.5)) const noexcept; [[nodiscard]] value_type octave2D(value_type x, value_type y, std::int32_t octaves, value_type persistence = value_type(0.5)) const noexcept; [[nodiscard]] value_type octave3D(value_type x, value_type y, value_type z, std::int32_t octaves, value_type persistence = value_type(0.5)) const noexcept; /////////////////////////////////////// // // Octave noise (The result is clamped to the range [-1, 1]) // [[nodiscard]] value_type octave1D_11(value_type x, std::int32_t octaves, value_type persistence = value_type(0.5)) const noexcept; [[nodiscard]] value_type octave2D_11(value_type x, value_type y, std::int32_t octaves, value_type persistence = value_type(0.5)) const noexcept; [[nodiscard]] value_type octave3D_11(value_type x, value_type y, value_type z, std::int32_t octaves, value_type persistence = value_type(0.5)) const noexcept; /////////////////////////////////////// // // Octave noise (The result is clamped and remapped to the range [0, 1]) // [[nodiscard]] value_type octave1D_01(value_type x, std::int32_t octaves, value_type persistence = value_type(0.5)) const noexcept; [[nodiscard]] value_type octave2D_01(value_type x, value_type y, std::int32_t octaves, value_type persistence = value_type(0.5)) const noexcept; [[nodiscard]] value_type octave3D_01(value_type x, value_type y, value_type z, std::int32_t octaves, value_type persistence = value_type(0.5)) const noexcept; /////////////////////////////////////// // // Octave noise (The result is normalized to the range [-1, 1]) // [[nodiscard]] value_type normalizedOctave1D(value_type x, std::int32_t octaves, value_type persistence = value_type(0.5)) const noexcept; [[nodiscard]] value_type normalizedOctave2D(value_type x, value_type y, std::int32_t octaves, value_type persistence = value_type(0.5)) const noexcept; [[nodiscard]] value_type normalizedOctave3D(value_type x, value_type y, value_type z, std::int32_t octaves, value_type persistence = value_type(0.5)) const noexcept; /////////////////////////////////////// // // Octave noise (The result is normalized and remapped to the range [0, 1]) // [[nodiscard]] value_type normalizedOctave1D_01(value_type x, std::int32_t octaves, value_type persistence = value_type(0.5)) const noexcept; [[nodiscard]] value_type normalizedOctave2D_01(value_type x, value_type y, std::int32_t octaves, value_type persistence = value_type(0.5)) const noexcept; [[nodiscard]] value_type normalizedOctave3D_01(value_type x, value_type y, value_type z, std::int32_t octaves, value_type persistence = value_type(0.5)) const noexcept; private: state_type m_permutation; }; using PerlinNoise = BasicPerlinNoise; namespace perlin_detail { //////////////////////////////////////////////// // // These functions are provided for consistency. // You may get different results from std::shuffle() with different standard library implementations. // SIVPERLIN_CONCEPT_URBG [[nodiscard]] inline std::uint64_t Random(const std::uint64_t max, URBG&& urbg) { return (urbg() % (max + 1)); } template inline void Shuffle(RandomIt first, RandomIt last, URBG&& urbg) { if (first == last) { return; } using difference_type = typename std::iterator_traits::difference_type; for (RandomIt it = first + 1; it < last; ++it) { const std::uint64_t n = static_cast(it - first); std::iter_swap(it, first + static_cast(Random(n, std::forward(urbg)))); } } // //////////////////////////////////////////////// template [[nodiscard]] inline constexpr Float Fade(const Float t) noexcept { return t * t * t * (t * (t * 6 - 15) + 10); } template [[nodiscard]] inline constexpr Float Lerp(const Float a, const Float b, const Float t) noexcept { return (a + (b - a) * t); } template [[nodiscard]] inline constexpr Float Grad(const std::uint8_t hash, const Float x, const Float y, const Float z) noexcept { const std::uint8_t h = hash & 15; const Float u = h < 8 ? x : y; const Float v = h < 4 ? y : h == 12 || h == 14 ? x : z; return ((h & 1) == 0 ? u : -u) + ((h & 2) == 0 ? v : -v); } template [[nodiscard]] inline constexpr Float Remap_01(const Float x) noexcept { return (x * Float(0.5) + Float(0.5)); } template [[nodiscard]] inline constexpr Float Clamp_11(const Float x) noexcept { return std::clamp(x, Float(-1.0), Float(1.0)); } template [[nodiscard]] inline constexpr Float RemapClamp_01(const Float x) noexcept { if (x <= Float(-1.0)) { return Float(0.0); } else if (Float(1.0) <= x) { return Float(1.0); } return (x * Float(0.5) + Float(0.5)); } template [[nodiscard]] inline auto Octave1D(const Noise& noise, Float x, const std::int32_t octaves, const Float persistence) noexcept { using value_type = Float; value_type result = 0; value_type amplitude = 1; for (std::int32_t i = 0; i < octaves; ++i) { result += (noise.noise1D(x) * amplitude); x *= 2; amplitude *= persistence; } return result; } template [[nodiscard]] inline auto Octave2D(const Noise& noise, Float x, Float y, const std::int32_t octaves, const Float persistence) noexcept { using value_type = Float; value_type result = 0; value_type amplitude = 1; for (std::int32_t i = 0; i < octaves; ++i) { result += (noise.noise2D(x, y) * amplitude); x *= 2; y *= 2; amplitude *= persistence; } return result; } template [[nodiscard]] inline auto Octave3D(const Noise& noise, Float x, Float y, Float z, const std::int32_t octaves, const Float persistence) noexcept { using value_type = Float; value_type result = 0; value_type amplitude = 1; for (std::int32_t i = 0; i < octaves; ++i) { result += (noise.noise3D(x, y, z) * amplitude); x *= 2; y *= 2; z *= 2; amplitude *= persistence; } return result; } template [[nodiscard]] inline constexpr Float MaxAmplitude(const std::int32_t octaves, const Float persistence) noexcept { using value_type = Float; value_type result = 0; value_type amplitude = 1; for (std::int32_t i = 0; i < octaves; ++i) { result += amplitude; amplitude *= persistence; } return result; } } /////////////////////////////////////// template inline constexpr BasicPerlinNoise::BasicPerlinNoise() noexcept : m_permutation{ 151,160,137,91,90,15, 131,13,201,95,96,53,194,233,7,225,140,36,103,30,69,142,8,99,37,240,21,10,23, 190, 6,148,247,120,234,75,0,26,197,62,94,252,219,203,117,35,11,32,57,177,33, 88,237,149,56,87,174,20,125,136,171,168, 68,175,74,165,71,134,139,48,27,166, 77,146,158,231,83,111,229,122,60,211,133,230,220,105,92,41,55,46,245,40,244, 102,143,54, 65,25,63,161, 1,216,80,73,209,76,132,187,208, 89,18,169,200,196, 135,130,116,188,159,86,164,100,109,198,173,186, 3,64,52,217,226,250,124,123, 5,202,38,147,118,126,255,82,85,212,207,206,59,227,47,16,58,17,182,189,28,42, 223,183,170,213,119,248,152, 2,44,154,163, 70,221,153,101,155,167, 43,172,9, 129,22,39,253, 19,98,108,110,79,113,224,232,178,185, 112,104,218,246,97,228, 251,34,242,193,238,210,144,12,191,179,162,241, 81,51,145,235,249,14,239,107, 49,192,214, 31,181,199,106,157,184, 84,204,176,115,121,50,45,127, 4,150,254, 138,236,205,93,222,114,67,29,24,72,243,141,128,195,78,66,215,61,156,180 } {} template inline BasicPerlinNoise::BasicPerlinNoise(const seed_type seed) { reseed(seed); } template SIVPERLIN_CONCEPT_URBG_ inline BasicPerlinNoise::BasicPerlinNoise(URBG&& urbg) { reseed(std::forward(urbg)); } /////////////////////////////////////// template inline void BasicPerlinNoise::reseed(const seed_type seed) { reseed(default_random_engine{ seed }); } template SIVPERLIN_CONCEPT_URBG_ inline void BasicPerlinNoise::reseed(URBG&& urbg) { std::iota(m_permutation.begin(), m_permutation.end(), uint8_t{ 0 }); perlin_detail::Shuffle(m_permutation.begin(), m_permutation.end(), std::forward(urbg)); } /////////////////////////////////////// template inline constexpr const typename BasicPerlinNoise::state_type& BasicPerlinNoise::serialize() const noexcept { return m_permutation; } template inline constexpr void BasicPerlinNoise::deserialize(const state_type& state) noexcept { m_permutation = state; } /////////////////////////////////////// template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::noise1D(const value_type x) const noexcept { return noise3D(x, static_cast(SIVPERLIN_DEFAULT_Y), static_cast(SIVPERLIN_DEFAULT_Z)); } template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::noise2D(const value_type x, const value_type y) const noexcept { return noise3D(x, y, static_cast(SIVPERLIN_DEFAULT_Z)); } template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::noise3D(const value_type x, const value_type y, const value_type z) const noexcept { const value_type _x = std::floor(x); const value_type _y = std::floor(y); const value_type _z = std::floor(z); const std::int32_t ix = static_cast(_x) & 255; const std::int32_t iy = static_cast(_y) & 255; const std::int32_t iz = static_cast(_z) & 255; const value_type fx = (x - _x); const value_type fy = (y - _y); const value_type fz = (z - _z); const value_type u = perlin_detail::Fade(fx); const value_type v = perlin_detail::Fade(fy); const value_type w = perlin_detail::Fade(fz); const std::uint8_t A = (m_permutation[ix & 255] + iy) & 255; const std::uint8_t B = (m_permutation[(ix + 1) & 255] + iy) & 255; const std::uint8_t AA = (m_permutation[A] + iz) & 255; const std::uint8_t AB = (m_permutation[(A + 1) & 255] + iz) & 255; const std::uint8_t BA = (m_permutation[B] + iz) & 255; const std::uint8_t BB = (m_permutation[(B + 1) & 255] + iz) & 255; const value_type p0 = perlin_detail::Grad(m_permutation[AA], fx, fy, fz); const value_type p1 = perlin_detail::Grad(m_permutation[BA], fx - 1, fy, fz); const value_type p2 = perlin_detail::Grad(m_permutation[AB], fx, fy - 1, fz); const value_type p3 = perlin_detail::Grad(m_permutation[BB], fx - 1, fy - 1, fz); const value_type p4 = perlin_detail::Grad(m_permutation[(AA + 1) & 255], fx, fy, fz - 1); const value_type p5 = perlin_detail::Grad(m_permutation[(BA + 1) & 255], fx - 1, fy, fz - 1); const value_type p6 = perlin_detail::Grad(m_permutation[(AB + 1) & 255], fx, fy - 1, fz - 1); const value_type p7 = perlin_detail::Grad(m_permutation[(BB + 1) & 255], fx - 1, fy - 1, fz - 1); const value_type q0 = perlin_detail::Lerp(p0, p1, u); const value_type q1 = perlin_detail::Lerp(p2, p3, u); const value_type q2 = perlin_detail::Lerp(p4, p5, u); const value_type q3 = perlin_detail::Lerp(p6, p7, u); const value_type r0 = perlin_detail::Lerp(q0, q1, v); const value_type r1 = perlin_detail::Lerp(q2, q3, v); return perlin_detail::Lerp(r0, r1, w); } /////////////////////////////////////// template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::noise1D_01(const value_type x) const noexcept { return perlin_detail::Remap_01(noise1D(x)); } template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::noise2D_01(const value_type x, const value_type y) const noexcept { return perlin_detail::Remap_01(noise2D(x, y)); } template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::noise3D_01(const value_type x, const value_type y, const value_type z) const noexcept { return perlin_detail::Remap_01(noise3D(x, y, z)); } /////////////////////////////////////// template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::octave1D(const value_type x, const std::int32_t octaves, const value_type persistence) const noexcept { return perlin_detail::Octave1D(*this, x, octaves, persistence); } template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::octave2D(const value_type x, const value_type y, const std::int32_t octaves, const value_type persistence) const noexcept { return perlin_detail::Octave2D(*this, x, y, octaves, persistence); } template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::octave3D(const value_type x, const value_type y, const value_type z, const std::int32_t octaves, const value_type persistence) const noexcept { return perlin_detail::Octave3D(*this, x, y, z, octaves, persistence); } /////////////////////////////////////// template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::octave1D_11(const value_type x, const std::int32_t octaves, const value_type persistence) const noexcept { return perlin_detail::Clamp_11(octave1D(x, octaves, persistence)); } template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::octave2D_11(const value_type x, const value_type y, const std::int32_t octaves, const value_type persistence) const noexcept { return perlin_detail::Clamp_11(octave2D(x, y, octaves, persistence)); } template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::octave3D_11(const value_type x, const value_type y, const value_type z, const std::int32_t octaves, const value_type persistence) const noexcept { return perlin_detail::Clamp_11(octave3D(x, y, z, octaves, persistence)); } /////////////////////////////////////// template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::octave1D_01(const value_type x, const std::int32_t octaves, const value_type persistence) const noexcept { return perlin_detail::RemapClamp_01(octave1D(x, octaves, persistence)); } template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::octave2D_01(const value_type x, const value_type y, const std::int32_t octaves, const value_type persistence) const noexcept { return perlin_detail::RemapClamp_01(octave2D(x, y, octaves, persistence)); } template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::octave3D_01(const value_type x, const value_type y, const value_type z, const std::int32_t octaves, const value_type persistence) const noexcept { return perlin_detail::RemapClamp_01(octave3D(x, y, z, octaves, persistence)); } /////////////////////////////////////// template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::normalizedOctave1D(const value_type x, const std::int32_t octaves, const value_type persistence) const noexcept { return (octave1D(x, octaves, persistence) / perlin_detail::MaxAmplitude(octaves, persistence)); } template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::normalizedOctave2D(const value_type x, const value_type y, const std::int32_t octaves, const value_type persistence) const noexcept { return (octave2D(x, y, octaves, persistence) / perlin_detail::MaxAmplitude(octaves, persistence)); } template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::normalizedOctave3D(const value_type x, const value_type y, const value_type z, const std::int32_t octaves, const value_type persistence) const noexcept { return (octave3D(x, y, z, octaves, persistence) / perlin_detail::MaxAmplitude(octaves, persistence)); } /////////////////////////////////////// template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::normalizedOctave1D_01(const value_type x, const std::int32_t octaves, const value_type persistence) const noexcept { return perlin_detail::Remap_01(normalizedOctave1D(x, octaves, persistence)); } template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::normalizedOctave2D_01(const value_type x, const value_type y, const std::int32_t octaves, const value_type persistence) const noexcept { return perlin_detail::Remap_01(normalizedOctave2D(x, y, octaves, persistence)); } template inline typename BasicPerlinNoise::value_type BasicPerlinNoise::normalizedOctave3D_01(const value_type x, const value_type y, const value_type z, const std::int32_t octaves, const value_type persistence) const noexcept { return perlin_detail::Remap_01(normalizedOctave3D(x, y, z, octaves, persistence)); } } # undef SIVPERLIN_NODISCARD_CXX20 # undef SIVPERLIN_CONCEPT_URBG # undef SIVPERLIN_CONCEPT_URBG_