External/cglm
1
0
Fork 0
mirror of https://github.com/recp/cglm.git synced 2026-01-02 05:28:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs for new ray functions

Browse Source
This commit is contained in:
Recep Aslantas
2024-03-22 22:30:22 +03:00
parent 6ad0aca7e0
commit da57558078
6 changed files with 132 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/source/vec2.rst
View File

@@ -53,6 +53,8 @@ Functions:
#. :c:func:`glm_vec2_clamp`
#. :c:func:`glm_vec2_lerp`
#. :c:func:`glm_vec2_make`
#. :c:func:`glm_vec2_reflect`
#. :c:func:`glm_vec2_refract`
Functions documentation
~~~~~~~~~~~~~~~~~~~~~~~
@@ -394,3 +396,25 @@ Functions documentation
Parameters:
| *[in]* **src** pointer to an array of floats
| *[out]* **dest** destination vector
.. c:function:: void glm_vec2_reflect(vec2 I, vec2 N, vec2 dest)
Reflection vector using an incident ray and a surface normal
Parameters:
| *[in]* **I** incident vector
| *[in]* **N** *❗️ normalized ❗️* normal vector
| *[out]* **dest** destination: reflection result
.. c:function:: void glm_vec2_refract(vec2 I, vec2 N, float eta, vec2 dest)
Refraction vector using entering ray, surface normal and refraction index
If the angle between the entering ray I and the surface normal N is too
great for a given refraction index, the return value is zero
Parameters:
| *[in]* **I** *❗️ normalized ❗️* incident vector
| *[in]* **N** *❗️ normalized ❗️* normal vector
| *[in]* **eta** ratio of indices of refraction ( η )
| *[out]* **dest** destination: refraction result