External/cglm
1
0
Fork 0
mirror of https://github.com/recp/cglm.git synced 2026-01-06 15:10:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Recep Aslantas
2018-05-27 11:54:05 +03:00
parent ef0653640f
commit 059bdfdd4b
5 changed files with 30 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/source/box.rst
View File

@@ -28,6 +28,7 @@ Functions:
#. :c:func:`glm_aabb_isvalid` #. :c:func:`glm_aabb_isvalid`
#. :c:func:`glm_aabb_size` #. :c:func:`glm_aabb_size`
#. :c:func:`glm_aabb_radius` #. :c:func:`glm_aabb_radius`
#. :c:func:`glm_aabb_center`
Functions documentation Functions documentation
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
@@ -131,3 +132,11 @@ Functions documentation
Parameters: Parameters:
| *[in]* **box** bounding box | *[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

9
docs/source/mat3.rst
View File

@@ -24,6 +24,7 @@ Functions:
#. :c:func:`glm_mat3_transpose_to` #. :c:func:`glm_mat3_transpose_to`
#. :c:func:`glm_mat3_transpose` #. :c:func:`glm_mat3_transpose`
#. :c:func:`glm_mat3_mulv` #. :c:func:`glm_mat3_mulv`
#. :c:func:`glm_mat3_quat`
#. :c:func:`glm_mat3_scale` #. :c:func:`glm_mat3_scale`
#. :c:func:`glm_mat3_det` #. :c:func:`glm_mat3_det`
#. :c:func:`glm_mat3_inv` #. :c:func:`glm_mat3_inv`
@@ -89,6 +90,14 @@ Functions documentation
| *[in]* **v** vec3 (right, column vector) | *[in]* **v** vec3 (right, column vector)
| *[out]* **dest** destination (result, 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) .. c:function:: void glm_mat3_scale(mat3 m, float s)
multiply matrix with scalar multiply matrix with scalar

9
docs/source/mat4.rst
View File

@@ -32,6 +32,7 @@ Functions:
#. :c:func:`glm_mat4_mulN` #. :c:func:`glm_mat4_mulN`
#. :c:func:`glm_mat4_mulv` #. :c:func:`glm_mat4_mulv`
#. :c:func:`glm_mat4_mulv3` #. :c:func:`glm_mat4_mulv3`
#. :c:func:`glm_mat4_quat`
#. :c:func:`glm_mat4_transpose_to` #. :c:func:`glm_mat4_transpose_to`
#. :c:func:`glm_mat4_transpose` #. :c:func:`glm_mat4_transpose`
#. :c:func:`glm_mat4_scale_p` #. :c:func:`glm_mat4_scale_p`
@@ -146,6 +147,14 @@ Functions documentation
| *[in]* **v** vec3 (right, column vector) | *[in]* **v** vec3 (right, column vector)
| *[out]* **dest** vec3 (result, 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) .. c:function:: void glm_mat4_transpose_to(mat4 m, mat4 dest)
transpose mat4 and store in dest transpose mat4 and store in dest

4
include/cglm/mat3.h
View File

@@ -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 * @param[out] dest destination quaternion
*/ */
CGLM_INLINE CGLM_INLINE

2
include/cglm/mat4.h
View File

@@ -323,7 +323,7 @@ glm_mat4_mulv(mat4 m, vec4 v, vec4 dest) {
/*! /*!
* @brief convert mat4's rotation part to quaternion * @brief convert mat4's rotation part to quaternion
* *
* @param[in] m left matrix * @param[in] m affine matrix
* @param[out] dest destination quaternion * @param[out] dest destination quaternion
*/ */
CGLM_INLINE CGLM_INLINE