From 71b48b530ebd73a33a8f72cb92092db5b6caf9de Mon Sep 17 00:00:00 2001 From: Recep Aslantas Date: Thu, 22 Mar 2018 21:24:26 +0300 Subject: [PATCH] add documentation for clamp --- docs/source/util.rst | 15 +++++++++++++++ docs/source/vec3.rst | 10 ++++++++++ docs/source/vec4.rst | 10 ++++++++++ 3 files changed, 35 insertions(+) diff --git a/docs/source/util.rst b/docs/source/util.rst index 048be70..43a9d49 100644 --- a/docs/source/util.rst +++ b/docs/source/util.rst @@ -18,6 +18,9 @@ Functions: #. :c:func:`glm_make_rad` #. :c:func:`glm_make_deg` #. :c:func:`glm_pow2` +#. :c:func:`glm_min` +#. :c:func:`glm_max` +#. :c:func:`glm_clamp` Functions documentation ~~~~~~~~~~~~~~~~~~~~~~~ @@ -91,3 +94,15 @@ Functions documentation Returns: maximum value + +.. c:function:: void glm_clamp(float val, float minVal, float maxVal) + + constrain a value to lie between two further values + + Parameters: + | *[in]* **val** input value + | *[in]* **minVal** minimum value + | *[in]* **maxVal** maximum value + + Returns: + clamped value diff --git a/docs/source/vec3.rst b/docs/source/vec3.rst index 2ae95f0..355178d 100644 --- a/docs/source/vec3.rst +++ b/docs/source/vec3.rst @@ -53,6 +53,7 @@ Functions: #. :c:func:`glm_vec_maxv` #. :c:func:`glm_vec_minv` #. :c:func:`glm_vec_ortho` +#. :c:func:`glm_vec_clamp` Functions documentation ~~~~~~~~~~~~~~~~~~~~~~~ @@ -271,3 +272,12 @@ Functions documentation Parameters: | *[in]* **mat** vector | *[out]* **dest** orthogonal/perpendicular vector + +.. c:function:: void glm_vec_clamp(vec3 v, float minVal, float maxVal) + + constrain a value to lie between two further values + + Parameters: + | *[in, out]* **v** vector + | *[in]* **minVal** minimum value + | *[in]* **maxVal** maximum value diff --git a/docs/source/vec4.rst b/docs/source/vec4.rst index 60be7fa..ac1b9c5 100644 --- a/docs/source/vec4.rst +++ b/docs/source/vec4.rst @@ -39,6 +39,7 @@ Functions: #. :c:func:`glm_vec4_distance` #. :c:func:`glm_vec4_maxv` #. :c:func:`glm_vec4_minv` +#. :c:func:`glm_vec4_clamp` Functions documentation ~~~~~~~~~~~~~~~~~~~~~~~ @@ -203,3 +204,12 @@ Functions documentation | *[in]* **v1** vector1 | *[in]* **v2** vector2 | *[out]* **dest** destination + +.. c:function:: void glm_vec4_clamp(vec4 v, float minVal, float maxVal) + + constrain a value to lie between two further values + + Parameters: + | *[in, out]* **v** vector + | *[in]* **minVal** minimum value + | *[in]* **maxVal** maximum value