mirror of
https://github.com/recp/cglm.git
synced 2026-01-05 22:59:12 +00:00
docs: use sphinx_rtd_theme theme dor documentation
This commit is contained in:
@@ -3,7 +3,7 @@
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to cglm's documentation!
|
||||
cglm Documentation
|
||||
================================
|
||||
|
||||
**cglm** is optimized 3D math library written in C99 (compatible with C89).
|
||||
@@ -14,33 +14,36 @@ is considered to be supported as optional.
|
||||
|
||||
Also currently only **float** type is supported for most operations.
|
||||
|
||||
**Features**
|
||||
|
||||
* general purpose matrix operations (mat4, mat3)
|
||||
* chain matrix multiplication (square only)
|
||||
* general purpose vector operations (cross, dot, rotate, proj, angle...)
|
||||
* affine transforms
|
||||
* matrix decomposition (extract rotation, scaling factor)
|
||||
* optimized affine transform matrices (mul, rigid-body inverse)
|
||||
* camera (lookat)
|
||||
* projections (ortho, perspective)
|
||||
* quaternions
|
||||
* euler angles / yaw-pitch-roll to matrix
|
||||
* extract euler angles
|
||||
* inline or pre-compiled function call
|
||||
* frustum (extract view frustum planes, corners...)
|
||||
* bounding box (AABB in Frustum (culling), crop, merge...)
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Table Of Contents:
|
||||
: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
|
||||
|
||||
Reference in New Issue
Block a user