From a68097a219543160ea6ff12628626dcdb070f97e Mon Sep 17 00:00:00 2001 From: Billy Biggs Date: Mon, 22 Aug 2005 22:11:44 +0000 Subject: [PATCH] Rework the index for the reference manual. Update descriptions and add new files for added sections. --- ChangeLog | 33 + doc/public/cairo-docs.xml | 50 +- doc/public/cairo-sections.txt | 332 ++++---- doc/public/tmpl/cairo-font-options.sgml | 194 +++++ doc/public/tmpl/cairo-font.sgml | 268 +------ doc/public/tmpl/cairo-ft.sgml | 18 +- doc/public/tmpl/cairo-glitz.sgml | 4 +- doc/public/tmpl/cairo-image.sgml | 73 ++ doc/public/tmpl/cairo-matrix.sgml | 5 +- doc/public/tmpl/cairo-paths.sgml | 207 +++++ doc/public/tmpl/cairo-pattern.sgml | 122 +-- doc/public/tmpl/cairo-pdf.sgml | 4 +- doc/public/tmpl/cairo-png.sgml | 26 +- doc/public/tmpl/cairo-ps.sgml | 4 +- doc/public/tmpl/cairo-quartz.sgml | 4 +- doc/public/tmpl/cairo-scaled-font.sgml | 110 +++ doc/public/tmpl/cairo-status.sgml | 63 ++ doc/public/tmpl/cairo-surface.sgml | 65 +- doc/public/tmpl/cairo-text.sgml | 189 +++++ doc/public/tmpl/cairo-transforms.sgml | 127 +++ doc/public/tmpl/cairo-types.sgml | 42 + doc/public/tmpl/cairo-version.sgml | 54 ++ doc/public/tmpl/cairo-win32-fonts.sgml | 57 ++ doc/public/tmpl/cairo-win32.sgml | 40 +- doc/public/tmpl/cairo-xcb-xrender.sgml | 4 +- doc/public/tmpl/cairo-xcb.sgml | 4 +- doc/public/tmpl/cairo-xlib.sgml | 4 +- doc/public/tmpl/cairo.sgml | 995 +++++------------------- 28 files changed, 1725 insertions(+), 1373 deletions(-) create mode 100644 doc/public/tmpl/cairo-font-options.sgml create mode 100644 doc/public/tmpl/cairo-image.sgml create mode 100644 doc/public/tmpl/cairo-paths.sgml create mode 100644 doc/public/tmpl/cairo-scaled-font.sgml create mode 100644 doc/public/tmpl/cairo-status.sgml create mode 100644 doc/public/tmpl/cairo-text.sgml create mode 100644 doc/public/tmpl/cairo-transforms.sgml create mode 100644 doc/public/tmpl/cairo-types.sgml create mode 100644 doc/public/tmpl/cairo-version.sgml create mode 100644 doc/public/tmpl/cairo-win32-fonts.sgml diff --git a/ChangeLog b/ChangeLog index f297e2a20..4b172005a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,36 @@ +2005-08-22 Billy Biggs + + * doc/public/cairo-docs.xml: + * doc/public/cairo-sections.txt: Rework the index for the + reference manual. + + * doc/public/tmpl/cairo-font-options.sgml: + * doc/public/tmpl/cairo-font.sgml: + * doc/public/tmpl/cairo-ft.sgml: + * doc/public/tmpl/cairo-glitz.sgml: + * doc/public/tmpl/cairo-image.sgml: + * doc/public/tmpl/cairo-matrix.sgml: + * doc/public/tmpl/cairo-paths.sgml: + * doc/public/tmpl/cairo-pattern.sgml: + * doc/public/tmpl/cairo-pdf.sgml: + * doc/public/tmpl/cairo-png.sgml: + * doc/public/tmpl/cairo-ps.sgml: + * doc/public/tmpl/cairo-quartz.sgml: + * doc/public/tmpl/cairo-scaled-font.sgml: + * doc/public/tmpl/cairo-status.sgml: + * doc/public/tmpl/cairo-surface.sgml: + * doc/public/tmpl/cairo-text.sgml: + * doc/public/tmpl/cairo-transforms.sgml: + * doc/public/tmpl/cairo-types.sgml: + * doc/public/tmpl/cairo-version.sgml: + * doc/public/tmpl/cairo-win32-fonts.sgml: + * doc/public/tmpl/cairo-win32.sgml: + * doc/public/tmpl/cairo-xcb-xrender.sgml: + * doc/public/tmpl/cairo-xcb.sgml: + * doc/public/tmpl/cairo-xlib.sgml: + * doc/public/tmpl/cairo.sgml: Update descriptions and add new + files for added sections. + 2005-08-22 Owen Taylor * src/cairo-ft-font.c: Make cairo_ft_unscaled_font_backend static. 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 @@ Reference - - - - - - - - - - - - - - + + Drawing + + + + + + + + Fonts + + + + + + + + Surfaces + + + + + + + + + + + + + Utilities + + + + + Index 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,63 +1,80 @@
cairo-ft FreeType Fonts -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
-cairo-glitz -Glitz backend -cairo_glitz_surface_create -
- -
-cairo-pdf -PDF Backend -cairo_pdf_surface_create -cairo_pdf_surface_create_for_stream -cairo_pdf_surface_set_dpi -
- -
-cairo-png -PNG Backend -cairo_image_surface_create_from_png -cairo_image_surface_create_from_png_stream -cairo_surface_write_to_png -cairo_surface_write_to_png_stream -
- -
-cairo-ps -PS Backend -cairo_ps_surface_create -cairo_ps_surface_create_for_stream -cairo_ps_surface_set_dpi -
- -
-cairo-quartz -Quartz Backend -cairo_quartz_surface_create -
- -
-cairo-win32 -Microsoft Windows Backend -cairo_win32_surface_create +cairo-win32-fonts +Win32 Fonts 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
+
+cairo-glitz +Glitz Surfaces +cairo_glitz_surface_create +
+ +
+cairo-image +Image Surfaces +cairo_format_t +cairo_image_surface_create +cairo_image_surface_create_for_data +cairo_image_surface_get_width +cairo_image_surface_get_height +
+ +
+cairo-pdf +PDF Surfaces +cairo_pdf_surface_create +cairo_pdf_surface_create_for_stream +cairo_pdf_surface_set_dpi +
+ +
+cairo-png +PNG Support +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 +
+ +
+cairo-ps +PostScript Surfaces +cairo_ps_surface_create +cairo_ps_surface_create_for_stream +cairo_ps_surface_set_dpi +
+ +
+cairo-quartz +Quartz Surfaces +cairo_quartz_surface_create +
+ +
+cairo-win32 +Win32 Surfaces +cairo_win32_surface_create +
+
cairo-xcb -XCB Backend +XCB Surfaces cairo_xcb_surface_create cairo_xcb_surface_create_for_bitmap cairo_xcb_surface_set_size @@ -65,13 +82,13 @@ cairo_xcb_surface_set_size
cairo-xcb-xrender -XCB Backend +XCB Render Surfaces cairo_xcb_surface_create_with_xrender_format
cairo-xlib -XLib Backend +XLib Surfaces 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 cairo-surface cairo_surface_t 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 +
+ +
+cairo-version +Version Information +CAIRO_VERSION +CAIRO_VERSION_STRING +CAIRO_VERSION_ENCODE +cairo_version +cairo_version_string
cairo-pattern -cairo_pattern_t +Patterns 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
@@ -143,16 +172,29 @@ cairo_matrix_transform_distance cairo_matrix_transform_point
+
+cairo-status +Error handling +cairo_status_t +cairo_status_to_string +cairo_debug_reset_static_data +
+
cairo-font -Fonts +cairo_font_face_t 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 +
+ +
+cairo-scaled-font +Scaled Fonts +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 +
+ +
+cairo-font-options +Font Options cairo_font_options_t cairo_font_options_create cairo_font_options_copy @@ -183,47 +230,43 @@ cairo_font_options_get_hint_metrics
-cairo -cairo_t -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 +cairo-types +Types +cairo_bool_t +cairo_user_data_key_t +cairo_destroy_func_t +
+ +
+cairo-transforms +Transformations 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 +
+ + +
+cairo-paths +Paths +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 +
+ +
+cairo-text +Text 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 -cairo_get_source -cairo_get_tolerance -cairo_get_antialias -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 -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 +cairo_t +cairo_t +cairo_create +cairo_reference +cairo_destroy +cairo_save +cairo_restore 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_get_target +cairo_set_source_rgb +cairo_set_source_rgba +cairo_set_source +cairo_set_source_surface +cairo_get_source +cairo_antialias_t +cairo_set_antialias +cairo_get_antialias +cairo_set_dash +cairo_fill_rule_t +cairo_set_fill_rule +cairo_get_fill_rule +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_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 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
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 @@ + + + Font Options + + + + How a font should be rendered + + + + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@original: +@Returns: + + + + + + + +@options: + + + + + + + +@options: +@Returns: + + + + + + + +@options: +@other: + + + + + + + +@options: +@Returns: + + + + + + + +@options: +@other: +@Returns: + + + + + + + +@options: +@antialias: + + + + + + + +@options: +@Returns: + + + + + + + +@CAIRO_SUBPIXEL_ORDER_DEFAULT: +@CAIRO_SUBPIXEL_ORDER_RGB: +@CAIRO_SUBPIXEL_ORDER_BGR: +@CAIRO_SUBPIXEL_ORDER_VRGB: +@CAIRO_SUBPIXEL_ORDER_VBGR: + + + + + + +@options: +@subpixel_order: + + + + + + + +@options: +@Returns: + +@option: + + + + + + + +@CAIRO_HINT_STYLE_DEFAULT: +@CAIRO_HINT_STYLE_NONE: +@CAIRO_HINT_STYLE_SLIGHT: +@CAIRO_HINT_STYLE_MEDIUM: +@CAIRO_HINT_STYLE_FULL: + + + + + + +@options: +@hint_style: + + + + + + + +@options: +@Returns: + + + + + + + +@CAIRO_HINT_METRICS_DEFAULT: +@CAIRO_HINT_METRICS_OFF: +@CAIRO_HINT_METRICS_ON: + + + + + + +@options: +@hint_metrics: + + + + + + + +@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 @@ -Fonts + + cairo_font_face_t -Font Handling + + Base class for fonts @@ -23,12 +25,6 @@ Font Handling - - - - - - @@ -77,259 +73,3 @@ Font Handling @Returns: - - - - - -@font_face: -@font_matrix: -@ctm: -@options: -@Returns: - - - - - - - -@scaled_font: -@Returns: - - - - - - - -@scaled_font: - - - - - - - -@scaled_font: -@Returns: - - - - - - - -@ascent: -@descent: -@height: -@max_x_advance: -@max_y_advance: - - - - - - -@scaled_font: -@extents: - -@Returns: - - - - - - - -@x_bearing: -@y_bearing: -@width: -@height: -@x_advance: -@y_advance: - - - - - - -@scaled_font: -@glyphs: -@num_glyphs: -@extents: - - - - - - - - - - - - - -@Returns: - - - - - - - -@original: -@Returns: - - - - - - - -@options: - - - - - - - -@options: -@Returns: - - - - - - - -@options: -@other: - - - - - - - -@options: -@Returns: - - - - - - - -@options: -@other: -@Returns: - - - - - - - -@options: -@antialias: - - - - - - - -@options: -@Returns: - - - - - - - -@CAIRO_SUBPIXEL_ORDER_DEFAULT: -@CAIRO_SUBPIXEL_ORDER_RGB: -@CAIRO_SUBPIXEL_ORDER_BGR: -@CAIRO_SUBPIXEL_ORDER_VRGB: -@CAIRO_SUBPIXEL_ORDER_VBGR: - - - - - - -@options: -@subpixel_order: - - - - - - - -@options: -@Returns: - -@option: - - - - - - - -@CAIRO_HINT_STYLE_DEFAULT: -@CAIRO_HINT_STYLE_NONE: -@CAIRO_HINT_STYLE_SLIGHT: -@CAIRO_HINT_STYLE_MEDIUM: -@CAIRO_HINT_STYLE_FULL: - - - - - - -@options: -@hint_style: - - - - - - - -@options: -@Returns: - - - - - - - -@CAIRO_HINT_METRICS_DEFAULT: -@CAIRO_HINT_METRICS_OFF: -@CAIRO_HINT_METRICS_ON: - - - - - - -@options: -@hint_metrics: - - - - - - - -@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 @@ -FreeType Fonts + + FreeType Fonts + Font support for FreeType @@ -17,13 +19,14 @@ FreeType Fonts - + -@options: -@pattern: +@face: +@load_flags: +@Returns: @@ -35,14 +38,13 @@ FreeType Fonts @Returns: - + -@face: -@load_flags: -@Returns: +@options: +@pattern: 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 @@ -Glitz backend + + Glitz Surfaces + OpenGL accelerated rendering using the Glitz library 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 @@ + + + Image Surfaces + + + + Rendering to memory buffers + + + + + + + + + + + + + + + + + + + +@CAIRO_FORMAT_ARGB32: +@CAIRO_FORMAT_RGB24: +@CAIRO_FORMAT_A8: +@CAIRO_FORMAT_A1: + + + + + + +@format: +@width: +@height: +@Returns: + + + + + + + +@data: +@format: +@width: +@height: +@stride: +@Returns: + + + + + + + +@surface: +@Returns: + + + + + + + +@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 @@ -cairo_matrix_t + + cairo_matrix_t - Transformation matrices + Generic matrix operations 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 @@ + + + Paths + + + + Creating paths and manipulating path data + + + + + + + + + + + + + + + + + + + +@status: +@data: +@num_data: + + + + + + +@CAIRO_PATH_MOVE_TO: +@CAIRO_PATH_LINE_TO: +@CAIRO_PATH_CURVE_TO: +@CAIRO_PATH_CLOSE_PATH: + + + + + + +@cr: +@Returns: + + + + + + + +@cr: +@Returns: + + + + + + + +@path: + + + + + + + +@cr: +@path: + + + + + + + +@cr: + + + + + + + +@cr: + + + + + + + +@cr: +@x: +@y: + + + + + + + +@cr: +@x: +@y: + + + + + + + +@cr: +@x: +@y: + + + + + + + +@cr: +@x1: +@y1: +@x2: +@y2: +@x3: +@y3: + + + + + + + +@cr: +@xc: +@yc: +@radius: +@angle1: +@angle2: + + + + + + + +@cr: +@xc: +@yc: +@radius: +@angle1: +@angle2: + + + + + + + +@cr: +@dx: +@dy: + + + + + + + +@cr: +@dx: +@dy: + + + + + + + +@cr: +@dx1: +@dy1: +@dx2: +@dy2: +@dx3: +@dy3: + + + + + + + +@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 @@ -cairo_pattern_t + + Patterns + Gradients and filtered sources @@ -23,6 +25,31 @@ cairo_pattern_t + + + + + +@pattern: +@offset: +@red: +@green: +@blue: + + + + + + + +@pattern: +@offset: +@red: +@green: +@blue: +@alpha: + + @@ -81,6 +108,14 @@ cairo_pattern_t @Returns: + + + + + +@pattern: + + @@ -90,14 +125,6 @@ cairo_pattern_t @Returns: - - - - - -@pattern: - - @@ -107,51 +134,6 @@ cairo_pattern_t @Returns: - - - - - -@pattern: -@offset: -@red: -@green: -@blue: - - - - - - - -@pattern: -@offset: -@red: -@green: -@blue: -@alpha: - - - - - - - -@pattern: -@matrix: - - - - - - - -@pattern: -@matrix: - -@Returns: - - @@ -179,6 +161,18 @@ cairo_pattern_t @Returns: + + + + + +@CAIRO_FILTER_FAST: +@CAIRO_FILTER_GOOD: +@CAIRO_FILTER_BEST: +@CAIRO_FILTER_NEAREST: +@CAIRO_FILTER_BILINEAR: +@CAIRO_FILTER_GAUSSIAN: + @@ -197,3 +191,23 @@ cairo_pattern_t @Returns: + + + + + +@pattern: +@matrix: + + + + + + + +@pattern: +@matrix: + +@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 @@ -PDF Backend + + PDF Surfaces + Rendering PDF documents 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 @@ -PNG Backend + + PNG Support + Reading and writing PNG images @@ -26,6 +28,17 @@ PNG Backend @Returns: + + + + + +@closure: +@data: +@length: +@Returns: + + @@ -46,6 +59,17 @@ PNG Backend @Returns: + + + + + +@closure: +@data: +@length: +@Returns: + + 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 @@ -PS Backend + + PostScript Surfaces + Rendering PostScript documents 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 @@ -Quartz Backend + + Quartz Surfaces + Rendering to Quartz surfaces 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 @@ + + + Scaled Fonts + + + + Caching metrics for a particular font size + + + + + + + + + + + + + + + + + + + + + + + + + +@font_face: +@font_matrix: +@ctm: +@options: +@Returns: + + + + + + + +@scaled_font: +@Returns: + + + + + + + +@scaled_font: + + + + + + + +@scaled_font: +@Returns: + + + + + + + +@ascent: +@descent: +@height: +@max_x_advance: +@max_y_advance: + + + + + + +@scaled_font: +@extents: + +@Returns: + + + + + + + +@x_bearing: +@y_bearing: +@width: +@height: +@x_advance: +@y_advance: + + + + + + +@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 @@ + + + Error handling + + + + Decoding Cairo's status + + + + + + + + + + + + + + + + + + + +@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: + + + + + + +@status: +@Returns: + + + + + + + + + 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 @@ -cairo_surface_t + + cairo_surface_t + Base class for surfaces @@ -23,6 +25,15 @@ cairo_surface_t + + + + + +@CAIRO_CONTENT_COLOR: +@CAIRO_CONTENT_ALPHA: +@CAIRO_CONTENT_COLOR_ALPHA: + @@ -37,15 +48,6 @@ cairo_surface_t @format: - - - - - -@surface: -@Returns: - - @@ -54,15 +56,6 @@ cairo_surface_t @surface: - - - - - -@surface: -@Returns: - - @@ -73,6 +66,14 @@ cairo_surface_t @Returns: + + + + + +@surface: + + @@ -104,14 +105,6 @@ cairo_surface_t @Returns: - - - - - -@surface: - - @@ -132,6 +125,15 @@ cairo_surface_t @height: + + + + + +@surface: +@Returns: + + @@ -142,3 +144,12 @@ cairo_surface_t @y_offset: + + + + + +@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 @@ + + + Text + + + + Rendering text and sets of glyphs + + + + + + + + + + + + + + + + + + + +@index: +@x: +@y: + + + + + + +@CAIRO_FONT_SLANT_NORMAL: +@CAIRO_FONT_SLANT_ITALIC: +@CAIRO_FONT_SLANT_OBLIQUE: + + + + + + +@CAIRO_FONT_WEIGHT_NORMAL: +@CAIRO_FONT_WEIGHT_BOLD: + + + + + + +@cr: +@family: +@slant: +@weight: + + + + + + + +@cr: +@size: + + + + + + + +@cr: +@matrix: + + + + + + + +@cr: +@matrix: + + + + + + + +@cr: +@options: + + + + + + + +@cr: +@options: + + + + + + + +@cr: +@utf8: + + + + + + + +@cr: +@glyphs: +@num_glyphs: + + + + + + + +@cr: +@Returns: + + + + + + + +@cr: +@extents: + + + + + + + +@cr: +@font_face: + + + + + + + +@cr: +@utf8: +@extents: + + + + + + + +@cr: +@glyphs: +@num_glyphs: +@extents: + + + + + + + +@cr: +@utf8: + + + + + + + +@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 @@ + + + Transformations + + + + Manipulating the current transformation matrix + + + + + + + + + + + + + + + + + + + +@cr: +@tx: +@ty: + + + + + + + +@cr: +@sx: +@sy: + + + + + + + +@cr: +@angle: + + + + + + + +@cr: +@matrix: + + + + + + + +@cr: +@matrix: + + + + + + + +@cr: +@matrix: + +@Returns: + + + + + + + +@cr: + + + + + + + +@cr: +@x: +@y: + + + + + + + +@cr: +@dx: +@dy: + + + + + + + +@cr: +@x: +@y: + + + + + + + +@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 @@ + + + Types + + + + Generic data types used in the Cairo API + + + + + + + + + + + + + + + + + + + + + + + + + +@unused: + + + + + + +@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 @@ + + + Version Information + + + + Compile and run time version checks + + + + + + + + + + + + + + + + + + + + + + + + + + +@major: +@minor: +@micro: + + + + + + + +@Returns: + + + + + + + +@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 @@ + + + Win32 Fonts + + + + Font support for Microsoft Windows + + + + + + + + + + + + + + + + + + + +@logfont: +@Returns: + + + + + + + +@scaled_font: +@hdc: +@Returns: + + + + + + + +@scaled_font: + + + + + + + +@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 @@ -Microsoft Windows Backend + + Win32 Surfaces + Microsoft Windows surface support @@ -26,39 +28,3 @@ Microsoft Windows Backend @Returns: - - - - - -@logfont: -@Returns: - - - - - - - -@scaled_font: -@hdc: -@Returns: - - - - - - - -@scaled_font: - - - - - - - -@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 @@ -XCB Backend + + XCB Surfaces + X Window System rendering using the XCB library 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 @@ -XCB Backend + + XCB Surfaces + X Window System rendering using the XCB library 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 @@ -XLib Backend + + XLib Surfaces + X Window System rendering using XLib 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 @@ -cairo_t + + cairo_t -Drawing contexts. + + The Cairo drawing context @@ -75,68 +77,22 @@ Drawing contexts. @cr: - - - - - -@CAIRO_CONTENT_COLOR: -@CAIRO_CONTENT_ALPHA: -@CAIRO_CONTENT_COLOR_ALPHA: - - - - - - -@content: - - - - - - - -@CAIRO_FORMAT_ARGB32: -@CAIRO_FORMAT_RGB24: -@CAIRO_FORMAT_A8: -@CAIRO_FORMAT_A1: - - - - - - -@format: - - - - - - - -@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: - - + @cr: -@op: +@Returns: + + + + + + + +@cr: +@Returns: @@ -182,13 +138,13 @@ Drawing contexts. @y: - + @cr: -@tolerance: +@Returns: @@ -210,6 +166,28 @@ Drawing contexts. @antialias: + + + + + +@cr: +@Returns: + + + + + + + +@cr: +@dashes: +@num_dashes: +@offset: + +@ndash: + + @@ -227,13 +205,13 @@ Drawing contexts. @fill_rule: - + @cr: -@width: +@Returns: @@ -254,6 +232,15 @@ Drawing contexts. @line_cap: + + + + + +@cr: +@Returns: + + @@ -272,17 +259,31 @@ Drawing contexts. @line_join: - + @cr: -@dashes: -@num_dashes: -@offset: - -@ndash: +@Returns: + + + + + + + +@cr: +@width: + + + + + + + +@cr: +@Returns: @@ -294,358 +295,69 @@ Drawing contexts. @limit: - + @cr: -@tx: -@ty: - - - - - - - -@cr: -@sx: -@sy: - - - - - - - -@cr: -@angle: - - - - - - - -@cr: -@matrix: - - - - - - - -@cr: -@matrix: - - - - - - - -@cr: - - - - - - - -@cr: -@x: -@y: - - - - - - - -@cr: -@dx: -@dy: - - - - - - - -@cr: -@x: -@y: - - - - - - - -@cr: -@dx: -@dy: - - - - - - - -@cr: - - - - - - - -@cr: -@x: -@y: - - - - - - - -@cr: -@x: -@y: - - - - - - - -@cr: -@x1: -@y1: -@x2: -@y2: -@x3: -@y3: - - - - - - - -@cr: -@xc: -@yc: -@radius: -@angle1: -@angle2: - - - - - - - -@cr: -@xc: -@yc: -@radius: -@angle1: -@angle2: - - - - - - - -@cr: -@dx: -@dy: - - - - - - - -@cr: -@dx: -@dy: - - - - - - - -@cr: -@dx1: -@dy1: -@dx2: -@dy2: -@dx3: -@dy3: - - - - - - - -@cr: -@x: -@y: -@width: -@height: - - - - - - - -@cr: - - - - - - - -@cr: - - - - - - - -@cr: -@alpha: - - - - - - - -@cr: -@pattern: - - - - - - - -@cr: -@surface: -@surface_x: -@surface_y: - - - - - - - -@cr: - - - - - - - -@cr: - - - - - - - -@cr: - - - - - - - -@cr: - - - - - - - -@cr: - - - - - - - -@cr: - - - - - - - -@cr: -@x: -@y: @Returns: - + + + + + +@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: + + + + + + +@cr: +@op: + + + @cr: -@x: -@y: @Returns: - - - - - - - + @cr: -@x1: -@y1: -@x2: -@y2: +@tolerance: - + @cr: -@x1: -@y1: -@x2: -@y2: +@Returns: @@ -672,211 +384,35 @@ Drawing contexts. @cr: - - - - - -@index: -@x: -@y: - - - - - - -@CAIRO_FONT_SLANT_NORMAL: -@CAIRO_FONT_SLANT_ITALIC: -@CAIRO_FONT_SLANT_OBLIQUE: - - - - - - -@CAIRO_FONT_WEIGHT_NORMAL: -@CAIRO_FONT_WEIGHT_BOLD: - - + @cr: -@family: -@slant: -@weight: - + @cr: -@size: - + @cr: -@matrix: +@x1: +@y1: +@x2: +@y2: - - - - - -@cr: -@matrix: - - - - - - - -@cr: -@options: - - - - - - - -@cr: -@options: - - - - - - - -@cr: -@utf8: - - - - - - - -@cr: -@glyphs: -@num_glyphs: - - - - - - - -@cr: -@Returns: - - - - - - - -@cr: -@extents: - - - - - - - -@cr: -@font_face: - - - - - - - -@cr: -@utf8: -@extents: - - - - - - - -@cr: -@glyphs: -@num_glyphs: -@extents: - - - - - - - -@cr: -@utf8: - - - - - - - -@cr: -@glyphs: -@num_glyphs: - - - - - - - -@cr: -@Returns: - - - - - - - -@cr: -@Returns: - - - - - - - -@cr: -@Returns: - - - - - - - -@cr: -@Returns: - - - + @@ -884,273 +420,98 @@ Drawing contexts. @cr: @x: @y: +@Returns: - + @cr: -@Returns: +@pattern: - + @cr: -@Returns: - - - - - - - -@cr: -@Returns: - - - - - - - -@cr: -@Returns: - - - - - - - -@cr: -@Returns: - - - - - - - -@cr: -@matrix: - -@Returns: - - - - - - - -@cr: -@Returns: - - - - - - - -@cr: -@Returns: - - - - - - - -@cr: -@Returns: - - - - - - - -@cr: -@path: - - - - - - - -@CAIRO_PATH_MOVE_TO: -@CAIRO_PATH_LINE_TO: -@CAIRO_PATH_CURVE_TO: -@CAIRO_PATH_CLOSE_PATH: - - - - - - -@status: -@data: -@num_data: - - - - - - -@path: - - - - - - - -@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: - - - - - - -@cr: -@Returns: - - - - - - - - - - - - - - -@status: -@Returns: - - - - - - - -@CAIRO_FILTER_FAST: -@CAIRO_FILTER_GOOD: -@CAIRO_FILTER_BEST: -@CAIRO_FILTER_NEAREST: -@CAIRO_FILTER_BILINEAR: -@CAIRO_FILTER_GAUSSIAN: - - - - - - -@format: -@width: -@height: -@Returns: - - - - - - - -@data: -@format: -@width: -@height: -@stride: -@Returns: - - - - - - - @surface: +@surface_x: +@surface_y: + + + + + + + +@cr: + + + + + + + +@cr: +@alpha: + + + + + + + +@cr: + + + + + + + +@cr: + + + + + + + +@cr: +@x1: +@y1: +@x2: +@y2: + + + + + + + +@cr: +@x: +@y: @Returns: - + -@surface: -@Returns: +@cr: - - - - - -@data: - - - - - - - -@unused: - - - - - - -@closure: -@data: -@length: -@Returns: - - - - - - - -@closure: -@data: -@length: -@Returns: - - - + +@cr: