diff options
| author | Billy Biggs <vektor@dumbterm.net> | 2005-08-22 22:11:44 +0000 |
|---|---|---|
| committer | Billy Biggs <vektor@dumbterm.net> | 2005-08-22 22:11:44 +0000 |
| commit | a68097a219543160ea6ff12628626dcdb070f97e (patch) | |
| tree | 5b9e32aed4f2ff53242afd084dd3aceb6a9212b0 /doc/public | |
| parent | 2d9d744f8c8a9fdf011a292ef6e823605d000f23 (diff) | |
Rework the index for the reference manual.
Update descriptions and add new files for added sections.
Diffstat (limited to 'doc/public')
27 files changed, 1548 insertions, 1229 deletions
diff --git a/doc/public/cairo-docs.xml b/doc/public/cairo-docs.xml index f4e61e194..3ad8ce916 100644 --- a/doc/public/cairo-docs.xml +++ b/doc/public/cairo-docs.xml @@ -14,20 +14,42 @@ </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-font.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"/> + <chapter id="Drawing"> + <title>Drawing</title> + <xi:include href="xml/cairo.xml"/> + <xi:include href="xml/cairo-paths.xml"/> + <xi:include href="xml/cairo-pattern.xml"/> + <xi:include href="xml/cairo-transforms.xml"/> + <xi:include href="xml/cairo-text.xml"/> + </chapter> + <chapter id="Fonts"> + <title>Fonts</title> + <xi:include href="xml/cairo-font.xml"/> + <xi:include href="xml/cairo-scaled-font.xml"/> + <xi:include href="xml/cairo-font-options.xml"/> + <xi:include href="xml/cairo-ft.xml"/> + <xi:include href="xml/cairo-win32-fonts.xml"/> + </chapter> + <chapter id="Surfaces"> + <title>Surfaces</title> + <xi:include href="xml/cairo-surface.xml"/> + <xi:include href="xml/cairo-image.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"/> + </chapter> + <chapter id="Support"> + <title>Utilities</title> + <xi:include href="xml/cairo-matrix.xml"/> + <xi:include href="xml/cairo-status.xml"/> + <xi:include href="xml/cairo-version.xml"/> + <xi:include href="xml/cairo-types.xml"/> + </chapter> </part> <index> <title>Index</title> diff --git a/doc/public/cairo-sections.txt b/doc/public/cairo-sections.txt index 0c2fe4ed0..e3c4799d1 100644 --- a/doc/public/cairo-sections.txt +++ b/doc/public/cairo-sections.txt @@ -1,22 +1,41 @@ <SECTION> <FILE>cairo-ft</FILE> <TITLE>FreeType Fonts</TITLE> -cairo_ft_font_options_substitute -cairo_ft_font_face_create_for_pattern cairo_ft_font_face_create_for_ft_face +cairo_ft_font_face_create_for_pattern +cairo_ft_font_options_substitute cairo_ft_scaled_font_lock_face cairo_ft_scaled_font_unlock_face </SECTION> <SECTION> +<FILE>cairo-win32-fonts</FILE> +<TITLE>Win32 Fonts</TITLE> +cairo_win32_font_face_create_for_logfontw +cairo_win32_scaled_font_select_font +cairo_win32_scaled_font_done_font +cairo_win32_scaled_font_get_metrics_factor +</SECTION> + +<SECTION> <FILE>cairo-glitz</FILE> -<TITLE>Glitz backend</TITLE> +<TITLE>Glitz Surfaces</TITLE> cairo_glitz_surface_create </SECTION> <SECTION> +<FILE>cairo-image</FILE> +<TITLE>Image Surfaces</TITLE> +cairo_format_t +cairo_image_surface_create +cairo_image_surface_create_for_data +cairo_image_surface_get_width +cairo_image_surface_get_height +</SECTION> + +<SECTION> <FILE>cairo-pdf</FILE> -<TITLE>PDF Backend</TITLE> +<TITLE>PDF Surfaces</TITLE> cairo_pdf_surface_create cairo_pdf_surface_create_for_stream cairo_pdf_surface_set_dpi @@ -24,16 +43,18 @@ cairo_pdf_surface_set_dpi <SECTION> <FILE>cairo-png</FILE> -<TITLE>PNG Backend</TITLE> +<TITLE>PNG Support</TITLE> cairo_image_surface_create_from_png +cairo_read_func_t cairo_image_surface_create_from_png_stream cairo_surface_write_to_png +cairo_write_func_t cairo_surface_write_to_png_stream </SECTION> <SECTION> <FILE>cairo-ps</FILE> -<TITLE>PS Backend</TITLE> +<TITLE>PostScript Surfaces</TITLE> cairo_ps_surface_create cairo_ps_surface_create_for_stream cairo_ps_surface_set_dpi @@ -41,23 +62,19 @@ cairo_ps_surface_set_dpi <SECTION> <FILE>cairo-quartz</FILE> -<TITLE>Quartz Backend</TITLE> +<TITLE>Quartz Surfaces</TITLE> cairo_quartz_surface_create </SECTION> <SECTION> <FILE>cairo-win32</FILE> -<TITLE>Microsoft Windows Backend</TITLE> +<TITLE>Win32 Surfaces</TITLE> cairo_win32_surface_create -cairo_win32_font_face_create_for_logfontw -cairo_win32_scaled_font_select_font -cairo_win32_scaled_font_done_font -cairo_win32_scaled_font_get_metrics_factor </SECTION> <SECTION> <FILE>cairo-xcb</FILE> -<TITLE>XCB Backend</TITLE> +<TITLE>XCB Surfaces</TITLE> cairo_xcb_surface_create cairo_xcb_surface_create_for_bitmap cairo_xcb_surface_set_size @@ -65,13 +82,13 @@ cairo_xcb_surface_set_size <SECTION> <FILE>cairo-xcb-xrender</FILE> -<TITLE>XCB Backend</TITLE> +<TITLE>XCB Render Surfaces</TITLE> cairo_xcb_surface_create_with_xrender_format </SECTION> <SECTION> <FILE>cairo-xlib</FILE> -<TITLE>XLib Backend</TITLE> +<TITLE>XLib Surfaces</TITLE> cairo_xlib_surface_create cairo_xlib_surface_create_for_bitmap cairo_xlib_surface_set_size @@ -88,41 +105,53 @@ cairo_xlib_surface_create_with_xrender_format <FILE>cairo-surface</FILE> <TITLE>cairo_surface_t</TITLE> cairo_surface_t +cairo_content_t cairo_surface_create_similar -cairo_surface_reference cairo_surface_destroy -cairo_surface_status cairo_surface_finish +cairo_surface_flush cairo_surface_get_font_options cairo_surface_set_user_data cairo_surface_get_user_data -cairo_surface_flush cairo_surface_mark_dirty cairo_surface_mark_dirty_rectangle +cairo_surface_reference cairo_surface_set_device_offset +cairo_surface_status +</SECTION> + +<SECTION> +<FILE>cairo-version</FILE> +<TITLE>Version Information</TITLE> +CAIRO_VERSION +CAIRO_VERSION_STRING +CAIRO_VERSION_ENCODE +cairo_version +cairo_version_string </SECTION> <SECTION> <FILE>cairo-pattern</FILE> -<TITLE>cairo_pattern_t</TITLE> +<TITLE>Patterns</TITLE> cairo_pattern_t +cairo_pattern_add_color_stop_rgb +cairo_pattern_add_color_stop_rgba cairo_pattern_create_rgb cairo_pattern_create_rgba cairo_pattern_create_for_surface cairo_pattern_create_linear cairo_pattern_create_radial -cairo_pattern_reference cairo_pattern_destroy +cairo_pattern_reference cairo_pattern_status -cairo_pattern_add_color_stop_rgb -cairo_pattern_add_color_stop_rgba -cairo_pattern_set_matrix -cairo_pattern_get_matrix cairo_extend_t cairo_pattern_set_extend cairo_pattern_get_extend +cairo_filter_t cairo_pattern_set_filter cairo_pattern_get_filter +cairo_pattern_set_matrix +cairo_pattern_get_matrix </SECTION> <SECTION> @@ -144,15 +173,28 @@ cairo_matrix_transform_point </SECTION> <SECTION> +<FILE>cairo-status</FILE> +<TITLE>Error handling</TITLE> +cairo_status_t +cairo_status_to_string +cairo_debug_reset_static_data +</SECTION> + +<SECTION> <FILE>cairo-font</FILE> -<TITLE>Fonts</TITLE> +<TITLE>cairo_font_face_t</TITLE> cairo_font_face_t -cairo_scaled_font_t cairo_font_face_reference cairo_font_face_destroy cairo_font_face_status cairo_font_face_get_user_data cairo_font_face_set_user_data +</SECTION> + +<SECTION> +<FILE>cairo-scaled-font</FILE> +<TITLE>Scaled Fonts</TITLE> +cairo_scaled_font_t cairo_scaled_font_create cairo_scaled_font_reference cairo_scaled_font_destroy @@ -161,6 +203,11 @@ cairo_font_extents_t cairo_scaled_font_extents cairo_text_extents_t cairo_scaled_font_glyph_extents +</SECTION> + +<SECTION> +<FILE>cairo-font-options</FILE> +<TITLE>Font Options</TITLE> cairo_font_options_t cairo_font_options_create cairo_font_options_copy @@ -183,47 +230,43 @@ cairo_font_options_get_hint_metrics </SECTION> <SECTION> -<FILE>cairo</FILE> -<TITLE>cairo_t</TITLE> -cairo_t -cairo_create -cairo_reference -cairo_destroy -cairo_save -cairo_restore -cairo_content_t -CAIRO_CONTENT_VALID -cairo_format_t -CAIRO_FORMAT_VALID -cairo_operator_t -cairo_set_operator -cairo_set_source_rgb -cairo_set_source_rgba -cairo_set_source -cairo_set_source_surface -cairo_set_tolerance -cairo_antialias_t -cairo_set_antialias -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 +<FILE>cairo-types</FILE> +<TITLE>Types</TITLE> +cairo_bool_t +cairo_user_data_key_t +cairo_destroy_func_t +</SECTION> + +<SECTION> +<FILE>cairo-transforms</FILE> +<TITLE>Transformations</TITLE> cairo_translate cairo_scale cairo_rotate cairo_transform cairo_set_matrix +cairo_get_matrix cairo_identity_matrix cairo_user_to_device cairo_user_to_device_distance cairo_device_to_user cairo_device_to_user_distance +</SECTION> + + +<SECTION> +<FILE>cairo-paths</FILE> +<TITLE>Paths</TITLE> +cairo_path_t +cairo_path_data_t +cairo_path_data_type_t +cairo_copy_path +cairo_copy_path_flat +cairo_path_destroy +cairo_append_path cairo_new_path +cairo_close_path +cairo_get_current_point cairo_move_to cairo_line_to cairo_curve_to @@ -233,25 +276,11 @@ cairo_rel_move_to cairo_rel_line_to cairo_rel_curve_to cairo_rectangle -cairo_close_path -cairo_paint -cairo_paint_with_alpha -cairo_mask -cairo_mask_surface -cairo_stroke -cairo_stroke_preserve -cairo_fill -cairo_fill_preserve -cairo_copy_page -cairo_show_page -cairo_in_stroke -cairo_in_fill -cairo_bool_t -cairo_stroke_extents -cairo_fill_extents -cairo_clip -cairo_clip_preserve -cairo_reset_clip +</SECTION> + +<SECTION> +<FILE>cairo-text</FILE> +<TITLE>Text</TITLE> cairo_glyph_t cairo_font_slant_t cairo_font_weight_t @@ -270,39 +299,63 @@ cairo_text_extents cairo_glyph_extents cairo_text_path cairo_glyph_path -cairo_get_operator +</SECTION> + +<SECTION> +<FILE>cairo</FILE> +<TITLE>cairo_t</TITLE> +cairo_t +cairo_create +cairo_reference +cairo_destroy +cairo_save +cairo_restore +cairo_status +cairo_get_target +cairo_set_source_rgb +cairo_set_source_rgba +cairo_set_source +cairo_set_source_surface cairo_get_source -cairo_get_tolerance +cairo_antialias_t +cairo_set_antialias cairo_get_antialias -cairo_get_current_point +cairo_set_dash +cairo_fill_rule_t +cairo_set_fill_rule cairo_get_fill_rule -cairo_get_line_width +cairo_line_cap_t +cairo_set_line_cap cairo_get_line_cap +cairo_line_join_t +cairo_set_line_join cairo_get_line_join +cairo_set_line_width +cairo_get_line_width +cairo_set_miter_limit cairo_get_miter_limit -cairo_get_matrix -cairo_get_target -cairo_copy_path -cairo_copy_path_flat -cairo_append_path -cairo_path_data_type_t -cairo_path_data_t -cairo_path_t -cairo_path_destroy -cairo_status_t -cairo_status -cairo_status_string -cairo_status_to_string -cairo_filter_t -cairo_image_surface_create -cairo_image_surface_create_for_data -cairo_image_surface_get_width -cairo_image_surface_get_height -cairo_destroy_func_t -cairo_user_data_key_t -cairo_read_func_t -cairo_write_func_t -cairo_debug_reset_static_data +cairo_operator_t +cairo_set_operator +cairo_get_operator +cairo_set_tolerance +cairo_get_tolerance +cairo_clip +cairo_clip_preserve +cairo_reset_clip +cairo_fill +cairo_fill_preserve +cairo_fill_extents +cairo_in_fill +cairo_mask +cairo_mask_surface +cairo_paint +cairo_paint_with_alpha +cairo_stroke +cairo_stroke_preserve +cairo_stroke_extents +cairo_in_stroke +cairo_copy_page +cairo_show_page <SUBSECTION Private> cairo_current_font_extents cairo_get_font_extents @@ -366,9 +419,4 @@ cairo_set_target_quartz cairo_set_target_win32 cairo_set_target_xcb cairo_set_target_drawable -CAIRO_VERSION -CAIRO_VERSION_STRING -CAIRO_VERSION_ENCODE -cairo_version -cairo_version_string </SECTION> diff --git a/doc/public/tmpl/cairo-font-options.sgml b/doc/public/tmpl/cairo-font-options.sgml new file mode 100644 index 000000000..de756e780 --- /dev/null +++ b/doc/public/tmpl/cairo-font-options.sgml @@ -0,0 +1,194 @@ +<!-- ##### SECTION Title ##### --> + + Font Options + +<!-- ##### SECTION Short_Description ##### --> + + How a font should be rendered + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### TYPEDEF cairo_font_options_t ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION cairo_font_options_create ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION cairo_font_options_copy ##### --> +<para> + +</para> + +@original: +@Returns: + + +<!-- ##### FUNCTION cairo_font_options_destroy ##### --> +<para> + +</para> + +@options: + + +<!-- ##### FUNCTION cairo_font_options_status ##### --> +<para> + +</para> + +@options: +@Returns: + + +<!-- ##### FUNCTION cairo_font_options_merge ##### --> +<para> + +</para> + +@options: +@other: + + +<!-- ##### FUNCTION cairo_font_options_hash ##### --> +<para> + +</para> + +@options: +@Returns: + + +<!-- ##### FUNCTION cairo_font_options_equal ##### --> +<para> + +</para> + +@options: +@other: +@Returns: + + +<!-- ##### FUNCTION cairo_font_options_set_antialias ##### --> +<para> + +</para> + +@options: +@antialias: + + +<!-- ##### FUNCTION cairo_font_options_get_antialias ##### --> +<para> + +</para> + +@options: +@Returns: + + +<!-- ##### ENUM cairo_subpixel_order_t ##### --> +<para> + +</para> + +@CAIRO_SUBPIXEL_ORDER_DEFAULT: +@CAIRO_SUBPIXEL_ORDER_RGB: +@CAIRO_SUBPIXEL_ORDER_BGR: +@CAIRO_SUBPIXEL_ORDER_VRGB: +@CAIRO_SUBPIXEL_ORDER_VBGR: + +<!-- ##### FUNCTION cairo_font_options_set_subpixel_order ##### --> +<para> + +</para> + +@options: +@subpixel_order: + + +<!-- ##### FUNCTION cairo_font_options_get_subpixel_order ##### --> +<para> + +</para> + +@options: +@Returns: +<!-- # Unused Parameters # --> +@option: + + +<!-- ##### ENUM cairo_hint_style_t ##### --> +<para> + +</para> + +@CAIRO_HINT_STYLE_DEFAULT: +@CAIRO_HINT_STYLE_NONE: +@CAIRO_HINT_STYLE_SLIGHT: +@CAIRO_HINT_STYLE_MEDIUM: +@CAIRO_HINT_STYLE_FULL: + +<!-- ##### FUNCTION cairo_font_options_set_hint_style ##### --> +<para> + +</para> + +@options: +@hint_style: + + +<!-- ##### FUNCTION cairo_font_options_get_hint_style ##### --> +<para> + +</para> + +@options: +@Returns: + + +<!-- ##### ENUM cairo_hint_metrics_t ##### --> +<para> + +</para> + +@CAIRO_HINT_METRICS_DEFAULT: +@CAIRO_HINT_METRICS_OFF: +@CAIRO_HINT_METRICS_ON: + +<!-- ##### FUNCTION cairo_font_options_set_hint_metrics ##### --> +<para> + +</para> + +@options: +@hint_metrics: + + +<!-- ##### FUNCTION cairo_font_options_get_hint_metrics ##### --> +<para> + +</para> + +@options: +@Returns: + + diff --git a/doc/public/tmpl/cairo-font.sgml b/doc/public/tmpl/cairo-font.sgml index 78c9d3bfd..d69295a38 100644 --- a/doc/public/tmpl/cairo-font.sgml +++ b/doc/public/tmpl/cairo-font.sgml @@ -1,8 +1,10 @@ <!-- ##### SECTION Title ##### --> -Fonts + + cairo_font_face_t <!-- ##### SECTION Short_Description ##### --> -Font Handling + + Base class for fonts <!-- ##### SECTION Long_Description ##### --> <para> @@ -23,12 +25,6 @@ Font Handling </para> -<!-- ##### TYPEDEF cairo_scaled_font_t ##### --> -<para> - -</para> - - <!-- ##### FUNCTION cairo_font_face_reference ##### --> <para> @@ -77,259 +73,3 @@ Font Handling @Returns: -<!-- ##### FUNCTION cairo_scaled_font_create ##### --> -<para> - -</para> - -@font_face: -@font_matrix: -@ctm: -@options: -@Returns: - - -<!-- ##### FUNCTION cairo_scaled_font_reference ##### --> -<para> - -</para> - -@scaled_font: -@Returns: - - -<!-- ##### FUNCTION cairo_scaled_font_destroy ##### --> -<para> - -</para> - -@scaled_font: - - -<!-- ##### FUNCTION cairo_scaled_font_status ##### --> -<para> - -</para> - -@scaled_font: -@Returns: - - -<!-- ##### STRUCT cairo_font_extents_t ##### --> -<para> - -</para> - -@ascent: -@descent: -@height: -@max_x_advance: -@max_y_advance: - -<!-- ##### FUNCTION cairo_scaled_font_extents ##### --> -<para> - -</para> - -@scaled_font: -@extents: -<!-- # Unused Parameters # --> -@Returns: - - -<!-- ##### STRUCT cairo_text_extents_t ##### --> -<para> - -</para> - -@x_bearing: -@y_bearing: -@width: -@height: -@x_advance: -@y_advance: - -<!-- ##### FUNCTION cairo_scaled_font_glyph_extents ##### --> -<para> - -</para> - -@scaled_font: -@glyphs: -@num_glyphs: -@extents: - - -<!-- ##### TYPEDEF cairo_font_options_t ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION cairo_font_options_create ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION cairo_font_options_copy ##### --> -<para> - -</para> - -@original: -@Returns: - - -<!-- ##### FUNCTION cairo_font_options_destroy ##### --> -<para> - -</para> - -@options: - - -<!-- ##### FUNCTION cairo_font_options_status ##### --> -<para> - -</para> - -@options: -@Returns: - - -<!-- ##### FUNCTION cairo_font_options_merge ##### --> -<para> - -</para> - -@options: -@other: - - -<!-- ##### FUNCTION cairo_font_options_hash ##### --> -<para> - -</para> - -@options: -@Returns: - - -<!-- ##### FUNCTION cairo_font_options_equal ##### --> -<para> - -</para> - -@options: -@other: -@Returns: - - -<!-- ##### FUNCTION cairo_font_options_set_antialias ##### --> -<para> - -</para> - -@options: -@antialias: - - -<!-- ##### FUNCTION cairo_font_options_get_antialias ##### --> -<para> - -</para> - -@options: -@Returns: - - -<!-- ##### ENUM cairo_subpixel_order_t ##### --> -<para> - -</para> - -@CAIRO_SUBPIXEL_ORDER_DEFAULT: -@CAIRO_SUBPIXEL_ORDER_RGB: -@CAIRO_SUBPIXEL_ORDER_BGR: -@CAIRO_SUBPIXEL_ORDER_VRGB: -@CAIRO_SUBPIXEL_ORDER_VBGR: - -<!-- ##### FUNCTION cairo_font_options_set_subpixel_order ##### --> -<para> - -</para> - -@options: -@subpixel_order: - - -<!-- ##### FUNCTION cairo_font_options_get_subpixel_order ##### --> -<para> - -</para> - -@options: -@Returns: -<!-- # Unused Parameters # --> -@option: - - -<!-- ##### ENUM cairo_hint_style_t ##### --> -<para> - -</para> - -@CAIRO_HINT_STYLE_DEFAULT: -@CAIRO_HINT_STYLE_NONE: -@CAIRO_HINT_STYLE_SLIGHT: -@CAIRO_HINT_STYLE_MEDIUM: -@CAIRO_HINT_STYLE_FULL: - -<!-- ##### FUNCTION cairo_font_options_set_hint_style ##### --> -<para> - -</para> - -@options: -@hint_style: - - -<!-- ##### FUNCTION cairo_font_options_get_hint_style ##### --> -<para> - -</para> - -@options: -@Returns: - - -<!-- ##### ENUM cairo_hint_metrics_t ##### --> -<para> - -</para> - -@CAIRO_HINT_METRICS_DEFAULT: -@CAIRO_HINT_METRICS_OFF: -@CAIRO_HINT_METRICS_ON: - -<!-- ##### FUNCTION cairo_font_options_set_hint_metrics ##### --> -<para> - -</para> - -@options: -@hint_metrics: - - -<!-- ##### FUNCTION cairo_font_options_get_hint_metrics ##### --> -<para> - -</para> - -@options: -@Returns: - - diff --git a/doc/public/tmpl/cairo-ft.sgml b/doc/public/tmpl/cairo-ft.sgml index 383cf1935..393e2ed9d 100644 --- a/doc/public/tmpl/cairo-ft.sgml +++ b/doc/public/tmpl/cairo-ft.sgml @@ -1,8 +1,10 @@ <!-- ##### SECTION Title ##### --> -FreeType Fonts + + FreeType Fonts <!-- ##### SECTION Short_Description ##### --> + Font support for FreeType <!-- ##### SECTION Long_Description ##### --> <para> @@ -17,13 +19,14 @@ FreeType Fonts <!-- ##### SECTION Stability_Level ##### --> -<!-- ##### FUNCTION cairo_ft_font_options_substitute ##### --> +<!-- ##### FUNCTION cairo_ft_font_face_create_for_ft_face ##### --> <para> </para> -@options: -@pattern: +@face: +@load_flags: +@Returns: <!-- ##### FUNCTION cairo_ft_font_face_create_for_pattern ##### --> @@ -35,14 +38,13 @@ FreeType Fonts @Returns: -<!-- ##### FUNCTION cairo_ft_font_face_create_for_ft_face ##### --> +<!-- ##### FUNCTION cairo_ft_font_options_substitute ##### --> <para> </para> -@face: -@load_flags: -@Returns: +@options: +@pattern: <!-- ##### FUNCTION cairo_ft_scaled_font_lock_face ##### --> diff --git a/doc/public/tmpl/cairo-glitz.sgml b/doc/public/tmpl/cairo-glitz.sgml index 9594d87a5..6b7899d04 100644 --- a/doc/public/tmpl/cairo-glitz.sgml +++ b/doc/public/tmpl/cairo-glitz.sgml @@ -1,8 +1,10 @@ <!-- ##### SECTION Title ##### --> -Glitz backend + + Glitz Surfaces <!-- ##### SECTION Short_Description ##### --> + OpenGL accelerated rendering using the Glitz library <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/doc/public/tmpl/cairo-image.sgml b/doc/public/tmpl/cairo-image.sgml new file mode 100644 index 000000000..4f5a4e487 --- /dev/null +++ b/doc/public/tmpl/cairo-image.sgml @@ -0,0 +1,73 @@ +<!-- ##### SECTION Title ##### --> + + Image Surfaces + +<!-- ##### SECTION Short_Description ##### --> + + Rendering to memory buffers + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### ENUM cairo_format_t ##### --> +<para> + +</para> + +@CAIRO_FORMAT_ARGB32: +@CAIRO_FORMAT_RGB24: +@CAIRO_FORMAT_A8: +@CAIRO_FORMAT_A1: + +<!-- ##### 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: + + +<!-- ##### FUNCTION cairo_image_surface_get_width ##### --> +<para> + +</para> + +@surface: +@Returns: + + +<!-- ##### FUNCTION cairo_image_surface_get_height ##### --> +<para> + +</para> + +@surface: +@Returns: + + diff --git a/doc/public/tmpl/cairo-matrix.sgml b/doc/public/tmpl/cairo-matrix.sgml index d9549b4a6..577136753 100644 --- a/doc/public/tmpl/cairo-matrix.sgml +++ b/doc/public/tmpl/cairo-matrix.sgml @@ -1,9 +1,10 @@ <!-- ##### SECTION Title ##### --> -cairo_matrix_t + + cairo_matrix_t <!-- ##### SECTION Short_Description ##### --> - Transformation matrices + Generic matrix operations <!-- ##### SECTION Long_Description ##### --> diff --git a/doc/public/tmpl/cairo-paths.sgml b/doc/public/tmpl/cairo-paths.sgml new file mode 100644 index 000000000..e648bc20a --- /dev/null +++ b/doc/public/tmpl/cairo-paths.sgml @@ -0,0 +1,207 @@ +<!-- ##### SECTION Title ##### --> + + Paths + +<!-- ##### SECTION Short_Description ##### --> + + Creating paths and manipulating path data + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT cairo_path_t ##### --> +<para> + +</para> + +@status: +@data: +@num_data: + +<!-- ##### ENUM cairo_path_data_type_t ##### --> +<para> + +</para> + +@CAIRO_PATH_MOVE_TO: +@CAIRO_PATH_LINE_TO: +@CAIRO_PATH_CURVE_TO: +@CAIRO_PATH_CLOSE_PATH: + +<!-- ##### FUNCTION cairo_copy_path ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### FUNCTION cairo_copy_path_flat ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### FUNCTION cairo_path_destroy ##### --> +<para> + +</para> + +@path: + + +<!-- ##### FUNCTION cairo_append_path ##### --> +<para> + +</para> + +@cr: +@path: + + +<!-- ##### FUNCTION cairo_new_path ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_close_path ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_get_current_point ##### --> +<para> + +</para> + +@cr: +@x: +@y: + + +<!-- ##### 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: + + diff --git a/doc/public/tmpl/cairo-pattern.sgml b/doc/public/tmpl/cairo-pattern.sgml index 78964ef41..0df0dd9f2 100644 --- a/doc/public/tmpl/cairo-pattern.sgml +++ b/doc/public/tmpl/cairo-pattern.sgml @@ -1,8 +1,10 @@ <!-- ##### SECTION Title ##### --> -cairo_pattern_t + + Patterns <!-- ##### SECTION Short_Description ##### --> + Gradients and filtered sources <!-- ##### SECTION Long_Description ##### --> <para> @@ -23,6 +25,31 @@ cairo_pattern_t </para> +<!-- ##### FUNCTION cairo_pattern_add_color_stop_rgb ##### --> +<para> + +</para> + +@pattern: +@offset: +@red: +@green: +@blue: + + +<!-- ##### FUNCTION cairo_pattern_add_color_stop_rgba ##### --> +<para> + +</para> + +@pattern: +@offset: +@red: +@green: +@blue: +@alpha: + + <!-- ##### FUNCTION cairo_pattern_create_rgb ##### --> <para> @@ -81,15 +108,6 @@ cairo_pattern_t @Returns: -<!-- ##### FUNCTION cairo_pattern_reference ##### --> -<para> - -</para> - -@pattern: -@Returns: - - <!-- ##### FUNCTION cairo_pattern_destroy ##### --> <para> @@ -98,7 +116,7 @@ cairo_pattern_t @pattern: -<!-- ##### FUNCTION cairo_pattern_status ##### --> +<!-- ##### FUNCTION cairo_pattern_reference ##### --> <para> </para> @@ -107,70 +125,64 @@ cairo_pattern_t @Returns: -<!-- ##### FUNCTION cairo_pattern_add_color_stop_rgb ##### --> +<!-- ##### FUNCTION cairo_pattern_status ##### --> <para> </para> @pattern: -@offset: -@red: -@green: -@blue: +@Returns: -<!-- ##### FUNCTION cairo_pattern_add_color_stop_rgba ##### --> +<!-- ##### ENUM cairo_extend_t ##### --> <para> </para> -@pattern: -@offset: -@red: -@green: -@blue: -@alpha: - +@CAIRO_EXTEND_NONE: +@CAIRO_EXTEND_REPEAT: +@CAIRO_EXTEND_REFLECT: -<!-- ##### FUNCTION cairo_pattern_set_matrix ##### --> +<!-- ##### FUNCTION cairo_pattern_set_extend ##### --> <para> </para> @pattern: -@matrix: +@extend: -<!-- ##### FUNCTION cairo_pattern_get_matrix ##### --> +<!-- ##### FUNCTION cairo_pattern_get_extend ##### --> <para> </para> @pattern: -@matrix: -<!-- # Unused Parameters # --> @Returns: -<!-- ##### ENUM cairo_extend_t ##### --> +<!-- ##### ENUM cairo_filter_t ##### --> <para> </para> -@CAIRO_EXTEND_NONE: -@CAIRO_EXTEND_REPEAT: -@CAIRO_EXTEND_REFLECT: +@CAIRO_FILTER_FAST: +@CAIRO_FILTER_GOOD: +@CAIRO_FILTER_BEST: +@CAIRO_FILTER_NEAREST: +@CAIRO_FILTER_BILINEAR: +@CAIRO_FILTER_GAUSSIAN: -<!-- ##### FUNCTION cairo_pattern_set_extend ##### --> +<!-- ##### FUNCTION cairo_pattern_set_filter ##### --> <para> </para> @pattern: -@extend: +@filter: -<!-- ##### FUNCTION cairo_pattern_get_extend ##### --> +<!-- ##### FUNCTION cairo_pattern_get_filter ##### --> <para> </para> @@ -179,21 +191,23 @@ cairo_pattern_t @Returns: -<!-- ##### FUNCTION cairo_pattern_set_filter ##### --> +<!-- ##### FUNCTION cairo_pattern_set_matrix ##### --> <para> </para> @pattern: -@filter: +@matrix: -<!-- ##### FUNCTION cairo_pattern_get_filter ##### --> +<!-- ##### FUNCTION cairo_pattern_get_matrix ##### --> <para> </para> @pattern: +@matrix: +<!-- # Unused Parameters # --> @Returns: diff --git a/doc/public/tmpl/cairo-pdf.sgml b/doc/public/tmpl/cairo-pdf.sgml index d29ed0e26..a7d9ac507 100644 --- a/doc/public/tmpl/cairo-pdf.sgml +++ b/doc/public/tmpl/cairo-pdf.sgml @@ -1,8 +1,10 @@ <!-- ##### SECTION Title ##### --> -PDF Backend + + PDF Surfaces <!-- ##### SECTION Short_Description ##### --> + Rendering PDF documents <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/doc/public/tmpl/cairo-png.sgml b/doc/public/tmpl/cairo-png.sgml index dd4486c71..ad66de8b8 100644 --- a/doc/public/tmpl/cairo-png.sgml +++ b/doc/public/tmpl/cairo-png.sgml @@ -1,8 +1,10 @@ <!-- ##### SECTION Title ##### --> -PNG Backend + + PNG Support <!-- ##### SECTION Short_Description ##### --> + Reading and writing PNG images <!-- ##### SECTION Long_Description ##### --> <para> @@ -26,6 +28,17 @@ PNG Backend @Returns: +<!-- ##### USER_FUNCTION cairo_read_func_t ##### --> +<para> + +</para> + +@closure: +@data: +@length: +@Returns: + + <!-- ##### FUNCTION cairo_image_surface_create_from_png_stream ##### --> <para> @@ -46,6 +59,17 @@ PNG Backend @Returns: +<!-- ##### USER_FUNCTION cairo_write_func_t ##### --> +<para> + +</para> + +@closure: +@data: +@length: +@Returns: + + <!-- ##### FUNCTION cairo_surface_write_to_png_stream ##### --> <para> diff --git a/doc/public/tmpl/cairo-ps.sgml b/doc/public/tmpl/cairo-ps.sgml index 4c5e8b37b..056c59611 100644 --- a/doc/public/tmpl/cairo-ps.sgml +++ b/doc/public/tmpl/cairo-ps.sgml @@ -1,8 +1,10 @@ <!-- ##### SECTION Title ##### --> -PS Backend + + PostScript Surfaces <!-- ##### SECTION Short_Description ##### --> + Rendering PostScript documents <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/doc/public/tmpl/cairo-quartz.sgml b/doc/public/tmpl/cairo-quartz.sgml index c83de6c77..9b9d114fd 100644 --- a/doc/public/tmpl/cairo-quartz.sgml +++ b/doc/public/tmpl/cairo-quartz.sgml @@ -1,8 +1,10 @@ <!-- ##### SECTION Title ##### --> -Quartz Backend + + Quartz Surfaces <!-- ##### SECTION Short_Description ##### --> + Rendering to Quartz surfaces <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/doc/public/tmpl/cairo-scaled-font.sgml b/doc/public/tmpl/cairo-scaled-font.sgml new file mode 100644 index 000000000..ff1c09918 --- /dev/null +++ b/doc/public/tmpl/cairo-scaled-font.sgml @@ -0,0 +1,110 @@ +<!-- ##### SECTION Title ##### --> + + Scaled Fonts + +<!-- ##### SECTION Short_Description ##### --> + + Caching metrics for a particular font size + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### TYPEDEF cairo_scaled_font_t ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION cairo_scaled_font_create ##### --> +<para> + +</para> + +@font_face: +@font_matrix: +@ctm: +@options: +@Returns: + + +<!-- ##### FUNCTION cairo_scaled_font_reference ##### --> +<para> + +</para> + +@scaled_font: +@Returns: + + +<!-- ##### FUNCTION cairo_scaled_font_destroy ##### --> +<para> + +</para> + +@scaled_font: + + +<!-- ##### FUNCTION cairo_scaled_font_status ##### --> +<para> + +</para> + +@scaled_font: +@Returns: + + +<!-- ##### STRUCT cairo_font_extents_t ##### --> +<para> + +</para> + +@ascent: +@descent: +@height: +@max_x_advance: +@max_y_advance: + +<!-- ##### FUNCTION cairo_scaled_font_extents ##### --> +<para> + +</para> + +@scaled_font: +@extents: +<!-- # Unused Parameters # --> +@Returns: + + +<!-- ##### STRUCT cairo_text_extents_t ##### --> +<para> + +</para> + +@x_bearing: +@y_bearing: +@width: +@height: +@x_advance: +@y_advance: + +<!-- ##### FUNCTION cairo_scaled_font_glyph_extents ##### --> +<para> + +</para> + +@scaled_font: +@glyphs: +@num_glyphs: +@extents: + + diff --git a/doc/public/tmpl/cairo-status.sgml b/doc/public/tmpl/cairo-status.sgml new file mode 100644 index 000000000..d0a859363 --- /dev/null +++ b/doc/public/tmpl/cairo-status.sgml @@ -0,0 +1,63 @@ +<!-- ##### SECTION Title ##### --> + + Error handling + +<!-- ##### SECTION Short_Description ##### --> + + Decoding Cairo's status + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### 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_INVALID_STATUS: +@CAIRO_STATUS_NULL_POINTER: +@CAIRO_STATUS_INVALID_STRING: +@CAIRO_STATUS_INVALID_PATH_DATA: +@CAIRO_STATUS_READ_ERROR: +@CAIRO_STATUS_WRITE_ERROR: +@CAIRO_STATUS_SURFACE_FINISHED: +@CAIRO_STATUS_SURFACE_TYPE_MISMATCH: +@CAIRO_STATUS_PATTERN_TYPE_MISMATCH: +@CAIRO_STATUS_INVALID_CONTENT: +@CAIRO_STATUS_INVALID_FORMAT: +@CAIRO_STATUS_INVALID_VISUAL: +@CAIRO_STATUS_FILE_NOT_FOUND: +@CAIRO_STATUS_INVALID_DASH: + +<!-- ##### FUNCTION cairo_status_to_string ##### --> +<para> + +</para> + +@status: +@Returns: + + +<!-- ##### FUNCTION cairo_debug_reset_static_data ##### --> +<para> + +</para> + + + diff --git a/doc/public/tmpl/cairo-surface.sgml b/doc/public/tmpl/cairo-surface.sgml index 64e65f9d4..8eaae2a2a 100644 --- a/doc/public/tmpl/cairo-surface.sgml +++ b/doc/public/tmpl/cairo-surface.sgml @@ -1,8 +1,10 @@ <!-- ##### SECTION Title ##### --> -cairo_surface_t + + cairo_surface_t <!-- ##### SECTION Short_Description ##### --> + Base class for surfaces <!-- ##### SECTION Long_Description ##### --> <para> @@ -23,6 +25,15 @@ cairo_surface_t </para> +<!-- ##### ENUM cairo_content_t ##### --> +<para> + +</para> + +@CAIRO_CONTENT_COLOR: +@CAIRO_CONTENT_ALPHA: +@CAIRO_CONTENT_COLOR_ALPHA: + <!-- ##### FUNCTION cairo_surface_create_similar ##### --> <para> @@ -37,15 +48,6 @@ cairo_surface_t @format: -<!-- ##### FUNCTION cairo_surface_reference ##### --> -<para> - -</para> - -@surface: -@Returns: - - <!-- ##### FUNCTION cairo_surface_destroy ##### --> <para> @@ -54,23 +56,22 @@ cairo_surface_t @surface: -<!-- ##### FUNCTION cairo_surface_status ##### --> +<!-- ##### FUNCTION cairo_surface_finish ##### --> <para> </para> @surface: +<!-- # Unused Parameters # --> @Returns: -<!-- ##### FUNCTION cairo_surface_finish ##### --> +<!-- ##### FUNCTION cairo_surface_flush ##### --> <para> </para> @surface: -<!-- # Unused Parameters # --> -@Returns: <!-- ##### FUNCTION cairo_surface_get_font_options ##### --> @@ -104,7 +105,7 @@ cairo_surface_t @Returns: -<!-- ##### FUNCTION cairo_surface_flush ##### --> +<!-- ##### FUNCTION cairo_surface_mark_dirty ##### --> <para> </para> @@ -112,24 +113,25 @@ cairo_surface_t @surface: -<!-- ##### FUNCTION cairo_surface_mark_dirty ##### --> +<!-- ##### FUNCTION cairo_surface_mark_dirty_rectangle ##### --> <para> </para> @surface: +@x: +@y: +@width: +@height: -<!-- ##### FUNCTION cairo_surface_mark_dirty_rectangle ##### --> +<!-- ##### FUNCTION cairo_surface_reference ##### --> <para> </para> @surface: -@x: -@y: -@width: -@height: +@Returns: <!-- ##### FUNCTION cairo_surface_set_device_offset ##### --> @@ -142,3 +144,12 @@ cairo_surface_t @y_offset: +<!-- ##### FUNCTION cairo_surface_status ##### --> +<para> + +</para> + +@surface: +@Returns: + + diff --git a/doc/public/tmpl/cairo-text.sgml b/doc/public/tmpl/cairo-text.sgml new file mode 100644 index 000000000..a580a3518 --- /dev/null +++ b/doc/public/tmpl/cairo-text.sgml @@ -0,0 +1,189 @@ +<!-- ##### SECTION Title ##### --> + + Text + +<!-- ##### SECTION Short_Description ##### --> + + Rendering text and sets of glyphs + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT cairo_glyph_t ##### --> +<para> + +</para> + +@index: +@x: +@y: + +<!-- ##### 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_face ##### --> +<para> + +</para> + +@cr: +@family: +@slant: +@weight: + + +<!-- ##### FUNCTION cairo_set_font_size ##### --> +<para> + +</para> + +@cr: +@size: + + +<!-- ##### FUNCTION cairo_set_font_matrix ##### --> +<para> + +</para> + +@cr: +@matrix: + + +<!-- ##### FUNCTION cairo_get_font_matrix ##### --> +<para> + +</para> + +@cr: +@matrix: + + +<!-- ##### FUNCTION cairo_set_font_options ##### --> +<para> + +</para> + +@cr: +@options: + + +<!-- ##### FUNCTION cairo_get_font_options ##### --> +<para> + +</para> + +@cr: +@options: + + +<!-- ##### FUNCTION cairo_show_text ##### --> +<para> + +</para> + +@cr: +@utf8: + + +<!-- ##### FUNCTION cairo_show_glyphs ##### --> +<para> + +</para> + +@cr: +@glyphs: +@num_glyphs: + + +<!-- ##### FUNCTION cairo_get_font_face ##### --> +<para> + +</para> + +@cr: +@Returns: + + +<!-- ##### FUNCTION cairo_font_extents ##### --> +<para> + +</para> + +@cr: +@extents: + + +<!-- ##### FUNCTION cairo_set_font_face ##### --> +<para> + +</para> + +@cr: +@font_face: + + +<!-- ##### 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: + + diff --git a/doc/public/tmpl/cairo-transforms.sgml b/doc/public/tmpl/cairo-transforms.sgml new file mode 100644 index 000000000..952894e52 --- /dev/null +++ b/doc/public/tmpl/cairo-transforms.sgml @@ -0,0 +1,127 @@ +<!-- ##### SECTION Title ##### --> + + Transformations + +<!-- ##### SECTION Short_Description ##### --> + + Manipulating the current transformation matrix + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### 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_transform ##### --> +<para> + +</para> + +@cr: +@matrix: + + +<!-- ##### FUNCTION cairo_set_matrix ##### --> +<para> + +</para> + +@cr: +@matrix: + + +<!-- ##### FUNCTION cairo_get_matrix ##### --> +<para> + +</para> + +@cr: +@matrix: +<!-- # Unused Parameters # --> +@Returns: + + +<!-- ##### FUNCTION cairo_identity_matrix ##### --> +<para> + +</para> + +@cr: + + +<!-- ##### FUNCTION cairo_user_to_device ##### --> +<para> + +</para> + +@cr: +@x: +@y: + + +<!-- ##### FUNCTION cairo_user_to_device_distance ##### --> +<para> + +</para> + +@cr: +@dx: +@dy: + + +<!-- ##### FUNCTION cairo_device_to_user ##### --> +<para> + +</para> + +@cr: +@x: +@y: + + +<!-- ##### FUNCTION cairo_device_to_user_distance ##### --> +<para> + +</para> + +@cr: +@dx: +@dy: + + diff --git a/doc/public/tmpl/cairo-types.sgml b/doc/public/tmpl/cairo-types.sgml new file mode 100644 index 000000000..f3c191086 --- /dev/null +++ b/doc/public/tmpl/cairo-types.sgml @@ -0,0 +1,42 @@ +<!-- ##### SECTION Title ##### --> + + Types + +<!-- ##### SECTION Short_Description ##### --> + + Generic data types used in the Cairo API + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### TYPEDEF cairo_bool_t ##### --> +<para> + +</para> + + +<!-- ##### STRUCT cairo_user_data_key_t ##### --> +<para> + +</para> + +@unused: + +<!-- ##### USER_FUNCTION cairo_destroy_func_t ##### --> +<para> + +</para> + +@data: + + diff --git a/doc/public/tmpl/cairo-version.sgml b/doc/public/tmpl/cairo-version.sgml new file mode 100644 index 000000000..eee32d67c --- /dev/null +++ b/doc/public/tmpl/cairo-version.sgml @@ -0,0 +1,54 @@ +<!-- ##### SECTION Title ##### --> + + Version Information + +<!-- ##### SECTION Short_Description ##### --> + + Compile and run time version checks + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO CAIRO_VERSION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO CAIRO_VERSION_ENCODE ##### --> +<para> + +</para> + +@major: +@minor: +@micro: + + +<!-- ##### FUNCTION cairo_version ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION cairo_version_string ##### --> +<para> + +</para> + +@Returns: + + diff --git a/doc/public/tmpl/cairo-win32-fonts.sgml b/doc/public/tmpl/cairo-win32-fonts.sgml new file mode 100644 index 000000000..cf798296f --- /dev/null +++ b/doc/public/tmpl/cairo-win32-fonts.sgml @@ -0,0 +1,57 @@ +<!-- ##### SECTION Title ##### --> + + Win32 Fonts + +<!-- ##### SECTION Short_Description ##### --> + + Font support for Microsoft Windows + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION cairo_win32_font_face_create_for_logfontw ##### --> +<para> + +</para> + +@logfont: +@Returns: + + +<!-- ##### FUNCTION cairo_win32_scaled_font_select_font ##### --> +<para> + +</para> + +@scaled_font: +@hdc: +@Returns: + + +<!-- ##### FUNCTION cairo_win32_scaled_font_done_font ##### --> +<para> + +</para> + +@scaled_font: + + +<!-- ##### FUNCTION cairo_win32_scaled_font_get_metrics_factor ##### --> +<para> + +</para> + +@scaled_font: +@Returns: + + diff --git a/doc/public/tmpl/cairo-win32.sgml b/doc/public/tmpl/cairo-win32.sgml index 4976ea064..9faa97d81 100644 --- a/doc/public/tmpl/cairo-win32.sgml +++ b/doc/public/tmpl/cairo-win32.sgml @@ -1,8 +1,10 @@ <!-- ##### SECTION Title ##### --> -Microsoft Windows Backend + + Win32 Surfaces <!-- ##### SECTION Short_Description ##### --> + Microsoft Windows surface support <!-- ##### SECTION Long_Description ##### --> <para> @@ -26,39 +28,3 @@ Microsoft Windows Backend @Returns: -<!-- ##### FUNCTION cairo_win32_font_face_create_for_logfontw ##### --> -<para> - -</para> - -@logfont: -@Returns: - - -<!-- ##### FUNCTION cairo_win32_scaled_font_select_font ##### --> -<para> - -</para> - -@scaled_font: -@hdc: -@Returns: - - -<!-- ##### FUNCTION cairo_win32_scaled_font_done_font ##### --> -<para> - -</para> - -@scaled_font: - - -<!-- ##### FUNCTION cairo_win32_scaled_font_get_metrics_factor ##### --> -<para> - -</para> - -@scaled_font: -@Returns: - - diff --git a/doc/public/tmpl/cairo-xcb-xrender.sgml b/doc/public/tmpl/cairo-xcb-xrender.sgml index 892967ec0..7ec6da14f 100644 --- a/doc/public/tmpl/cairo-xcb-xrender.sgml +++ b/doc/public/tmpl/cairo-xcb-xrender.sgml @@ -1,8 +1,10 @@ <!-- ##### SECTION Title ##### --> -XCB Backend + + XCB Surfaces <!-- ##### SECTION Short_Description ##### --> + X Window System rendering using the XCB library <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/doc/public/tmpl/cairo-xcb.sgml b/doc/public/tmpl/cairo-xcb.sgml index a58912c75..8b30cd512 100644 --- a/doc/public/tmpl/cairo-xcb.sgml +++ b/doc/public/tmpl/cairo-xcb.sgml @@ -1,8 +1,10 @@ <!-- ##### SECTION Title ##### --> -XCB Backend + + XCB Surfaces <!-- ##### SECTION Short_Description ##### --> + X Window System rendering using the XCB library <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/doc/public/tmpl/cairo-xlib.sgml b/doc/public/tmpl/cairo-xlib.sgml index d4cda4567..e669a24c2 100644 --- a/doc/public/tmpl/cairo-xlib.sgml +++ b/doc/public/tmpl/cairo-xlib.sgml @@ -1,8 +1,10 @@ <!-- ##### SECTION Title ##### --> -XLib Backend + + XLib Surfaces <!-- ##### SECTION Short_Description ##### --> + X Window System rendering using XLib <!-- ##### SECTION Long_Description ##### --> <para> diff --git a/doc/public/tmpl/cairo.sgml b/doc/public/tmpl/cairo.sgml index 81a0580fb..d161b79a4 100644 --- a/doc/public/tmpl/cairo.sgml +++ b/doc/public/tmpl/cairo.sgml @@ -1,8 +1,10 @@ <!-- ##### SECTION Title ##### --> -cairo_t + + cairo_t <!-- ##### SECTION Short_Description ##### --> -Drawing contexts. + + The Cairo drawing context <!-- ##### SECTION Long_Description ##### --> @@ -75,68 +77,22 @@ Drawing contexts. @cr: -<!-- ##### ENUM cairo_content_t ##### --> -<para> - -</para> - -@CAIRO_CONTENT_COLOR: -@CAIRO_CONTENT_ALPHA: -@CAIRO_CONTENT_COLOR_ALPHA: - -<!-- ##### MACRO CAIRO_CONTENT_VALID ##### --> -<para> - -</para> - -@content: - - -<!-- ##### ENUM cairo_format_t ##### --> -<para> - -</para> - -@CAIRO_FORMAT_ARGB32: -@CAIRO_FORMAT_RGB24: -@CAIRO_FORMAT_A8: -@CAIRO_FORMAT_A1: - -<!-- ##### MACRO CAIRO_FORMAT_VALID ##### --> +<!-- ##### FUNCTION cairo_status ##### --> <para> </para> -@format: - - -<!-- ##### ENUM cairo_operator_t ##### --> -<para> +@cr: +@Returns: -</para> -@CAIRO_OPERATOR_CLEAR: -@CAIRO_OPERATOR_SOURCE: -@CAIRO_OPERATOR_OVER: -@CAIRO_OPERATOR_IN: -@CAIRO_OPERATOR_OUT: -@CAIRO_OPERATOR_ATOP: -@CAIRO_OPERATOR_DEST: -@CAIRO_OPERATOR_DEST_OVER: -@CAIRO_OPERATOR_DEST_IN: -@CAIRO_OPERATOR_DEST_OUT: -@CAIRO_OPERATOR_DEST_ATOP: -@CAIRO_OPERATOR_XOR: -@CAIRO_OPERATOR_ADD: -@CAIRO_OPERATOR_SATURATE: - -<!-- ##### FUNCTION cairo_set_operator ##### --> +<!-- ##### FUNCTION cairo_get_target ##### --> <para> </para> @cr: -@op: +@Returns: <!-- ##### FUNCTION cairo_set_source_rgb ##### --> @@ -182,13 +138,13 @@ Drawing contexts. @y: -<!-- ##### FUNCTION cairo_set_tolerance ##### --> +<!-- ##### FUNCTION cairo_get_source ##### --> <para> </para> @cr: -@tolerance: +@Returns: <!-- ##### ENUM cairo_antialias_t ##### --> @@ -210,66 +166,13 @@ Drawing contexts. @antialias: -<!-- ##### 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 ##### --> +<!-- ##### FUNCTION cairo_get_antialias ##### --> <para> </para> @cr: -@line_join: +@Returns: <!-- ##### FUNCTION cairo_set_dash ##### --> @@ -285,270 +188,187 @@ Drawing contexts. @ndash: -<!-- ##### 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_transform ##### --> -<para> - -</para> - -@cr: -@matrix: - - -<!-- ##### FUNCTION cairo_set_matrix ##### --> -<para> - -</para> - -@cr: -@matrix: - - -<!-- ##### FUNCTION cairo_identity_matrix ##### --> -<para> - -</para> - -@cr: - - -<!-- ##### FUNCTION cairo_user_to_device ##### --> +<!-- ##### ENUM cairo_fill_rule_t ##### --> <para> </para> -@cr: -@x: -@y: - +@CAIRO_FILL_RULE_WINDING: +@CAIRO_FILL_RULE_EVEN_ODD: -<!-- ##### FUNCTION cairo_user_to_device_distance ##### --> +<!-- ##### FUNCTION cairo_set_fill_rule ##### --> <para> </para> @cr: -@dx: -@dy: +@fill_rule: -<!-- ##### FUNCTION cairo_device_to_user ##### --> +<!-- ##### FUNCTION cairo_get_fill_rule ##### --> <para> </para> @cr: -@x: -@y: +@Returns: -<!-- ##### FUNCTION cairo_device_to_user_distance ##### --> +<!-- ##### ENUM cairo_line_cap_t ##### --> <para> </para> -@cr: -@dx: -@dy: - +@CAIRO_LINE_CAP_BUTT: +@CAIRO_LINE_CAP_ROUND: +@CAIRO_LINE_CAP_SQUARE: -<!-- ##### FUNCTION cairo_new_path ##### --> +<!-- ##### FUNCTION cairo_set_line_cap ##### --> <para> </para> @cr: +@line_cap: -<!-- ##### FUNCTION cairo_move_to ##### --> +<!-- ##### FUNCTION cairo_get_line_cap ##### --> <para> </para> @cr: -@x: -@y: +@Returns: -<!-- ##### FUNCTION cairo_line_to ##### --> +<!-- ##### ENUM cairo_line_join_t ##### --> <para> </para> -@cr: -@x: -@y: - +@CAIRO_LINE_JOIN_MITER: +@CAIRO_LINE_JOIN_ROUND: +@CAIRO_LINE_JOIN_BEVEL: -<!-- ##### FUNCTION cairo_curve_to ##### --> +<!-- ##### FUNCTION cairo_set_line_join ##### --> <para> </para> @cr: -@x1: -@y1: -@x2: -@y2: -@x3: -@y3: +@line_join: -<!-- ##### FUNCTION cairo_arc ##### --> +<!-- ##### FUNCTION cairo_get_line_join ##### --> <para> </para> @cr: -@xc: -@yc: -@radius: -@angle1: -@angle2: +@Returns: -<!-- ##### FUNCTION cairo_arc_negative ##### --> +<!-- ##### FUNCTION cairo_set_line_width ##### --> <para> </para> @cr: -@xc: -@yc: -@radius: -@angle1: -@angle2: +@width: -<!-- ##### FUNCTION cairo_rel_move_to ##### --> +<!-- ##### FUNCTION cairo_get_line_width ##### --> <para> </para> @cr: -@dx: -@dy: +@Returns: -<!-- ##### FUNCTION cairo_rel_line_to ##### --> +<!-- ##### FUNCTION cairo_set_miter_limit ##### --> <para> </para> @cr: -@dx: -@dy: +@limit: -<!-- ##### FUNCTION cairo_rel_curve_to ##### --> +<!-- ##### FUNCTION cairo_get_miter_limit ##### --> <para> </para> @cr: -@dx1: -@dy1: -@dx2: -@dy2: -@dx3: -@dy3: +@Returns: -<!-- ##### FUNCTION cairo_rectangle ##### --> +<!-- ##### ENUM cairo_operator_t ##### --> <para> </para> -@cr: -@x: -@y: -@width: -@height: - +@CAIRO_OPERATOR_CLEAR: +@CAIRO_OPERATOR_SOURCE: +@CAIRO_OPERATOR_OVER: +@CAIRO_OPERATOR_IN: +@CAIRO_OPERATOR_OUT: +@CAIRO_OPERATOR_ATOP: +@CAIRO_OPERATOR_DEST: +@CAIRO_OPERATOR_DEST_OVER: +@CAIRO_OPERATOR_DEST_IN: +@CAIRO_OPERATOR_DEST_OUT: +@CAIRO_OPERATOR_DEST_ATOP: +@CAIRO_OPERATOR_XOR: +@CAIRO_OPERATOR_ADD: +@CAIRO_OPERATOR_SATURATE: -<!-- ##### FUNCTION cairo_close_path ##### --> +<!-- ##### FUNCTION cairo_set_operator ##### --> <para> </para> @cr: +@op: -<!-- ##### FUNCTION cairo_paint ##### --> +<!-- ##### FUNCTION cairo_get_operator ##### --> <para> </para> @cr: +@Returns: -<!-- ##### FUNCTION cairo_paint_with_alpha ##### --> +<!-- ##### FUNCTION cairo_set_tolerance ##### --> <para> </para> @cr: -@alpha: +@tolerance: -<!-- ##### FUNCTION cairo_mask ##### --> +<!-- ##### FUNCTION cairo_get_tolerance ##### --> <para> </para> @cr: -@pattern: +@Returns: -<!-- ##### FUNCTION cairo_mask_surface ##### --> +<!-- ##### FUNCTION cairo_clip ##### --> <para> </para> @cr: -@surface: -@surface_x: -@surface_y: -<!-- ##### FUNCTION cairo_stroke ##### --> +<!-- ##### FUNCTION cairo_clip_preserve ##### --> <para> </para> @@ -556,7 +376,7 @@ Drawing contexts. @cr: -<!-- ##### FUNCTION cairo_stroke_preserve ##### --> +<!-- ##### FUNCTION cairo_reset_clip ##### --> <para> </para> @@ -580,62 +400,6 @@ Drawing contexts. @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> @@ -648,235 +412,83 @@ Drawing contexts. @y2: -<!-- ##### FUNCTION cairo_clip ##### --> -<para> - -</para> - -@cr: - - -<!-- ##### FUNCTION cairo_clip_preserve ##### --> -<para> - -</para> - -@cr: - - -<!-- ##### FUNCTION cairo_reset_clip ##### --> +<!-- ##### FUNCTION cairo_in_fill ##### --> <para> </para> @cr: - - -<!-- ##### STRUCT cairo_glyph_t ##### --> -<para> - -</para> - -@index: @x: @y: - -<!-- ##### 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_face ##### --> -<para> - -</para> - -@cr: -@family: -@slant: -@weight: - - -<!-- ##### FUNCTION cairo_set_font_size ##### --> -<para> - -</para> - -@cr: -@size: - - -<!-- ##### FUNCTION cairo_set_font_matrix ##### --> -<para> - -</para> - -@cr: -@matrix: - - -<!-- ##### FUNCTION cairo_get_font_matrix ##### --> -<para> - -</para> - -@cr: -@matrix: - - -<!-- ##### FUNCTION cairo_set_font_options ##### --> -<para> - -</para> - -@cr: -@options: - - -<!-- ##### FUNCTION cairo_get_font_options ##### --> -<para> - -</para> - -@cr: -@options: - - -<!-- ##### FUNCTION cairo_show_text ##### --> -<para> - -</para> - -@cr: -@utf8: - - -<!-- ##### FUNCTION cairo_show_glyphs ##### --> -<para> - -</para> - -@cr: -@glyphs: -@num_glyphs: - - -<!-- ##### FUNCTION cairo_get_font_face ##### --> -<para> - -</para> - -@cr: @Returns: -<!-- ##### FUNCTION cairo_font_extents ##### --> -<para> - -</para> - -@cr: -@extents: - - -<!-- ##### FUNCTION cairo_set_font_face ##### --> -<para> - -</para> - -@cr: -@font_face: - - -<!-- ##### FUNCTION cairo_text_extents ##### --> -<para> - -</para> - -@cr: -@utf8: -@extents: - - -<!-- ##### FUNCTION cairo_glyph_extents ##### --> +<!-- ##### FUNCTION cairo_mask ##### --> <para> </para> @cr: -@glyphs: -@num_glyphs: -@extents: +@pattern: -<!-- ##### FUNCTION cairo_text_path ##### --> +<!-- ##### FUNCTION cairo_mask_surface ##### --> <para> </para> @cr: -@utf8: +@surface: +@surface_x: +@surface_y: -<!-- ##### FUNCTION cairo_glyph_path ##### --> +<!-- ##### FUNCTION cairo_paint ##### --> <para> </para> @cr: -@glyphs: -@num_glyphs: -<!-- ##### FUNCTION cairo_get_operator ##### --> +<!-- ##### FUNCTION cairo_paint_with_alpha ##### --> <para> </para> @cr: -@Returns: +@alpha: -<!-- ##### FUNCTION cairo_get_source ##### --> +<!-- ##### FUNCTION cairo_stroke ##### --> <para> </para> @cr: -@Returns: -<!-- ##### FUNCTION cairo_get_tolerance ##### --> +<!-- ##### FUNCTION cairo_stroke_preserve ##### --> <para> </para> @cr: -@Returns: -<!-- ##### FUNCTION cairo_get_antialias ##### --> +<!-- ##### FUNCTION cairo_stroke_extents ##### --> <para> </para> @cr: -@Returns: +@x1: +@y1: +@x2: +@y2: -<!-- ##### FUNCTION cairo_get_current_point ##### --> +<!-- ##### FUNCTION cairo_in_stroke ##### --> <para> </para> @@ -884,273 +496,22 @@ Drawing contexts. @cr: @x: @y: - - -<!-- ##### FUNCTION cairo_get_fill_rule ##### --> -<para> - -</para> - -@cr: -@Returns: - - -<!-- ##### FUNCTION cairo_get_line_width ##### --> -<para> - -</para> - -@cr: -@Returns: - - -<!-- ##### FUNCTION cairo_get_line_cap ##### --> -<para> - -</para> - -@cr: -@Returns: - - -<!-- ##### FUNCTION cairo_get_line_join ##### --> -<para> - -</para> - -@cr: -@Returns: - - -<!-- ##### FUNCTION cairo_get_miter_limit ##### --> -<para> - -</para> - -@cr: -@Returns: - - -<!-- ##### FUNCTION cairo_get_matrix ##### --> -<para> - -</para> - -@cr: -@matrix: -<!-- # Unused Parameters # --> -@Returns: - - -<!-- ##### FUNCTION cairo_get_target ##### --> -<para> - -</para> - -@cr: @Returns: -<!-- ##### FUNCTION cairo_copy_path ##### --> -<para> - -</para> - -@cr: -@Returns: - - -<!-- ##### FUNCTION cairo_copy_path_flat ##### --> -<para> - -</para> - -@cr: -@Returns: - - -<!-- ##### FUNCTION cairo_append_path ##### --> +<!-- ##### FUNCTION cairo_copy_page ##### --> <para> </para> @cr: -@path: - - -<!-- ##### ENUM cairo_path_data_type_t ##### --> -<para> -</para> - -@CAIRO_PATH_MOVE_TO: -@CAIRO_PATH_LINE_TO: -@CAIRO_PATH_CURVE_TO: -@CAIRO_PATH_CLOSE_PATH: -<!-- ##### STRUCT cairo_path_t ##### --> -<para> - -</para> - -@status: -@data: -@num_data: - -<!-- ##### FUNCTION cairo_path_destroy ##### --> -<para> - -</para> - -@path: - - -<!-- ##### 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_INVALID_STATUS: -@CAIRO_STATUS_NULL_POINTER: -@CAIRO_STATUS_INVALID_STRING: -@CAIRO_STATUS_INVALID_PATH_DATA: -@CAIRO_STATUS_READ_ERROR: -@CAIRO_STATUS_WRITE_ERROR: -@CAIRO_STATUS_SURFACE_FINISHED: -@CAIRO_STATUS_SURFACE_TYPE_MISMATCH: -@CAIRO_STATUS_PATTERN_TYPE_MISMATCH: -@CAIRO_STATUS_INVALID_CONTENT: -@CAIRO_STATUS_INVALID_FORMAT: -@CAIRO_STATUS_INVALID_VISUAL: -@CAIRO_STATUS_FILE_NOT_FOUND: -@CAIRO_STATUS_INVALID_DASH: - -<!-- ##### FUNCTION cairo_status ##### --> +<!-- ##### FUNCTION cairo_show_page ##### --> <para> </para> @cr: -@Returns: - - -<!-- ##### MACRO cairo_status_string ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION cairo_status_to_string ##### --> -<para> - -</para> - -@status: -@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: - - -<!-- ##### FUNCTION cairo_image_surface_get_width ##### --> -<para> - -</para> - -@surface: -@Returns: - - -<!-- ##### FUNCTION cairo_image_surface_get_height ##### --> -<para> - -</para> - -@surface: -@Returns: - - -<!-- ##### USER_FUNCTION cairo_destroy_func_t ##### --> -<para> - -</para> - -@data: - - -<!-- ##### STRUCT cairo_user_data_key_t ##### --> -<para> - -</para> - -@unused: - -<!-- ##### USER_FUNCTION cairo_read_func_t ##### --> -<para> - -</para> - -@closure: -@data: -@length: -@Returns: - - -<!-- ##### USER_FUNCTION cairo_write_func_t ##### --> -<para> - -</para> - -@closure: -@data: -@length: -@Returns: - - -<!-- ##### FUNCTION cairo_debug_reset_static_data ##### --> -<para> - -</para> - |