[cogl-matrix] Documents that CoglMatrix members should be considered read only

In the future if we want to annotate matrices with internal flags, and add
caching of the inverse matrix then we need to ensure that all matrix
modifications are done by cogl_matrix API so we'd know when to dirty the
cache or update the flags.

This just adds documentation to that effect, and assuming the most likley
case where someone would try and directly write to matrix members would
probably be to load a constant matrix other than the identity matrix; I
renamed cogl_matrix_init_from_gl_matrix to cogl_matrix_init_from_array to
make it seem more general purpose.

1 files changed, 3 insertions, 3 deletions

diff --git a/common/cogl-matrix.c b/common/cogl-matrix.c
index 26b6b926..a99473da 100644
--- a/common/cogl-matrix.c
+++ b/common/cogl-matrix.c
@@ -141,13 +141,13 @@ cogl_matrix_transform_point (const CoglMatrix *matrix,
 }
 
 void
-cogl_matrix_init_from_gl_matrix (CoglMatrix *matrix, const float *gl_matrix)
+cogl_matrix_init_from_array (CoglMatrix *matrix, const float *array)
 {
-  memcpy (matrix, gl_matrix, sizeof (float) * 16);
+  memcpy (matrix, array, sizeof (float) * 16);
 }
 
 const float *
-cogl_matrix_get_gl_matrix (const CoglMatrix *matrix)
+cogl_matrix_get_array (const CoglMatrix *matrix)
 {
   return (float *)matrix;
 }