YourWishes/cglm
1
0
Fork 0
mirror of https://github.com/recp/cglm.git synced 2026-02-17 03:39:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Marcin
2025-01-17 20:34:47 +00:00
parent 9085ed020a
commit f1a72241b1
2 changed files with 20 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/source/noise.rst
View File

@@ -7,6 +7,14 @@ Header: cglm/noise.h
Classic Perlin noise implementation. 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): Table of contents (click to go):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -14,6 +22,7 @@ Functions:
1. :c:func:`glm_perlin_vec4` 1. :c:func:`glm_perlin_vec4`
#. :c:func:`glm_perlin_vec3` #. :c:func:`glm_perlin_vec3`
#. :c:func:`glm_perlin_vec2`
Functions documentation Functions documentation
@@ -39,3 +48,13 @@ Functions documentation
Returns: Returns:
| noise value | noise value
.. c:function:: float glm_perlin_vec2(vec2 point)
| Classic Perlin noise
Parameters:
| *[in]* **point** 2D point
Returns:
| noise value

2
include/cglm/noise.h
View File

@@ -9,7 +9,7 @@
* Following Stefan Gustavson's paper "Simplex noise demystified": * Following Stefan Gustavson's paper "Simplex noise demystified":
* http://www.itn.liu.se/~stegu/simplexnoise/simplexnoise.pdf * 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 * https://github.com/g-truc/glm/blob/master/glm/gtc/noise.inl
*/ */