diff options
Diffstat (limited to 'doc/public')
-rw-r--r-- | doc/public/.cvsignore | 15 | ||||
-rw-r--r-- | doc/public/Makefile.am | 46 | ||||
-rw-r--r-- | doc/public/cairo-docs.xml | 31 | ||||
-rw-r--r-- | doc/public/cairo-overrides.txt | 0 | ||||
-rw-r--r-- | doc/public/cairo-sections.txt | 251 | ||||
-rw-r--r-- | doc/public/cairo.types | 0 | ||||
-rw-r--r-- | doc/public/tmpl/.cvsignore | 1 | ||||
-rw-r--r-- | doc/public/tmpl/cairo-atsui.sgml | 25 | ||||
-rw-r--r-- | doc/public/tmpl/cairo-ft.sgml | 63 | ||||
-rw-r--r-- | doc/public/tmpl/cairo-glitz.sgml | 34 | ||||
-rw-r--r-- | doc/public/tmpl/cairo-matrix.sgml | 193 | ||||
-rw-r--r-- | doc/public/tmpl/cairo-pattern.sgml | 154 | ||||
-rw-r--r-- | doc/public/tmpl/cairo-pdf.sgml | 42 | ||||
-rw-r--r-- | doc/public/tmpl/cairo-png.sgml | 40 | ||||
-rw-r--r-- | doc/public/tmpl/cairo-ps.sgml | 42 | ||||
-rw-r--r-- | doc/public/tmpl/cairo-quartz.sgml | 38 | ||||
-rw-r--r-- | doc/public/tmpl/cairo-surface.sgml | 112 | ||||
-rw-r--r-- | doc/public/tmpl/cairo-xcb.sgml | 28 | ||||
-rw-r--r-- | doc/public/tmpl/cairo-xlib.sgml | 39 | ||||
-rw-r--r-- | doc/public/tmpl/cairo.sgml | 1019 |
20 files changed, 2173 insertions, 0 deletions
diff --git a/doc/public/.cvsignore b/doc/public/.cvsignore new file mode 100644 index 000000000..35479d5e3 --- /dev/null +++ b/doc/public/.cvsignore @@ -0,0 +1,15 @@ +*.stamp +Makefile +Makefile.in +cairo-decl-list.txt +cairo-decl.txt +cairo-undocumented.txt +cairo-unused.txt +cairo.hierarchy +cairo.interfaces +cairo.prerequisites +cairo.args +cairo.signals +html +xml + diff --git a/doc/public/Makefile.am b/doc/public/Makefile.am new file mode 100644 index 000000000..b993bb978 --- /dev/null +++ b/doc/public/Makefile.am @@ -0,0 +1,46 @@ +## Process this file with automake to create Makefile.in. + +AUTOMAKE_OPTIONS = 1.7 + +# The name of the module. +DOC_MODULE=cairo + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=cairo-docs.xml + +# Extra options to supply to gtkdoc-scan +SCAN_OPTIONS=--deprecated-guards="CAIRO_DISABLE_DEPRECATED" + +# The directory containing the source code. Relative to $(srcdir) +DOC_SOURCE_DIR=../../src + +# Used for dependencies +HFILE_GLOB=$(top_srcdir)/src/*.h +CFILE_GLOB=$(top_srcdir)/src/*.c $(top_srcdir)/src/*.h + +# Headers to ignore +IGNORE_HFILES= \ + cairo-features.h \ + cairo-ft-private.h \ + cairo-win32-private.h \ + cairoint.h \ + cairo-wideint.h + +# CFLAGS and LDFLAGS for compiling scan program. Only needed +# if $(DOC_MODULE).types is non-empty. +INCLUDES = +GTKDOC_LIBS = + +# Extra options to supply to gtkdoc-mkdb +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE) +content_files = + +# Images to copy into HTML directory +HTML_IMAGES = + +# Extra options to supply to gtkdoc-fixref +FIXXREF_OPTIONS= + +include $(top_srcdir)/gtk-doc.make diff --git a/doc/public/cairo-docs.xml b/doc/public/cairo-docs.xml new file mode 100644 index 000000000..2a4cdae8a --- /dev/null +++ b/doc/public/cairo-docs.xml @@ -0,0 +1,31 @@ +<?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<book lang="en" id="libglade" xmlns:xi="http://www.w3.org/2003/XInclude"> +<title>Cairo: A Vector Graphics Library</title> + <part> + <title>Tutorial</title> + </part> + <part> + <title>Reference</title> + <xi:include href="xml/cairo.xml"/> + <xi:include href="xml/cairo-surface.xml"/> + <xi:include href="xml/cairo-pattern.xml"/> + <xi:include href="xml/cairo-matrix.xml"/> + <xi:include href="xml/cairo-atsui.xml"/> + <xi:include href="xml/cairo-ft.xml"/> + <xi:include href="xml/cairo-glitz.xml"/> + <xi:include href="xml/cairo-pdf.xml"/> + <xi:include href="xml/cairo-png.xml"/> + <xi:include href="xml/cairo-ps.xml"/> + <xi:include href="xml/cairo-quartz.xml"/> + <xi:include href="xml/cairo-win32.xml"/> + <xi:include href="xml/cairo-xcb.xml"/> + <xi:include href="xml/cairo-xlib.xml"/> + </part> +</book> + + + + + diff --git a/doc/public/cairo-overrides.txt b/doc/public/cairo-overrides.txt new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/doc/public/cairo-overrides.txt diff --git a/doc/public/cairo-sections.txt b/doc/public/cairo-sections.txt new file mode 100644 index 000000000..3da0fa801 --- /dev/null +++ b/doc/public/cairo-sections.txt @@ -0,0 +1,251 @@ +<SECTION> +<FILE>cairo-atsui</FILE> +<TITLE>ATSUI Fonts</TITLE> +cairo_atsui_font_create +</SECTION> + +<SECTION> +<FILE>cairo-ft</FILE> +<TITLE>FreeType Fonts</TITLE> +cairo_ft_font_create +cairo_ft_font_create_for_ft_face +cairo_ft_font_lock_face +cairo_ft_font_unlock_face +cairo_ft_font_get_pattern +</SECTION> + +<SECTION> +<FILE>cairo-glitz</FILE> +<TITLE>Glitz backend</TITLE> +cairo_set_target_glitz +cairo_glitz_surface_create +</SECTION> + +<SECTION> +<FILE>cairo-pdf</FILE> +<TITLE>PDF Backend</TITLE> +cairo_set_target_pdf +cairo_pdf_surface_create +</SECTION> + +<SECTION> +<FILE>cairo-png</FILE> +<TITLE>PNG Backend</TITLE> +cairo_set_target_png +cairo_png_surface_create +</SECTION> + +<SECTION> +<FILE>cairo-ps</FILE> +<TITLE>PS Backend</TITLE> +cairo_set_target_ps +cairo_ps_surface_create +</SECTION> + +<SECTION> +<FILE>cairo-quartz</FILE> +<TITLE>Quartz Backend</TITLE> +cairo_set_target_quartz_context +cairo_quartz_surface_create +</SECTION> + +<SECTION> +<FILE>cairo-win32</FILE> +<TITLE>Microsoft Windows Backend</TITLE> +cairo_set_target_win32 +cairo_win32_surface_create +cairo_win32_font_create_for_logfontw +cairo_win32_font_select_font +cairo_win32_font_done_font +cairo_win32_font_get_scale_factor +</SECTION> + +<SECTION> +<FILE>cairo-xcb</FILE> +<TITLE>XCB Backend</TITLE> +cairo_set_target_xcb +</SECTION> + +<SECTION> +<FILE>cairo-xlib</FILE> +<TITLE>XLib Backend</TITLE> +cairo_set_target_drawable +cairo_xlib_surface_create +</SECTION> + +<SECTION> +<FILE>cairo-surface</FILE> +<TITLE>cairo_surface_t</TITLE> +cairo_surface_t +cairo_surface_create_for_image +cairo_surface_create_similar +cairo_surface_reference +cairo_surface_destroy +cairo_surface_set_repeat +cairo_surface_set_matrix +cairo_surface_get_matrix +cairo_surface_set_filter +cairo_surface_get_filter +</SECTION> + +<SECTION> +<FILE>cairo-pattern</FILE> +<TITLE>cairo_pattern_t</TITLE> +cairo_pattern_t +cairo_pattern_create_for_surface +cairo_pattern_create_linear +cairo_pattern_create_radial +cairo_pattern_reference +cairo_pattern_destroy +cairo_pattern_add_color_stop +cairo_pattern_set_matrix +cairo_pattern_get_matrix +cairo_extend_t +cairo_pattern_set_extend +cairo_pattern_get_extend +cairo_pattern_set_filter +cairo_pattern_get_filter +</SECTION> + +<SECTION> +<FILE>cairo-matrix</FILE> +<TITLE>cairo_matrix_t</TITLE> +cairo_matrix_t +cairo_matrix_create +cairo_matrix_destroy +cairo_matrix_copy +cairo_matrix_set_identity +cairo_matrix_set_affine +cairo_matrix_get_affine +cairo_matrix_translate +cairo_matrix_scale +cairo_matrix_rotate +cairo_matrix_invert +cairo_matrix_multiply +cairo_matrix_transform_distance +cairo_matrix_transform_point +</SECTION> + +<SECTION> +<FILE>cairo</FILE> +<TITLE>cairo_t</TITLE> +cairo_t +cairo_create +cairo_reference +cairo_destroy +cairo_save +cairo_restore +cairo_copy +cairo_set_target_surface +cairo_format_t +cairo_set_target_image +cairo_operator_t +cairo_set_operator +cairo_set_rgb_color +cairo_set_pattern +cairo_set_alpha +cairo_set_tolerance +cairo_fill_rule_t +cairo_set_fill_rule +cairo_set_line_width +cairo_line_cap_t +cairo_set_line_cap +cairo_line_join_t +cairo_set_line_join +cairo_set_dash +cairo_set_miter_limit +cairo_translate +cairo_scale +cairo_rotate +cairo_concat_matrix +cairo_set_matrix +cairo_default_matrix +cairo_identity_matrix +cairo_transform_point +cairo_transform_distance +cairo_inverse_transform_point +cairo_inverse_transform_distance +cairo_new_path +cairo_move_to +cairo_line_to +cairo_curve_to +cairo_arc +cairo_arc_negative +cairo_rel_move_to +cairo_rel_line_to +cairo_rel_curve_to +cairo_rectangle +cairo_close_path +cairo_stroke +cairo_fill +cairo_copy_page +cairo_show_page +cairo_in_stroke +cairo_in_fill +cairo_bool_t +cairo_stroke_extents +cairo_fill_extents +cairo_init_clip +cairo_clip +cairo_font_t +cairo_glyph_t +cairo_text_extents_t +cairo_font_extents_t +cairo_font_slant_t +cairo_font_weight_t +cairo_select_font +cairo_scale_font +cairo_transform_font +cairo_show_text +cairo_show_glyphs +cairo_current_font +cairo_current_font_extents +cairo_set_font +cairo_text_extents +cairo_glyph_extents +cairo_text_path +cairo_glyph_path +cairo_font_reference +cairo_font_destroy +cairo_font_extents +cairo_font_glyph_extents +cairo_show_surface +cairo_current_operator +cairo_current_rgb_color +cairo_current_pattern +cairo_current_alpha +cairo_current_tolerance +cairo_current_point +cairo_current_fill_rule +cairo_current_line_width +cairo_current_line_cap +cairo_current_line_join +cairo_current_miter_limit +cairo_current_matrix +cairo_current_target_surface +cairo_current_path +cairo_current_path_flat +cairo_status_t +cairo_status +cairo_status_string +cairo_filter_t +cairo_image_surface_create +cairo_image_surface_create_for_data +<SUBSECTION Private> +CAIRO_BEGIN_DECLS +CAIRO_END_DECLS +cairo_get_operator +cairo_get_rgb_color +cairo_get_alpha +cairo_get_tolerance +cairo_get_current_point +cairo_get_fill_rule +cairo_get_line_width +cairo_get_line_cap +cairo_get_line_join +cairo_get_miter_limit +cairo_get_matrix +cairo_get_target_surface +cairo_get_status +cairo_get_status_string +</SECTION> diff --git a/doc/public/cairo.types b/doc/public/cairo.types new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/doc/public/cairo.types diff --git a/doc/public/tmpl/.cvsignore b/doc/public/tmpl/.cvsignore new file mode 100644 index 000000000..844dc52df --- /dev/null +++ b/doc/public/tmpl/.cvsignore @@ -0,0 +1 @@ +cairo-unused.sgml diff --git a/doc/public/tmpl/cairo-atsui.sgml b/doc/public/tmpl/cairo-atsui.sgml new file mode 100644 index 000000000..0d957ecdf --- /dev/null +++ b/doc/public/tmpl/cairo-atsui.sgml @@ -0,0 +1,25 @@ +<!-- ##### 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: + + diff --git a/doc/public/tmpl/cairo-ft.sgml b/doc/public/tmpl/cairo-ft.sgml new file mode 100644 index 000000000..bcf52ac34 --- /dev/null +++ b/doc/public/tmpl/cairo-ft.sgml @@ -0,0 +1,63 @@ +<!-- ##### 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: + + diff --git a/doc/public/tmpl/cairo-glitz.sgml b/doc/public/tmpl/cairo-glitz.sgml new file mode 100644 index 000000000..101eb9e3e --- /dev/null +++ b/doc/public/tmpl/cairo-glitz.sgml @@ -0,0 +1,34 @@ +<!-- ##### 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: + + 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: +--> + + diff --git a/doc/public/tmpl/cairo-pattern.sgml b/doc/public/tmpl/cairo-pattern.sgml new file mode 100644 index 000000000..84728212b --- /dev/null +++ b/doc/public/tmpl/cairo-pattern.sgml @@ -0,0 +1,154 @@ +<!-- ##### 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: + + diff --git a/doc/public/tmpl/cairo-pdf.sgml b/doc/public/tmpl/cairo-pdf.sgml new file mode 100644 index 000000000..e627c236e --- /dev/null +++ b/doc/public/tmpl/cairo-pdf.sgml @@ -0,0 +1,42 @@ +<!-- ##### 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: + + diff --git a/doc/public/tmpl/cairo-png.sgml b/doc/public/tmpl/cairo-png.sgml new file mode 100644 index 000000000..d4d5a66b5 --- /dev/null +++ b/doc/public/tmpl/cairo-png.sgml @@ -0,0 +1,40 @@ +<!-- ##### 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: + + diff --git a/doc/public/tmpl/cairo-ps.sgml b/doc/public/tmpl/cairo-ps.sgml new file mode 100644 index 000000000..70b2e7e8f --- /dev/null +++ b/doc/public/tmpl/cairo-ps.sgml @@ -0,0 +1,42 @@ +<!-- ##### 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: + + diff --git a/doc/public/tmpl/cairo-quartz.sgml b/doc/public/tmpl/cairo-quartz.sgml new file mode 100644 index 000000000..04c9bc61f --- /dev/null +++ b/doc/public/tmpl/cairo-quartz.sgml @@ -0,0 +1,38 @@ +<!-- ##### 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: + + diff --git a/doc/public/tmpl/cairo-surface.sgml b/doc/public/tmpl/cairo-surface.sgml new file mode 100644 index 000000000..2f8ad470c --- /dev/null +++ b/doc/public/tmpl/cairo-surface.sgml @@ -0,0 +1,112 @@ +<!-- ##### 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: + + diff --git a/doc/public/tmpl/cairo-xcb.sgml b/doc/public/tmpl/cairo-xcb.sgml new file mode 100644 index 000000000..e5e1ee912 --- /dev/null +++ b/doc/public/tmpl/cairo-xcb.sgml @@ -0,0 +1,28 @@ +<!-- ##### 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: + + diff --git a/doc/public/tmpl/cairo-xlib.sgml b/doc/public/tmpl/cairo-xlib.sgml new file mode 100644 index 000000000..b18e76aae --- /dev/null +++ b/doc/public/tmpl/cairo-xlib.sgml @@ -0,0 +1,39 @@ +<!-- ##### 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: + + diff --git a/doc/public/tmpl/cairo.sgml b/doc/public/tmpl/cairo.sgml new file mode 100644 index 000000000..a9e195c73 --- /dev/null +++ b/doc/public/tmpl/cairo.sgml @@ -0,0 +1,1019 @@ +<!-- ##### 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. + </para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### TYPEDEF cairo_t ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION cairo_create ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION cairo_reference ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_destroy ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_save ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_restore ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_copy ##### --> +<para> + +</para> + +@dest: +@src: + + +<!-- ##### FUNCTION cairo_set_target_surface ##### --> +<para> + +</para> + +@cr: +@surface: + + +<!-- ##### ENUM cairo_format_t ##### --> +<para> + +</para> + +@CAIRO_FORMAT_ARGB32: +@CAIRO_FORMAT_RGB24: +@CAIRO_FORMAT_A8: +@CAIRO_FORMAT_A1: + +<!-- ##### FUNCTION cairo_set_target_image ##### --> +<para> + +</para> + +@cr: +@data: +@format: +@width: +@height: +@stride: + + +<!-- ##### ENUM cairo_operator_t ##### --> +<para> + +</para> + +@CAIRO_OPERATOR_CLEAR: +@CAIRO_OPERATOR_SRC: +@CAIRO_OPERATOR_DST: +@CAIRO_OPERATOR_OVER: +@CAIRO_OPERATOR_OVER_REVERSE: +@CAIRO_OPERATOR_IN: +@CAIRO_OPERATOR_IN_REVERSE: +@CAIRO_OPERATOR_OUT: +@CAIRO_OPERATOR_OUT_REVERSE: +@CAIRO_OPERATOR_ATOP: +@CAIRO_OPERATOR_ATOP_REVERSE: +@CAIRO_OPERATOR_XOR: +@CAIRO_OPERATOR_ADD: +@CAIRO_OPERATOR_SATURATE: + +<!-- ##### FUNCTION cairo_set_operator ##### --> +<para> + +</para> + +@cr: +@op: + + +<!-- ##### FUNCTION cairo_set_rgb_color ##### --> +<para> + +</para> + +@cr: +@red: +@green: +@blue: + + +<!-- ##### FUNCTION cairo_set_pattern ##### --> +<para> + +</para> + +@cr: +@pattern: + + +<!-- ##### FUNCTION cairo_set_alpha ##### --> +<para> + +</para> + +@cr: +@alpha: + + +<!-- ##### FUNCTION cairo_set_tolerance ##### --> +<para> + +</para> + +@cr: +@tolerance: + + +<!-- ##### ENUM cairo_fill_rule_t ##### --> +<para> + +</para> + +@CAIRO_FILL_RULE_WINDING: +@CAIRO_FILL_RULE_EVEN_ODD: + +<!-- ##### FUNCTION cairo_set_fill_rule ##### --> +<para> + +</para> + +@cr: +@fill_rule: + + +<!-- ##### FUNCTION cairo_set_line_width ##### --> +<para> + +</para> + +@cr: +@width: + + +<!-- ##### ENUM cairo_line_cap_t ##### --> +<para> + +</para> + +@CAIRO_LINE_CAP_BUTT: +@CAIRO_LINE_CAP_ROUND: +@CAIRO_LINE_CAP_SQUARE: + +<!-- ##### FUNCTION cairo_set_line_cap ##### --> +<para> + +</para> + +@cr: +@line_cap: + + +<!-- ##### ENUM cairo_line_join_t ##### --> +<para> + +</para> + +@CAIRO_LINE_JOIN_MITER: +@CAIRO_LINE_JOIN_ROUND: +@CAIRO_LINE_JOIN_BEVEL: + +<!-- ##### FUNCTION cairo_set_line_join ##### --> +<para> + +</para> + +@cr: +@line_join: + + +<!-- ##### FUNCTION cairo_set_dash ##### --> +<para> + +</para> + +@cr: +@dashes: +@ndash: +@offset: + + +<!-- ##### FUNCTION cairo_set_miter_limit ##### --> +<para> + +</para> + +@cr: +@limit: + + +<!-- ##### FUNCTION cairo_translate ##### --> +<para> + +</para> + +@cr: +@tx: +@ty: + + +<!-- ##### FUNCTION cairo_scale ##### --> +<para> + +</para> + +@cr: +@sx: +@sy: + + +<!-- ##### FUNCTION cairo_rotate ##### --> +<para> + +</para> + +@cr: +@angle: + + +<!-- ##### FUNCTION cairo_concat_matrix ##### --> +<para> + +</para> + +@cr: +@matrix: + + +<!-- ##### FUNCTION cairo_set_matrix ##### --> +<para> + +</para> + +@cr: +@matrix: + + +<!-- ##### FUNCTION cairo_default_matrix ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_identity_matrix ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_transform_point ##### --> +<para> + +</para> + +@cr: +@x: +@y: + + +<!-- ##### FUNCTION cairo_transform_distance ##### --> +<para> + +</para> + +@cr: +@dx: +@dy: + + +<!-- ##### FUNCTION cairo_inverse_transform_point ##### --> +<para> + +</para> + +@cr: +@x: +@y: + + +<!-- ##### FUNCTION cairo_inverse_transform_distance ##### --> +<para> + +</para> + +@cr: +@dx: +@dy: + + +<!-- ##### FUNCTION cairo_new_path ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_move_to ##### --> +<para> + +</para> + +@cr: +@x: +@y: + + +<!-- ##### FUNCTION cairo_line_to ##### --> +<para> + +</para> + +@cr: +@x: +@y: + + +<!-- ##### FUNCTION cairo_curve_to ##### --> +<para> + +</para> + +@cr: +@x1: +@y1: +@x2: +@y2: +@x3: +@y3: + + +<!-- ##### FUNCTION cairo_arc ##### --> +<para> + +</para> + +@cr: +@xc: +@yc: +@radius: +@angle1: +@angle2: + + +<!-- ##### FUNCTION cairo_arc_negative ##### --> +<para> + +</para> + +@cr: +@xc: +@yc: +@radius: +@angle1: +@angle2: + + +<!-- ##### FUNCTION cairo_rel_move_to ##### --> +<para> + +</para> + +@cr: +@dx: +@dy: + + +<!-- ##### FUNCTION cairo_rel_line_to ##### --> +<para> + +</para> + +@cr: +@dx: +@dy: + + +<!-- ##### FUNCTION cairo_rel_curve_to ##### --> +<para> + +</para> + +@cr: +@dx1: +@dy1: +@dx2: +@dy2: +@dx3: +@dy3: + + +<!-- ##### FUNCTION cairo_rectangle ##### --> +<para> + +</para> + +@cr: +@x: +@y: +@width: +@height: + + +<!-- ##### FUNCTION cairo_close_path ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_stroke ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_fill ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_copy_page ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_show_page ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_in_stroke ##### --> +<para> + +</para> + +@cr: +@x: +@y: +@Returns: + + +<!-- ##### FUNCTION cairo_in_fill ##### --> +<para> + +</para> + +@cr: +@x: +@y: +@Returns: + + +<!-- ##### TYPEDEF cairo_bool_t ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION cairo_stroke_extents ##### --> +<para> + +</para> + +@cr: +@x1: +@y1: +@x2: +@y2: + + +<!-- ##### FUNCTION cairo_fill_extents ##### --> +<para> + +</para> + +@cr: +@x1: +@y1: +@x2: +@y2: + + +<!-- ##### FUNCTION cairo_init_clip ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_clip ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### TYPEDEF cairo_font_t ##### --> +<para> + +</para> + + +<!-- ##### STRUCT cairo_glyph_t ##### --> +<para> + +</para> + +@index: +@x: +@y: + +<!-- ##### STRUCT cairo_text_extents_t ##### --> +<para> + +</para> + +@x_bearing: +@y_bearing: +@width: +@height: +@x_advance: +@y_advance: + +<!-- ##### STRUCT cairo_font_extents_t ##### --> +<para> + +</para> + +@ascent: +@descent: +@height: +@max_x_advance: +@max_y_advance: + +<!-- ##### ENUM cairo_font_slant_t ##### --> +<para> + +</para> + +@CAIRO_FONT_SLANT_NORMAL: +@CAIRO_FONT_SLANT_ITALIC: +@CAIRO_FONT_SLANT_OBLIQUE: + +<!-- ##### ENUM cairo_font_weight_t ##### --> +<para> + +</para> + +@CAIRO_FONT_WEIGHT_NORMAL: +@CAIRO_FONT_WEIGHT_BOLD: + +<!-- ##### FUNCTION cairo_select_font ##### --> +<para> + +</para> + +@cr: +@family: +@slant: +@weight: + + +<!-- ##### FUNCTION cairo_scale_font ##### --> +<para> + +</para> + +@cr: +@scale: + + +<!-- ##### FUNCTION cairo_transform_font ##### --> +<para> + +</para> + +@cr: +@matrix: + + +<!-- ##### FUNCTION cairo_show_text ##### --> +<para> + +</para> + +@cr: +@utf8: + + +<!-- ##### FUNCTION cairo_show_glyphs ##### --> +<para> + +</para> + +@cr: +@glyphs: +@num_glyphs: + + +<!-- ##### FUNCTION cairo_current_font ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### FUNCTION cairo_current_font_extents ##### --> +<para> + +</para> + +@cr: +@extents: + + +<!-- ##### FUNCTION cairo_set_font ##### --> +<para> + +</para> + +@cr: +@font: + + +<!-- ##### FUNCTION cairo_text_extents ##### --> +<para> + +</para> + +@cr: +@utf8: +@extents: + + +<!-- ##### FUNCTION cairo_glyph_extents ##### --> +<para> + +</para> + +@cr: +@glyphs: +@num_glyphs: +@extents: + + +<!-- ##### FUNCTION cairo_text_path ##### --> +<para> + +</para> + +@cr: +@utf8: + + +<!-- ##### FUNCTION cairo_glyph_path ##### --> +<para> + +</para> + +@cr: +@glyphs: +@num_glyphs: + + +<!-- ##### FUNCTION cairo_font_reference ##### --> +<para> + +</para> + +@font: + + +<!-- ##### FUNCTION cairo_font_destroy ##### --> +<para> + +</para> + +@font: + + +<!-- ##### FUNCTION cairo_font_glyph_extents ##### --> +<para> + +</para> + +@font: +@font_matrix: +@glyphs: +@num_glyphs: +@extents: + + +<!-- ##### FUNCTION cairo_show_surface ##### --> +<para> + +</para> + +@cr: +@surface: +@width: +@height: + + +<!-- ##### FUNCTION cairo_current_operator ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### FUNCTION cairo_current_rgb_color ##### --> +<para> + +</para> + +@cr: +@red: +@green: +@blue: + + +<!-- ##### FUNCTION cairo_current_pattern ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### FUNCTION cairo_current_alpha ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### FUNCTION cairo_current_tolerance ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### FUNCTION cairo_current_point ##### --> +<para> + +</para> + +@cr: +@x: +@y: + + +<!-- ##### FUNCTION cairo_current_fill_rule ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### FUNCTION cairo_current_line_width ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### FUNCTION cairo_current_line_cap ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### FUNCTION cairo_current_line_join ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### FUNCTION cairo_current_miter_limit ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### FUNCTION cairo_current_matrix ##### --> +<para> + +</para> + +@cr: +@matrix: + + +<!-- ##### FUNCTION cairo_current_target_surface ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### FUNCTION cairo_current_path ##### --> +<para> + +</para> + +@cr: +@move_to: +@line_to: +@curve_to: +@close_path: +@closure: + + +<!-- ##### FUNCTION cairo_current_path_flat ##### --> +<para> + +</para> + +@cr: +@move_to: +@line_to: +@close_path: +@closure: + + +<!-- ##### ENUM cairo_status_t ##### --> +<para> + +</para> + +@CAIRO_STATUS_SUCCESS: +@CAIRO_STATUS_NO_MEMORY: +@CAIRO_STATUS_INVALID_RESTORE: +@CAIRO_STATUS_INVALID_POP_GROUP: +@CAIRO_STATUS_NO_CURRENT_POINT: +@CAIRO_STATUS_INVALID_MATRIX: +@CAIRO_STATUS_NO_TARGET_SURFACE: +@CAIRO_STATUS_NULL_POINTER: +@CAIRO_STATUS_INVALID_STRING: + +<!-- ##### FUNCTION cairo_status ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### FUNCTION cairo_status_string ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### ENUM cairo_filter_t ##### --> +<para> + +</para> + +@CAIRO_FILTER_FAST: +@CAIRO_FILTER_GOOD: +@CAIRO_FILTER_BEST: +@CAIRO_FILTER_NEAREST: +@CAIRO_FILTER_BILINEAR: +@CAIRO_FILTER_GAUSSIAN: + +<!-- ##### FUNCTION cairo_image_surface_create ##### --> +<para> + +</para> + +@format: +@width: +@height: +@Returns: + + +<!-- ##### FUNCTION cairo_image_surface_create_for_data ##### --> +<para> + +</para> + +@data: +@format: +@width: +@height: +@stride: +@Returns: + + + +<!-- +Local variables: +mode: sgml +sgml-parent-document: ("../cairo-docs.xml" "book" "refsect2" "") +End: +--> + + |