summaryrefslogtreecommitdiff
path: root/libs/cglm/docs/source/index.rst
blob: 34a71c43378a36cc793d76b742596a8d7693fdee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
.. cglm documentation master file, created by
   sphinx-quickstart on Tue Jun  6 20:31:05 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

cglm Documentation
================================

**cglm** is an optimized 3D math library written in C99 (compatible with C89).
It is similar to the original **glm** library, except **cglm** is mainly for
**C**.

**cglm** stores matrices as column-major order but in the future row-major is
considered to be supported as optional.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started:

   features
   build
   getting_started

.. toctree::
   :maxdepth: 2
   :caption: How To:

   opengl

.. toctree::
   :maxdepth: 2
   :caption: API:

   api

.. toctree::
   :maxdepth: 2
   :caption: Options:

   opt

.. toctree::
   :maxdepth: 2
   :caption: Troubleshooting:

   troubleshooting

Indices and Tables:
===================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`