mirror of
https://github.com/recp/cglm.git
synced 2025-10-04 01:00:46 +00:00
047138321c
Second commit for fixing non-square matrix multiplication docs. Signed-off-by: Vincent Davis Jr <vince@underview.tech>
90 lines
2.1 KiB
ReStructuredText
90 lines
2.1 KiB
ReStructuredText
.. 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`
|
|
|
|
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(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, mat3 dest)
|
|
|
|
multiply m1 and m2 to dest
|
|
|
|
.. code-block:: c
|
|
|
|
glm_mat3x2_mul(mat3x2, mat2x3, mat3);
|
|
|
|
Parameters:
|
|
| *[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)
|
|
|
|
multiply mat3x2 with vec2 (column vector) and store in dest vector
|
|
|
|
Parameters:
|
|
| *[in]* **m** mat3x2 (left)
|
|
| *[in]* **v** vec3 (right, column vector)
|
|
| *[out]* **dest** destination (result, column vector)
|
|
|
|
.. 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
|