Vulkan spec

2026-05-25 11:04:30 +01:00
commit d86a518b7d
375 changed files with 77089 additions and 0 deletions
@@ -0,0 +1,137 @@
+.. default-domain:: C
+
+mat3x2
+======
+
+Header: cglm/mat3x2.h
+
+Table of contents (click to go):
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Macros:
+
+1. GLM_MAT3X2_ZERO_INIT
+#. GLM_MAT3X2_ZERO
+
+Functions:
+
+1. :c:func:`glm_mat3x2_copy`
+#. :c:func:`glm_mat3x2_zero`
+#. :c:func:`glm_mat3x2_make`
+#. :c:func:`glm_mat3x2_mul`
+#. :c:func:`glm_mat3x2_mulv`
+#. :c:func:`glm_mat3x2_transpose`
+#. :c:func:`glm_mat3x2_scale`
+
+Represented
+~~~~~~~~~~~
+
+.. csv-table:: mat3x2
+   :header: "", "column 1", "column 2", "column 3"
+
+   "row 1", "m00", "m10", "m20"
+   "row 2", "m01", "m11", "m21"
+
+Functions documentation
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. c:function:: void glm_mat3x2_copy(mat3x2 mat, mat3x2 dest)
+
+    copy mat3x2 to another one (dest).
+
+    Parameters:
+      | *[in]*  **mat**   source
+      | *[out]* **dest**  destination
+
+.. c:function:: void glm_mat3x2_zero(mat3x2 mat)
+
+    make given matrix zero
+
+    Parameters:
+      | *[in,out]* **mat**  matrix
+
+.. c:function:: void glm_mat3x2_make(const float * __restrict src, mat3x2 dest)
+
+    Create mat3x2 matrix from pointer
+
+    .. note:: **@src** must contain at least 6 elements.
+
+    Parameters:
+      | *[in]*  **src**  pointer to an array of floats
+      | *[out]* **dest** destination matrix3x2
+
+.. c:function:: void glm_mat3x2_mul(mat3x2 m1, mat2x3 m2, mat2 dest)
+
+    multiply m1 and m2 to dest
+
+    .. code-block:: c
+
+       glm_mat3x2_mul(mat3x2, mat2x3, mat2);
+
+    Parameters:
+      | *[in]*  **m1**    left matrix (mat3x2)
+      | *[in]*  **m2**    right matrix (mat2x3)
+      | *[out]* **dest**  destination matrix (mat2)
+
+    .. csv-table:: mat3x2
+        :header: "", "column 1", "column 2", "column 3"
+
+        "row 1", "a00", "a10", "a20"
+        "row 2", "a01", "a11", "a21"
+
+    .. csv-table:: mat2x3
+        :header: "", "column 1", "column 2"
+
+        "row 1", "b00", "b10"
+        "row 2", "b01", "b11"
+        "row 3", "b02", "b12"
+
+    .. csv-table:: mat2x2
+        :header: "", "column 1", "column 2"
+
+        "row 1", "a00 * b00 + a10 * b01 + a20 * b02", "a00 * b10 + a10 * b11 + a20 * b12"
+        "row 2", "a01 * b00 + a11 * b01 + a21 * b02", "a01 * b10 + a11 * b11 + a21 * b12"
+
+.. c:function:: void glm_mat3x2_mulv(mat3x2 m, vec3 v, vec2 dest)
+
+    multiply mat3x2 with vec3 (column vector) and store in dest vector
+
+    Parameters:
+      | *[in]*  **m**     mat3x2 (left)
+      | *[in]*  **v**     vec3 (right, column vector)
+      | *[out]* **dest**  destination (result, column vector)
+
+    .. csv-table:: mat3x2
+        :header: "", "column 1", "column 2", "column 3"
+
+        "row 1", "m00", "m10", "m20"
+        "row 2", "m01", "m11", "m21"
+
+    .. csv-table:: column vec3 (1x3)
+        :header: "", "column 1"
+
+        "row 1", "v0"
+        "row 2", "v1"
+        "row 3", "v2"
+
+    .. csv-table:: column vec2 (1x2)
+        :header: "", "column 1"
+
+        "row 1", "m00 * v0 + m10 * v1 + m20 * v2"
+        "row 2", "m01 * v0 + m11 * v1 + m21 * v2"
+
+.. c:function:: void glm_mat3x2_transpose(mat3x2 m, mat2x3 dest)
+
+    transpose matrix and store in dest
+
+    Parameters:
+      | *[in]*  **m**     matrix
+      | *[out]* **dest**  destination
+
+.. c:function:: void  glm_mat3x2_scale(mat3x2 m, float s)
+
+    multiply matrix with scalar
+
+    Parameters:
+      | *[in, out]* **m** matrix
+      | *[in]*      **s** scalar