mirror of
https://github.com/recp/cglm.git
synced 2025-10-04 01:00:46 +00:00
docs: update documentation
This commit is contained in:
@@ -51,3 +51,4 @@ Follow the :doc:`build` documentation for this
|
||||
sphere
|
||||
curve
|
||||
bezier
|
||||
version
|
||||
|
@@ -146,7 +146,7 @@ Functions documentation
|
||||
| *[in]* **b** b
|
||||
|
||||
Returns:
|
||||
true if a and b equals
|
||||
true if a and b are equal
|
||||
|
||||
.. c:function:: float glm_percent(float from, float to, float current)
|
||||
|
||||
@@ -158,7 +158,7 @@ Functions documentation
|
||||
| *[in]* **current** value between from and to values
|
||||
|
||||
Returns:
|
||||
clamped normalized percent (0-100 in 0-1)
|
||||
percentage of current value
|
||||
|
||||
.. c:function:: float glm_percentc(float from, float to, float current)
|
||||
|
||||
@@ -171,3 +171,11 @@ Functions documentation
|
||||
|
||||
Returns:
|
||||
clamped normalized percent (0-100 in 0-1)
|
||||
|
||||
.. c:function:: void glm_swapf(float *a, float *b)
|
||||
|
||||
swap two float values
|
||||
|
||||
Parameters:
|
||||
| *[in]* **a** float 1
|
||||
| *[in]* **b** float 2
|
||||
|
15
docs/source/version.rst
Normal file
15
docs/source/version.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
.. default-domain:: C
|
||||
|
||||
version
|
||||
================================================================================
|
||||
|
||||
Header: cglm/version.h
|
||||
|
||||
**cglm** uses semantic versioning (http://semver.org) which is MAJOR.MINOR.PATCH
|
||||
|
||||
**CGLM_VERSION_MAJOR** is major number of the version.
|
||||
**CGLM_VERSION_MINOR** is minor number of the version.
|
||||
**CGLM_VERSION_PATCH** is path number of the version.
|
||||
|
||||
every release increases these numbers. You can check existing version by
|
||||
including cglm/version.h
|
Reference in New Issue
Block a user