diff --git a/docs/source/mat2x3.rst b/docs/source/mat2x3.rst index 06780d6..33298a0 100644 --- a/docs/source/mat2x3.rst +++ b/docs/source/mat2x3.rst @@ -36,58 +36,103 @@ Represented Functions documentation ~~~~~~~~~~~~~~~~~~~~~~~ -.. c:function:: void glm_mat2x3_copy(mat2x3 mat, mat2x3 dest) +.. c:function:: void glm_mat2x3_copy(mat2x3 src, mat2x3 dest) - copy mat2x3 to another one (dest). + Copy mat2x3 (src) to mat2x3 (dest). Parameters: - | *[in]* **mat** source - | *[out]* **dest** destination + | *[in]* **src** mat2x3 (left) + | *[out]* **dest** destination (result, mat2x3) -.. c:function:: void glm_mat2x3_zero(mat2x3 mat) - - make given matrix zero - - Parameters: - | *[in,out]* **mat** matrix - -.. c:function:: void glm_mat2x3_make(const float * __restrict src, mat2x3 dest) - - Create mat2x3 matrix from pointer - - .. note:: **@src** must contain at least 6 elements. - - Parameters: - | *[in]* **src** pointer to an array of floats - | *[out]* **dest** destination matrix2x3 - -.. c:function:: void glm_mat2x3_mul(mat2x3 m1, mat3x2 m2, mat3 dest) - - multiply m1 and m2 to dest - - .. code-block:: c - - glm_mat2x3_mul(mat2x3, mat3x2, mat3); - - Parameters: - | *[in]* **m1** left matrix (mat2x3) - | *[in]* **m2** right matrix (mat3x2) - | *[out]* **dest** destination matrix (mat3) - - .. csv-table:: mat2x3 + .. csv-table:: mat2x3 **(src)** :header: "", "column 1", "column 2" "row 1", "a00", "a10" "row 2", "a01", "a11" "row 3", "a02", "a12" - .. csv-table:: mat3x2 + .. csv-table:: mat2x3 **(dest)** + :header: "", "column 1", "column 2" + + "row 1", "b00 = a00", "b10 = a10" + "row 2", "b01 = a01", "b11 = a11" + "row 3", "b02 = a02", "b12 = a12" + +.. c:function:: void glm_mat2x3_zero(mat2x3 m) + + Zero out the mat2x3 (m). + + Parameters: + | *[in, out]* **mat** mat2x3 (src, dest) + + .. csv-table:: mat2x3 **(m)** + :header: "", "column 1", "column 2" + + "row 1", "0.00", "2.00" + "row 2", "5.00", "4.00" + "row 3", "7.00", "6.00" + + .. csv-table:: mat2x3 **(m)** + :header: "", "column 1", "column 2" + + "row 1", "0.00", "0.00" + "row 2", "0.00", "0.00" + "row 3", "0.00", "0.00" + +.. c:function:: void glm_mat2x3_make(const float * __restrict src, mat2x3 dest) + + Create mat2x3 (dest) from pointer (src). + + .. note:: **@src** must contain at least 6 elements. + + Parameters: + | *[in]* **src** pointer to an array of floats (left) + | *[out]* **dest** destination (result, mat2x3) + + .. csv-table:: float array (1x6) **(src)** + :header: "", "column 1" + + "row 1", "v0" + "row 2", "v1" + "row 3", "v2" + "row 4", "v3" + "row 5", "v4" + "row 6", "v5" + + .. csv-table:: mat2x3 **(dest)** + :header: "", "column 1", "column 2" + + "row 1", "v0", "v3" + "row 2", "v1", "v4" + "row 3", "v2", "v5" + +.. c:function:: void glm_mat2x3_mul(mat2x3 m1, mat3x2 m2, mat3 dest) + + Multiply mat2x3 (m1) by mat3x2 (m2) and store in mat3 (dest). + + .. code-block:: c + + glm_mat2x3_mul(mat2x3, mat3x2, mat3); + + Parameters: + | *[in]* **m1** mat2x3 (left) + | *[in]* **m2** mat3x2 (right) + | *[out]* **dest** destination (result, mat3) + + .. csv-table:: mat2x3 **(m1)** + :header: "", "column 1", "column 2" + + "row 1", "a00", "a10" + "row 2", "a01", "a11" + "row 3", "a02", "a12" + + .. csv-table:: mat3x2 **(m2)** :header: "", "column 1", "column 2", "column 3" "row 1", "b00", "b10", "b20" "row 2", "b01", "b11", "b21" - .. csv-table:: mat3x3 + .. csv-table:: mat3 **(dest)** :header: "", "column 1", "column 2", "column 3" "row 1", "a00 * b00 + a10 * b01", "a00 * b10 + a10 * b11", "a00 * b20 + a10 * b21" @@ -96,45 +141,65 @@ Functions documentation .. c:function:: void glm_mat2x3_mulv(mat2x3 m, vec2 v, vec3 dest) - multiply mat2x3 with vec2 (column vector) and store in dest column vector + Multiply mat2x3 (m) by vec2 (v) and store in vec3 (dest). Parameters: - | *[in]* **m** mat2x3 (left) - | *[in]* **v** vec3 (right, column vector) - | *[out]* **dest** destination (result, column vector) + | *[in]* **m** mat2x3 (left) + | *[in]* **v** vec2 (right, column vector) + | *[out]* **dest** destination (result, column vector) - .. csv-table:: mat2x3 + .. csv-table:: mat2x3 **(m)** :header: "", "column 1", "column 2" "row 1", "m00", "m10" "row 2", "m01", "m11" "row 3", "m02", "m12" - .. csv-table:: column vec2 (1x2) + .. csv-table:: column vec2 (1x2) **(v)** :header: "", "column 1" "row 1", "v0" "row 2", "v1" - .. csv-table:: column vec3 (1x3) + .. csv-table:: column vec3 (1x3) **(dest)** :header: "", "column 1" "row 1", "m00 * v0 + m10 * v1" "row 2", "m01 * v0 + m11 * v1" "row 3", "m02 * v0 + m12 * v1" -.. c:function:: void glm_mat2x3_transpose(mat2x3 m, mat3x2 dest) +.. c:function:: void glm_mat2x3_transpose(mat2x3 src, mat3x2 dest) - transpose matrix and store in dest + Transpose mat2x3 (src) and store in mat3x2 (dest). Parameters: - | *[in]* **m** matrix - | *[out]* **dest** destination + | *[in]* **src** mat2x3 (left) + | *[out]* **dest** destination (result, mat3x2) -.. c:function:: void glm_mat2x3_scale(mat2x3 m, float s) + .. csv-table:: mat2x3 **(src)** + :header: "", "column 1", "column 2" - multiply matrix with scalar + "row 1", "a00", "a10" + "row 2", "a01", "a11" + "row 3", "a02", "a12" + + .. csv-table:: mat3x2 **(dest)** + :header: "", "column 1", "column 2", "column 3" + + "row 1", "b00 = a00", "b10 = a01", "b20 = a02" + "row 2", "b01 = a10", "b11 = a11", "b21 = a12" + +.. c:function:: void glm_mat2x3_scale(mat2x3 m, float s) + + Multiply mat2x3 (m) by scalar constant (s). Parameters: - | *[in, out]* **m** matrix - | *[in]* **s** scalar + | *[in, out]* **m** mat2x3 (src, dest) + | *[in]* **s** float (scalar) + + .. csv-table:: mat2x3 **(m)** + :header: "", "column 1", "column 2" + + "row 1", "m00 = m00 * s", "m10 = m10 * s" + "row 2", "m01 = m01 * s", "m11 = m11 * s" + "row 3", "m02 = m02 * s", "m12 = m12 * s" diff --git a/include/cglm/call/mat2x3.h b/include/cglm/call/mat2x3.h index 59c9ee3..215d9a4 100644 --- a/include/cglm/call/mat2x3.h +++ b/include/cglm/call/mat2x3.h @@ -15,11 +15,11 @@ extern "C" { CGLM_EXPORT void -glmc_mat2x3_copy(mat2x3 mat, mat2x3 dest); +glmc_mat2x3_copy(mat2x3 src, mat2x3 dest); CGLM_EXPORT void -glmc_mat2x3_zero(mat2x3 mat); +glmc_mat2x3_zero(mat2x3 m); CGLM_EXPORT void @@ -35,7 +35,7 @@ glmc_mat2x3_mulv(mat2x3 m, vec2 v, vec3 dest); CGLM_EXPORT void -glmc_mat2x3_transpose(mat2x3 m, mat3x2 dest); +glmc_mat2x3_transpose(mat2x3 src, mat3x2 dest); CGLM_EXPORT void diff --git a/include/cglm/mat2x3.h b/include/cglm/mat2x3.h index 811baaf..0bb8d70 100644 --- a/include/cglm/mat2x3.h +++ b/include/cglm/mat2x3.h @@ -11,12 +11,12 @@ GLM_MAT2X3_ZERO Functions: - CGLM_INLINE void glm_mat2x3_copy(mat2x3 mat, mat2x3 dest); - CGLM_INLINE void glm_mat2x3_zero(mat2x3 mat); + CGLM_INLINE void glm_mat2x3_copy(mat2x3 src, mat2x3 dest); + CGLM_INLINE void glm_mat2x3_zero(mat2x3 m); CGLM_INLINE void glm_mat2x3_make(const float * __restrict src, mat2x3 dest); CGLM_INLINE void glm_mat2x3_mul(mat2x3 m1, mat3x2 m2, mat3 dest); CGLM_INLINE void glm_mat2x3_mulv(mat2x3 m, vec2 v, vec3 dest); - CGLM_INLINE void glm_mat2x3_transpose(mat2x3 m, mat3x2 dest); + CGLM_INLINE void glm_mat2x3_transpose(mat2x3 src, mat3x2 dest); CGLM_INLINE void glm_mat2x3_scale(mat2x3 m, float s); */ @@ -31,40 +31,35 @@ #define GLM_MAT2X3_ZERO GLM_MAT2X3_ZERO_INIT /*! - * @brief copy all members of [mat] to [dest] + * @brief Copy mat2x3 (src) to mat2x3 (dest). * - * @param[in] mat source - * @param[out] dest destination + * @param[in] src mat2x3 (left) + * @param[out] dest destination (result, mat2x3) */ CGLM_INLINE void -glm_mat2x3_copy(mat2x3 mat, mat2x3 dest) { - dest[0][0] = mat[0][0]; - dest[0][1] = mat[0][1]; - dest[0][2] = mat[0][2]; - - dest[1][0] = mat[1][0]; - dest[1][1] = mat[1][1]; - dest[1][2] = mat[1][2]; +glm_mat2x3_copy(mat2x3 src, mat2x3 dest) { + glm_vec3_copy(src[0], dest[0]); + glm_vec3_copy(src[1], dest[1]); } /*! - * @brief make given matrix zero. + * @brief Zero out the mat2x3 (m). * - * @param[in, out] mat matrix + * @param[in, out] mat2x3 (src, dest) */ CGLM_INLINE void -glm_mat2x3_zero(mat2x3 mat) { +glm_mat2x3_zero(mat2x3 m) { CGLM_ALIGN_MAT mat2x3 t = GLM_MAT2X3_ZERO_INIT; - glm_mat2x3_copy(t, mat); + glm_mat2x3_copy(t, m); } /*! - * @brief Create mat2x3 matrix from pointer + * @brief Create mat2x3 (dest) from pointer (src). * - * @param[in] src pointer to an array of floats - * @param[out] dest matrix + * @param[in] src pointer to an array of floats (left) + * @param[out] dest destination (result, mat2x3) */ CGLM_INLINE void @@ -79,15 +74,15 @@ glm_mat2x3_make(const float * __restrict src, mat2x3 dest) { } /*! - * @brief multiply m1 and m2 to dest + * @brief Multiply mat2x3 (m1) by mat3x2 (m2) and store in mat3 (dest). * * @code * glm_mat2x3_mul(mat2x3, mat3x2, mat3); * @endcode * - * @param[in] m1 left matrix (mat2x3) - * @param[in] m2 right matrix (mat3x2) - * @param[out] dest destination matrix (mat2) + * @param[in] m1 mat2x3 (left) + * @param[in] m2 mat3x2 (right) + * @param[out] dest destination (result, mat3) */ CGLM_INLINE void @@ -113,11 +108,11 @@ glm_mat2x3_mul(mat2x3 m1, mat3x2 m2, mat3 dest) { } /*! - * @brief multiply matrix with column vector and store in dest vector + * @brief Multiply mat2x3 (m) by vec2 (v) and store in vec3 (dest). * - * @param[in] m matrix (left) - * @param[in] v vector (right, column vector) - * @param[out] dest result vector + * @param[in] m mat2x3 (left) + * @param[in] v vec2 (right, column vector) + * @param[out] dest destination (result, column vector) */ CGLM_INLINE void @@ -130,26 +125,24 @@ glm_mat2x3_mulv(mat2x3 m, vec2 v, vec3 dest) { } /*! - * @brief transpose matrix and store in dest + * @brief Transpose mat2x3 (src) and store in mat3x2 (dest). * - * @param[in] m matrix - * @param[out] dest result + * @param[in] src mat2x3 (left) + * @param[out] dest destination (result, mat3x2) */ CGLM_INLINE void -glm_mat2x3_transpose(mat2x3 m, mat3x2 dest) { - dest[0][0] = m[0][0]; dest[0][1] = m[1][0]; - dest[1][0] = m[0][1]; dest[1][1] = m[1][1]; - dest[2][0] = m[0][2]; dest[2][1] = m[1][2]; +glm_mat2x3_transpose(mat2x3 src, mat3x2 dest) { + dest[0][0] = src[0][0]; dest[0][1] = src[1][0]; + dest[1][0] = src[0][1]; dest[1][1] = src[1][1]; + dest[2][0] = src[0][2]; dest[2][1] = src[1][2]; } /*! - * @brief scale (multiply with scalar) matrix + * @brief Multiply mat2x3 (m) by scalar constant (s). * - * multiply matrix with scalar - * - * @param[in, out] m matrix - * @param[in] s scalar + * @param[in, out] m (src, dest) + * @param[in] float (scalar) */ CGLM_INLINE void diff --git a/include/cglm/struct/mat2x3.h b/include/cglm/struct/mat2x3.h index 3798893..5b061ba 100644 --- a/include/cglm/struct/mat2x3.h +++ b/include/cglm/struct/mat2x3.h @@ -35,87 +35,85 @@ #define GLMS_MAT2X3_ZERO ((mat2x3s)GLMS_MAT2X3_ZERO_INIT) /*! - * @brief make given matrix zero. + * @brief Zero out the mat2x3s (dest). * - * @param[in, out] mat matrix + * @return[out] dest constructed mat2x3s from raw pointer */ CGLM_INLINE mat2x3s glms_mat2x3_(zero)(void) { - mat2x3s r; - glm_mat2x3_zero(r.raw); - return r; + mat2x3s dest; + glm_mat2x3_zero(dest.raw); + return dest; } /*! - * @brief Create mat2x3 matrix from pointer + * @brief Create mat2x3s (dest) from pointer (src). * - * @param[in] src pointer to an array of floats - * @return constructed matrix from raw pointer + * @param[in] src pointer to an array of floats + * @return[out] dest constructed mat2x3s from raw pointer */ CGLM_INLINE mat2x3s glms_mat2x3_(make)(const float * __restrict src) { - mat2x3s r; - glm_mat2x3_make(src, r.raw); - return r; + mat2x3s dest; + glm_mat2x3_make(src, dest.raw); + return dest; } /*! - * @brief multiply m1 and m2 to dest + * @brief Multiply mat2x3s (m1) by mat3x2s (m2) and store in mat3s (dest). * * @code * r = glms_mat2x3_mul(mat2x3s, mat3x2s); * @endcode * - * @param[in] m1 left matrix (mat2x3s) - * @param[in] m2 right matrix (mat3x2s) - * @returns destination matrix (mat2s) + * @param[in] m1 mat2x3s (left) + * @param[in] m2 mat3x2s (right) + * @return[out] dest constructed mat3s from raw pointers */ CGLM_INLINE mat3s glms_mat2x3_(mul)(mat2x3s m1, mat3x2s m2) { - mat3s r; - glm_mat2x3_mul(m1.raw, m2.raw, r.raw); - return r; + mat3s dest; + glm_mat2x3_mul(m1.raw, m2.raw, dest.raw); + return dest; } /*! - * @brief multiply matrix with column vector and store in dest vector + * @brief Multiply mat2x3s (m) by vec2s (v) and store in vec3s (dest). * - * @param[in] m matrix (left) - * @param[in] v vector (right, column vector) - * @returns destination vector (vec3s) + * @param[in] m mat2x3s (left) + * @param[in] v vec2s (right, column vector) + * @return[out] dest constructed vec3s from raw pointers */ CGLM_INLINE vec3s glms_mat2x3_(mulv)(mat2x3s m, vec2s v) { - vec3s r; - glm_mat2x3_mulv(m.raw, v.raw, r.raw); - return r; + vec3s dest; + glm_mat2x3_mulv(m.raw, v.raw, dest.raw); + return dest; } /*! - * @brief transpose matrix and store in dest + * @brief Transpose mat2x3s (m) and store in mat3x2s (dest). * - * @param[in] m matrix - * @param[out] dest result + * @param[in] m mat2x3s (left) + * @return[out] dest constructed mat3x2s from raw pointers */ CGLM_INLINE mat3x2s glms_mat2x3_(transpose)(mat2x3s m) { - mat3x2s r; - glm_mat2x3_transpose(m.raw, r.raw); - return r; + mat3x2s dest; + glm_mat2x3_transpose(m.raw, dest.raw); + return dest; } /*! - * @brief scale (multiply with scalar) matrix + * @brief Multiply mat2x3s (m) by scalar constant (s). * - * multiply matrix with scalar - * - * @param[in, out] m matrix - * @param[in] s scalar + * @param[in, out] m mat2x3 (src, dest) + * @param[in] s float (scalar) */ CGLM_INLINE mat2x3s diff --git a/src/mat2x3.c b/src/mat2x3.c index 3397bf2..8f1aa72 100644 --- a/src/mat2x3.c +++ b/src/mat2x3.c @@ -10,14 +10,14 @@ CGLM_EXPORT void -glmc_mat2x3_copy(mat2x3 mat, mat2x3 dest) { - glm_mat2x3_copy(mat, dest); +glmc_mat2x3_copy(mat2x3 src, mat2x3 dest) { + glm_mat2x3_copy(src, dest); } CGLM_EXPORT void -glmc_mat2x3_zero(mat2x3 mat) { - glm_mat2x3_zero(mat); +glmc_mat2x3_zero(mat2x3 m) { + glm_mat2x3_zero(m); } CGLM_EXPORT @@ -40,8 +40,8 @@ glmc_mat2x3_mulv(mat2x3 m, vec2 v, vec3 dest) { CGLM_EXPORT void -glmc_mat2x3_transpose(mat2x3 m, mat3x2 dest) { - glm_mat2x3_transpose(m, dest); +glmc_mat2x3_transpose(mat2x3 src, mat3x2 dest) { + glm_mat2x3_transpose(src, dest); } CGLM_EXPORT