Skip to content

Commit

Permalink
Merge pull request #384 from waywardmonkeys/fix-more-typos
Browse files Browse the repository at this point in the history
Fix typos.
  • Loading branch information
recp authored Feb 8, 2024
2 parents b63b2b9 + e4419c4 commit 45134b1
Show file tree
Hide file tree
Showing 66 changed files with 261 additions and 263 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ you have the latest version
- **[major change]** by starting v0.5.0, vec3 functions use **glm_vec3_** namespace, it was **glm_vec_** until v0.5.0
- **[major change]** by starting v0.5.1, built-in alignment is removed from **vec3** and **mat3** types
- **[major change]** by starting v0.7.3, inline print functions are disabled in release/production mode to eliminate print costs (see options in documentation). Print output also improved. You can disable colors if you need (see documentation)
- **[major change]** by starting v0.8.3, **cglm** supports alternative clipspace configuations e.g. Left Handed, Zero-to-One (_zo)... `CGLM_FORCE_DEPTH_ZERO_TO_ONE` and `CGLM_FORCE_LEFT_HANDED` is provided to control clipspace. You should be able to use **cglm** with Vulkan, DirectX and Metal now... see https://cglm.readthedocs.io/en/latest/opt.html#clipspace-option-s
- **[major change]** by starting v0.8.3, **cglm** supports alternative clipspace configurations e.g. Left Handed, Zero-to-One (_zo)... `CGLM_FORCE_DEPTH_ZERO_TO_ONE` and `CGLM_FORCE_LEFT_HANDED` is provided to control clipspace. You should be able to use **cglm** with Vulkan, DirectX and Metal now... see https://cglm.readthedocs.io/en/latest/opt.html#clipspace-option-s

#### 📌 Note for C++ developers:
If you are not aware of the original GLM library yet, you may also want to look at:
Expand Down Expand Up @@ -108,7 +108,7 @@ https://github.com/g-truc/glm

## 🚀 Features
- **scalar** and **simd** (sse, avx, neon...) optimizations
- option to use different clipspaces e.g. Left Handed, Zero-to-One... (currrently right handed negative-one is default)
- option to use different clipspaces e.g. Left Handed, Zero-to-One... (currently right handed negative-one is default)
- array api and struct api, you can use arrays or structs.
- general purpose matrix operations (mat4, mat3)
- chain matrix multiplication (square only)
Expand Down Expand Up @@ -148,7 +148,7 @@ To call pre-compiled versions, just use `glmc_` (c stands for 'call') instead of
glm_mul(trans, rot, rt); /* inline */
glmc_mul(trans, rot, rt); /* call from library */
```
Most of math functions are optimized manualy with SSE2 if available, if not? Dont worry there are non-sse versions of all operations
Most of math functions are optimized manually with SSE2 if available, if not? Dont worry there are non-sse versions of all operations
You can pass matrices and vectors as array to functions rather than get address.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/aabb2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Functions documentation
Parameters:
| *[in]* **aabb** bounding box
| *[in]* **cropAabb** crop box
| *[in]* **clampAabb** miniumum box
| *[in]* **clampAabb** minimum box
| *[out]* **dest** cropped bounding box
.. c:function:: void glm_aabb2d_invalidate(vec2 aabb[2])
Expand Down
18 changes: 9 additions & 9 deletions docs/source/affine-common.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
3D Affine Transforms (common)
================================================================================

Common transfrom functions.
Common transform functions.

Table of contents (click to go):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -30,15 +30,15 @@ Functions documentation
creates NEW translate transform matrix by *v* vector.
Parameters:
| *[in, out]* **m** affine transfrom
| *[in, out]* **m** affine transform
| *[in]* **v** translate vector [x, y, z]
.. c:function:: void glm_scale_to(mat4 m, vec3 v, mat4 dest)
scale existing transform matrix by *v* vector and store result in dest
Parameters:
| *[in]* **m** affine transfrom
| *[in]* **m** affine transform
| *[in]* **v** scale vector [x, y, z]
| *[out]* **dest** scaled matrix
Expand All @@ -47,7 +47,7 @@ Functions documentation
creates NEW scale matrix by v vector
Parameters:
| *[out]* **m** affine transfrom
| *[out]* **m** affine transform
| *[in]* **v** scale vector [x, y, z]
.. c:function:: void glm_scale(mat4 m, vec3 v)
Expand All @@ -56,7 +56,7 @@ Functions documentation
and stores result in same matrix
Parameters:
| *[in, out]* **m** affine transfrom
| *[in, out]* **m** affine transform
| *[in]* **v** scale vector [x, y, z]
.. c:function:: void glm_scale_uni(mat4 m, float s)
Expand All @@ -65,7 +65,7 @@ Functions documentation
and stores result in same matrix
Parameters:
| *[in, out]* **m** affine transfrom
| *[in, out]* **m** affine transform
| *[in]* **v** scale factor
.. c:function:: void glm_rotate_make(mat4 m, float angle, vec3 axis)
Expand All @@ -74,7 +74,7 @@ Functions documentation
axis will be normalized so you don't need to normalize it
Parameters:
| *[out]* **m** affine transfrom
| *[out]* **m** affine transform
| *[in]* **axis** angle (radians)
| *[in]* **axis** axis
Expand All @@ -86,7 +86,7 @@ Functions documentation
| this should work faster than glm_rotate_at because it reduces one glm_translate.
Parameters:
| *[in, out]* **m** affine transfrom
| *[in, out]* **m** affine transform
| *[in]* **pivot** pivot, anchor point, rotation center
| *[in]* **angle** angle (radians)
| *[in]* **axis** axis
Expand Down Expand Up @@ -123,7 +123,7 @@ Functions documentation
DON'T pass projected matrix here
Parameters:
| *[in]* **m** affine transfrom
| *[in]* **m** affine transform
| *[out]* **t** translation vector
| *[out]* **r** rotation matrix (mat4)
| *[out]* **s** scaling vector [X, Y, Z]
2 changes: 1 addition & 1 deletion docs/source/affine-mat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You cannot use :c:func:`glm_mul` anymore.
Same is also true for :c:func:`glm_inv_tr` if you only have rotation and
translation then it will work as expected, otherwise you cannot use that.

In the future it may accept scale factors too but currectly it does not.
In the future it may accept scale factors too but currently it does not.

Table of contents (click func go):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
28 changes: 13 additions & 15 deletions docs/source/affine-post.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,8 @@
3D Affine Transforms (post)
================================================================================

Post transfrom functions are similar to pre transform functions except order of application is reversed.
Post transform functions are applied after the object is transformed with given (model matrix) transfrom.

Ther are named af
Post transform functions are similar to pre transform functions except order of application is reversed.
Post transform functions are applied after the object is transformed with given (model matrix) transform.

Table of contents (click to go):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -33,7 +31,7 @@ Functions documentation
translate existing transform matrix by *v* vector and store result in dest
Parameters:
| *[in]* **m** affine transfrom
| *[in]* **m** affine transform
| *[in]* **v** translate vector [x, y, z]
| *[out]* **dest** translated matrix
Expand All @@ -43,31 +41,31 @@ Functions documentation
and stores result in same matrix
Parameters:
| *[in, out]* **m** affine transfrom
| *[in, out]* **m** affine transform
| *[in]* **v** translate vector [x, y, z]
.. c:function:: void glm_translated_x(mat4 m, float x)
translate existing transform matrix by x factor
Parameters:
| *[in, out]* **m** affine transfrom
| *[in, out]* **m** affine transform
| *[in]* **v** x factor
.. c:function:: void glm_translated_y(mat4 m, float y)
translate existing transform matrix by *y* factor
Parameters:
| *[in, out]* **m** affine transfrom
| *[in, out]* **m** affine transform
| *[in]* **v** y factor
.. c:function:: void glm_translated_z(mat4 m, float z)
translate existing transform matrix by *z* factor
Parameters:
| *[in, out]* **m** affine transfrom
| *[in, out]* **m** affine transform
| *[in]* **v** z factor
.. c:function:: void glm_rotated_x(mat4 m, float angle, mat4 dest)
Expand All @@ -76,7 +74,7 @@ Functions documentation
and store result in dest
Parameters:
| *[in]* **m** affine transfrom
| *[in]* **m** affine transform
| *[in]* **angle** angle (radians)
| *[out]* **dest** rotated matrix
Expand All @@ -86,7 +84,7 @@ Functions documentation
and store result in dest
Parameters:
| *[in]* **m** affine transfrom
| *[in]* **m** affine transform
| *[in]* **angle** angle (radians)
| *[out]* **dest** rotated matrix
Expand All @@ -96,7 +94,7 @@ Functions documentation
and store result in dest
Parameters:
| *[in]* **m** affine transfrom
| *[in]* **m** affine transform
| *[in]* **angle** angle (radians)
| *[out]* **dest** rotated matrix
Expand All @@ -105,7 +103,7 @@ Functions documentation
rotate existing transform matrix around Z axis by angle and axis
Parameters:
| *[in, out]* **m** affine transfrom
| *[in, out]* **m** affine transform
| *[in]* **angle** angle (radians)
| *[in]* **axis** axis
Expand All @@ -114,7 +112,7 @@ Functions documentation
rotate existing transform around given axis by angle at given pivot point (rotation center)
Parameters:
| *[in, out]* **m** affine transfrom
| *[in, out]* **m** affine transform
| *[in]* **pivot** pivot, anchor point, rotation center
| *[in]* **angle** angle (radians)
| *[in]* **axis** axis
Expand All @@ -124,6 +122,6 @@ Functions documentation
| rotate existing transform matrix around given axis by angle around self (doesn't affected by position)
Parameters:
| *[in, out]* **m** affine transfrom
| *[in, out]* **m** affine transform
| *[in]* **angle** angle (radians)
| *[in]* **axis** axis
Loading

0 comments on commit 45134b1

Please sign in to comment.