cogl/matrix: Update outdated documentation and comments

No direct access of matrix entries is allowed anymore; and we
use graphene_matrix_t internally.

https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1439
This commit is contained in:
Georges Basile Stavracas Neto 2020-09-11 08:24:24 -03:00
parent 1adc9c7c4a
commit 1c41bfbcbb

View File

@ -59,8 +59,8 @@ G_BEGIN_DECLS
/** /**
* CoglMatrix: * CoglMatrix:
* *
* A CoglMatrix holds a 4x4 transform matrix. This is a single precision, * A CoglMatrix holds a 4x4 transform matrix. It uses #graphene_matrix_t
* column-major matrix which means it is compatible with what OpenGL expects. * internally which means it is compatible with what OpenGL expects.
* *
* A CoglMatrix can represent transforms such as, rotations, scaling, * A CoglMatrix can represent transforms such as, rotations, scaling,
* translation, sheering, and linear projections. You can combine these * translation, sheering, and linear projections. You can combine these
@ -77,20 +77,12 @@ G_BEGIN_DECLS
* ]| * ]|
* *
* Where w is normally 1 * Where w is normally 1
*
* <note>You must consider the members of the CoglMatrix structure read only,
* and all matrix modifications must be done via the cogl_matrix API. This
* allows Cogl to annotate the matrices internally. Violation of this will give
* undefined results. If you need to initialize a matrix with a constant other
* than the identity matrix you can use cogl_matrix_init_from_array().</note>
*/ */
struct _CoglMatrix struct _CoglMatrix
{ {
/*< private >*/ /*< private >*/
graphene_matrix_t m; graphene_matrix_t m;
/* Note: we may want to extend this later with private flags
* and a cache of the inverse transform matrix. */
graphene_matrix_t COGL_PRIVATE (inv); graphene_matrix_t COGL_PRIVATE (inv);
unsigned long COGL_PRIVATE (flags); unsigned long COGL_PRIVATE (flags);
unsigned long COGL_PRIVATE (_padding3); unsigned long COGL_PRIVATE (_padding3);