docs: add docs for api, mat4

This commit is contained in:
Recep Aslantas
2018-02-24 13:18:28 +03:00
parent 6d5734fe7e
commit fc424631a4
3 changed files with 261 additions and 0 deletions

29
docs/source/api.rst Normal file
View File

@@ -0,0 +1,29 @@
API documentation
================================
Some functions may exist twice,
once for their namespace and once for global namespace
to make easier to write very common functions
For instance, in general we use :code:`glm_vec_dot` to get dot product
of two **vec3**. Now we can also do this with :code:`glm_dot`,
same for *_cross* and so on...
The original function stays where it is, the function in global namespace
of same name is just an alias, so there is no call version of those functions.
e.g there is no func like :code:`glmc_dot` because *glm_dot* is just alias for
:code:`glm_vec_dot`
By including **cglm/cglm.h** header you will include all inline version
of functions. Since functions in this header[s] are inline you don't need to
build or link *cglm* against your project.
But by including **cglm/call.h** header you will include all *non-inline*
version of functions. You need to build *cglm* and link it.
Follow the :doc:`build` documentation for this
.. toctree::
:maxdepth: 2
:caption: API categories:
mat4