mirror of
https://github.com/recp/cglm.git
synced 2026-02-17 03:39:05 +00:00
Merge pull request #423 from waywardmonkeys/reduce-typo-count
Reduce typo count.
This commit is contained in:
@@ -82,7 +82,7 @@ Functions documentation
|
|||||||
|
|
||||||
| crops a bounding box with another one.
|
| crops a bounding box with another one.
|
||||||
|
|
||||||
this could be useful for gettng a bbox which fits with view frustum and
|
this could be useful for getting a bbox which fits with view frustum and
|
||||||
object bounding boxes. In this case you crop view frustum box with objects
|
object bounding boxes. In this case you crop view frustum box with objects
|
||||||
box
|
box
|
||||||
|
|
||||||
@@ -95,7 +95,7 @@ Functions documentation
|
|||||||
|
|
||||||
| crops a bounding box with another one.
|
| crops a bounding box with another one.
|
||||||
|
|
||||||
this could be useful for gettng a bbox which fits with view frustum and
|
this could be useful for getting a bbox which fits with view frustum and
|
||||||
object bounding boxes. In this case you crop view frustum box with objects
|
object bounding boxes. In this case you crop view frustum box with objects
|
||||||
box
|
box
|
||||||
|
|
||||||
|
|||||||
@@ -117,7 +117,7 @@ Functions documentation
|
|||||||
If you need to rotate object around itself e.g. center of object or at
|
If you need to rotate object around itself e.g. center of object or at
|
||||||
some point [of object] then `glm_rotate_at()` would be better choice to do so.
|
some point [of object] then `glm_rotate_at()` would be better choice to do so.
|
||||||
|
|
||||||
Even if object's model transform is identiy, rotation may not be around
|
Even if object's model transform is identity, rotation may not be around
|
||||||
center of object if object does not lay out at ORIGIN perfectly.
|
center of object if object does not lay out at ORIGIN perfectly.
|
||||||
|
|
||||||
Using `glm_rotate_at()` with center of bounding shape ( AABB, Sphere ... )
|
Using `glm_rotate_at()` with center of bounding shape ( AABB, Sphere ... )
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ By default struct api adds `s` suffix to every type name e.g. vec3s, mat4s, vers
|
|||||||
Also struct api `s` suffix to namespace e.g. `glms_vec3_add`, `glms_mat4_mul` etc.
|
Also struct api `s` suffix to namespace e.g. `glms_vec3_add`, `glms_mat4_mul` etc.
|
||||||
|
|
||||||
By starting v0.9.0, struct api namespace is configurable. We can omit **glms_** namespace or
|
By starting v0.9.0, struct api namespace is configurable. We can omit **glms_** namespace or
|
||||||
even change it with custom name to move existing api integrations to **cglm** more easliy...
|
even change it with custom name to move existing api integrations to **cglm** more easily...
|
||||||
We can also add **s** to function names if we want e.g. `glms_vec3_add()` -> `vec3_add()` or `vec3s_add()`.
|
We can also add **s** to function names if we want e.g. `glms_vec3_add()` -> `vec3_add()` or `vec3s_add()`.
|
||||||
|
|
||||||
By including **cglm/struct.h** header you will include all struct api. It will also include **cglm/cglm.h** too.
|
By including **cglm/struct.h** header you will include all struct api. It will also include **cglm/cglm.h** too.
|
||||||
|
|||||||
@@ -62,7 +62,7 @@ Functions documentation
|
|||||||
|
|
||||||
| crops a bounding box with another one.
|
| crops a bounding box with another one.
|
||||||
|
|
||||||
this could be useful for gettng a bbox which fits with view frustum and
|
this could be useful for getting a bbox which fits with view frustum and
|
||||||
object bounding boxes. In this case you crop view frustum box with objects
|
object bounding boxes. In this case you crop view frustum box with objects
|
||||||
box
|
box
|
||||||
|
|
||||||
@@ -75,7 +75,7 @@ Functions documentation
|
|||||||
|
|
||||||
| crops a bounding box with another one.
|
| crops a bounding box with another one.
|
||||||
|
|
||||||
this could be useful for gettng a bbox which fits with view frustum and
|
this could be useful for getting a bbox which fits with view frustum and
|
||||||
object bounding boxes. In this case you crop view frustum box with objects
|
object bounding boxes. In this case you crop view frustum box with objects
|
||||||
box
|
box
|
||||||
|
|
||||||
|
|||||||
@@ -11,9 +11,9 @@ Header: cglm/quat.h
|
|||||||
|
|
||||||
What you can do with quaternions with existing functions is (Some of them):
|
What you can do with quaternions with existing functions is (Some of them):
|
||||||
|
|
||||||
- You can rotate transform matrix using quaterion
|
- You can rotate transform matrix using quaternion
|
||||||
- You can rotate vector using quaterion
|
- You can rotate vector using quaternion
|
||||||
- You can create view matrix using quaterion
|
- You can create view matrix using quaternion
|
||||||
- You can create a lookrotation (from source point to dest)
|
- You can create a lookrotation (from source point to dest)
|
||||||
|
|
||||||
Table of contents (click to go):
|
Table of contents (click to go):
|
||||||
|
|||||||
@@ -95,7 +95,7 @@ glm_aabb2d_merge(vec2 aabb1[2], vec2 aabb2[2], vec2 dest[2]) {
|
|||||||
/*!
|
/*!
|
||||||
* @brief crops a bounding aabb with another one.
|
* @brief crops a bounding aabb with another one.
|
||||||
*
|
*
|
||||||
* this could be useful for gettng a baabb which fits with view frustum and
|
* this could be useful for getting a baabb which fits with view frustum and
|
||||||
* object bounding aabbes. In this case you crop view frustum aabb with objects
|
* object bounding aabbes. In this case you crop view frustum aabb with objects
|
||||||
* aabb
|
* aabb
|
||||||
*
|
*
|
||||||
@@ -116,7 +116,7 @@ glm_aabb2d_crop(vec2 aabb[2], vec2 cropAabb[2], vec2 dest[2]) {
|
|||||||
/*!
|
/*!
|
||||||
* @brief crops a bounding aabb with another one.
|
* @brief crops a bounding aabb with another one.
|
||||||
*
|
*
|
||||||
* this could be useful for gettng a baabb which fits with view frustum and
|
* this could be useful for getting a baabb which fits with view frustum and
|
||||||
* object bounding aabbes. In this case you crop view frustum aabb with objects
|
* object bounding aabbes. In this case you crop view frustum aabb with objects
|
||||||
* aabb
|
* aabb
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -215,7 +215,7 @@ glm_rotate_z(mat4 m, float angle, mat4 dest) {
|
|||||||
* If you need to rotate object around itself e.g. center of object or at
|
* If you need to rotate object around itself e.g. center of object or at
|
||||||
* some point [of object] then `glm_rotate_at()` would be better choice to do so.
|
* some point [of object] then `glm_rotate_at()` would be better choice to do so.
|
||||||
*
|
*
|
||||||
* Even if object's model transform is identiy, rotation may not be around
|
* Even if object's model transform is identity, rotation may not be around
|
||||||
* center of object if object does not lay out at ORIGIN perfectly.
|
* center of object if object does not lay out at ORIGIN perfectly.
|
||||||
*
|
*
|
||||||
* Using `glm_rotate_at()` with center of bounding shape ( AABB, Sphere ... )
|
* Using `glm_rotate_at()` with center of bounding shape ( AABB, Sphere ... )
|
||||||
|
|||||||
@@ -75,7 +75,7 @@ glm_aabb_merge(vec3 box1[2], vec3 box2[2], vec3 dest[2]) {
|
|||||||
/*!
|
/*!
|
||||||
* @brief crops a bounding box with another one.
|
* @brief crops a bounding box with another one.
|
||||||
*
|
*
|
||||||
* this could be useful for gettng a bbox which fits with view frustum and
|
* this could be useful for getting a bbox which fits with view frustum and
|
||||||
* object bounding boxes. In this case you crop view frustum box with objects
|
* object bounding boxes. In this case you crop view frustum box with objects
|
||||||
* box
|
* box
|
||||||
*
|
*
|
||||||
@@ -98,7 +98,7 @@ glm_aabb_crop(vec3 box[2], vec3 cropBox[2], vec3 dest[2]) {
|
|||||||
/*!
|
/*!
|
||||||
* @brief crops a bounding box with another one.
|
* @brief crops a bounding box with another one.
|
||||||
*
|
*
|
||||||
* this could be useful for gettng a bbox which fits with view frustum and
|
* this could be useful for getting a bbox which fits with view frustum and
|
||||||
* object bounding boxes. In this case you crop view frustum box with objects
|
* object bounding boxes. In this case you crop view frustum box with objects
|
||||||
* box
|
* box
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -123,7 +123,7 @@ glm_quat_identity_array(versor * __restrict q, size_t count) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
* @brief inits quaterion with raw values
|
* @brief inits quaternion with raw values
|
||||||
*
|
*
|
||||||
* @param[out] q quaternion
|
* @param[out] q quaternion
|
||||||
* @param[in] x x
|
* @param[in] x x
|
||||||
@@ -749,7 +749,7 @@ glm_quat_slerp(versor from, versor to, float t, versor dest) {
|
|||||||
*
|
*
|
||||||
* @param[in] from from
|
* @param[in] from from
|
||||||
* @param[in] to to
|
* @param[in] to to
|
||||||
* @param[in] t amout
|
* @param[in] t amount
|
||||||
* @param[out] dest result quaternion
|
* @param[out] dest result quaternion
|
||||||
*/
|
*/
|
||||||
CGLM_INLINE
|
CGLM_INLINE
|
||||||
|
|||||||
@@ -62,7 +62,7 @@ glms_aabb2d_(merge)(vec2s aabb1[2], vec2s aabb2[2], vec2s dest[2]) {
|
|||||||
/*!
|
/*!
|
||||||
* @brief crops a bounding box with another one.
|
* @brief crops a bounding box with another one.
|
||||||
*
|
*
|
||||||
* this could be useful for gettng a bbox which fits with view frustum and
|
* this could be useful for getting a bbox which fits with view frustum and
|
||||||
* object bounding boxes. In this case you crop view frustum box with objects
|
* object bounding boxes. In this case you crop view frustum box with objects
|
||||||
* box
|
* box
|
||||||
*
|
*
|
||||||
@@ -86,7 +86,7 @@ glms_aabb2d_(crop)(vec2s aabb[2], vec2s cropAabb[2], vec2s dest[2]) {
|
|||||||
/*!
|
/*!
|
||||||
* @brief crops a bounding box with another one.
|
* @brief crops a bounding box with another one.
|
||||||
*
|
*
|
||||||
* this could be useful for gettng a bbox which fits with view frustum and
|
* this could be useful for getting a bbox which fits with view frustum and
|
||||||
* object bounding boxes. In this case you crop view frustum box with objects
|
* object bounding boxes. In this case you crop view frustum box with objects
|
||||||
* box
|
* box
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -62,7 +62,7 @@ glms_aabb_(merge)(vec3s box1[2], vec3s box2[2], vec3s dest[2]) {
|
|||||||
/*!
|
/*!
|
||||||
* @brief crops a bounding box with another one.
|
* @brief crops a bounding box with another one.
|
||||||
*
|
*
|
||||||
* this could be useful for gettng a bbox which fits with view frustum and
|
* this could be useful for getting a bbox which fits with view frustum and
|
||||||
* object bounding boxes. In this case you crop view frustum box with objects
|
* object bounding boxes. In this case you crop view frustum box with objects
|
||||||
* box
|
* box
|
||||||
*
|
*
|
||||||
@@ -86,7 +86,7 @@ glms_aabb_(crop)(vec3s box[2], vec3s cropBox[2], vec3s dest[2]) {
|
|||||||
/*!
|
/*!
|
||||||
* @brief crops a bounding box with another one.
|
* @brief crops a bounding box with another one.
|
||||||
*
|
*
|
||||||
* this could be useful for gettng a bbox which fits with view frustum and
|
* this could be useful for getting a bbox which fits with view frustum and
|
||||||
* object bounding boxes. In this case you crop view frustum box with objects
|
* object bounding boxes. In this case you crop view frustum box with objects
|
||||||
* box
|
* box
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -238,7 +238,7 @@ glms_ivec2_(subs)(ivec2s v, int s) {
|
|||||||
/*!
|
/*!
|
||||||
* @brief multiply vector [a] with vector [b] and store result in [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[in] b second vector
|
||||||
* @returns destination
|
* @returns destination
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -163,7 +163,7 @@ glms_ivec3_(dot)(ivec3s a, ivec3s b) {
|
|||||||
* @brief norm * norm (magnitude) of vec
|
* @brief norm * norm (magnitude) of vec
|
||||||
*
|
*
|
||||||
* we can use this func instead of calling norm * norm, because it would call
|
* 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
|
* not good name for this func
|
||||||
*
|
*
|
||||||
* @param[in] v vector
|
* @param[in] v vector
|
||||||
@@ -253,7 +253,7 @@ glms_ivec3_(subs)(ivec3s v, int s) {
|
|||||||
/*!
|
/*!
|
||||||
* @brief multiply vector [a] with vector [b] and store result in [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[in] b second vector
|
||||||
* @returns destination
|
* @returns destination
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -201,7 +201,7 @@ glms_ivec4_(subs)(ivec4s v, int s) {
|
|||||||
/*!
|
/*!
|
||||||
* @brief multiply vector [a] with vector [b] and store result in [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[in] b second vector
|
||||||
* @returns destination
|
* @returns destination
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -105,7 +105,7 @@ glms_quat_(identity_array)(versors * __restrict q, size_t count) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
* @brief inits quaterion with raw values
|
* @brief inits quaternion with raw values
|
||||||
*
|
*
|
||||||
* @param[in] x x
|
* @param[in] x x
|
||||||
* @param[in] y y
|
* @param[in] y y
|
||||||
@@ -464,7 +464,7 @@ glms_quat_(slerp)(versors from, versors to, float t) {
|
|||||||
*
|
*
|
||||||
* @param[in] from from
|
* @param[in] from from
|
||||||
* @param[in] to to
|
* @param[in] to to
|
||||||
* @param[in] t amout
|
* @param[in] t amount
|
||||||
* @returns result quaternion
|
* @returns result quaternion
|
||||||
*/
|
*/
|
||||||
CGLM_INLINE
|
CGLM_INLINE
|
||||||
|
|||||||
Reference in New Issue
Block a user