External/cglm
1
0
Fork 0
mirror of https://github.com/recp/cglm.git synced 2025-10-04 01:00:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update docs

Browse Source
This commit is contained in:
Recep Aslantas
2018-02-24 00:54:59 +03:00
parent 891148cbe3
commit d95bf60b02
3 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/source/cglm-intro.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 72 KiB

4
docs/source/getting_started.rst
View File

@@ -1,5 +1,9 @@
Getting Started Getting Started
================================ ================================
.. image:: cglm-intro.png
:width: 492px 
:height: 297px
:align: center
**cglm** uses **glm** prefix for all functions e.g. glm_lookat. You can see supported types in common header file: **cglm** uses **glm** prefix for all functions e.g. glm_lookat. You can see supported types in common header file:

6
docs/source/index.rst
View File

@@ -9,7 +9,7 @@ Welcome to cglm's documentation!
**cglm** is optimized 3D math library written in C99 (compatible with C89). **cglm** is optimized 3D math library written in C99 (compatible with C89).
It is similar to original **glm** library except this is mainly for **C** It is similar to original **glm** library except this is mainly for **C**
This library stores matrices as row-major order but in the future column-major This library stores matrices as column-major order but in the future row-major
is considered to be supported as optional. is considered to be supported as optional.
Also currently only **float** type is supported for most operations. Also currently only **float** type is supported for most operations.
@@ -28,7 +28,9 @@ Also currently only **float** type is supported for most operations.
* euler angles / yaw-pitch-roll to matrix * euler angles / yaw-pitch-roll to matrix
* extract euler angles * extract euler angles
* inline or pre-compiled function call * inline or pre-compiled function call
* more features (todo) * frustum (extract view frustum planes, corners...)
* bounding box (AABB in Frustum (culling), crop, merge...)
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2