mirror of
https://github.com/recp/cglm.git
synced 2025-12-26 10:35:10 +00:00
vec: rename glm_vec_ to glm_vec3_ (continue)
* add missing functions to vec4 * update docs
This commit is contained in:
@@ -14,25 +14,25 @@ Table of contents (click to go):
|
||||
|
||||
Functions:
|
||||
|
||||
1. :c:func:`glm_vec_mulv`
|
||||
#. :c:func:`glm_vec_broadcast`
|
||||
#. :c:func:`glm_vec_eq`
|
||||
#. :c:func:`glm_vec_eq_eps`
|
||||
#. :c:func:`glm_vec_eq_all`
|
||||
#. :c:func:`glm_vec_eqv`
|
||||
#. :c:func:`glm_vec_eqv_eps`
|
||||
#. :c:func:`glm_vec_max`
|
||||
#. :c:func:`glm_vec_min`
|
||||
#. :c:func:`glm_vec_isnan`
|
||||
#. :c:func:`glm_vec_isinf`
|
||||
#. :c:func:`glm_vec_isvalid`
|
||||
#. :c:func:`glm_vec_sign`
|
||||
#. :c:func:`glm_vec_sqrt`
|
||||
1. :c:func:`glm_vec3_mulv`
|
||||
#. :c:func:`glm_vec3_broadcast`
|
||||
#. :c:func:`glm_vec3_eq`
|
||||
#. :c:func:`glm_vec3_eq_eps`
|
||||
#. :c:func:`glm_vec3_eq_all`
|
||||
#. :c:func:`glm_vec3_eqv`
|
||||
#. :c:func:`glm_vec3_eqv_eps`
|
||||
#. :c:func:`glm_vec3_max`
|
||||
#. :c:func:`glm_vec3_min`
|
||||
#. :c:func:`glm_vec3_isnan`
|
||||
#. :c:func:`glm_vec3_isinf`
|
||||
#. :c:func:`glm_vec3_isvalid`
|
||||
#. :c:func:`glm_vec3_sign`
|
||||
#. :c:func:`glm_vec3_sqrt`
|
||||
|
||||
Functions documentation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. c:function:: void glm_vec_mulv(vec3 a, vec3 b, vec3 d)
|
||||
.. c:function:: void glm_vec3_mulv(vec3 a, vec3 b, vec3 d)
|
||||
|
||||
multiplies individual items
|
||||
|
||||
@@ -41,7 +41,7 @@ Functions documentation
|
||||
| *[in]* **b** vec2
|
||||
| *[out]* **d** destination (v1[0] * v2[0], v1[1] * v2[1], v1[2] * v2[2])
|
||||
|
||||
.. c:function:: void glm_vec_broadcast(float val, vec3 d)
|
||||
.. c:function:: void glm_vec3_broadcast(float val, vec3 d)
|
||||
|
||||
fill a vector with specified value
|
||||
|
||||
@@ -49,7 +49,7 @@ Functions documentation
|
||||
| *[in]* **val** value
|
||||
| *[out]* **dest** destination
|
||||
|
||||
.. c:function:: bool glm_vec_eq(vec3 v, float val)
|
||||
.. c:function:: bool glm_vec3_eq(vec3 v, float val)
|
||||
|
||||
check if vector is equal to value (without epsilon)
|
||||
|
||||
@@ -57,7 +57,7 @@ Functions documentation
|
||||
| *[in]* **v** vector
|
||||
| *[in]* **val** value
|
||||
|
||||
.. c:function:: bool glm_vec_eq_eps(vec3 v, float val)
|
||||
.. c:function:: bool glm_vec3_eq_eps(vec3 v, float val)
|
||||
|
||||
check if vector is equal to value (with epsilon)
|
||||
|
||||
@@ -65,14 +65,14 @@ Functions documentation
|
||||
| *[in]* **v** vector
|
||||
| *[in]* **val** value
|
||||
|
||||
.. c:function:: bool glm_vec_eq_all(vec3 v)
|
||||
.. c:function:: bool glm_vec3_eq_all(vec3 v)
|
||||
|
||||
check if vectors members are equal (without epsilon)
|
||||
|
||||
Parameters:
|
||||
| *[in]* **v** vector
|
||||
|
||||
.. c:function:: bool glm_vec_eqv(vec3 v1, vec3 v2)
|
||||
.. c:function:: bool glm_vec3_eqv(vec3 v1, vec3 v2)
|
||||
|
||||
check if vector is equal to another (without epsilon) vector
|
||||
|
||||
@@ -80,7 +80,7 @@ Functions documentation
|
||||
| *[in]* **vec** vector 1
|
||||
| *[in]* **vec** vector 2
|
||||
|
||||
.. c:function:: bool glm_vec_eqv_eps(vec3 v1, vec3 v2)
|
||||
.. c:function:: bool glm_vec3_eqv_eps(vec3 v1, vec3 v2)
|
||||
|
||||
check if vector is equal to another (with epsilon)
|
||||
|
||||
@@ -88,21 +88,21 @@ Functions documentation
|
||||
| *[in]* **v1** vector1
|
||||
| *[in]* **v2** vector2
|
||||
|
||||
.. c:function:: float glm_vec_max(vec3 v)
|
||||
.. c:function:: float glm_vec3_max(vec3 v)
|
||||
|
||||
max value of vector
|
||||
|
||||
Parameters:
|
||||
| *[in]* **v** vector
|
||||
|
||||
.. c:function:: float glm_vec_min(vec3 v)
|
||||
.. c:function:: float glm_vec3_min(vec3 v)
|
||||
|
||||
min value of vector
|
||||
|
||||
Parameters:
|
||||
| *[in]* **v** vector
|
||||
|
||||
.. c:function:: bool glm_vec_isnan(vec3 v)
|
||||
.. c:function:: bool glm_vec3_isnan(vec3 v)
|
||||
|
||||
| check if one of items is NaN (not a number)
|
||||
| you should only use this in DEBUG mode or very critical asserts
|
||||
@@ -110,7 +110,7 @@ Functions documentation
|
||||
Parameters:
|
||||
| *[in]* **v** vector
|
||||
|
||||
.. c:function:: bool glm_vec_isinf(vec3 v)
|
||||
.. c:function:: bool glm_vec3_isinf(vec3 v)
|
||||
|
||||
| check if one of items is INFINITY
|
||||
| you should only use this in DEBUG mode or very critical asserts
|
||||
@@ -118,7 +118,7 @@ Functions documentation
|
||||
Parameters:
|
||||
| *[in]* **v** vector
|
||||
|
||||
.. c:function:: bool glm_vec_isvalid(vec3 v)
|
||||
.. c:function:: bool glm_vec3_isvalid(vec3 v)
|
||||
|
||||
| check if all items are valid number
|
||||
| you should only use this in DEBUG mode or very critical asserts
|
||||
@@ -126,7 +126,7 @@ Functions documentation
|
||||
Parameters:
|
||||
| *[in]* **v** vector
|
||||
|
||||
.. c:function:: void glm_vec_sign(vec3 v, vec3 dest)
|
||||
.. c:function:: void glm_vec3_sign(vec3 v, vec3 dest)
|
||||
|
||||
get sign of 32 bit float as +1, -1, 0
|
||||
|
||||
@@ -134,7 +134,7 @@ Functions documentation
|
||||
| *[in]* **v** vector
|
||||
| *[out]* **dest** sign vector (only keeps signs as -1, 0, -1)
|
||||
|
||||
.. c:function:: void glm_vec_sqrt(vec3 v, vec3 dest)
|
||||
.. c:function:: void glm_vec3_sqrt(vec3 v, vec3 dest)
|
||||
|
||||
square root of each vector item
|
||||
|
||||
|
||||
Reference in New Issue
Block a user