summaryrefslogtreecommitdiff
path: root/src/cairo-matrix.c
diff options
context:
space:
mode:
authorBenjamin Otte <otte@redhat.com>2010-07-08 13:05:18 +0200
committerBenjamin Otte <otte@redhat.com>2010-07-08 14:27:16 +0200
commitb870cc030d8e0eb6309695e5a101c802f688cf40 (patch)
tree943381b08e5af5a8053d043b1465c0b2340e50a4 /src/cairo-matrix.c
parent65a1e351330106ee0af9f6f0df06b82954341ee6 (diff)
downloadcairo-b870cc030d8e0eb6309695e5a101c802f688cf40.tar.gz
doc: Move tmpl/ docs to inline docs
I did this manually so I could review the docs at the same time. If anyone finds typos or other mistakes I did, please complain to me (or better: fix them).
Diffstat (limited to 'src/cairo-matrix.c')
-rw-r--r--src/cairo-matrix.c23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/cairo-matrix.c b/src/cairo-matrix.c
index 6ae8e62c8..2536ebffd 100644
--- a/src/cairo-matrix.c
+++ b/src/cairo-matrix.c
@@ -43,6 +43,29 @@
#define ISFINITE(x) ((x) * (x) >= 0.) /* check for NaNs */
#endif
+/**
+ * SECTION:cairo-matrix
+ * @Title: cairo_matrix_t
+ * @Short_Description: Generic matrix operations
+ * @See_Also: #cairo_t
+ *
+ * #cairo_matrix_t is used throughout cairo to convert between different
+ * coordinate spaces. A #cairo_matrix_t holds an affine transformation,
+ * such as a scale, rotation, shear, or a combination of these.
+ * The transformation of a point (<literal>x</literal>,<literal>y</literal>)
+ * is given by:
+ *
+ * <programlisting>
+ * x_new = xx * x + xy * y + x0;
+ * y_new = yx * x + yy * y + y0;
+ * </programlisting>
+ *
+ * The current transformation matrix of a #cairo_t, represented as a
+ * #cairo_matrix_t, defines the transformation from user-space
+ * coordinates to device-space coordinates. See cairo_get_matrix() and
+ * cairo_set_matrix().
+ */
+
static void
_cairo_matrix_scalar_multiply (cairo_matrix_t *matrix, double scalar);