YourWishes/cglm
1
0
Fork 0
mirror of https://github.com/recp/cglm.git synced 2026-02-17 03:39:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

mat3x2: add tables to docs & fix comments

Browse Source 
Signed-off-by: Vincent Davis Jr <vince@underview.tech>
This commit is contained in:
Vincent Davis Jr
2025-04-03 00:20:39 -04:00
parent f3094cdc65
commit b64067a94d
5 changed files with 168 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
include/cglm/struct/mat3x2.h
View File

@@ -35,87 +35,85 @@
#define GLMS_MAT3X2_ZERO ((mat3x2s)GLMS_MAT3X2_ZERO_INIT)
/*!
* @brief make given matrix zero.
* @brief Zero out the mat3x2s (dest).
*
* @param[in, out] mat matrix
* @return[out] dest constructed mat3x2s from raw pointer
*/
CGLM_INLINE
mat3x2s
glms_mat3x2_(zero)(void) {
mat3x2s r;
glm_mat3x2_zero(r.raw);
return r;
mat3x2s dest;
glm_mat3x2_zero(dest.raw);
return dest;
}
/*!
* @brief Create mat3x2 matrix from pointer
* @brief Create mat3x2s (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 mat3x2s from raw pointer
*/
CGLM_INLINE
mat3x2s
glms_mat3x2_(make)(const float * __restrict src) {
mat3x2s r;
glm_mat3x2_make(src, r.raw);
return r;
mat3x2s dest;
glm_mat3x2_make(src, dest.raw);
return dest;
}
/*!
* @brief multiply m1 and m2 to dest
* @brief Multiply mat3x2s (m1) by mat2x3s (m2) and store in mat2s (dest).
*
* @code
* r = glms_mat3x2_mul(mat3x2s, mat2x3s);
* @endcode
*
* @param[in] m1 left matrix (mat3x2s)
* @param[in] m2 right matrix (mat2x3s)
* @returns destination matrix (mat3s)
* @param[in] m1 mat3x2s (left)
* @param[in] m2 mat2x3s (right)
* @return[out] dest constructed mat2s from raw pointers
*/
CGLM_INLINE
mat2s
glms_mat3x2_(mul)(mat3x2s m1, mat2x3s m2) {
mat2s r;
glm_mat3x2_mul(m1.raw, m2.raw, r.raw);
return r;
mat2s dest;
glm_mat3x2_mul(m1.raw, m2.raw, dest.raw);
return dest;
}
/*!
* @brief multiply matrix with column vector and store in dest vector
* @brief Multiply mat3x2s (m) by vec3s (v) and store in vec2s (dest).
*
* @param[in] m matrix (left)
* @param[in] v vector (right, column vector)
* @param[out] dest result vector
* @param[in] m mat3x2s (left)
* @param[in] v vec3s (right, column vector)
* @return[out] dest constructed vec2s from raw pointers
*/
CGLM_INLINE
vec2s
glms_mat3x2_(mulv)(mat3x2s m, vec3s v) {
vec2s r;
glm_mat3x2_mulv(m.raw, v.raw, r.raw);
return r;
vec2s dest;
glm_mat3x2_mulv(m.raw, v.raw, dest.raw);
return dest;
}
/*!
* @brief transpose matrix and store in dest
* @brief Transpose mat3x2s (m) and store in mat2x3s (dest).
*
* @param[in] m matrix
* @param[out] dest result
* @param[in] m mat3x2s (left)
* @return[out] dest constructed mat2x3s from raw pointers
*/
CGLM_INLINE
mat2x3s
glms_mat3x2_(transpose)(mat3x2s m) {
mat2x3s r;
glm_mat3x2_transpose(m.raw, r.raw);
return r;
mat2x3s dest;
glm_mat3x2_transpose(m.raw, dest.raw);
return dest;
}
/*!
* @brief scale (multiply with scalar) matrix
* @brief Multiply mat3x2s (m) by scalar constant (s).
*
* multiply matrix with scalar
*
* @param[in, out] m matrix
* @param[in] s scalar
* @param[in, out] m mat3x2s (src, dest)
* @param[in] s float (scalar)
*/
CGLM_INLINE
mat3x2s