External/cglm
1
0
Fork 0
mirror of https://github.com/recp/cglm.git synced 2025-10-03 16:51:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix mat#x# comments and documentation

Browse Source 
Signed-off-by: Vincent Davis Jr <vince@underview.tech>
This commit is contained in:
Vincent Davis Jr
2023-07-16 15:31:38 -04:00
parent 8966f296ac
commit 82892085b3
13 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/mat2.rst
View File

@@ -183,7 +183,7 @@ Functions documentation
Create mat2 matrix from pointer Create mat2 matrix from pointer
| NOTE: **@src** must contain 4 elements. | NOTE: **@src** must contain at least 4 elements.
Parameters: Parameters:
| *[in]* **src** pointer to an array of floats | *[in]* **src** pointer to an array of floats

2
docs/source/mat2x3.rst
View File

@@ -11,7 +11,7 @@ Table of contents (click to go):
Macros: Macros:
1. GLM_MAT2X3_ZERO_INIT 1. GLM_MAT2X3_ZERO_INIT
#. GLM_MAT2x3_ZERO #. GLM_MAT2X3_ZERO
Functions: Functions:

2
docs/source/mat2x4.rst
View File

@@ -11,7 +11,7 @@ Table of contents (click to go):
Macros: Macros:
1. GLM_MAT2X4_ZERO_INIT 1. GLM_MAT2X4_ZERO_INIT
#. GLM_MAT2x4_ZERO #. GLM_MAT2X4_ZERO
Functions: Functions:

2
docs/source/mat3.rst
View File

@@ -193,7 +193,7 @@ Functions documentation
Create mat3 matrix from pointer Create mat3 matrix from pointer
| NOTE: **@src** must contain 9 elements. | NOTE: **@src** must contain at least 9 elements.
Parameters: Parameters:
| *[in]* **src** pointer to an array of floats | *[in]* **src** pointer to an array of floats

2
docs/source/mat3x2.rst
View File

@@ -11,7 +11,7 @@ Table of contents (click to go):
Macros: Macros:
1. GLM_MAT3X2_ZERO_INIT 1. GLM_MAT3X2_ZERO_INIT
#. GLM_MAT3x2_ZERO #. GLM_MAT3X2_ZERO
Functions: Functions:

2
docs/source/mat4.rst
View File

@@ -308,7 +308,7 @@ Functions documentation
Create mat4 matrix from pointer Create mat4 matrix from pointer
| NOTE: **@src** must contain 16 elements. | NOTE: **@src** must contain at least 16 elements.
Parameters: Parameters:
| *[in]* **src** pointer to an array of floats | *[in]* **src** pointer to an array of floats

6
include/cglm/struct/mat2.h
View File

@@ -27,7 +27,7 @@
CGLM_INLINE void glms_mat2_swap_col(mat2 mat, int col1, int col2) CGLM_INLINE void glms_mat2_swap_col(mat2 mat, int col1, int col2)
CGLM_INLINE void glms_mat2_swap_row(mat2 mat, int row1, int row2) CGLM_INLINE void glms_mat2_swap_row(mat2 mat, int row1, int row2)
CGLM_INLINE float glms_mat2_rmc(vec2 r, mat2 m, vec2 c) CGLM_INLINE float glms_mat2_rmc(vec2 r, mat2 m, vec2 c)
CGLM_INLINE float glms_mat42_make(float * __restrict src); CGLM_INLINE mat2s glms_mat2_make(float * __restrict src);
*/ */
#ifndef cglms_mat2_h #ifndef cglms_mat2_h
@@ -44,8 +44,8 @@
#define GLMS_MAT2_ZERO_INIT {GLM_MAT2_ZERO_INIT} #define GLMS_MAT2_ZERO_INIT {GLM_MAT2_ZERO_INIT}
/* for C only */ /* for C only */
#define GLMS_MAT2_IDENTITY ((mat3s)GLMS_MAT2_IDENTITY_INIT) #define GLMS_MAT2_IDENTITY ((mat2s)GLMS_MAT2_IDENTITY_INIT)
#define GLMS_MAT2_ZERO ((mat3s)GLMS_MAT2_ZERO_INIT) #define GLMS_MAT2_ZERO ((mat2s)GLMS_MAT2_ZERO_INIT)
/*! /*!
* @brief make given matrix identity. It is identical with below, * @brief make given matrix identity. It is identical with below,

2
include/cglm/struct/mat2x3.h
View File

@@ -11,7 +11,7 @@
GLMS_MAT2X3_ZERO GLMS_MAT2X3_ZERO
Functions: Functions:
CGLM_INLINE float glms_mat2x3_make(float * __restrict src); CGLM_INLINE mat2x3s glms_mat2x3_make(float * __restrict src);
*/ */
#ifndef cglms_mat2x3_h #ifndef cglms_mat2x3_h

2
include/cglm/struct/mat2x4.h
View File

@@ -11,7 +11,7 @@
GLMS_MAT2X4_ZERO GLMS_MAT2X4_ZERO
Functions: Functions:
CGLM_INLINE float glms_mat2x4_make(float * __restrict src); CGLM_INLINE mat2x4s glms_mat2x4_make(float * __restrict src);
*/ */
#ifndef cglms_mat2x4_h #ifndef cglms_mat2x4_h

2
include/cglm/struct/mat3.h
View File

@@ -28,7 +28,7 @@
CGLM_INLINE mat3s glms_mat3_swap_col(mat3s mat, int col1, int col2); CGLM_INLINE mat3s glms_mat3_swap_col(mat3s mat, int col1, int col2);
CGLM_INLINE mat3s glms_mat3_swap_row(mat3s mat, int row1, int row2); CGLM_INLINE mat3s glms_mat3_swap_row(mat3s mat, int row1, int row2);
CGLM_INLINE float glms_mat3_rmc(vec3s r, mat3s m, vec3s c); CGLM_INLINE float glms_mat3_rmc(vec3s r, mat3s m, vec3s c);
CGLM_INLINE float glms_mat3_make(float * __restrict src); CGLM_INLINE mat3s glms_mat3_make(float * __restrict src);
*/ */
#ifndef cglms_mat3s_h #ifndef cglms_mat3s_h

2
include/cglm/struct/mat4.h
View File

@@ -42,7 +42,7 @@
CGLM_INLINE mat4s glms_mat4_swap_col(mat4s mat, int col1, int col2); CGLM_INLINE mat4s glms_mat4_swap_col(mat4s mat, int col1, int col2);
CGLM_INLINE mat4s glms_mat4_swap_row(mat4s mat, int row1, int row2); CGLM_INLINE mat4s glms_mat4_swap_row(mat4s mat, int row1, int row2);
CGLM_INLINE float glms_mat4_rmc(vec4s r, mat4s m, vec4s c); CGLM_INLINE float glms_mat4_rmc(vec4s r, mat4s m, vec4s c);
CGLM_INLINE float glms_mat4_make(float * __restrict src); CGLM_INLINE mat4s glms_mat4_make(float * __restrict src);
*/ */
#ifndef cglms_mat4s_h #ifndef cglms_mat4s_h

6
include/cglm/types-struct.h
View File

@@ -199,7 +199,7 @@ typedef union mat2s {
typedef union mat2x3s { typedef union mat2x3s {
mat2x3 raw; mat2x3 raw;
vec3s col[2]; /* col -> row | [row (2), col (3)] */ vec3s col[2]; /* [col (2), row (3)] */
#if CGLM_USE_ANONYMOUS_STRUCT #if CGLM_USE_ANONYMOUS_STRUCT
struct { struct {
float m00, m01, m02; float m00, m01, m02;
@@ -210,7 +210,7 @@ typedef union mat2x3s {
typedef union mat2x4s { typedef union mat2x4s {
mat2x4 raw; mat2x4 raw;
vec4s col[2]; /* col -> row | [row (2), col (4)] */ vec4s col[2]; /* [col (2), row (4)] */
#if CGLM_USE_ANONYMOUS_STRUCT #if CGLM_USE_ANONYMOUS_STRUCT
struct { struct {
float m00, m01, m02, m03; float m00, m01, m02, m03;
@@ -233,7 +233,7 @@ typedef union mat3s {
typedef union mat3x2s { typedef union mat3x2s {
mat3x2 raw; mat3x2 raw;
vec2s col[3]; /* col -> row | [row (3), col (2)] */ vec2s col[3]; /* [col (3), row (2)] */
#if CGLM_USE_ANONYMOUS_STRUCT #if CGLM_USE_ANONYMOUS_STRUCT
struct { struct {
float m00, m01; float m00, m01;

6
include/cglm/types.h
View File

@@ -55,10 +55,10 @@ typedef float vec3[3];
typedef CGLM_ALIGN_IF(16) float vec4[4]; typedef CGLM_ALIGN_IF(16) float vec4[4];
typedef vec4 versor; /* |x, y, z, w| -> w is the last */ typedef vec4 versor; /* |x, y, z, w| -> w is the last */
typedef vec3 mat3[3]; typedef vec3 mat3[3];
typedef vec2 mat3x2[3]; /* [row (3), col (2)] */ typedef vec2 mat3x2[3]; /* [col (3), row (2)] */
typedef CGLM_ALIGN_IF(16) vec2 mat2[2]; typedef CGLM_ALIGN_IF(16) vec2 mat2[2];
typedef vec3 mat2x3[2]; /* [row (2), col (3)] */ typedef vec3 mat2x3[2]; /* [col (2), row (3)] */
typedef vec4 mat2x4[2]; /* [row (2), col (4)] */ typedef vec4 mat2x4[2]; /* [col (2), row (4)] */
typedef CGLM_ALIGN_MAT vec4 mat4[4]; typedef CGLM_ALIGN_MAT vec4 mat4[4];
/* /*