mirror of
https://github.com/recp/cglm.git
synced 2025-12-26 10:35:10 +00:00
docs: add docs for vec3-ext
This commit is contained in:
@@ -30,3 +30,4 @@ Follow the :doc:`build` documentation for this
|
||||
mat4
|
||||
mat3
|
||||
vec3
|
||||
vec3-ext
|
||||
|
||||
98
docs/source/vec3-ext.rst
Normal file
98
docs/source/vec3-ext.rst
Normal file
@@ -0,0 +1,98 @@
|
||||
.. default-domain:: C
|
||||
|
||||
vec3 extra
|
||||
==========
|
||||
|
||||
Header: cglm/vec3-ext.h
|
||||
|
||||
There are some functions are in called in extra header. These are called extra
|
||||
because they are not used like other functions in vec3.h in the future some of
|
||||
these functions ma be moved to vec3 header.
|
||||
|
||||
Table of contents (clik func/macro 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`
|
||||
|
||||
Functions documentation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. c:function:: void glm_vec_mulv(vec3 a, vec3 b, vec3 d)
|
||||
|
||||
multiplies individual items
|
||||
|
||||
Parameters:
|
||||
| *[in]* **a** vec1
|
||||
| *[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)
|
||||
|
||||
fill a vector with specified value
|
||||
|
||||
Parameters:
|
||||
| *[in]* **val** value
|
||||
| *[out]* **dest** destination
|
||||
|
||||
.. c:function:: bool glm_vec_eq(vec3 v, float val)
|
||||
|
||||
check if vector is equal to value (without epsilon)
|
||||
|
||||
Parameters:
|
||||
| *[in]* **v** vector
|
||||
| *[in]* **val** value
|
||||
|
||||
.. c:function:: bool glm_vec_eq_eps(vec4 v, float val)
|
||||
|
||||
check if vector is equal to value (with epsilon)
|
||||
|
||||
Parameters:
|
||||
| *[in]* **v** vector
|
||||
| *[in]* **val** value
|
||||
|
||||
.. c:function:: bool glm_vec_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)
|
||||
|
||||
check if vector is equal to another (without epsilon) vector
|
||||
|
||||
Parameters:
|
||||
| *[in]* **vec** vector 1
|
||||
| *[in]* **vec** vector 2
|
||||
|
||||
.. c:function:: bool glm_vec_eqv_eps(vec3 v1, vec3 v2)
|
||||
|
||||
check if vector is equal to another (with epsilon)
|
||||
|
||||
Parameters:
|
||||
| *[in]* **v1** vector1
|
||||
| *[in]* **v2** vector2
|
||||
|
||||
.. c:function:: float glm_vec_max(vec3 v)
|
||||
|
||||
max value of vector
|
||||
|
||||
Parameters:
|
||||
| *[in]* **v** vector
|
||||
|
||||
.. c:function:: float glm_vec_min(vec3 v)
|
||||
|
||||
min value of vector
|
||||
|
||||
Parameters:
|
||||
| *[in]* **v** vector
|
||||
Reference in New Issue
Block a user