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

Fix typos.

Browse Source
This commit is contained in:
Bruce Mitchener
2024-02-08 15:12:30 +07:00
parent a8685ed6ab
commit e4419c4f18
66 changed files with 261 additions and 263 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/cglm/aabb2d.h
View File

@@ -108,7 +108,7 @@ glm_aabb2d_crop(vec2 aabb[2], vec2 cropAabb[2], vec2 dest[2]) {
*
* @param[in] aabb bounding aabb
* @param[in] cropAabb crop aabb
* @param[in] clampAabb miniumum aabb
* @param[in] clampAabb minimum aabb
* @param[out] dest cropped bounding aabb
*/
CGLM_INLINE

44
include/cglm/affine-post.h
View File

@@ -34,9 +34,9 @@
* @brief translate existing transform matrix by v vector
* and stores result in same matrix
*
* this is POST transform, applies to existing transform as last transfrom
* this is POST transform, applies to existing transform as last transform
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] v translate vector [x, y, z]
*/
CGLM_INLINE
@@ -51,9 +51,9 @@ glm_translated(mat4 m, vec3 v) {
*
* source matrix will remain same
*
* this is POST transform, applies to existing transform as last transfrom
* this is POST transform, applies to existing transform as last transform
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] v translate vector [x, y, z]
* @param[out] dest translated matrix
*/
@@ -67,9 +67,9 @@ glm_translated_to(mat4 m, vec3 v, mat4 dest) {
/*!
* @brief translate existing transform matrix by x factor
*
* this is POST transform, applies to existing transform as last transfrom
* this is POST transform, applies to existing transform as last transform
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] x x factor
*/
CGLM_INLINE
@@ -81,9 +81,9 @@ glm_translated_x(mat4 m, float x) {
/*!
* @brief translate existing transform matrix by y factor
*
* this is POST transform, applies to existing transform as last transfrom
* this is POST transform, applies to existing transform as last transform
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] y y factor
*/
CGLM_INLINE
@@ -95,9 +95,9 @@ glm_translated_y(mat4 m, float y) {
/*!
* @brief translate existing transform matrix by z factor
*
* this is POST transform, applies to existing transform as last transfrom
* this is POST transform, applies to existing transform as last transform
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] z z factor
*/
CGLM_INLINE
@@ -110,9 +110,9 @@ glm_translated_z(mat4 m, float z) {
* @brief rotate existing transform matrix around X axis by angle
* and store result in dest
*
* this is POST transform, applies to existing transform as last transfrom
* this is POST transform, applies to existing transform as last transform
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @param[out] dest rotated matrix
*/
@@ -137,9 +137,9 @@ glm_rotated_x(mat4 m, float angle, mat4 dest) {
* @brief rotate existing transform matrix around Y axis by angle
* and store result in dest
*
* this is POST transform, applies to existing transform as last transfrom
* this is POST transform, applies to existing transform as last transform
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @param[out] dest rotated matrix
*/
@@ -164,9 +164,9 @@ glm_rotated_y(mat4 m, float angle, mat4 dest) {
* @brief rotate existing transform matrix around Z axis by angle
* and store result in dest
*
* this is POST transform, applies to existing transform as last transfrom
* this is POST transform, applies to existing transform as last transform
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @param[out] dest rotated matrix
*/
@@ -190,9 +190,9 @@ glm_rotated_z(mat4 m, float angle, mat4 dest) {
/*!
* @brief rotate existing transform matrix around given axis by angle
*
* this is POST transform, applies to existing transform as last transfrom
* this is POST transform, applies to existing transform as last transform
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] angle angle (radians)
* @param[in] axis axis
*/
@@ -208,9 +208,9 @@ glm_rotated(mat4 m, float angle, vec3 axis) {
* @brief rotate existing transform
* around given axis by angle at given pivot point (rotation center)
*
* this is POST transform, applies to existing transform as last transfrom
* this is POST transform, applies to existing transform as last transform
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] pivot rotation center
* @param[in] angle angle (radians)
* @param[in] axis axis
@@ -230,9 +230,9 @@ glm_rotated_at(mat4 m, vec3 pivot, float angle, vec3 axis) {
/*!
* @brief rotate existing transform matrix around given axis by angle around self (doesn't affected by position)
*
* this is POST transform, applies to existing transform as last transfrom
* this is POST transform, applies to existing transform as last transform
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] angle angle (radians)
* @param[in] axis axis
*/

24
include/cglm/affine-pre.h
View File

@@ -35,7 +35,7 @@
* @brief translate existing transform matrix by v vector
* and stores result in same matrix
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] v translate vector [x, y, z]
*/
CGLM_INLINE
@@ -66,7 +66,7 @@ glm_translate(mat4 m, vec3 v) {
*
* source matrix will remain same
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] v translate vector [x, y, z]
* @param[out] dest translated matrix
*/
@@ -80,7 +80,7 @@ glm_translate_to(mat4 m, vec3 v, mat4 dest) {
/*!
* @brief translate existing transform matrix by x factor
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] x x factor
*/
CGLM_INLINE
@@ -98,7 +98,7 @@ glm_translate_x(mat4 m, float x) {
/*!
* @brief translate existing transform matrix by y factor
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] y y factor
*/
CGLM_INLINE
@@ -116,7 +116,7 @@ glm_translate_y(mat4 m, float y) {
/*!
* @brief translate existing transform matrix by z factor
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] z z factor
*/
CGLM_INLINE
@@ -135,7 +135,7 @@ glm_translate_z(mat4 m, float z) {
* @brief rotate existing transform matrix around X axis by angle
* and store result in dest
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @param[out] dest rotated matrix
*/
@@ -160,7 +160,7 @@ glm_rotate_x(mat4 m, float angle, mat4 dest) {
* @brief rotate existing transform matrix around Y axis by angle
* and store result in dest
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @param[out] dest rotated matrix
*/
@@ -185,7 +185,7 @@ glm_rotate_y(mat4 m, float angle, mat4 dest) {
* @brief rotate existing transform matrix around Z axis by angle
* and store result in dest
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @param[out] dest rotated matrix
*/
@@ -209,7 +209,7 @@ glm_rotate_z(mat4 m, float angle, mat4 dest) {
/*!
* @brief rotate existing transform matrix around given axis by angle
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] angle angle (radians)
* @param[in] axis axis
*/
@@ -225,7 +225,7 @@ glm_rotate(mat4 m, float angle, vec3 axis) {
* @brief rotate existing transform
* around given axis by angle at given pivot point (rotation center)
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] pivot rotation center
* @param[in] angle angle (radians)
* @param[in] axis axis
@@ -250,7 +250,7 @@ glm_rotate_at(mat4 m, vec3 pivot, float angle, vec3 axis) {
* this should work faster than glm_rotate_at because it reduces
* one glm_translate.
*
* @param[out] m affine transfrom
* @param[out] m affine transform
* @param[in] pivot rotation center
* @param[in] angle angle (radians)
* @param[in] axis axis
@@ -270,7 +270,7 @@ glm_rotate_atm(mat4 m, vec3 pivot, float angle, vec3 axis) {
/*!
* @brief rotate existing transform matrix around given axis by angle around self (doesn't affected by position)
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] angle angle (radians)
* @param[in] axis axis
*/

14
include/cglm/affine.h
View File

@@ -44,7 +44,7 @@
/*!
* @brief creates NEW translate transform matrix by v vector
*
* @param[out] m affine transfrom
* @param[out] m affine transform
* @param[in] v translate vector [x, y, z]
*/
CGLM_INLINE
@@ -58,7 +58,7 @@ glm_translate_make(mat4 m, vec3 v) {
* @brief scale existing transform matrix by v vector
* and store result in dest
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] v scale vector [x, y, z]
* @param[out] dest scaled matrix
*/
@@ -75,7 +75,7 @@ glm_scale_to(mat4 m, vec3 v, mat4 dest) {
/*!
* @brief creates NEW scale matrix by v vector
*
* @param[out] m affine transfrom
* @param[out] m affine transform
* @param[in] v scale vector [x, y, z]
*/
CGLM_INLINE
@@ -91,7 +91,7 @@ glm_scale_make(mat4 m, vec3 v) {
* @brief scales existing transform matrix by v vector
* and stores result in same matrix
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] v scale vector [x, y, z]
*/
CGLM_INLINE
@@ -104,7 +104,7 @@ glm_scale(mat4 m, vec3 v) {
* @brief applies uniform scale to existing transform matrix v = [s, s, s]
* and stores result in same matrix
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] s scale factor
*/
CGLM_INLINE
@@ -119,7 +119,7 @@ glm_scale_uni(mat4 m, float s) {
*
* axis will be normalized so you don't need to normalize it
*
* @param[out] m affine transfrom
* @param[out] m affine transform
* @param[in] angle angle (radians)
* @param[in] axis axis
*/
@@ -220,7 +220,7 @@ glm_decompose_rs(mat4 m, mat4 r, vec3 s) {
* @brief decompose affine transform, TODO: extract shear factors.
* DON'T pass projected matrix here
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[out] t translation vector
* @param[out] r rotation matrix (mat4)
* @param[out] s scaling vector [X, Y, Z]

24
include/cglm/affine2d.h
View File

@@ -33,7 +33,7 @@
* @brief translate existing 2d transform matrix by v vector
* and stores result in same matrix
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] v translate vector [x, y]
*/
CGLM_INLINE
@@ -50,7 +50,7 @@ glm_translate2d(mat3 m, vec2 v) {
*
* source matrix will remain same
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] v translate vector [x, y]
* @param[out] dest translated matrix
*/
@@ -64,7 +64,7 @@ glm_translate2d_to(mat3 m, vec2 v, mat3 dest) {
/*!
* @brief translate existing 2d transform matrix by x factor
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] x x factor
*/
CGLM_INLINE
@@ -78,7 +78,7 @@ glm_translate2d_x(mat3 m, float x) {
/*!
* @brief translate existing 2d transform matrix by y factor
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] y y factor
*/
CGLM_INLINE
@@ -92,7 +92,7 @@ glm_translate2d_y(mat3 m, float y) {
/*!
* @brief creates NEW translate 2d transform matrix by v vector
*
* @param[out] m affine transfrom
* @param[out] m affine transform
* @param[in] v translate vector [x, y]
*/
CGLM_INLINE
@@ -107,7 +107,7 @@ glm_translate2d_make(mat3 m, vec2 v) {
* @brief scale existing 2d transform matrix by v vector
* and store result in dest
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] v scale vector [x, y]
* @param[out] dest scaled matrix
*/
@@ -130,7 +130,7 @@ glm_scale2d_to(mat3 m, vec2 v, mat3 dest) {
/*!
* @brief creates NEW 2d scale matrix by v vector
*
* @param[out] m affine transfrom
* @param[out] m affine transform
* @param[in] v scale vector [x, y]
*/
CGLM_INLINE
@@ -145,7 +145,7 @@ glm_scale2d_make(mat3 m, vec2 v) {
* @brief scales existing 2d transform matrix by v vector
* and stores result in same matrix
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] v scale vector [x, y]
*/
CGLM_INLINE
@@ -164,7 +164,7 @@ glm_scale2d(mat3 m, vec2 v) {
* @brief applies uniform scale to existing 2d transform matrix v = [s, s]
* and stores result in same matrix
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] s scale factor
*/
CGLM_INLINE
@@ -182,7 +182,7 @@ glm_scale2d_uni(mat3 m, float s) {
/*!
* @brief creates NEW rotation matrix by angle around Z axis
*
* @param[out] m affine transfrom
* @param[out] m affine transform
* @param[in] angle angle (radians)
*/
CGLM_INLINE
@@ -210,7 +210,7 @@ glm_rotate2d_make(mat3 m, float angle) {
* @brief rotate existing 2d transform matrix around Z axis by angle
* and store result in same matrix
*
* @param[in, out] m affine transfrom
* @param[in, out] m affine transform
* @param[in] angle angle (radians)
*/
CGLM_INLINE
@@ -237,7 +237,7 @@ glm_rotate2d(mat3 m, float angle) {
* @brief rotate existing 2d transform matrix around Z axis by angle
* and store result in dest
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @param[out] dest destination
*/

2
include/cglm/box.h
View File

@@ -104,7 +104,7 @@ glm_aabb_crop(vec3 box[2], vec3 cropBox[2], vec3 dest[2]) {
*
* @param[in] box bounding box
* @param[in] cropBox crop box
* @param[in] clampBox miniumum box
* @param[in] clampBox minimum box
* @param[out] dest cropped bounding box
*/
CGLM_INLINE

2
include/cglm/cam.h
View File

@@ -474,7 +474,7 @@ glm_persp_decomp_x(mat4 proj,
/*!
* @brief decomposes top and bottom values of perspective projection.
* y stands for y axis (top / botom axis)
* y stands for y axis (top / bottom axis)
*
* @param[in] proj perspective projection matrix
* @param[out] top top

2
include/cglm/clipspace/persp_lh_no.h
View File

@@ -266,7 +266,7 @@ glm_persp_decomp_x_lh_no(mat4 proj,
* @brief decomposes top and bottom values of perspective projection
* with a left-hand coordinate system and a
* clip-space of [-1, 1].
* y stands for y axis (top / botom axis)
* y stands for y axis (top / bottom axis)
*
* @param[in] proj perspective projection matrix
* @param[out] top top

2
include/cglm/clipspace/persp_rh_no.h
View File

@@ -266,7 +266,7 @@ glm_persp_decomp_x_rh_no(mat4 proj,
* @brief decomposes top and bottom values of perspective projection
* with a right-hand coordinate system and a
* clip-space of [-1, 1].
* y stands for y axis (top / botom axis)
* y stands for y axis (top / bottom axis)
*
* @param[in] proj perspective projection matrix
* @param[out] top top

2
include/cglm/euler.h
View File

@@ -9,7 +9,7 @@
NOTE:
angles must be passed as [X-Angle, Y-Angle, Z-angle] order
For instance you don't pass angles as [Z-Angle, X-Angle, Y-angle] to
glm_euler_zxy funciton, All RELATED functions accept angles same order
glm_euler_zxy function, All RELATED functions accept angles same order
which is [X, Y, Z].
*/

2
include/cglm/ivec2.h
View File

@@ -204,7 +204,7 @@ glm_ivec2_subs(ivec2 v, int s, ivec2 dest) {
/*!
* @brief multiply vector [a] with vector [b] and store result in [dest]
*
* @param[in] a frist vector
* @param[in] a first vector
* @param[in] b second vector
* @param[out] dest destination
*/

4
include/cglm/ivec3.h
View File

@@ -136,7 +136,7 @@ glm_ivec3_dot(ivec3 a, ivec3 b) {
* @brief norm * norm (magnitude) of vec
*
* we can use this func instead of calling norm * norm, because it would call
* sqrtf fuction twice but with this func we can avoid func call, maybe this is
* sqrtf function twice but with this func we can avoid func call, maybe this is
* not good name for this func
*
* @param[in] v vector
@@ -226,7 +226,7 @@ glm_ivec3_subs(ivec3 v, int s, ivec3 dest) {
/*!
* @brief multiply vector [a] with vector [b] and store result in [dest]
*
* @param[in] a frist vector
* @param[in] a first vector
* @param[in] b second vector
* @param[out] dest destination
*/

2
include/cglm/ivec4.h
View File

@@ -179,7 +179,7 @@ glm_ivec4_subs(ivec4 v, int s, ivec4 dest) {
/*!
* @brief multiply vector [a] with vector [b] and store result in [dest]
*
* @param[in] a frist vector
* @param[in] a first vector
* @param[in] b second vector
* @param[out] dest destination
*/

2
include/cglm/mat2.h
View File

@@ -180,7 +180,7 @@ glm_mat2_transpose_to(mat2 m, mat2 dest) {
}
/*!
* @brief tranpose mat2 and store result in same matrix
* @brief transpose mat2 and store result in same matrix
*
* @param[in, out] m source and dest
*/

2
include/cglm/mat3.h
View File

@@ -201,7 +201,7 @@ glm_mat3_transpose_to(mat3 m, mat3 dest) {
}
/*!
* @brief tranpose mat3 and store result in same matrix
* @brief transpose mat3 and store result in same matrix
*
* @param[in, out] m source and dest
*/

2
include/cglm/mat4.h
View File

@@ -537,7 +537,7 @@ glm_mat4_transpose_to(mat4 m, mat4 dest) {
}
/*!
* @brief tranpose mat4 and store result in same matrix
* @brief transpose mat4 and store result in same matrix
*
* @param[in, out] m source and dest
*/

2
include/cglm/quat.h
View File

@@ -703,7 +703,7 @@ glm_quat_nlerp(versor from, versor to, float t, versor dest) {
*
* @param[in] from from
* @param[in] to to
* @param[in] t amout
* @param[in] t amount
* @param[out] dest result quaternion
*/
CGLM_INLINE

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

@@ -92,7 +92,7 @@ glms_aabb2d_(crop)(vec2s aabb[2], vec2s cropAabb[2], vec2s dest[2]) {
*
* @param[in] aabb bounding box
* @param[in] cropAabb crop box
* @param[in] clampAabb miniumum box
* @param[in] clampAabb minimum box
* @param[out] dest cropped bounding box
*/
CGLM_INLINE

34
include/cglm/struct/affine-post.h
View File

@@ -33,9 +33,9 @@
* @brief translate existing transform matrix by v vector
* and stores result in same matrix
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] v translate vector [x, y, z]
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -47,9 +47,9 @@ glms_translated(mat4s m, vec3s v) {
/*!
* @brief translate existing transform matrix by x factor
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] x x factor
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -61,9 +61,9 @@ glms_translated_x(mat4s m, float x) {
/*!
* @brief translate existing transform matrix by y factor
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] y y factor
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -75,9 +75,9 @@ glms_translated_y(mat4s m, float y) {
/*!
* @brief translate existing transform matrix by z factor
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] z z factor
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -90,7 +90,7 @@ glms_translated_z(mat4s m, float z) {
* @brief rotate existing transform matrix around X axis by angle
* and store result in dest
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @returns rotated matrix
*/
@@ -106,7 +106,7 @@ glms_rotated_x(mat4s m, float angle) {
* @brief rotate existing transform matrix around Y axis by angle
* and store result in dest
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @returns rotated matrix
*/
@@ -122,7 +122,7 @@ glms_rotated_y(mat4s m, float angle) {
* @brief rotate existing transform matrix around Z axis by angle
* and store result in dest
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @returns rotated matrix
*/
@@ -137,10 +137,10 @@ glms_rotated_z(mat4s m, float angle) {
/*!
* @brief rotate existing transform matrix around given axis by angle
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @param[in] axis axis
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -153,11 +153,11 @@ glms_rotated(mat4s m, float angle, vec3s axis) {
* @brief rotate existing transform
* around given axis by angle at given pivot point (rotation center)
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] pivot rotation center
* @param[in] angle angle (radians)
* @param[in] axis axis
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -169,10 +169,10 @@ glms_rotated_at(mat4s m, vec3s pivot, float angle, vec3s axis) {
/*!
* @brief rotate existing transform matrix around given axis by angle around self (doesn't affected by position)
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @param[in] axis axis
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s

34
include/cglm/struct/affine-pre.h
View File

@@ -33,9 +33,9 @@
* @brief translate existing transform matrix by v vector
* and stores result in same matrix
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] v translate vector [x, y, z]
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -47,9 +47,9 @@ glms_translate(mat4s m, vec3s v) {
/*!
* @brief translate existing transform matrix by x factor
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] x x factor
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -61,9 +61,9 @@ glms_translate_x(mat4s m, float x) {
/*!
* @brief translate existing transform matrix by y factor
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] y y factor
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -75,9 +75,9 @@ glms_translate_y(mat4s m, float y) {
/*!
* @brief translate existing transform matrix by z factor
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] z z factor
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -90,7 +90,7 @@ glms_translate_z(mat4s m, float z) {
* @brief rotate existing transform matrix around X axis by angle
* and store result in dest
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @returns rotated matrix
*/
@@ -106,7 +106,7 @@ glms_rotate_x(mat4s m, float angle) {
* @brief rotate existing transform matrix around Y axis by angle
* and store result in dest
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @returns rotated matrix
*/
@@ -122,7 +122,7 @@ glms_rotate_y(mat4s m, float angle) {
* @brief rotate existing transform matrix around Z axis by angle
* and store result in dest
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @returns rotated matrix
*/
@@ -137,10 +137,10 @@ glms_rotate_z(mat4s m, float angle) {
/*!
* @brief rotate existing transform matrix around given axis by angle
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @param[in] axis axis
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -153,11 +153,11 @@ glms_rotate(mat4s m, float angle, vec3s axis) {
* @brief rotate existing transform
* around given axis by angle at given pivot point (rotation center)
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] pivot rotation center
* @param[in] angle angle (radians)
* @param[in] axis axis
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -169,10 +169,10 @@ glms_rotate_at(mat4s m, vec3s pivot, float angle, vec3s axis) {
/*!
* @brief rotate existing transform matrix around given axis by angle around self (doesn't affected by position)
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @param[in] axis axis
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s

18
include/cglm/struct/affine.h
View File

@@ -45,7 +45,7 @@
* @brief creates NEW translate transform matrix by v vector
*
* @param[in] v translate vector [x, y, z]
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -59,7 +59,7 @@ glms_translate_make(vec3s v) {
* @brief creates NEW scale matrix by v vector
*
* @param[in] v scale vector [x, y, z]
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -73,9 +73,9 @@ glms_scale_make(vec3s v) {
* @brief scales existing transform matrix by v vector
* and stores result in same matrix
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] v scale vector [x, y, z]
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -89,9 +89,9 @@ glms_scale(mat4s m, vec3s v) {
* @brief applies uniform scale to existing transform matrix v = [s, s, s]
* and stores result in same matrix
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] s scale factor
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -107,7 +107,7 @@ glms_scale_uni(mat4s m, float s) {
*
* @param[in] angle angle (radians)
* @param[in] axis axis
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -128,7 +128,7 @@ glms_rotate_make(float angle, vec3s axis) {
* @param[in] pivot rotation center
* @param[in] angle angle (radians)
* @param[in] axis axis
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat4s
@@ -184,7 +184,7 @@ glms_decompose_rs(mat4s m, mat4s * __restrict r, vec3s * __restrict s) {
* @brief decompose affine transform, TODO: extract shear factors.
* DON'T pass projected matrix here
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[out] t translation vector
* @param[out] r rotation matrix (mat4)
* @param[out] s scaling vector [X, Y, Z]

34
include/cglm/struct/affine2d.h
View File

@@ -32,9 +32,9 @@
* @brief translate existing 2d transform matrix by v vector
* and stores result in same matrix
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] v translate vector [x, y]
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat3s
@@ -46,9 +46,9 @@ glms_translate2d(mat3s m, vec2s v) {
/*!
* @brief translate existing 2d transform matrix by x factor
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] x x factor
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat3s
@@ -60,9 +60,9 @@ glms_translate2d_x(mat3s m, float x) {
/*!
* @brief translate existing 2d transform matrix by y factor
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] y y factor
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat3s
@@ -75,7 +75,7 @@ glms_translate2d_y(mat3s m, float y) {
* @brief creates NEW translate 2d transform matrix by v vector
*
* @param[in] v translate vector [x, y]
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat3s
@@ -89,7 +89,7 @@ glms_translate2d_make(vec2s v) {
* @brief creates NEW 2d scale matrix by v vector
*
* @param[in] v scale vector [x, y]
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat3s
@@ -103,9 +103,9 @@ glms_scale2d_make(vec2s v) {
* @brief scales existing 2d transform matrix by v vector
* and stores result in same matrix
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] v scale vector [x, y, z]
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat3s
@@ -119,9 +119,9 @@ glms_scale2d(mat3s m, vec2s v) {
* @brief applies uniform scale to existing 2d transform matrix v = [s, s, s]
* and stores result in same matrix
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] s scale factor
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat3s
@@ -136,7 +136,7 @@ glms_scale2d_uni(mat3s m, float s) {
* axis will be normalized so you don't need to normalize it
*
* @param[in] angle angle (radians)
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat3s
@@ -149,9 +149,9 @@ glms_rotate2d_make(float angle) {
/*!
* @brief rotate existing 2d transform matrix around given axis by angle
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat3s
@@ -163,9 +163,9 @@ glms_rotate2d(mat3s m, float angle) {
/*!
* @brief rotate existing 2d transform matrix around given axis by angle
*
* @param[in] m affine transfrom
* @param[in] m affine transform
* @param[in] angle angle (radians)
* @returns affine transfrom
* @returns affine transform
*/
CGLM_INLINE
mat3s

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

@@ -92,7 +92,7 @@ glms_aabb_(crop)(vec3s box[2], vec3s cropBox[2], vec3s dest[2]) {
*
* @param[in] box bounding box
* @param[in] cropBox crop box
* @param[in] clampBox miniumum box
* @param[in] clampBox minimum box
* @param[out] dest cropped bounding box
*/
CGLM_INLINE

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

@@ -495,7 +495,7 @@ glms_persp_decomp_x(mat4s proj,
/*!
* @brief decomposes top and bottom values of perspective projection.
* y stands for y axis (top / botom axis)
* y stands for y axis (top / bottom axis)
*
* @param[in] proj perspective projection matrix
* @param[out] top top

2
include/cglm/struct/clipspace/persp_lh_no.h
View File

@@ -203,7 +203,7 @@ glms_persp_decomp_x_lh_no(mat4s proj,
* @brief decomposes top and bottom values of perspective projection
* with a left-hand coordinate system and a
* clip-space of [-1, 1].
* y stands for y axis (top / botom axis)
* y stands for y axis (top / bottom axis)
*
* @param[in] proj perspective projection matrix
* @param[out] top top

2
include/cglm/struct/clipspace/persp_lh_zo.h
View File

@@ -203,7 +203,7 @@ glms_persp_decomp_x_lh_zo(mat4s proj,
* @brief decomposes top and bottom values of perspective projection
* with a left-hand coordinate system and a
* clip-space of [0, 1].
* y stands for y axis (top / botom axis)
* y stands for y axis (top / bottom axis)
*
* @param[in] proj perspective projection matrix
* @param[out] top top

2
include/cglm/struct/clipspace/persp_rh_no.h
View File

@@ -203,7 +203,7 @@ glms_persp_decomp_x_rh_no(mat4s proj,
* @brief decomposes top and bottom values of perspective projection
* with a right-hand coordinate system and a
* clip-space of [-1, 1].
* y stands for y axis (top / botom axis)
* y stands for y axis (top / bottom axis)
*
* @param[in] proj perspective projection matrix
* @param[out] top top

2
include/cglm/struct/clipspace/persp_rh_zo.h
View File

@@ -203,7 +203,7 @@ glms_persp_decomp_x_rh_zo(mat4s proj,
* @brief decomposes top and bottom values of perspective projection
* with a right-hand coordinate system and a
* clip-space of [0, 1].
* y stands for y axis (top / botom axis)
* y stands for y axis (top / bottom axis)
*
* @param[in] proj perspective projection matrix
* @param[out] top top

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

@@ -9,7 +9,7 @@
NOTE:
angles must be passed as [X-Angle, Y-Angle, Z-angle] order
For instance you don't pass angles as [Z-Angle, X-Angle, Y-angle] to
glm_euler_zxy funciton, All RELATED functions accept angles same order
glm_euler_zxy function, All RELATED functions accept angles same order
which is [X, Y, Z].
*/

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

@@ -140,7 +140,7 @@ glms_mat3_(mul)(mat3s m1, mat3s m2) {
}
/*!
* @brief tranpose mat3 and store result in same matrix
* @brief transpose mat3 and store result in same matrix
*
* @param[in, out] m source and dest
*/

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

@@ -107,7 +107,7 @@ glms_mat4_(copy)(mat4s mat) {
* mat4 mat = GLM_MAT4_IDENTITY_INIT;
* @endcode
*
* @retuns destination
* @returns destination
*/
CGLM_INLINE
mat4s
@@ -319,7 +319,7 @@ glms_mat4_(mulv3)(mat4s m, vec3s v, float last) {
}
/*!
* @brief tranpose mat4 and store result in same matrix
* @brief transpose mat4 and store result in same matrix
*
* @param[in] m source
* @returns result

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

@@ -446,7 +446,7 @@ glms_quat_(nlerp)(versors from, versors to, float t) {
*
* @param[in] from from
* @param[in] to to
* @param[in] t amout
* @param[in] t amount
* @returns result quaternion
*/
CGLM_INLINE

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

@@ -179,7 +179,7 @@ glms_vec2_(cross)(vec2s a, vec2s b) {
* @brief norm * norm (magnitude) of vec
*
* we can use this func instead of calling norm * norm, because it would call
* sqrtf fuction twice but with this func we can avoid func call, maybe this is
* sqrtf function twice but with this func we can avoid func call, maybe this is
* not good name for this func
*
* @param[in] v vector

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

@@ -194,7 +194,7 @@ glms_vec3_(dot)(vec3s a, vec3s b) {
* @brief norm * norm (magnitude) of vec
*
* we can use this func instead of calling norm * norm, because it would call
* sqrtf fuction twice but with this func we can avoid func call, maybe this is
* sqrtf function twice but with this func we can avoid func call, maybe this is
* not good name for this func
*
* @param[in] v vector
@@ -656,7 +656,7 @@ glms_vec3_(crossn)(vec3s a, vec3s b) {
}
/*!
* @brief angle betwen two vector
* @brief angle between two vector
*
* @param[in] a vector1
* @param[in] b vector2
@@ -1055,7 +1055,7 @@ glms_normalize(vec3s v) {
/*!
* @brief swizzle vector components
*
* you can use existin masks e.g. GLM_XXX, GLM_ZYX
* you can use existing masks e.g. GLM_XXX, GLM_ZYX
*
* @param[in] v source
* @param[in] mask mask

4
include/cglm/struct/vec4.h
View File

@@ -223,7 +223,7 @@ glms_vec4_(dot)(vec4s a, vec4s b) {
* @brief norm * norm (magnitude) of vec
*
* we can use this func instead of calling norm * norm, because it would call
* sqrtf fuction twice but with this func we can avoid func call, maybe this is
* sqrtf function twice but with this func we can avoid func call, maybe this is
* not good name for this func
*
* @param[in] v vec4
@@ -899,7 +899,7 @@ glms_vec4_(cubic)(float s) {
/*!
* @brief swizzle vector components
*
* you can use existin masks e.g. GLM_XXXX, GLM_WZYX
* you can use existing masks e.g. GLM_XXXX, GLM_WZYX
*
* @param[in] v source
* @param[in] mask mask

4
include/cglm/util.h
View File

@@ -87,7 +87,7 @@ glm_deg(float rad) {
}
/*!
* @brief convert exsisting degree to radians. this will override degrees value
* @brief convert existing degree to radians. this will override degrees value
*
* @param[in, out] deg pointer to angle in degrees
*/
@@ -98,7 +98,7 @@ glm_make_rad(float *deg) {
}
/*!
* @brief convert exsisting radians to degree. this will override radians value
* @brief convert existing radians to degree. this will override radians value
*
* @param[in, out] rad pointer to angle in radians
*/

2
include/cglm/vec2.h
View File

@@ -154,7 +154,7 @@ glm_vec2_cross(vec2 a, vec2 b) {
* @brief norm * norm (magnitude) of vec
*
* we can use this func instead of calling norm * norm, because it would call
* sqrtf fuction twice but with this func we can avoid func call, maybe this is
* sqrtf function twice but with this func we can avoid func call, maybe this is
* not good name for this func
*
* @param[in] v vector

6
include/cglm/vec3.h
View File

@@ -196,7 +196,7 @@ glm_vec3_dot(vec3 a, vec3 b) {
* @brief norm * norm (magnitude) of vec
*
* we can use this func instead of calling norm * norm, because it would call
* sqrtf fuction twice but with this func we can avoid func call, maybe this is
* sqrtf function twice but with this func we can avoid func call, maybe this is
* not good name for this func
*
* @param[in] v vector
@@ -710,7 +710,7 @@ glm_vec3_crossn(vec3 a, vec3 b, vec3 dest) {
}
/*!
* @brief angle betwen two vector
* @brief angle between two vector
*
* @param[in] a vector1
* @param[in] b vector2
@@ -1112,7 +1112,7 @@ glm_vec3_smoothinterpc(vec3 from, vec3 to, float t, vec3 dest) {
/*!
* @brief swizzle vector components
*
* you can use existin masks e.g. GLM_XXX, GLM_ZYX
* you can use existing masks e.g. GLM_XXX, GLM_ZYX
*
* @param[in] v source
* @param[in] mask mask

4
include/cglm/vec4.h
View File

@@ -246,7 +246,7 @@ glm_vec4_dot(vec4 a, vec4 b) {
* @brief norm * norm (magnitude) of vec
*
* we can use this func instead of calling norm * norm, because it would call
* sqrtf fuction twice but with this func we can avoid func call, maybe this is
* sqrtf function twice but with this func we can avoid func call, maybe this is
* not good name for this func
*
* @param[in] v vec4
@@ -1272,7 +1272,7 @@ glm_vec4_cubic(float s, vec4 dest) {
/*!
* @brief swizzle vector components
*
* you can use existin masks e.g. GLM_XXXX, GLM_WZYX
* you can use existing masks e.g. GLM_XXXX, GLM_WZYX
*
* @param[in] v source
* @param[in] mask mask