docs and call api for _aabb2d_zero

duarm · Feb 23, 2024 · 0d92bfc · 0d92bfc
1 parent 2374329
commit 0d92bfc
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 3 deletions.
diff --git a/docs/source/aabb2d.rst b/docs/source/aabb2d.rst
@@ -24,6 +24,7 @@ Macros:
 Functions:
 
 1. :c:func:`glm_aabb2d_copy`
+#. :c:func:`glm_aabb2d_zero`
 #. :c:func:`glm_aabb2d_transform`
 #. :c:func:`glm_aabb2d_merge`
 #. :c:func:`glm_aabb2d_crop`
@@ -50,6 +51,13 @@ Functions documentation
       | *[in]*  **aabb**  bounding box
       | *[out]* **dest**  destination
 
+.. c:function:: void  glm_aabb2d_zero(vec2 aabb[2])
+
+    | makes all members of [aabb] 0.0f (zero)
+
+    Parameters:
+      | *[in, out]*  **aabb**     bounding box
+
 .. c:function:: void  glm_aabb2d_transform(vec2 aabb[2], mat3 m, vec2 dest[2])
 
     | apply transform to Axis-Aligned Bounding Box

diff --git a/include/cglm/aabb2d.h b/include/cglm/aabb2d.h
@@ -16,10 +16,9 @@
 #define glm_aabb2d_size(aabb)         glm_aabb2d_diag(aabb)
 
 /*!
- * @brief copy all members of [aabb] to [dest]
+ * @brief make [aabb] zero
  *
- * @param[in]  aabb source
- * @param[out] dest destination
+ * @param[in, out]  aabb
  */
 CGLM_INLINE
 void

diff --git a/src/aabb2d.c b/src/aabb2d.c
@@ -11,6 +11,12 @@
 /* DEPRECATED! use _diag */
 #define glmc_aabb2d_size(aabb)         glmc_aabb2d_diag(aabb)
 
+CGLM_EXPORT
+void
+glmc_aabb2d_zero(vec2 aabb[2]) {
+  glm_aabb2d_zero(aabb);
+}
+
 CGLM_EXPORT
 void
 glmc_aabb2d_copy(vec2 aabb[2], vec2 dest[2]) {