From 059bdfdd4b6ea58f09372cfd170518e50575ca3b Mon Sep 17 00:00:00 2001 From: Recep Aslantas Date: Sun, 27 May 2018 11:54:05 +0300 Subject: [PATCH] update docs --- docs/source/box.rst | 9 +++++++++ docs/source/mat3.rst | 9 +++++++++ docs/source/mat4.rst | 9 +++++++++ include/cglm/mat3.h | 4 ++-- include/cglm/mat4.h | 2 +- 5 files changed, 30 insertions(+), 3 deletions(-) diff --git a/docs/source/box.rst b/docs/source/box.rst index 6aa4d62..6430c64 100644 --- a/docs/source/box.rst +++ b/docs/source/box.rst @@ -28,6 +28,7 @@ Functions: #. :c:func:`glm_aabb_isvalid` #. :c:func:`glm_aabb_size` #. :c:func:`glm_aabb_radius` +#. :c:func:`glm_aabb_center` Functions documentation ~~~~~~~~~~~~~~~~~~~~~~~ @@ -131,3 +132,11 @@ Functions documentation Parameters: | *[in]* **box** bounding box + +.. c:function:: void glm_aabb_center(vec3 box[2], vec3 dest) + + | computes center point of AABB + + Parameters: + | *[in]* **box** bounding box + | *[out]* **box** center of bounding box diff --git a/docs/source/mat3.rst b/docs/source/mat3.rst index 9b00417..b9f56ee 100644 --- a/docs/source/mat3.rst +++ b/docs/source/mat3.rst @@ -24,6 +24,7 @@ Functions: #. :c:func:`glm_mat3_transpose_to` #. :c:func:`glm_mat3_transpose` #. :c:func:`glm_mat3_mulv` +#. :c:func:`glm_mat3_quat` #. :c:func:`glm_mat3_scale` #. :c:func:`glm_mat3_det` #. :c:func:`glm_mat3_inv` @@ -89,6 +90,14 @@ Functions documentation | *[in]* **v** vec3 (right, column vector) | *[out]* **dest** destination (result, column vector) +.. c:function:: void glm_mat3_quat(mat3 m, versor dest) + + convert mat3 to quaternion + + Parameters: + | *[in]* **m** rotation matrix + | *[out]* **dest** destination quaternion + .. c:function:: void glm_mat3_scale(mat3 m, float s) multiply matrix with scalar diff --git a/docs/source/mat4.rst b/docs/source/mat4.rst index 1a391cb..7fb0857 100644 --- a/docs/source/mat4.rst +++ b/docs/source/mat4.rst @@ -32,6 +32,7 @@ Functions: #. :c:func:`glm_mat4_mulN` #. :c:func:`glm_mat4_mulv` #. :c:func:`glm_mat4_mulv3` +#. :c:func:`glm_mat4_quat` #. :c:func:`glm_mat4_transpose_to` #. :c:func:`glm_mat4_transpose` #. :c:func:`glm_mat4_scale_p` @@ -146,6 +147,14 @@ Functions documentation | *[in]* **v** vec3 (right, column vector) | *[out]* **dest** vec3 (result, column vector) +.. c:function:: void glm_mat4_quat(mat4 m, versor dest) + + convert mat4's rotation part to quaternion + + Parameters: + | *[in]* **m** affine matrix + | *[out]* **dest** destination quaternion + .. c:function:: void glm_mat4_transpose_to(mat4 m, mat4 dest) transpose mat4 and store in dest diff --git a/include/cglm/mat3.h b/include/cglm/mat3.h index 1df3a3b..f932bce 100644 --- a/include/cglm/mat3.h +++ b/include/cglm/mat3.h @@ -189,9 +189,9 @@ glm_mat3_mulv(mat3 m, vec3 v, vec3 dest) { /*! - * @brief convert mat4's rotation part to quaternion + * @brief convert mat3 to quaternion * - * @param[in] m left matrix + * @param[in] m rotation matrix * @param[out] dest destination quaternion */ CGLM_INLINE diff --git a/include/cglm/mat4.h b/include/cglm/mat4.h index 53e69de..e6e358f 100644 --- a/include/cglm/mat4.h +++ b/include/cglm/mat4.h @@ -323,7 +323,7 @@ glm_mat4_mulv(mat4 m, vec4 v, vec4 dest) { /*! * @brief convert mat4's rotation part to quaternion * - * @param[in] m left matrix + * @param[in] m affine matrix * @param[out] dest destination quaternion */ CGLM_INLINE