/binding/cairo/cairo.d
D | 1775 lines | 467 code | 509 blank | 799 comment | 0 complexity | 0a57629c2ff5fe800e1c40d24287ba0e MD5 | raw file
- /*
- * cairo.d
- *
- * This file holds bindings to cairo. The original copyright
- * is displayed below, but does not pertain to this file.
- *
- * Author: Dave Wilkinson
- *
- */
- /* Converted to D from cairo.h by htod */
- module binding.cairo.cairo;
- /* cairo - a vector graphics library with display and print output
- *
- * Copyright © 2002 University of Southern California
- * Copyright © 2005 Red Hat, Inc.
- *
- * This library is free software; you can redistribute it and/or
- * modify it either under the terms of the GNU Lesser General Public
- * License version 2.1 as published by the Free Software Foundation
- * (the "LGPL") or, at your option, under the terms of the Mozilla
- * Public License Version 1.1 (the "MPL"). If you do not alter this
- * notice, a recipient may use your version of this file under either
- * the MPL or the LGPL.
- *
- * You should have received a copy of the LGPL along with this library
- * in the file COPYING-LGPL-2.1; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- * You should have received a copy of the MPL along with this library
- * in the file COPYING-MPL-1.1
- *
- * The contents of this file are subject to the Mozilla Public License
- * Version 1.1 (the "License"); you may not use this file except in
- * compliance with the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
- * OF ANY KIND, either express or implied. See the LGPL or the MPL for
- * the specific language governing rights and limitations.
- *
- * The Original Code is the cairo graphics library.
- *
- * The Initial Developer of the Original Code is University of Southern
- * California.
- *
- * Contributor(s):
- * Carl D. Worth <cworth@cworth.org>
- */
- public import binding.cairo.features;
- public import core.definitions;
- extern (C):
- int cairo_version();
- char * cairo_version_string();
- /**
- * cairo_bool_t:
- *
- * #cairo_bool_t is used for boolean values. Returns of type
- * #cairo_bool_t will always be either 0 or 1, but testing against
- * these values explicitly is not encouraged; just use the
- * value as a boolean condition.
- *
- * <informalexample><programlisting>
- * if (cairo_in_stroke (cr, x, y)) {
- * /<!-- -->* do something *<!-- -->/
- * }
- * </programlisting></informalexample>
- **/
- alias int cairo_bool_t;
- /**
- * cairo_t:
- *
- * A #cairo_t contains the current state of the rendering device,
- * including coordinates of yet to be drawn shapes.
- *
- * Cairo contexts, as #cairo_t objects are named, are central to
- * cairo and all drawing with cairo is always done to a #cairo_t
- * object.
- *
- * Memory management of #cairo_t is done with
- * cairo_reference() and cairo_destroy().
- **/
- extern (C) struct _cairo;
- alias _cairo cairo_t;
- /**
- * cairo_surface_t:
- *
- * A #cairo_surface_t represents an image, either as the destination
- * of a drawing operation or as source when drawing onto another
- * surface. To draw to a #cairo_surface_t, create a cairo context
- * with the surface as the target, using cairo_create().
- *
- * There are different subtypes of #cairo_surface_t for
- * different drawing backends; for example, cairo_image_surface_create()
- * creates a bitmap image in memory.
- * The type of a surface can be queried with cairo_surface_get_type().
- *
- * Memory management of #cairo_surface_t is done with
- * cairo_surface_reference() and cairo_surface_destroy().
- **/
- extern (C) struct _cairo_surface;
- alias _cairo_surface cairo_surface_t;
- /**
- * cairo_matrix_t:
- * @xx: xx component of the affine transformation
- * @yx: yx component of the affine transformation
- * @xy: xy component of the affine transformation
- * @yy: yy component of the affine transformation
- * @x0: X translation component of the affine transformation
- * @y0: Y translation component of the affine transformation
- *
- * A #cairo_matrix_t holds an affine transformation, such as a scale,
- * rotation, shear, or a combination of those. The transformation of
- * a point (x, y) is given by:
- * <programlisting>
- * x_new = xx * x + xy * y + x0;
- * y_new = yx * x + yy * y + y0;
- * </programlisting>
- **/
- struct cairo_matrix_t
- {
- double xx;
- double yx;
- double xy;
- double yy;
- double x0;
- double y0;
- }
- /**
- * cairo_pattern_t:
- *
- * A #cairo_pattern_t represents a source when drawing onto a
- * surface. There are different subtypes of #cairo_pattern_t,
- * for different types of sources; for example,
- * cairo_pattern_create_rgb() creates a pattern for a solid
- * opaque color.
- *
- * Other than various cairo_pattern_create_<emphasis>type</emphasis>
- * functions, some of the pattern types can be implicitly created
- * using vairous cairo_set_source_<emphasis>type</emphasis> functions;
- * for example cairo_set_source_rgb().
- *
- * The type of a pattern can be queried with cairo_pattern_get_type().
- *
- * Memory management of #cairo_pattern_t is done with
- * cairo_pattern_reference() and cairo_pattern_destroy().
- **/
- extern (C) struct _cairo_pattern;
- alias _cairo_pattern cairo_pattern_t;
- /**
- * cairo_destroy_func_t:
- * @data: The data element being destroyed.
- *
- * #cairo_destroy_func_t the type of function which is called when a
- * data element is destroyed. It is passed the pointer to the data
- * element and should free any memory and resources allocated for it.
- **/
- alias void function(void *data)cairo_destroy_func_t;
- /**
- * cairo_user_data_key_t:
- * @unused: not used; ignore.
- *
- * #cairo_user_data_key_t is used for attaching user data to cairo
- * data structures. The actual contents of the struct is never used,
- * and there is no need to initialize the object; only the unique
- * address of a #cairo_data_key_t object is used. Typically, you
- * would just use the address of a static #cairo_data_key_t object.
- **/
- struct cairo_user_data_key_t
- {
- int unused;
- }
- /**
- * cairo_status_t
- * @CAIRO_STATUS_SUCCESS: no error has occurred
- * @CAIRO_STATUS_NO_MEMORY: out of memory
- * @CAIRO_STATUS_INVALID_RESTORE: cairo_restore without matching cairo_save
- * @CAIRO_STATUS_INVALID_POP_GROUP: no saved group to pop
- * @CAIRO_STATUS_NO_CURRENT_POINT: no current point defined
- * @CAIRO_STATUS_INVALID_MATRIX: invalid matrix (not invertible)
- * @CAIRO_STATUS_INVALID_STATUS: invalid value for an input cairo_status_t
- * @CAIRO_STATUS_NULL_POINTER: NULL pointer
- * @CAIRO_STATUS_INVALID_STRING: input string not valid UTF-8
- * @CAIRO_STATUS_INVALID_PATH_DATA: input path data not valid
- * @CAIRO_STATUS_READ_ERROR: error while reading from input stream
- * @CAIRO_STATUS_WRITE_ERROR: error while writing to output stream
- * @CAIRO_STATUS_SURFACE_FINISHED: target surface has been finished
- * @CAIRO_STATUS_SURFACE_TYPE_MISMATCH: the surface type is not appropriate for the operation
- * @CAIRO_STATUS_PATTERN_TYPE_MISMATCH: the pattern type is not appropriate for the operation
- * @CAIRO_STATUS_INVALID_CONTENT: invalid value for an input cairo_content_t
- * @CAIRO_STATUS_INVALID_FORMAT: invalid value for an input cairo_format_t
- * @CAIRO_STATUS_INVALID_VISUAL: invalid value for an input Visual*
- * @CAIRO_STATUS_FILE_NOT_FOUND: file not found
- * @CAIRO_STATUS_INVALID_DASH: invalid value for a dash setting
- * @CAIRO_STATUS_INVALID_DSC_COMMENT: invalid value for a DSC comment (Since 1.2)
- * @CAIRO_STATUS_INVALID_INDEX: invalid index passed to getter (Since 1.4)
- * @CAIRO_STATUS_CLIP_NOT_REPRESENTABLE: clip region not representable in desired format (Since 1.4)
- *
- * #cairo_status_t is used to indicate errors that can occur when
- * using Cairo. In some cases it is returned directly by functions.
- * but when using #cairo_t, the last error, if any, is stored in
- * the context and can be retrieved with cairo_status().
- *
- * New entries may be added in future versions. Use cairo_status_to_string()
- * to get a human-readable representation of an error message.
- **/
- enum cairo_status_t
- {
- CAIRO_STATUS_SUCCESS = 0,
- 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,
- CAIRO_STATUS_INVALID_DSC_COMMENT,
- CAIRO_STATUS_INVALID_INDEX,
- CAIRO_STATUS_CLIP_NOT_REPRESENTABLE,
- }
- /**
- * cairo_content_t
- * @CAIRO_CONTENT_COLOR: The surface will hold color content only.
- * @CAIRO_CONTENT_ALPHA: The surface will hold alpha content only.
- * @CAIRO_CONTENT_COLOR_ALPHA: The surface will hold color and alpha content.
- *
- * #cairo_content_t is used to describe the content that a surface will
- * contain, whether color information, alpha information (translucence
- * vs. opacity), or both.
- *
- * Note: The large values here are designed to keep cairo_content_t
- * values distinct from cairo_format_t values so that the
- * implementation can detect the error if users confuse the two types.
- **/
- enum cairo_content_t
- {
- CAIRO_CONTENT_COLOR = 4096,
- CAIRO_CONTENT_ALPHA = 8192,
- CAIRO_CONTENT_COLOR_ALPHA = 12288,
- }
- /**
- * cairo_write_func_t:
- * @closure: the output closure
- * @data: the buffer containing the data to write
- * @length: the amount of data to write
- *
- * #cairo_write_func_t is the type of function which is called when a
- * backend needs to write data to an output stream. It is passed the
- * closure which was specified by the user at the time the write
- * function was registered, the data to write and the length of the
- * data in bytes. The write function should return
- * CAIRO_STATUS_SUCCESS if all the data was successfully written,
- * CAIRO_STATUS_WRITE_ERROR otherwise.
- *
- * Returns: the status code of the write operation
- **/
- alias cairo_status_t function(void *closure, ubyte *data, uint length)cairo_write_func_t;
- /**
- * cairo_read_func_t:
- * @closure: the input closure
- * @data: the buffer into which to read the data
- * @length: the amount of data to read
- *
- * #cairo_read_func_t is the type of function which is called when a
- * backend needs to read data from an intput stream. It is passed the
- * closure which was specified by the user at the time the read
- * function was registered, the buffer to read the data into and the
- * length of the data in bytes. The read function should return
- * CAIRO_STATUS_SUCCESS if all the data was successfully read,
- * CAIRO_STATUS_READ_ERROR otherwise.
- *
- * Returns: the status code of the read operation
- **/
- alias cairo_status_t function(void *closure, ubyte *data, uint length)cairo_read_func_t;
- /* Functions for manipulating state objects */
- cairo_t * cairo_create(cairo_surface_t *target);
- cairo_t * cairo_reference(cairo_t *cr);
- void cairo_destroy(cairo_t *cr);
- uint cairo_get_reference_count(cairo_t *cr);
- void * cairo_get_user_data(cairo_t *cr, cairo_user_data_key_t *key);
- cairo_status_t cairo_set_user_data(cairo_t *cr, cairo_user_data_key_t *key, void *user_data, cairo_destroy_func_t destroy);
- void cairo_save(cairo_t *cr);
- void cairo_restore(cairo_t *cr);
- void cairo_push_group(cairo_t *cr);
- void cairo_push_group_with_content(cairo_t *cr, cairo_content_t content);
- cairo_pattern_t * cairo_pop_group(cairo_t *cr);
- void cairo_pop_group_to_source(cairo_t *cr);
- /* Modify state */
- enum cairo_operator_t
- {
- 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,
- }
- void cairo_set_operator(cairo_t *cr, cairo_operator_t op);
- void cairo_set_source(cairo_t *cr, cairo_pattern_t *source);
- void cairo_set_source_rgb(cairo_t *cr, double red, double green, double blue);
- void cairo_set_source_rgba(cairo_t *cr, double red, double green, double blue, double alpha);
- void cairo_set_source_surface(cairo_t *cr, cairo_surface_t *surface, double x, double y);
- void cairo_set_tolerance(cairo_t *cr, double tolerance);
- /**
- * cairo_antialias_t:
- * @CAIRO_ANTIALIAS_DEFAULT: Use the default antialiasing for
- * the subsystem and target device
- * @CAIRO_ANTIALIAS_NONE: Use a bilevel alpha mask
- * @CAIRO_ANTIALIAS_GRAY: Perform single-color antialiasing (using
- * shades of gray for black text on a white background, for example).
- * @CAIRO_ANTIALIAS_SUBPIXEL: Perform antialiasing by taking
- * advantage of the order of subpixel elements on devices
- * such as LCD panels
- *
- * Specifies the type of antialiasing to do when rendering text or shapes.
- **/
- enum cairo_antialias_t {
- CAIRO_ANTIALIAS_DEFAULT,
- CAIRO_ANTIALIAS_NONE,
- CAIRO_ANTIALIAS_GRAY,
- CAIRO_ANTIALIAS_SUBPIXEL,
- }
- void cairo_set_antialias(cairo_t *cr, cairo_antialias_t antialias);
- /**
- * cairo_fill_rule_t
- * @CAIRO_FILL_RULE_WINDING: If the path crosses the ray from
- * left-to-right, counts +1. If the path crosses the ray
- * from right to left, counts -1. (Left and right are determined
- * from the perspective of looking along the ray from the starting
- * point.) If the total count is non-zero, the point will be filled.
- * @CAIRO_FILL_RULE_EVEN_ODD: Counts the total number of
- * intersections, without regard to the orientation of the contour. If
- * the total number of intersections is odd, the point will be
- * filled.
- *
- * #cairo_fill_rule_t is used to select how paths are filled. For both
- * fill rules, whether or not a point is included in the fill is
- * determined by taking a ray from that point to infinity and looking
- * at intersections with the path. The ray can be in any direction,
- * as long as it doesn't pass through the end point of a segment
- * or have a tricky intersection such as intersecting tangent to the path.
- * (Note that filling is not actually implemented in this way. This
- * is just a description of the rule that is applied.)
- *
- * New entries may be added in future versions.
- **/
- enum cairo_fill_rule_t
- {
- CAIRO_FILL_RULE_WINDING,
- CAIRO_FILL_RULE_EVEN_ODD,
- }
- void cairo_set_fill_rule(cairo_t *cr, cairo_fill_rule_t fill_rule);
- void cairo_set_line_width(cairo_t *cr, double width);
- /**
- * cairo_line_cap_t
- * @CAIRO_LINE_CAP_BUTT: start(stop) the line exactly at the start(end) point
- * @CAIRO_LINE_CAP_ROUND: use a round ending, the center of the circle is the end point
- * @CAIRO_LINE_CAP_SQUARE: use squared ending, the center of the square is the end point
- *
- * Specifies how to render the endpoint of a line when stroking.
- **/
- enum cairo_line_cap_t
- {
- CAIRO_LINE_CAP_BUTT,
- CAIRO_LINE_CAP_ROUND,
- CAIRO_LINE_CAP_SQUARE,
- }
- void cairo_set_line_cap(cairo_t *cr, cairo_line_cap_t line_cap);
- /**
- * cairo_line_join_t
- * @CAIRO_LINE_JOIN_MITER: use a sharp (angled) corner, see
- * cairo_set_miter_limit()
- * @CAIRO_LINE_JOIN_ROUND: use a rounded join, the center of the circle is the
- * joint point
- * @CAIRO_LINE_JOIN_BEVEL: use a cut-off join, the join is cut off at half
- * the line width from the joint point
- *
- * Specifies how to render the junction of two lines when stroking.
- **/
- enum cairo_line_join_t
- {
- CAIRO_LINE_JOIN_MITER,
- CAIRO_LINE_JOIN_ROUND,
- CAIRO_LINE_JOIN_BEVEL,
- }
- void cairo_set_line_join(cairo_t *cr, cairo_line_join_t line_join);
- void cairo_set_dash(cairo_t *cr, double *dashes, int num_dashes, double offset);
- void cairo_set_miter_limit(cairo_t *cr, double limit);
- void cairo_translate(cairo_t *cr, double tx, double ty);
- void cairo_scale(cairo_t *cr, double sx, double sy);
- void cairo_rotate(cairo_t *cr, double angle);
- void cairo_transform(cairo_t *cr, cairo_matrix_t *matrix);
- void cairo_set_matrix(cairo_t *cr, cairo_matrix_t *matrix);
- void cairo_identity_matrix(cairo_t *cr);
- void cairo_user_to_device(cairo_t *cr, double *x, double *y);
- void cairo_user_to_device_distance(cairo_t *cr, double *dx, double *dy);
- void cairo_device_to_user(cairo_t *cr, double *x, double *y);
- void cairo_device_to_user_distance(cairo_t *cr, double *dx, double *dy);
- void cairo_new_path(cairo_t *cr);
- void cairo_move_to(cairo_t *cr, double x, double y);
- void cairo_new_sub_path(cairo_t *cr);
- void cairo_line_to(cairo_t *cr, double x, double y);
- void cairo_curve_to(cairo_t *cr, double x1, double y1, double x2, double y2, double x3, double y3);
- void cairo_arc(cairo_t *cr, double xc, double yc, double radius, double angle1, double angle2);
- void cairo_arc_negative(cairo_t *cr, double xc, double yc, double radius, double angle1, double angle2);
- /* XXX: NYI
- cairo_public void
- cairo_arc_to (cairo_t *cr,
- double x1, double y1,
- double x2, double y2,
- double radius);
- */
- void cairo_rel_move_to(cairo_t *cr, double dx, double dy);
- void cairo_rel_line_to(cairo_t *cr, double dx, double dy);
- void cairo_rel_curve_to(cairo_t *cr, double dx1, double dy1, double dx2, double dy2, double dx3, double dy3);
- void cairo_rectangle(cairo_t *cr, double x, double y, double width, double height);
- /* XXX: NYI
- cairo_public void
- cairo_stroke_to_path (cairo_t *cr);
- */
- void cairo_close_path(cairo_t *cr);
- /* Painting functions */
- void cairo_paint(cairo_t *cr);
- void cairo_paint_with_alpha(cairo_t *cr, double alpha);
- void cairo_mask(cairo_t *cr, cairo_pattern_t *pattern);
- void cairo_mask_surface(cairo_t *cr, cairo_surface_t *surface, double surface_x, double surface_y);
- void cairo_stroke(cairo_t *cr);
- void cairo_stroke_preserve(cairo_t *cr);
- void cairo_fill(cairo_t *cr);
- void cairo_fill_preserve(cairo_t *cr);
- void cairo_copy_page(cairo_t *cr);
- void cairo_show_page(cairo_t *cr);
- /* Insideness testing */
- cairo_bool_t cairo_in_stroke(cairo_t *cr, double x, double y);
- cairo_bool_t cairo_in_fill(cairo_t *cr, double x, double y);
- void cairo_stroke_extents(cairo_t *cr, double *x1, double *y1, double *x2, double *y2);
- void cairo_fill_extents(cairo_t *cr, double *x1, double *y1, double *x2, double *y2);
- /* Clipping */
- void cairo_reset_clip(cairo_t *cr);
- void cairo_clip(cairo_t *cr);
- void cairo_clip_preserve(cairo_t *cr);
- void cairo_clip_extents(cairo_t *cr, double *x1, double *y1, double *x2, double *y2);
- /**
- * cairo_rectangle_t:
- * @x: X coordinate of the left side of the rectangle
- * @y: Y coordinate of the the top side of the rectangle
- * @width: width of the rectangle
- * @height: height of the rectangle
- *
- * A data structure for holding a rectangle.
- *
- * Since: 1.4
- **/
- struct _cairo_rectangle
- {
- double x;
- double y;
- double width;
- double height;
- }
- alias _cairo_rectangle cairo_rectangle_t;
- /**
- * cairo_rectangle_list_t:
- * @status: Error status of the rectangle list
- * @rectangles: Array containing the rectangles
- * @num_rectangles: Number of rectangles in this list
- *
- * A data structure for holding a dynamically allocated
- * array of rectangles.
- *
- * Since: 1.4
- **/
- struct _cairo_rectangle_list
- {
- cairo_status_t status;
- cairo_rectangle_t *rectangles;
- int num_rectangles;
- }
- alias _cairo_rectangle_list cairo_rectangle_list_t;
- cairo_rectangle_list_t * cairo_copy_clip_rectangle_list(cairo_t *cr);
- void cairo_rectangle_list_destroy(cairo_rectangle_list_t *rectangle_list);
- /* Font/Text functions */
- /**
- * cairo_scaled_font_t:
- *
- * A #cairo_scaled_font_t is a font scaled to a particular size and device
- * resolution. A cairo_scaled_font_t is most useful for low-level font
- * usage where a library or application wants to cache a reference
- * to a scaled font to speed up the computation of metrics.
- *
- * There are various types of scaled fonts, depending on the
- * <firstterm>font backend</firstterm> they use. The type of a
- * scaled font can be queried using cairo_scaled_font_get_type().
- *
- * Memory management of #cairo_scaled_font_t is done with
- * cairo_scaled_font_reference() and cairo_scaled_font_destroy().
- **/
- extern (C) struct _cairo_scaled_font;
- alias _cairo_scaled_font cairo_scaled_font_t;
- /**
- * cairo_font_face_t:
- *
- * A #cairo_font_face_t specifies all aspects of a font other
- * than the size or font matrix (a font matrix is used to distort
- * a font by sheering it or scaling it unequally in the two
- * directions) . A font face can be set on a #cairo_t by using
- * cairo_set_font_face(); the size and font matrix are set with
- * cairo_set_font_size() and cairo_set_font_matrix().
- *
- * There are various types of font faces, depending on the
- * <firstterm>font backend</firstterm> they use. The type of a
- * font face can be queried using cairo_font_face_get_type().
- *
- * Memory management of #cairo_font_face_t is done with
- * cairo_font_face_reference() and cairo_font_face_destroy().
- **/
- extern(C) struct _cairo_font_face;
- alias _cairo_font_face cairo_font_face_t;
- /**
- * cairo_glyph_t:
- * @index: glyph index in the font. The exact interpretation of the
- * glyph index depends on the font technology being used.
- * @x: the offset in the X direction between the origin used for
- * drawing or measuring the string and the origin of this glyph.
- * @y: the offset in the Y direction between the origin used for
- * drawing or measuring the string and the origin of this glyph.
- *
- * The #cairo_glyph_t structure holds information about a single glyph
- * when drawing or measuring text. A font is (in simple terms) a
- * collection of shapes used to draw text. A glyph is one of these
- * shapes. There can be multiple glyphs for a single character
- * (alternates to be used in different contexts, for example), or a
- * glyph can be a <firstterm>ligature</firstterm> of multiple
- * characters. Cairo doesn't expose any way of converting input text
- * into glyphs, so in order to use the Cairo interfaces that take
- * arrays of glyphs, you must directly access the appropriate
- * underlying font system.
- *
- * Note that the offsets given by @x and @y are not cumulative. When
- * drawing or measuring text, each glyph is individually positioned
- * with respect to the overall origin
- **/
- struct cairo_glyph_t
- {
- Culong index;
- double x;
- double y;
- }
- /**
- * cairo_text_extents_t:
- * @x_bearing: the horizontal distance from the origin to the
- * leftmost part of the glyphs as drawn. Positive if the
- * glyphs lie entirely to the right of the origin.
- * @y_bearing: the vertical distance from the origin to the
- * topmost part of the glyphs as drawn. Positive only if the
- * glyphs lie completely below the origin; will usually be
- * negative.
- * @width: width of the glyphs as drawn
- * @height: height of the glyphs as drawn
- * @x_advance:distance to advance in the X direction
- * after drawing these glyphs
- * @y_advance: distance to advance in the Y direction
- * after drawing these glyphs. Will typically be zero except
- * for vertical text layout as found in East-Asian languages.
- *
- * The #cairo_text_extents_t structure stores the extents of a single
- * glyph or a string of glyphs in user-space coordinates. Because text
- * extents are in user-space coordinates, they are mostly, but not
- * entirely, independent of the current transformation matrix. If you call
- * <literal>cairo_scale(cr, 2.0, 2.0)</literal>, text will
- * be drawn twice as big, but the reported text extents will not be
- * doubled. They will change slightly due to hinting (so you can't
- * assume that metrics are independent of the transformation matrix),
- * but otherwise will remain unchanged.
- **/
- //C typedef struct {
- //C double x_bearing;
- //C double y_bearing;
- //C double width;
- //C double height;
- //C double x_advance;
- //C double y_advance;
- //C } cairo_text_extents_t;
- struct cairo_text_extents_t
- {
- double x_bearing;
- double y_bearing;
- double width;
- double height;
- double x_advance;
- double y_advance;
- }
- /**
- * cairo_font_extents_t:
- * @ascent: the distance that the font extends above the baseline.
- * Note that this is not always exactly equal to the maximum
- * of the extents of all the glyphs in the font, but rather
- * is picked to express the font designer's intent as to
- * how the font should align with elements above it.
- * @descent: the distance that the font extends below the baseline.
- * This value is positive for typical fonts that include
- * portions below the baseline. Note that this is not always
- * exactly equal to the maximum of the extents of all the
- * glyphs in the font, but rather is picked to express the
- * font designer's intent as to how the the font should
- * align with elements below it.
- * @height: the recommended vertical distance between baselines when
- * setting consecutive lines of text with the font. This
- * is greater than @ascent+@descent by a
- * quantity known as the <firstterm>line spacing</firstterm>
- * or <firstterm>external leading</firstterm>. When space
- * is at a premium, most fonts can be set with only
- * a distance of @ascent+@descent between lines.
- * @max_x_advance: the maximum distance in the X direction that
- * the the origin is advanced for any glyph in the font.
- * @max_y_advance: the maximum distance in the Y direction that
- * the the origin is advanced for any glyph in the font.
- * this will be zero for normal fonts used for horizontal
- * writing. (The scripts of East Asia are sometimes written
- * vertically.)
- *
- * The #cairo_font_extents_t structure stores metric information for
- * a font. Values are given in the current user-space coordinate
- * system.
- *
- * Because font metrics are in user-space coordinates, they are
- * mostly, but not entirely, independent of the current transformation
- * matrix. If you call <literal>cairo_scale(cr, 2.0, 2.0)</literal>,
- * text will be drawn twice as big, but the reported text extents will
- * not be doubled. They will change slightly due to hinting (so you
- * can't assume that metrics are independent of the transformation
- * matrix), but otherwise will remain unchanged.
- **/
- struct cairo_font_extents_t
- {
- double ascent;
- double descent;
- double height;
- double max_x_advance;
- double max_y_advance;
- }
- /**
- * cairo_font_slant_t:
- * @CAIRO_FONT_SLANT_NORMAL: Upright font style
- * @CAIRO_FONT_SLANT_ITALIC: Italic font style
- * @CAIRO_FONT_SLANT_OBLIQUE: Oblique font style
- *
- * Specifies variants of a font face based on their slant.
- **/
- enum cairo_font_slant_t
- {
- CAIRO_FONT_SLANT_NORMAL,
- CAIRO_FONT_SLANT_ITALIC,
- CAIRO_FONT_SLANT_OBLIQUE,
- }
- /**
- * cairo_font_weight_t:
- * @CAIRO_FONT_WEIGHT_NORMAL: Normal font weight
- * @CAIRO_FONT_WEIGHT_BOLD: Bold font weight
- *
- * Specifies variants of a font face based on their weight.
- **/
- enum cairo_font_weight_t
- {
- CAIRO_FONT_WEIGHT_NORMAL,
- CAIRO_FONT_WEIGHT_BOLD,
- }
- /**
- * cairo_subpixel_order_t:
- * @CAIRO_SUBPIXEL_ORDER_DEFAULT: Use the default subpixel order for
- * for the target device
- * @CAIRO_SUBPIXEL_ORDER_RGB: Subpixel elements are arranged horizontally
- * with red at the left
- * @CAIRO_SUBPIXEL_ORDER_BGR: Subpixel elements are arranged horizontally
- * with blue at the left
- * @CAIRO_SUBPIXEL_ORDER_VRGB: Subpixel elements are arranged vertically
- * with red at the top
- * @CAIRO_SUBPIXEL_ORDER_VBGR: Subpixel elements are arranged vertically
- * with blue at the top
- *
- * The subpixel order specifies the order of color elements within
- * each pixel on the display device when rendering with an
- * antialiasing mode of %CAIRO_ANTIALIAS_SUBPIXEL.
- **/
- enum cairo_subpixel_order_t
- {
- CAIRO_SUBPIXEL_ORDER_DEFAULT,
- CAIRO_SUBPIXEL_ORDER_RGB,
- CAIRO_SUBPIXEL_ORDER_BGR,
- CAIRO_SUBPIXEL_ORDER_VRGB,
- CAIRO_SUBPIXEL_ORDER_VBGR,
- }
- /**
- * cairo_hint_style_t:
- * @CAIRO_HINT_STYLE_DEFAULT: Use the default hint style for
- * for font backend and target device
- * @CAIRO_HINT_STYLE_NONE: Do not hint outlines
- * @CAIRO_HINT_STYLE_SLIGHT: Hint outlines slightly to improve
- * contrast while retaining good fidelity to the original
- * shapes.
- * @CAIRO_HINT_STYLE_MEDIUM: Hint outlines with medium strength
- * giving a compromise between fidelity to the original shapes
- * and contrast
- * @CAIRO_HINT_STYLE_FULL: Hint outlines to maximize contrast
- *
- * Specifies the type of hinting to do on font outlines. Hinting
- * is the process of fitting outlines to the pixel grid in order
- * to improve the appearance of the result. Since hinting outlines
- * involves distorting them, it also reduces the faithfulness
- * to the original outline shapes. Not all of the outline hinting
- * styles are supported by all font backends.
- *
- * New entries may be added in future versions.
- **/
- enum cairo_hint_style_t
- {
- CAIRO_HINT_STYLE_DEFAULT,
- CAIRO_HINT_STYLE_NONE,
- CAIRO_HINT_STYLE_SLIGHT,
- CAIRO_HINT_STYLE_MEDIUM,
- CAIRO_HINT_STYLE_FULL,
- }
- /**
- * cairo_hint_metrics_t:
- * @CAIRO_HINT_METRICS_DEFAULT: Hint metrics in the default
- * manner for the font backend and target device
- * @CAIRO_HINT_METRICS_OFF: Do not hint font metrics
- * @CAIRO_HINT_METRICS_ON: Hint font metrics
- *
- * Specifies whether to hint font metrics; hinting font metrics
- * means quantizing them so that they are integer values in
- * device space. Doing this improves the consistency of
- * letter and line spacing, however it also means that text
- * will be laid out differently at different zoom factors.
- **/
- //C typedef enum _cairo_hint_metrics {
- //C CAIRO_HINT_METRICS_DEFAULT,
- //C CAIRO_HINT_METRICS_OFF,
- //C CAIRO_HINT_METRICS_ON
- //C } cairo_hint_metrics_t;
- enum cairo_hint_metrics_t
- {
- CAIRO_HINT_METRICS_DEFAULT,
- CAIRO_HINT_METRICS_OFF,
- CAIRO_HINT_METRICS_ON,
- }
- /**
- * cairo_font_options_t:
- *
- * An opaque structure holding all options that are used when
- * rendering fonts.
- *
- * Individual features of a #cairo_font_options_t can be set or
- * accessed using functions named
- * cairo_font_options_set_<emphasis>feature_name</emphasis> and
- * cairo_font_options_get_<emphasis>feature_name</emphasis>, like
- * cairo_font_options_set_antialias() and
- * cairo_font_options_get_antialias().
- *
- * New features may be added to a #cairo_font_options_t in the
- * future. For this reason, cairo_font_options_copy(),
- * cairo_font_options_equal(), cairo_font_options_merge(), and
- * cairo_font_options_hash() should be used to copy, check
- * for equality, merge, or compute a hash value of
- * #cairo_font_options_t objects.
- **/
- extern(C) struct _cairo_font_options;
- alias _cairo_font_options cairo_font_options_t;
- cairo_font_options_t * cairo_font_options_create();
- cairo_font_options_t * cairo_font_options_copy(cairo_font_options_t *original);
- void cairo_font_options_destroy(cairo_font_options_t *options);
- cairo_status_t cairo_font_options_status(cairo_font_options_t *options);
- void cairo_font_options_merge(cairo_font_options_t *options, cairo_font_options_t *other);
- cairo_bool_t cairo_font_options_equal(cairo_font_options_t *options, cairo_font_options_t *other);
- Culong cairo_font_options_hash(cairo_font_options_t *options);
- void cairo_font_options_set_antialias(cairo_font_options_t *options, cairo_antialias_t antialias);
- cairo_antialias_t cairo_font_options_get_antialias(cairo_font_options_t *options);
- void cairo_font_options_set_subpixel_order(cairo_font_options_t *options, cairo_subpixel_order_t subpixel_order);
- cairo_subpixel_order_t cairo_font_options_get_subpixel_order(cairo_font_options_t *options);
- void cairo_font_options_set_hint_style(cairo_font_options_t *options, cairo_hint_style_t hint_style);
- cairo_hint_style_t cairo_font_options_get_hint_style(cairo_font_options_t *options);
- void cairo_font_options_set_hint_metrics(cairo_font_options_t *options, cairo_hint_metrics_t hint_metrics);
- cairo_hint_metrics_t cairo_font_options_get_hint_metrics(cairo_font_options_t *options);
- /* This interface is for dealing with text as text, not caring about the
- font object inside the the cairo_t. */
- void cairo_select_font_face(cairo_t *cr, char *family, cairo_font_slant_t slant, cairo_font_weight_t weight);
- void cairo_set_font_size(cairo_t *cr, double size);
- void cairo_set_font_matrix(cairo_t *cr, cairo_matrix_t *matrix);
- void cairo_get_font_matrix(cairo_t *cr, cairo_matrix_t *matrix);
- void cairo_set_font_options(cairo_t *cr, cairo_font_options_t *options);
- void cairo_get_font_options(cairo_t *cr, cairo_font_options_t *options);
- void cairo_set_font_face(cairo_t *cr, cairo_font_face_t *font_face);
- cairo_font_face_t * cairo_get_font_face(cairo_t *cr);
- void cairo_set_scaled_font(cairo_t *cr, cairo_scaled_font_t *scaled_font);
- cairo_scaled_font_t * cairo_get_scaled_font(cairo_t *cr);
- void cairo_show_text(cairo_t *cr, char *utf8);
- void cairo_show_glyphs(cairo_t *cr, cairo_glyph_t *glyphs, int num_glyphs);
- void cairo_text_path(cairo_t *cr, char *utf8);
- void cairo_glyph_path(cairo_t *cr, cairo_glyph_t *glyphs, int num_glyphs);
- void cairo_text_extents(cairo_t *cr, char *utf8, cairo_text_extents_t *extents);
- void cairo_glyph_extents(cairo_t *cr, cairo_glyph_t *glyphs, int num_glyphs, cairo_text_extents_t *extents);
- void cairo_font_extents(cairo_t *cr, cairo_font_extents_t *extents);
- /* Generic identifier for a font style */
- cairo_font_face_t * cairo_font_face_reference(cairo_font_face_t *font_face);
- void cairo_font_face_destroy(cairo_font_face_t *font_face);
- uint cairo_font_face_get_reference_count(cairo_font_face_t *font_face);
- cairo_status_t cairo_font_face_status(cairo_font_face_t *font_face);
- /**
- * cairo_font_type_t
- * @CAIRO_FONT_TYPE_TOY: The font was created using cairo's toy font api
- * @CAIRO_FONT_TYPE_FT: The font is of type FreeType
- * @CAIRO_FONT_TYPE_WIN32: The font is of type Win32
- * @CAIRO_FONT_TYPE_ATSUI: The font is of type ATSUI
- *
- * #cairo_font_type_t is used to describe the type of a given font
- * face or scaled font. The font types are also known as "font
- * backends" within cairo.
- *
- * The type of a font face is determined by the function used to
- * create it, which will generally be of the form
- * cairo_<emphasis>type</emphasis>_font_face_create. The font face type can be queried
- * with cairo_font_face_get_type()
- *
- * The various cairo_font_face functions can be used with a font face
- * of any type.
- *
- * The type of a scaled font is determined by the type of the font
- * face passed to cairo_scaled_font_create. The scaled font type can
- * be queried with cairo_scaled_font_get_type()
- *
- * The various cairo_scaled_font functions can be used with scaled
- * fonts of any type, but some font backends also provide
- * type-specific functions that must only be called with a scaled font
- * of the appropriate type. These functions have names that begin with
- * cairo_<emphasis>type</emphasis>_scaled_font such as cairo_ft_scaled_font_lock_face.
- *
- * The behavior of calling a type-specific function with a scaled font
- * of the wrong type is undefined.
- *
- * New entries may be added in future versions.
- *
- * Since: 1.2
- **/
- enum cairo_font_type_t
- {
- CAIRO_FONT_TYPE_TOY,
- CAIRO_FONT_TYPE_FT,
- CAIRO_FONT_TYPE_WIN32,
- CAIRO_FONT_TYPE_ATSUI,
- }
- cairo_font_type_t cairo_font_face_get_type(cairo_font_face_t *font_face);
- void * cairo_font_face_get_user_data(cairo_font_face_t *font_face, cairo_user_data_key_t *key);
- cairo_status_t cairo_font_face_set_user_data(cairo_font_face_t *font_face, cairo_user_data_key_t *key, void *user_data, cairo_destroy_func_t destroy);
- /* Portable interface to general font features. */
- cairo_scaled_font_t * cairo_scaled_font_create(cairo_font_face_t *font_face, cairo_matrix_t *font_matrix, cairo_matrix_t *ctm, cairo_font_options_t *options);
- cairo_scaled_font_t * cairo_scaled_font_reference(cairo_scaled_font_t *scaled_font);
- void cairo_scaled_font_destroy(cairo_scaled_font_t *scaled_font);
- uint cairo_scaled_font_get_reference_count(cairo_scaled_font_t *scaled_font);
- cairo_status_t cairo_scaled_font_status(cairo_scaled_font_t *scaled_font);
- cairo_font_type_t cairo_scaled_font_get_type(cairo_scaled_font_t *scaled_font);
- void * cairo_scaled_font_get_user_data(cairo_scaled_font_t *scaled_font, cairo_user_data_key_t *key);
- cairo_status_t cairo_scaled_font_set_user_data(cairo_scaled_font_t *scaled_font, cairo_user_data_key_t *key, void *user_data, cairo_destroy_func_t destroy);
- void cairo_scaled_font_extents(cairo_scaled_font_t *scaled_font, cairo_font_extents_t *extents);
- void cairo_scaled_font_text_extents(cairo_scaled_font_t *scaled_font, char *utf8, cairo_text_extents_t *extents);
- void cairo_scaled_font_glyph_extents(cairo_scaled_font_t *scaled_font, cairo_glyph_t *glyphs, int num_glyphs, cairo_text_extents_t *extents);
- cairo_font_face_t * cairo_scaled_font_get_font_face(cairo_scaled_font_t *scaled_font);
- void cairo_scaled_font_get_font_matrix(cairo_scaled_font_t *scaled_font, cairo_matrix_t *font_matrix);
- void cairo_scaled_font_get_ctm(cairo_scaled_font_t *scaled_font, cairo_matrix_t *ctm);
- void cairo_scaled_font_get_font_options(cairo_scaled_font_t *scaled_font, cairo_font_options_t *options);
- /* Query functions */
- cairo_operator_t cairo_get_operator(cairo_t *cr);
- cairo_pattern_t * cairo_get_source(cairo_t *cr);
- double cairo_get_tolerance(cairo_t *cr);
- cairo_antialias_t cairo_get_antialias(cairo_t *cr);
- void cairo_get_current_point(cairo_t *cr, double *x, double *y);
- cairo_fill_rule_t cairo_get_fill_rule(cairo_t *cr);
- double cairo_get_line_width(cairo_t *cr);
- cairo_line_cap_t cairo_get_line_cap(cairo_t *cr);
- cairo_line_join_t cairo_get_line_join(cairo_t *cr);
- double cairo_get_miter_limit(cairo_t *cr);
- int cairo_get_dash_count(cairo_t *cr);
- void cairo_get_dash(cairo_t *cr, double *dashes, double *offset);
- void cairo_get_matrix(cairo_t *cr, cairo_matrix_t *matrix);
- cairo_surface_t * cairo_get_target(cairo_t *cr);
- cairo_surface_t * cairo_get_group_target(cairo_t *cr);
- /**
- * cairo_path_data_type_t:
- * @CAIRO_PATH_MOVE_TO: A move-to operation
- * @CAIRO_PATH_LINE_TO: A line-to operation
- * @CAIRO_PATH_CURVE_TO: A curve-to operation
- * @CAIRO_PATH_CLOSE_PATH: A close-path operation
- *
- * #cairo_path_data_t is used to describe the type of one portion
- * of a path when represented as a #cairo_path_t.
- * See #cairo_path_data_t for details.
- **/
- enum cairo_path_data_type_t
- {
- CAIRO_PATH_MOVE_TO,
- CAIRO_PATH_LINE_TO,
- CAIRO_PATH_CURVE_TO,
- CAIRO_PATH_CLOSE_PATH,
- }
- /**
- * cairo_path_data_t:
- *
- * #cairo_path_data_t is used to represent the path data inside a
- * #cairo_path_t.
- *
- * The data structure is designed to try to balance the demands of
- * efficiency and ease-of-use. A path is represented as an array of
- * #cairo_path_data_t, which is a union of headers and points.
- *
- * Each portion of the path is represented by one or more elements in
- * the array, (one header followed by 0 or more points). The length
- * value of the header is the number of array elements for the current
- * portion including the header, (ie. length == 1 + # of points), and
- * where the number of points for each element type is as follows:
- *
- * <programlisting>
- * %CAIRO_PATH_MOVE_TO: 1 point
- * %CAIRO_PATH_LINE_TO: 1 point
- * %CAIRO_PATH_CURVE_TO: 3 points
- * %CAIRO_PATH_CLOSE_PATH: 0 points
- * </programlisting>
- *
- * The semantics and ordering of the coordinate values are consistent
- * with cairo_move_to(), cairo_line_to(), cairo_curve_to(), and
- * cairo_close_path().
- *
- * Here is sample code for iterating through a #cairo_path_t:
- *
- * <informalexample><programlisting>
- * int i;
- * cairo_path_t *path;
- * cairo_path_data_t *data;
- *
- * path = cairo_copy_path (cr);
- *
- * for (i=0; i < path->num_data; i += path->data[i].header.length) {
- * data = &path->data[i];
- * switch (data->header.type) {
- * case CAIRO_PATH_MOVE_TO:
- * do_move_to_things (data[1].point.x, data[1].point.y);
- * break;
- * case CAIRO_PATH_LINE_TO:
- * do_line_to_things (data[1].point.x, data[1].point.y);
- * break;
- * case CAIRO_PATH_CURVE_TO:
- * do_curve_to_things (data[1].point.x, data[1].point.y,
- * data[2].point.x, data[2].point.y,
- * data[3].point.x, data[3].point.y);
- * break;
- * case CAIRO_PATH_CLOSE_PATH:
- * do_close_path_things ();
- * break;
- * }
- * }
- * cairo_path_destroy (path);
- * </programlisting></informalexample>
- *
- * As of cairo 1.4, cairo does not mind if there are more elements in
- * a portion of the path than needed. Such elements can be used by
- * users of the cairo API to hold extra values in the path data
- * structure. For this reason, it is recommended that applications
- * always use <literal>data->header.length</literal> to
- * iterate over the path data, instead of hardcoding the number of
- * elements for each element type.
- **/
- struct _N4
- {
- cairo_path_data_type_t type;
- int length;
- }
- struct _N5
- {
- double x;
- double y;
- }
- union cairo_path_data_t
- {
- _N4 header;
- _N5 point;
- }
- /**
- * cairo_path_t:
- * @status: the current error status
- * @data: the elements in the path
- * @num_data: the number of elements in the data array
- *
- * A data structure for holding a path. This data structure serves as
- * the return value for cairo_copy_path() and
- * cairo_copy_path_flat() as well the input value for
- * cairo_append_path().
- *
- * See #cairo_path_data_t for hints on how to iterate over the
- * actual data within the path.
- *
- * The num_data member gives the number of elements in the data
- * array. This number is larger than the number of independent path
- * portions (defined in #cairo_path_data_type_t), since the data
- * includes both headers and coordinates for each portion.
- **/
- struct cairo_path_t
- {
- cairo_status_t status;
- cairo_path_data_t *data;
- int num_data;
- }
- cairo_path_t * cairo_copy_path(cairo_t *cr);
- cairo_path_t * cairo_copy_path_flat(cairo_t *cr);
- void cairo_append_path(cairo_t *cr, cairo_path_t *path);
- void cairo_path_destroy(cairo_path_t *path);
- /* Error status queries */
- cairo_status_t cairo_status(cairo_t *cr);
- char * cairo_status_to_string(cairo_status_t status);
- /* Surface manipulation */
- cairo_surface_t * cairo_surface_create_similar(cairo_surface_t *other, cairo_content_t content, int width, int height);
- cairo_surface_t * cairo_surface_reference(cairo_surface_t *surface);
- void cairo_surface_finish(cairo_surface_t *surface);
- void cairo_surface_destroy(cairo_surface_t *surface);
- uint cairo_surface_get_reference_count(cairo_surface_t *surface);
- cairo_status_t cairo_surface_status(cairo_surface_t *surface);
- /**
- * cairo_surface_type_t
- * @CAIRO_SURFACE_TYPE_IMAGE: The surface is of type image
- * @CAIRO_SURFACE_TYPE_PDF: The surface is of type pdf
- * @CAIRO_SURFACE_TYPE_PS: The surface is of type ps
- * @CAIRO_SURFACE_TYPE_XLIB: The surface is of type xlib
- * @CAIRO_SURFACE_TYPE_XCB: The surface is of type xcb
- * @CAIRO_SURFACE_TYPE_GLITZ: The surface is of type glitz
- * @CAIRO_SURFACE_TYPE_QUARTZ: The surface is of type quartz
- * @CAIRO_SURFACE_TYPE_WIN32: The surface is of type win32
- * @CAIRO_SURFACE_TYPE_BEOS: The surface is of type beos
- * @CAIRO_SURFACE_TYPE_DIRECTFB: The surface is of type directfb
- * @CAIRO_SURFACE_TYPE_SVG: The surface is of type svg
- * @CAIRO_SURFACE_TYPE_OS2: The surface is of type os2
- *
- * #cairo_surface_type_t is used to describe the type of a given
- * surface. The surface types are also known as "backends" or "surface
- * backends" within cairo.
- *
- * The type of a surface is determined by the function used to create
- * it, which will generally be of the form cairo_<emphasis>type</emphasis>_surface_create,
- * (though see cairo_surface_create_similar as well).
- *
- * The surface type can be queried with cairo_surface_get_type()
- *
- * The various cairo_surface functions can be used with surfaces of
- * any type, but some backends also provide type-specific functions
- * that must only be called with a surface of the appropriate
- * type. These functions have names that begin with
- * cairo_<emphasis>type</emphasis>_surface such as cairo_image_surface_get_width().
- *
- * The behavior of calling a type-specific function with a surface of
- * the wrong type is undefined.
- *
- * New entries may be added in future versions.
- *
- * Since: 1.2
- **/
- enum cairo_surface_type_t
- {
- CAIRO_SURFACE_TYPE_IMAGE,
- CAIRO_SURFACE_TYPE_PDF,
- CAIRO_SURFACE_TYPE_PS,
- CAIRO_SURFACE_TYPE_XLIB,
- CAIRO_SURFACE_TYPE_XCB,
- CAIRO_SURFACE_TYPE_GLITZ,
- CAIRO_SURFACE_TYPE_QUARTZ,
- CAIRO_SURFACE_TYPE_WIN32,
- CAIRO_SURFACE_TYPE_BEOS,
- CAIRO_SURFACE_TYPE_DIRECTFB,
- CAIRO_SURFACE_TYPE_SVG,
- CAIRO_SURFACE_TYPE_OS2,
- }
- cairo_surface_type_t cairo_surface_get_type(cairo_surface_t *surface);
- cairo_content_t cairo_surface_get_content(cairo_surface_t *surface);
- cairo_status_t cairo_surface_write_to_png(cairo_surface_t *surface, char *filename);
- cairo_status_t cairo_surface_write_to_png_stream(cairo_surface_t *surface, cairo_write_func_t write_func, void *closure);
- void * cairo_surface_get_user_data(cairo_surface_t *surface, cairo_user_data_key_t *key);
- cairo_status_t cairo_surface_set_user_data(cairo_surface_t *surface, cairo_user_data_key_t *key, void *user_data, cairo_destroy_func_t destroy);
- void cairo_surface_get_font_options(cairo_surface_t *surface, cairo_font_options_t *options);
- void cairo_surface_flush(cairo_surface_t *surface);
- void cairo_surface_mark_dirty(cairo_surface_t *surface);
- void cairo_surface_mark_dirty_rectangle(cairo_surface_t *surface, int x, int y, int width, int height);
- void cairo_surface_set_device_offset(cairo_surface_t *surface, double x_offset, double y_offset);
- void cairo_surface_get_device_offset(cairo_surface_t *surface, double *x_offset, double *y_offset);
- void cairo_surface_set_fallback_resolution(cairo_surface_t *surface, double x_pixels_per_inch, double y_pixels_per_inch);
- /* Image-surface functions */
- /**
- * cairo_format_t
- * @CAIRO_FORMAT_ARGB32: each pixel is a 32-bit quantity, with
- * alpha in the upper 8 bits, then red, then green, then blue.
- * The 32-bit quantities are stored native-endian. Pre-multiplied
- * alpha is used. (That is, 50% transparent red is 0x80800000,
- * not 0x80ff0000.)
- * @CAIRO_FORMAT_RGB24: each pixel is a 32-bit quantity, with
- * the upper 8 bits unused. Red, Green, and Blue are stored
- * in the remaining 24 bits in that order.
- * @CAIRO_FORMAT_A8: each pixel is a 8-bit quantity holding
- * an alpha value.
- * @CAIRO_FORMAT_A1: each pixel is a 1-bit quantity holding
- * an alpha value. Pixels are packed together into 32-bit
- * quantities. The ordering of the bits matches the
- * endianess of the platform. On a big-endian machine, the
- * first pixel is in the uppermost bit, on a little-endian
- * machine the first pixel is in the least-significant bit.
- * @CAIRO_FORMAT_RGB16_565: This format value is deprecated. It has
- * never been properly implemented in cairo and should not be used
- * by applications. (since 1.2)
- *
- * #cairo_format_t is used to identify the memory format of
- * image data.
- *
- * New entries may be added in future versions.
- **/
- enum cairo_format_t
- {
- CAIRO_FORMAT_ARGB32,
- CAIRO_FORMAT_RGB24,
- CAIRO_FORMAT_A8,
- CAIRO_FORMAT_A1,
- /* The value of 4 is reserved by a deprecated enum value.
- * The next format added must have an explicit value of 5.
- CAIRO_FORMAT_RGB16_565 = 4,
- */
- }
- cairo_surface_t * cairo_image_surface_create(cairo_format_t format, int width, int height);
- cairo_surface_t * cairo_image_surface_create_for_data(ubyte *data, cairo_format_t format, int width, int height, int stride);
- ubyte * cairo_image_surface_get_data(cairo_surface_t *surface);
- cairo_format_t cairo_image_surface_get_format(cairo_surface_t *surface);
- int cairo_image_surface_get_width(cairo_surface_t *surface);
- int cairo_image_surface_get_height(cairo_surface_t *surface);
- int cairo_image_surface_get_stride(cairo_surface_t *surface);
- cairo_surface_t * cairo_image_surface_create_from_png(char *filename);
- cairo_surface_t * cairo_image_surface_create_from_png_stream(cairo_read_func_t read_func, void *closure);
- /* Pattern creation functions */
- cairo_pattern_t * cairo_pattern_create_rgb(double red, double green, double blue);
- cairo_pattern_t * cairo_pattern_create_rgba(double red, double green, double blue, double alpha);
- cairo_pattern_t * cairo_pattern_create_for_surface(cairo_surface_t *surface);
- cairo_pattern_t * cairo_pattern_create_linear(double x0, double y0, double x1, double y1);
- cairo_pattern_t * cairo_pattern_create_radial(double cx0, double cy0, double radius0, double cx1, double cy1, double radius1);
- cairo_pattern_t * cairo_pattern_reference(cairo_pattern_t *pattern);
- void cairo_pattern_destroy(cairo_pattern_t *pattern);
- uint cairo_pattern_get_reference_count(cairo_pattern_t *pattern);
- cairo_status_t cairo_pattern_status(cairo_pattern_t *pattern);
- void * cairo_pattern_get_user_data(cairo_pattern_t *pattern, cairo_user_data_key_t *key);
- cairo_status_t cairo_pattern_set_user_data(cairo_pattern_t *pattern, cairo_user_data_key_t *key, void *user_data, cairo_destroy_func_t destroy);
- /**
- * cairo_pattern_type_t
- * @CAIRO_PATTERN_TYPE_SOLID: The pattern is a solid (uniform)
- * color. It may be opaque or translucent.
- * @CAIRO_PATTERN_TYPE_SURFACE: The pattern is a based on a surface (an image).
- * @CAIRO_PATTERN_TYPE_LINEAR: The pattern is a linear gradient.
- * @CAIRO_PATTERN_TYPE_RADIAL: The pattern is a radial gradient.
- *
- * #cairo_pattern_type_t is used to describe the type of a given pattern.
- *
- * The type of a pattern is determined by the function used to create
- * it. The cairo_pattern_create_rgb() and cairo_pattern_create_rgba()
- * functions create SOLID patterns. The remaining
- * cairo_pattern_create functions map to pattern types in obvious
- * ways.
- *
- * The pattern type can be queried with cairo_pattern_get_type()
- *
- * Most cairo_pattern functions can be called with a pattern of any
- * type, (though trying to change the extend or filter for a solid
- * pattern will have no effect). A notable exception is
- * cairo_pattern_add_color_stop_rgb() and
- * cairo_pattern_add_color_stop_rgba() which must only be called with
- * gradient patterns (either LINEAR or RADIAL). Otherwise the pattern
- * will be shutdown and put into an error state.
- *
- * New entries may be added in future versions.
- *
- * Since: 1.2
- **/
- enum cairo_pattern_type_t
- {
- CAIRO_PATTERN_TYPE_SOLID,
- CAIRO_PATTERN_TYPE_SURFACE,
- CAIRO_PATTERN_TYPE_LINEAR,
- CAIRO_PATTERN_TYPE_RADIAL,
- }
- cairo_pattern_type_t cairo_pattern_get_type(cairo_pattern_t *pattern);
- void cairo_pattern_add_color_stop_rgb(cairo_pattern_t *pattern, double offset, double red, double green, double blue);
- void cairo_pattern_add_color_stop_rgba(cairo_pattern_t *pattern, double offset, double red, double green, double blue, double alpha);
- void cairo_pattern_set_matrix(cairo_pattern_t *pattern, cairo_matrix_t *matrix);
- void cairo_pattern_get_matrix(cairo_pattern_t *pattern, cairo_matrix_t *matrix);
- /**
- * cairo_extend_t
- * @CAIRO_EXTEND_NONE: pixels outside of the source pattern
- * are fully transparent
- * @CAIRO_EXTEND_REPEAT: the pattern is tiled by repeating
- * @CAIRO_EXTEND_REFLECT: the pattern is tiled by reflecting
- * at the edges (not implemented for surface patterns currently)
- * @CAIRO_EXTEND_PAD: pixels outside of the pattern copy
- * the closest pixel from the source (Since 1.2; not implemented
- * for surface patterns currently)
- *
- * #cairo_extend_t is used to describe how the area outside
- * of a pattern will be drawn.
- *
- * New entries may be added in future versions.
- **/
- enum cairo_extend_t
- {
- CAIRO_EXTEND_NONE,
- CAIRO_EXTEND_REPEAT,
- CAIRO_EXTEND_REFLECT,
- CAIRO_EXTEND_PAD,
- }
- void cairo_pattern_set_extend(cairo_pattern_t *pattern, cairo_extend_t extend);
- cairo_extend_t cairo_pattern_get_extend(cairo_pattern_t *pattern);
- enum cairo_filter_t
- {
- CAIRO_FILTER_FAST,
- CAIRO_FILTER_GOOD,
- CAIRO_FILTER_BEST,
- CAIRO_FILTER_NEAREST,
- CAIRO_FILTER_BILINEAR,
- CAIRO_FILTER_GAUSSIAN,
- }
- void cairo_pattern_set_filter(cairo_pattern_t *pattern, cairo_filter_t filter);
- cairo_filter_t cairo_pattern_get_filter(cairo_pattern_t *pattern);
- cairo_status_t cairo_pattern_get_rgba(cairo_pattern_t *pattern, double *red, double *green, double *blue, double *alpha);
- cairo_status_t cairo_pattern_get_surface(cairo_pattern_t *pattern, cairo_surface_t **surface);
- cairo_status_t cairo_pattern_get_color_stop_rgba(cairo_pattern_t *pattern, int index, double *offset, double *red, double *green, double *blue, double *alpha);
- cairo_status_t cairo_pattern_get_color_stop_count(cairo_pattern_t *pattern, int *count);
- cairo_status_t cairo_pattern_get_linear_points(cairo_pattern_t *pattern, double *x0, double *y0, double *x1, double *y1);
- cairo_status_t cairo_pattern_get_radial_circles(cairo_pattern_t *pattern, double *x0, double *y0, double *r0, double *x1, double *y1, double *r1);
- /* Matrix functions */
- void cairo_matrix_init(cairo_matrix_t *matrix, double xx, double yx, double xy, double yy, double x0, double y0);
- void cairo_matrix_init_identity(cairo_matrix_t *matrix);
- void cairo_matrix_init_translate(cairo_matrix_t *matrix, double tx, double ty);
- void cairo_matrix_init_scale(cairo_matrix_t *matrix, double sx, double sy);
- void cairo_matrix_init_rotate(cairo_matrix_t *matrix, double radians);
- void cairo_matrix_translate(cairo_matrix_t *matrix, double tx, double ty);
- void cairo_matrix_scale(cairo_matrix_t *matrix, double sx, double sy);
- void cairo_matrix_rotate(cairo_matrix_t *matrix, double radians);
- cairo_status_t cairo_matrix_invert(cairo_matrix_t *matrix);
- void cairo_matrix_multiply(cairo_matrix_t *result, cairo_matrix_t *a, cairo_matrix_t *b);
- void cairo_matrix_transform_distance(cairo_matrix_t *matrix, double *dx, double *dy);
- void cairo_matrix_transform_point(cairo_matrix_t *matrix, double *x, double *y);
- /* Functions to be used while debugging (not intended for use in production code) */
- void cairo_debug_reset_static_data();