From 047138321ccf7c813d5b51c6787f5c7336a366d6 Mon Sep 17 00:00:00 2001 From: Vincent Davis Jr Date: Sat, 9 Dec 2023 14:23:19 -0500 Subject: [PATCH] docs: 2/2 fixes https://github.com/recp/cglm/issues/371 Second commit for fixing non-square matrix multiplication docs. Signed-off-by: Vincent Davis Jr --- docs/source/mat2x3.rst | 10 ++++------ docs/source/mat2x4.rst | 10 ++++------ docs/source/mat3x2.rst | 10 ++++------ docs/source/mat3x4.rst | 10 ++++------ docs/source/mat4x2.rst | 10 ++++------ docs/source/mat4x3.rst | 10 ++++------ 6 files changed, 24 insertions(+), 36 deletions(-) diff --git a/docs/source/mat2x3.rst b/docs/source/mat2x3.rst index 99ab6d5..84828c8 100644 --- a/docs/source/mat2x3.rst +++ b/docs/source/mat2x3.rst @@ -55,16 +55,14 @@ Functions documentation multiply m1 and m2 to dest - m1, m2 and dest matrices can be same matrix, it is possible to write this: - .. code-block:: c - glm_mat2x3_mul(m, m, m); + glm_mat2x3_mul(mat2x3, mat3x2, mat2); Parameters: - | *[in]* **m1** left matrix - | *[in]* **m2** right matrix - | *[out]* **dest** destination matrix + | *[in]* **m1** left matrix (mat2x3) + | *[in]* **m2** right matrix (mat3x2) + | *[out]* **dest** destination matrix (mat2) .. c:function:: void glm_mat2x3_mulv(mat2x3 m, vec3 v, vec2 dest) diff --git a/docs/source/mat2x4.rst b/docs/source/mat2x4.rst index efb79de..0311084 100644 --- a/docs/source/mat2x4.rst +++ b/docs/source/mat2x4.rst @@ -55,16 +55,14 @@ Functions documentation multiply m1 and m2 to dest - m1, m2 and dest matrices can be same matrix, it is possible to write this: - .. code-block:: c - glm_mat2x4_mul(m, m, m); + glm_mat2x4_mul(mat2x4, mat4x2, mat2); Parameters: - | *[in]* **m1** left matrix - | *[in]* **m2** right matrix - | *[out]* **dest** destination matrix + | *[in]* **m1** left matrix (mat2x4) + | *[in]* **m2** right matrix (mat4x2) + | *[out]* **dest** destination matrix (mat2) .. c:function:: void glm_mat2x4_mulv(mat2x4 m, vec4 v, vec2 dest) diff --git a/docs/source/mat3x2.rst b/docs/source/mat3x2.rst index 0a9cb87..c3e2c21 100644 --- a/docs/source/mat3x2.rst +++ b/docs/source/mat3x2.rst @@ -54,16 +54,14 @@ Functions documentation multiply m1 and m2 to dest - m1, m2 and dest matrices can be same matrix, it is possible to write this: - .. code-block:: c - glm_mat3x2_mul(m, m, m); + glm_mat3x2_mul(mat3x2, mat2x3, mat3); Parameters: - | *[in]* **m1** left matrix - | *[in]* **m2** right matrix - | *[out]* **dest** destination matrix + | *[in]* **m1** left matrix (mat3x2) + | *[in]* **m2** right matrix (mat2x3) + | *[out]* **dest** destination matrix (mat3) .. c:function:: void glm_mat3x2_mulv(mat3x2 m, vec2 v, vec3 dest) diff --git a/docs/source/mat3x4.rst b/docs/source/mat3x4.rst index 8afaff0..042c030 100644 --- a/docs/source/mat3x4.rst +++ b/docs/source/mat3x4.rst @@ -54,16 +54,14 @@ Functions documentation multiply m1 and m2 to dest - m1, m2 and dest matrices can be same matrix, it is possible to write this: - .. code-block:: c - glm_mat3x4_mul(m, m, m); + glm_mat3x4_mul(mat3x4, mat4x3, mat3); Parameters: - | *[in]* **m1** left matrix - | *[in]* **m2** right matrix - | *[out]* **dest** destination matrix + | *[in]* **m1** left matrix (mat3x4) + | *[in]* **m2** right matrix (mat4x3) + | *[out]* **dest** destination matrix (mat3) .. c:function:: void glm_mat3x4_mulv(mat3x4 m, vec4 v, vec3 dest) diff --git a/docs/source/mat4x2.rst b/docs/source/mat4x2.rst index ccda3ac..f4c71d2 100644 --- a/docs/source/mat4x2.rst +++ b/docs/source/mat4x2.rst @@ -54,16 +54,14 @@ Functions documentation multiply m1 and m2 to dest - m1, m2 and dest matrices can be same matrix, it is possible to write this: - .. code-block:: c - glm_mat4x2_mul(m, m, m); + glm_mat4x2_mul(mat4x2, mat2x4, mat4); Parameters: - | *[in]* **m1** left matrix - | *[in]* **m2** right matrix - | *[out]* **dest** destination matrix + | *[in]* **m1** left matrix (mat4x2) + | *[in]* **m2** right matrix (mat2x4) + | *[out]* **dest** destination matrix (mat4) .. c:function:: void glm_mat4x2_mulv(mat4x2 m, vec2 v, vec4 dest) diff --git a/docs/source/mat4x3.rst b/docs/source/mat4x3.rst index 7284045..84c9196 100644 --- a/docs/source/mat4x3.rst +++ b/docs/source/mat4x3.rst @@ -54,16 +54,14 @@ Functions documentation multiply m1 and m2 to dest - m1, m2 and dest matrices can be same matrix, it is possible to write this: - .. code-block:: c - glm_mat4x3_mul(m, m, m); + glm_mat4x3_mul(mat4x3, mat3x4, mat4); Parameters: - | *[in]* **m1** left matrix - | *[in]* **m2** right matrix - | *[out]* **dest** destination matrix + | *[in]* **m1** left matrix (mat4x3) + | *[in]* **m2** right matrix (mat3x4) + | *[out]* **dest** destination matrix (mat4) .. c:function:: void glm_mat4x3_mulv(mat4x3 m, vec3 v, vec4 dest)