diff --git a/docs/source/noise.rst b/docs/source/noise.rst index c7ec198..0976eee 100644 --- a/docs/source/noise.rst +++ b/docs/source/noise.rst @@ -7,6 +7,14 @@ Header: cglm/noise.h Classic Perlin noise implementation. +Based on the work of Stefan Gustavson and Ashima Arts on "webgl-noise": +https://github.com/stegu/webgl-noise +Following Stefan Gustavson's paper "Simplex noise demystified": +http://www.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf + +Implementation based on glm::perlin function: +https://github.com/g-truc/glm/blob/master/glm/gtc/noise.inl + Table of contents (click to go): ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -14,6 +22,7 @@ Functions: 1. :c:func:`glm_perlin_vec4` #. :c:func:`glm_perlin_vec3` +#. :c:func:`glm_perlin_vec2` Functions documentation @@ -39,3 +48,13 @@ Functions documentation Returns: | noise value + +.. c:function:: float glm_perlin_vec2(vec2 point) + + | Classic Perlin noise + + Parameters: + | *[in]* **point** 2D point + + Returns: + | noise value diff --git a/include/cglm/noise.h b/include/cglm/noise.h index 19f9da4..a118eae 100644 --- a/include/cglm/noise.h +++ b/include/cglm/noise.h @@ -9,7 +9,7 @@ * Following Stefan Gustavson's paper "Simplex noise demystified": * http://www.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf * - * Implementation based on glm::glc::noise.hpp: + * Implementation based on glm::perlin function: * https://github.com/g-truc/glm/blob/master/glm/gtc/noise.inl */