[cairo-commit] cairo/doc/public/tmpl .cvsignore, NONE, 1.1 cairo-atsui.sgml, NONE, 1.1 cairo-ft.sgml, NONE, 1.1 cairo-glitz.sgml, NONE, 1.1 cairo-matrix.sgml, NONE, 1.1 cairo-pattern.sgml, NONE, 1.1 cairo-pdf.sgml, NONE, 1.1 cairo-png.sgml, NONE, 1.1 cairo-ps.sgml, NONE, 1.1 cairo-quartz.sgml, NONE, 1.1 cairo-surface.sgml, NONE, 1.1 cairo-xcb.sgml, NONE, 1.1 cairo-xlib.sgml, NONE, 1.1 cairo.sgml, NONE, 1.1

[Owen Taylor]

Committed by: otaylor

Update of /cvs/cairo/cairo/doc/public/tmpl
In directory gabe:/tmp/cvs-serv29685/doc/public/tmpl

Added Files:
	.cvsignore cairo-atsui.sgml cairo-ft.sgml cairo-glitz.sgml 
	cairo-matrix.sgml cairo-pattern.sgml cairo-pdf.sgml 
	cairo-png.sgml cairo-ps.sgml cairo-quartz.sgml 
	cairo-surface.sgml cairo-xcb.sgml cairo-xlib.sgml cairo.sgml 
Log Message:
2005-01-27  Owen Taylor  <otaylor at redhat.com>

        * configure.in Makefile.am docs/Makefile.am docs/public/*:
        Add framework for doing docs via gtk-doc.

        * src/cairo.[ch] src/cairo-matrix.c: Add some inline docs
        for arcs and matrices.

        * gtk-doc.m4 acinclude.m4: Check in files from gtk-doc
        to make the dependency on gtk-doc optional.

        * autogen.sh (LANG): Add --enable-gtk-doc to the default
        args.


--- NEW FILE: .cvsignore ---
cairo-unused.sgml

--- NEW FILE: cairo-atsui.sgml ---
<!-- ##### SECTION Title ##### -->
ATSUI Fonts

<!-- ##### SECTION Short_Description ##### -->


<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### FUNCTION cairo_atsui_font_create ##### -->
<para>

</para>

@style: 
@Returns: 



--- NEW FILE: cairo-ft.sgml ---
<!-- ##### SECTION Title ##### -->
FreeType Fonts

<!-- ##### SECTION Short_Description ##### -->


<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### FUNCTION cairo_ft_font_create ##### -->
<para>

</para>

@pattern: 
@scale: 
@Returns: 


<!-- ##### FUNCTION cairo_ft_font_create_for_ft_face ##### -->
<para>

</para>

@face: 
@load_flags: 
@scale: 
@Returns: 


<!-- ##### FUNCTION cairo_ft_font_lock_face ##### -->
<para>

</para>

@ft_font: 
@Returns: 


<!-- ##### FUNCTION cairo_ft_font_unlock_face ##### -->
<para>

</para>

@ft_font: 


<!-- ##### FUNCTION cairo_ft_font_get_pattern ##### -->
<para>

</para>

@ft_font: 
@Returns: 



--- NEW FILE: cairo-glitz.sgml ---
<!-- ##### SECTION Title ##### -->
Glitz backend

<!-- ##### SECTION Short_Description ##### -->


<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### FUNCTION cairo_set_target_glitz ##### -->
<para>

</para>

@cr: 
@surface: 


<!-- ##### FUNCTION cairo_glitz_surface_create ##### -->
<para>

</para>

@surface: 
@Returns: 



--- NEW FILE: cairo-matrix.sgml ---
<!-- ##### 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:
-->



--- NEW FILE: cairo-pattern.sgml ---
<!-- ##### SECTION Title ##### -->
cairo_pattern_t

<!-- ##### SECTION Short_Description ##### -->


<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### TYPEDEF cairo_pattern_t ##### -->
<para>

</para>


<!-- ##### FUNCTION cairo_pattern_create_for_surface ##### -->
<para>

</para>

@surface: 
@Returns: 


<!-- ##### FUNCTION cairo_pattern_create_linear ##### -->
<para>

</para>

@x0: 
@y0: 
@x1: 
@y1: 
@Returns: 


<!-- ##### FUNCTION cairo_pattern_create_radial ##### -->
<para>

</para>

@cx0: 
@cy0: 
@radius0: 
@cx1: 
@cy1: 
@radius1: 
@Returns: 


<!-- ##### FUNCTION cairo_pattern_reference ##### -->
<para>

</para>

@pattern: 


<!-- ##### FUNCTION cairo_pattern_destroy ##### -->
<para>

</para>

@pattern: 


<!-- ##### FUNCTION cairo_pattern_add_color_stop ##### -->
<para>

</para>

@pattern: 
@offset: 
@red: 
@green: 
@blue: 
@alpha: 
@Returns: 


<!-- ##### FUNCTION cairo_pattern_set_matrix ##### -->
<para>

</para>

@pattern: 
@matrix: 
@Returns: 


<!-- ##### FUNCTION cairo_pattern_get_matrix ##### -->
<para>

</para>

@pattern: 
@matrix: 
@Returns: 


<!-- ##### ENUM cairo_extend_t ##### -->
<para>

</para>

@CAIRO_EXTEND_NONE: 
@CAIRO_EXTEND_REPEAT: 
@CAIRO_EXTEND_REFLECT: 

<!-- ##### FUNCTION cairo_pattern_set_extend ##### -->
<para>

</para>

@pattern: 
@extend: 
@Returns: 


<!-- ##### FUNCTION cairo_pattern_get_extend ##### -->
<para>

</para>

@pattern: 
@Returns: 


<!-- ##### FUNCTION cairo_pattern_set_filter ##### -->
<para>

</para>

@pattern: 
@filter: 
@Returns: 


<!-- ##### FUNCTION cairo_pattern_get_filter ##### -->
<para>

</para>

@pattern: 
@Returns: 



--- NEW FILE: cairo-pdf.sgml ---
<!-- ##### SECTION Title ##### -->
PDF Backend

<!-- ##### SECTION Short_Description ##### -->


<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### FUNCTION cairo_set_target_pdf ##### -->
<para>

</para>

@cr: 
@file: 
@width_inches: 
@height_inches: 
@x_pixels_per_inch: 
@y_pixels_per_inch: 


<!-- ##### FUNCTION cairo_pdf_surface_create ##### -->
<para>

</para>

@file: 
@width_inches: 
@height_inches: 
@x_pixels_per_inch: 
@y_pixels_per_inch: 
@Returns: 



--- NEW FILE: cairo-png.sgml ---
<!-- ##### SECTION Title ##### -->
PNG Backend

<!-- ##### SECTION Short_Description ##### -->


<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### FUNCTION cairo_set_target_png ##### -->
<para>

</para>

@cr: 
@file: 
@format: 
@width: 
@height: 


<!-- ##### FUNCTION cairo_png_surface_create ##### -->
<para>

</para>

@file: 
@format: 
@width: 
@height: 
@Returns: 



--- NEW FILE: cairo-ps.sgml ---
<!-- ##### SECTION Title ##### -->
PS Backend

<!-- ##### SECTION Short_Description ##### -->


<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### FUNCTION cairo_set_target_ps ##### -->
<para>

</para>

@cr: 
@file: 
@width_inches: 
@height_inches: 
@x_pixels_per_inch: 
@y_pixels_per_inch: 


<!-- ##### FUNCTION cairo_ps_surface_create ##### -->
<para>

</para>

@file: 
@width_inches: 
@height_inches: 
@x_pixels_per_inch: 
@y_pixels_per_inch: 
@Returns: 



--- NEW FILE: cairo-quartz.sgml ---
<!-- ##### SECTION Title ##### -->
Quartz Backend

<!-- ##### SECTION Short_Description ##### -->


<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### FUNCTION cairo_set_target_quartz_context ##### -->
<para>

</para>

@cr: 
@context: 
@width: 
@height: 


<!-- ##### FUNCTION cairo_quartz_surface_create ##### -->
<para>

</para>

@context: 
@width: 
@height: 
@Returns: 



--- NEW FILE: cairo-surface.sgml ---
<!-- ##### SECTION Title ##### -->
cairo_surface_t

<!-- ##### SECTION Short_Description ##### -->


<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### TYPEDEF cairo_surface_t ##### -->
<para>

</para>


<!-- ##### FUNCTION cairo_surface_create_for_image ##### -->
<para>

</para>

@data: 
@format: 
@width: 
@height: 
@stride: 
@Returns: 


<!-- ##### FUNCTION cairo_surface_create_similar ##### -->
<para>

</para>

@other: 
@format: 
@width: 
@height: 
@Returns: 


<!-- ##### FUNCTION cairo_surface_reference ##### -->
<para>

</para>

@surface: 


<!-- ##### FUNCTION cairo_surface_destroy ##### -->
<para>

</para>

@surface: 


<!-- ##### FUNCTION cairo_surface_set_repeat ##### -->
<para>

</para>

@surface: 
@repeat: 
@Returns: 


<!-- ##### FUNCTION cairo_surface_set_matrix ##### -->
<para>

</para>

@surface: 
@matrix: 
@Returns: 


<!-- ##### FUNCTION cairo_surface_get_matrix ##### -->
<para>

</para>

@surface: 
@matrix: 
@Returns: 


<!-- ##### FUNCTION cairo_surface_set_filter ##### -->
<para>

</para>

@surface: 
@filter: 
@Returns: 


<!-- ##### FUNCTION cairo_surface_get_filter ##### -->
<para>

</para>

@surface: 
@Returns: 



--- NEW FILE: cairo-xcb.sgml ---
<!-- ##### SECTION Title ##### -->
XCB Backend

<!-- ##### SECTION Short_Description ##### -->


<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### FUNCTION cairo_set_target_xcb ##### -->
<para>

</para>

@cr: 
@dpy: 
@drawable: 
@visual: 
@format: 



--- NEW FILE: cairo-xlib.sgml ---
<!-- ##### SECTION Title ##### -->
XLib Backend

<!-- ##### SECTION Short_Description ##### -->


<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### FUNCTION cairo_set_target_drawable ##### -->
<para>

</para>

@cr: 
@dpy: 
@drawable: 


<!-- ##### FUNCTION cairo_xlib_surface_create ##### -->
<para>

</para>

@dpy: 
@drawable: 
@visual: 
@format: 
@colormap: 
@Returns: 



--- NEW FILE: cairo.sgml ---
<!-- ##### SECTION Title ##### -->
cairo_t

<!-- ##### SECTION Short_Description ##### -->
Drawing contexts.

<!-- ##### SECTION Long_Description ##### -->

  <para>
    #cairo_t is the main object used when drawing with Cairo. To
    draw with Cairo, you create a #cairo_t, set the target surface,
    and drawing options for the #cairo_t, create shapes with
    functions like cairo_move_to() and cairo_line_to(), and then
    draw ships with cairo_stroke() or cairo_fill().
  </para>
  <para>
    #cairo_t<!-- -->'s can be pushed to a stack via cairo_save().
    They may then safely be changed, without loosing the current state.
    Use cairo_restore() to restore to the saved state.
[...973 lines suppressed...]

</para>

@data: 
@format: 
@width: 
@height: 
@stride: 
@Returns: 



<!--
Local variables:
mode: sgml
sgml-parent-document: ("../cairo-docs.xml" "book" "refsect2" "")
End:
-->