External/cglm
1
0
Fork 0
mirror of https://github.com/recp/cglm.git synced 2025-12-26 02:25:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

get sign of float helper as -1, +1 and 0

Browse Source 
* add clarification for zero input
This commit is contained in:
Recep Aslantas
2018-04-02 16:18:50 +03:00
parent 54c44ff224
commit acda316c12
2 changed files with 32 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/source/util.rst
View File

@@ -13,6 +13,7 @@ Table of contents (click to go):
Functions:
1. :c:func:`glm_sign`
#. :c:func:`glm_signf`
#. :c:func:`glm_rad`
#. :c:func:`glm_deg`
#. :c:func:`glm_make_rad`
@@ -27,7 +28,9 @@ Functions documentation
.. c:function:: int glm_sign(int val)
| returns sign of 32 bit integer as +1 or -1
| returns sign of 32 bit integer as +1, -1, 0
| **Important**: It returns 0 for zero input
Parameters:
| *[in]* **val** an integer
@@ -35,6 +38,18 @@ Functions documentation
Returns:
sign of given number
.. c:function:: float glm_signf(float val)
| returns sign of 32 bit integer as +1.0, -1.0, 0.0
| **Important**: It returns 0.0f for zero input
Parameters:
| *[in]* **val** a float
Returns:
sign of given number
.. c:function:: float glm_rad(float deg)
| convert degree to radians