mirror of
https://github.com/recp/cglm.git
synced 2026-02-17 03:39:05 +00:00
complete documentation
This commit is contained in:
33
docs/source/plane.rst
Normal file
33
docs/source/plane.rst
Normal file
@@ -0,0 +1,33 @@
|
||||
.. default-domain:: C
|
||||
|
||||
plane
|
||||
================================================================================
|
||||
|
||||
Header: cglm/plane.h
|
||||
|
||||
Plane extract functions are in frustum header and documented
|
||||
in :doc:`frustum` page.
|
||||
|
||||
**Definition of plane:**
|
||||
|
||||
Plane equation: **Ax + By + Cz + D = 0**
|
||||
|
||||
Plan is stored in **vec4** as **[A, B, C, D]**. (A, B, C) is normal and D is distance
|
||||
|
||||
Table of contents (click to go):
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Functions:
|
||||
|
||||
1. :c:func:`glm_plane_normalize`
|
||||
|
||||
|
||||
Functions documentation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. c:function:: void glm_plane_normalize(vec4 plane)
|
||||
|
||||
| normalizes a plane
|
||||
|
||||
Parameters:
|
||||
| *[in, out]* **plane** pnale to normalize
|
||||
Reference in New Issue
Block a user