X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fmath%2Fmatrix3.h;h=2c3ee6c0a69098fabeb20d2ae4cf7d26519a719d;hb=649ec06daecb510fb84fe4642a6af957f127e7ab;hp=16b52ebe0f445565369abdc1ad2501e87ec64159;hpb=0e7af4e7ad32c026530d0576e1eb0e4929ea4825;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/math/matrix3.h b/dali/public-api/math/matrix3.h index 16b52eb..2c3ee6c 100644 --- a/dali/public-api/math/matrix3.h +++ b/dali/public-api/math/matrix3.h @@ -36,6 +36,20 @@ struct Vector2; /** * @brief A 3x3 matrix. * + * The matrix is stored as a flat array and is Column Major, i.e. the storage order is as follows (numbers represent + * indices of array): + * + * @code + * + * 0 3 6 + * 1 4 7 + * 2 5 8 + * + * @endcode + * + * Each axis is contiguous in memory, so the x-axis corresponds to elements 0, 1 and 2, the y-axis corresponds to + * elements 3, 4 and 5, and the z-axis corresponds to elements 6, 7 and 8. + * * @SINCE_1_0.0 */ class DALI_CORE_API Matrix3 @@ -145,11 +159,7 @@ public: * The order of the values for a matrix is: * * @code - * - * xAxis.x yAxis.x zAxis.x - * xAxis.y yAxis.y zAxis.y - * xAxis.z yAxis.z zAxis.z - * + * [ xAxis.x, xAxis.y, xAxis.z, yAxis.x, yAxis.y, yAxis.z, zAxis.x, zAxis.y, zAxis.z ] * @endcode * * @SINCE_1_0.0 @@ -160,13 +170,10 @@ public: /** * @brief Returns the contents of the matrix as an array of 9 floats. * - * @code - * * The order of the values for a matrix is: - * xAxis.x yAxis.x zAxis.x - * xAxis.y yAxis.y zAxis.y - * xAxis.z yAxis.z zAxis.z * + * @code + * [ xAxis.x, xAxis.y, xAxis.z, yAxis.x, yAxis.y, yAxis.z, zAxis.x, zAxis.y, zAxis.z ] * @endcode * * @SINCE_1_0.0 @@ -194,7 +201,6 @@ public: * * @SINCE_1_0.0 * @param[in] scale The value by which to scale the whole matrix - * */ void Scale(float scale); @@ -224,6 +230,9 @@ public: * @brief Function to multiply two matrices and store the result onto third. * * Use this method in time critical path as it does not require temporaries + * + * result = rhs * lhs + * * @SINCE_1_0.0 * @param[out] result Result of the multiplication * @param[in] lhs Matrix, this can be same matrix as result