docs

recp · Jan 17, 2025 · f1a7224 · f1a7224
1 parent 9085ed0
commit f1a7224
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/docs/source/noise.rst b/docs/source/noise.rst
@@ -7,13 +7,22 @@ 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):
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 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
@@ -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
  */