summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-09-18 10:35:38 -0700
committerCedric BAIL <cedric@osg.samsung.com>2017-09-18 11:18:43 -0700
commit224b75b46dfa8b99da483394750633161bd70ed1 (patch)
treeee2b39f1b9b70093d57681e46cb9e63c15eeb1c8 /src/lib
parent128130285ad31b338a3ce25c2ccc23fe3e04d5fe (diff)
eina: document matrix3 multiplication routines
Reviewers: cedric Reviewed By: cedric Subscribers: cedric, jpeg Differential Revision: https://phab.enlightenment.org/D5200 Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/eina/eina_matrix.h23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/lib/eina/eina_matrix.h b/src/lib/eina/eina_matrix.h
index f04b175..377986e 100644
--- a/src/lib/eina/eina_matrix.h
+++ b/src/lib/eina/eina_matrix.h
@@ -178,6 +178,18 @@ struct _Eina_Matrix3_F16p16
178EAPI void eina_matrix3_f16p16_identity(Eina_Matrix3_F16p16 *m); 178EAPI void eina_matrix3_f16p16_identity(Eina_Matrix3_F16p16 *m);
179 179
180/** 180/**
181 * @brief Sets dst as the matrix multiplication (composition) of two
182 * Eina_F16p16 matrices.
183 *
184 * In matrix multiplication, AB, the resultant matrix is created from
185 * the rows of A multiplied against the columns of B and summed. This
186 * is not a cummutative; i.e. AB != BA, so the ordering of arguments
187 * @p m1 and @p m2 matters.
188 *
189 * @param[in] m1 The first matrix. Must be non-NULL.
190 * @param[in] m2 The second matrix. Must be non-NULL.
191 * @param[out] dst The matrix for the results to be placed.
192 *
181 * @since 1.14 193 * @since 1.14
182 */ 194 */
183EAPI void eina_matrix3_f16p16_compose(const Eina_Matrix3_F16p16 *m1, 195EAPI void eina_matrix3_f16p16_compose(const Eina_Matrix3_F16p16 *m1,
@@ -341,6 +353,17 @@ EAPI void eina_matrix3_matrix3_f16p16_to(const Eina_Matrix3 *m,
341EAPI Eina_Bool eina_matrix3_equal(const Eina_Matrix3 *m1, const Eina_Matrix3 *m2); 353EAPI Eina_Bool eina_matrix3_equal(const Eina_Matrix3 *m1, const Eina_Matrix3 *m2);
342 354
343/** 355/**
356 * @brief Sets dst as the matrix multiplication (composition) of two matrices.
357 *
358 * In matrix multiplication, AB, the resultant matrix is created from
359 * the rows of A multiplied against the columns of B and summed. This
360 * is not a cummutative; i.e. AB != BA, so the ordering of arguments
361 * @p m1 and @p m2 matters.
362 *
363 * @param[in] m1 The first matrix. Must be non-NULL.
364 * @param[in] m2 The second matrix. Must be non-NULL.
365 * @param[out] dst The matrix for the results to be placed.
366 *
344 * @since 1.14 367 * @since 1.14
345 */ 368 */
346EAPI void eina_matrix3_compose(const Eina_Matrix3 *m1, 369EAPI void eina_matrix3_compose(const Eina_Matrix3 *m1,