diff options
Diffstat (limited to 'doc/public/tmpl/cairo-matrix.sgml')
-rw-r--r-- | doc/public/tmpl/cairo-matrix.sgml | 193 |
1 files changed, 193 insertions, 0 deletions
diff --git a/doc/public/tmpl/cairo-matrix.sgml b/doc/public/tmpl/cairo-matrix.sgml new file mode 100644 index 000000000..dc24c5754 --- /dev/null +++ b/doc/public/tmpl/cairo-matrix.sgml @@ -0,0 +1,193 @@ +<!-- ##### SECTION Title ##### --> +cairo_matrix_t + +<!-- ##### SECTION Short_Description ##### --> + + Transformation matrices + +<!-- ##### SECTION Long_Description ##### --> + + <para><indexterm><primary>types</primary><secondary>cairo_matrix</secondary></indexterm><indexterm><primary/></indexterm> + <structname>cairo_matrix_t</structname> is used throughout + Cairo to represents between different coordinates spaces. + A <structname>cairo_matrix</structname> holds an affine + transformation, such as a scale, rotation, or shear, or a + combination of those. Mathematically, the effect of an affine + transformation on a point (<literal>x</literal>,<literal>y</literal>) is given by: + </para> + <programlisting> + x_new = x * a + y * c + tx; + y_new = x * b + y * d + ty; + </programlisting> + <para> + The parameters <literal>a</literal>, <literal>b</literal>, + <literal>c</literal>, <literal>d</literal>, <literal>tx</literal>, + <literal>ty</literal> can be retrieved with + cairo_matrix_get_affine() and set with cairo_matrix_get_affine(). + </para> + <para> + The primary use of transformation matrices in Cairo is as the + current transformation matrix in a #cairo_t. The current + transformation matrix gives the transformation from user space + coordinates to device coordinates. See cairo_set_matrix(), + cairo_current_matrix(). + </para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### TYPEDEF cairo_matrix_t ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION cairo_matrix_create ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION cairo_matrix_destroy ##### --> +<para> + +</para> + +@matrix: + + +<!-- ##### FUNCTION cairo_matrix_copy ##### --> +<para> + +</para> + +@matrix: +@other: +@Returns: + + +<!-- ##### FUNCTION cairo_matrix_set_identity ##### --> +<para> + +</para> + +@matrix: +@Returns: + + +<!-- ##### FUNCTION cairo_matrix_set_affine ##### --> +<para> + +</para> + +@matrix: +@a: +@b: +@c: +@d: +@tx: +@ty: +@Returns: +<!-- # Unused Parameters # --> +@cr: + + +<!-- ##### FUNCTION cairo_matrix_get_affine ##### --> +<para> + +</para> + +@matrix: +@a: +@b: +@c: +@d: +@tx: +@ty: +@Returns: + + +<!-- ##### FUNCTION cairo_matrix_translate ##### --> +<para> + +</para> + +@matrix: +@tx: +@ty: +@Returns: + + +<!-- ##### FUNCTION cairo_matrix_scale ##### --> +<para> + +</para> + +@matrix: +@sx: +@sy: +@Returns: + + +<!-- ##### FUNCTION cairo_matrix_rotate ##### --> +<para> + +</para> + +@matrix: +@radians: +@Returns: + + +<!-- ##### FUNCTION cairo_matrix_invert ##### --> +<para> + +</para> + +@matrix: +@Returns: + + +<!-- ##### FUNCTION cairo_matrix_multiply ##### --> +<para> + +</para> + +@result: +@a: +@b: +@Returns: + + +<!-- ##### FUNCTION cairo_matrix_transform_distance ##### --> +<para> + +</para> + +@matrix: +@dx: +@dy: +@Returns: + + +<!-- ##### FUNCTION cairo_matrix_transform_point ##### --> +<para> +</para> + +@matrix: +@x: +@y: +@Returns: + +<!-- +Local variables: +mode: sgml +sgml-parent-document: ("../cairo-docs.xml" "book" "refsect2" "") +End: +--> + + |