YourWishes/cglm
1
0
Fork 0
mirror of https://github.com/recp/cglm.git synced 2026-02-17 03:39:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

add docs for new aabb functions

Browse Source
This commit is contained in:
Recep Aslantas
2018-04-02 16:36:55 +03:00
parent dbd1e334ea
commit 74f9865884
2 changed files with 50 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/source/box.rst
View File

@@ -24,6 +24,10 @@ Functions:
#. :c:func:`glm_aabb_crop` #. :c:func:`glm_aabb_crop`
#. :c:func:`glm_aabb_crop_until` #. :c:func:`glm_aabb_crop_until`
#. :c:func:`glm_aabb_frustum` #. :c:func:`glm_aabb_frustum`
#. :c:func:`glm_aabb_invalidate`
#. :c:func:`glm_aabb_isvalid`
#. :c:func:`glm_aabb_size`
#. :c:func:`glm_aabb_radius`
Functions documentation Functions documentation
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
@@ -91,3 +95,39 @@ Functions documentation
Parameters: Parameters:
| *[in]* **box** bounding box | *[in]* **box** bounding box
| *[out]* **planes** frustum planes | *[out]* **planes** frustum planes
.. c:function:: void glm_aabb_invalidate(vec3 box[2])
| invalidate AABB min and max values
| It fills *max* values with -FLT_MAX and *min* values with +FLT_MAX
Parameters:
| *[in, out]* **box** bounding box
.. c:function:: bool check if AABB is valid or not
| check if AABB intersects with frustum planes
Parameters:
| *[in]* **box** bounding box
Returns:
returns true if aabb is valid otherwise false
.. c:function:: float glm_aabb_size(vec3 box[2])
| distance between of min and max
Parameters:
| *[in]* **box** bounding box
Returns:
distance between min - max
.. c:function:: float glm_aabb_radius(vec3 box[2])
| radius of sphere which surrounds AABB
Parameters:
| *[in]* **box** bounding box

10
docs/source/io.rst
View File

@@ -39,6 +39,7 @@ Functions:
#. :c:func:`glm_vec3_print` #. :c:func:`glm_vec3_print`
#. :c:func:`glm_ivec3_print` #. :c:func:`glm_ivec3_print`
#. :c:func:`glm_versor_print` #. :c:func:`glm_versor_print`
#. :c:func:`glm_aabb_print`
Functions documentation Functions documentation
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
@@ -90,3 +91,12 @@ Functions documentation
Parameters: Parameters:
| *[in]* **vec** quaternion | *[in]* **vec** quaternion
| *[in]* **ostream** FILE to write | *[in]* **ostream** FILE to write
.. c:function:: void glm_aabb_print(versor vec, const char * __restrict tag, FILE * __restrict ostream)
| print aabb to given stream
Parameters:
| *[in]* **vec** aabb (axis-aligned bounding box)
| *[in]* **tag** tag to find it more easly in logs
| *[in]* **ostream** FILE to write