From 8a2fd9cda92769c9acda12991153f0e2103744d1 Mon Sep 17 00:00:00 2001 From: Marcin Date: Tue, 14 Jan 2025 17:34:51 +0000 Subject: [PATCH] docs boilerplate --- docs/source/api_inline_array.rst | 1 + docs/source/perlin.rst | 29 +++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 docs/source/perlin.rst diff --git a/docs/source/api_inline_array.rst b/docs/source/api_inline_array.rst index 5d8ead8..becb684 100644 --- a/docs/source/api_inline_array.rst +++ b/docs/source/api_inline_array.rst @@ -66,6 +66,7 @@ Follow the :doc:`build` documentation for this ivec4 color plane + perlin project util io diff --git a/docs/source/perlin.rst b/docs/source/perlin.rst new file mode 100644 index 0000000..0fb6fb4 --- /dev/null +++ b/docs/source/perlin.rst @@ -0,0 +1,29 @@ +.. default-domain:: C + +perlin +================================================================================ + +Header: cglm/perlin.h + +Classic Perlin noise implementation. + +Table of contents (click to go): +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Functions: + +1. :c:func:`glm_perlin` + + +Functions documentation +~~~~~~~~~~~~~~~~~~~~~~~ + +.. c:function:: float glm_perlin(vec4 point) + + | Classic Perlin noise + + Parameters: + | *[in]* **point** 4D point + + Returns: + | noise value