mirror of
https://gitlab.freedesktop.org/cairo/cairo.git
synced 2025-12-30 12:00:15 +01:00
[doc] Make sure all type names in docs are prefixed by #
This commit is contained in:
parent
9ecde82d35
commit
0d898f2bad
29 changed files with 79 additions and 79 deletions
|
|
@ -177,7 +177,7 @@ _cairo_array_truncate (cairo_array_t *array, unsigned int num_elements)
|
|||
* pointer may be used for further direct indexing with []. For
|
||||
* example:
|
||||
*
|
||||
* cairo_array_t array;
|
||||
* #cairo_array_t array;
|
||||
* double *values;
|
||||
*
|
||||
* _cairo_array_init (&array, sizeof(double));
|
||||
|
|
|
|||
|
|
@ -129,7 +129,7 @@ typedef struct _cairo_bo_event_queue {
|
|||
unsigned num_startstop_events;
|
||||
} cairo_bo_event_queue_t;
|
||||
|
||||
/* This structure extends cairo_skip_list_t, which must come first. */
|
||||
/* This structure extends #cairo_skip_list_t, which must come first. */
|
||||
typedef struct _cairo_bo_sweep_line {
|
||||
cairo_skip_list_t active_edges;
|
||||
cairo_bo_edge_t *head;
|
||||
|
|
@ -1053,7 +1053,7 @@ print_state (const char *msg,
|
|||
}
|
||||
#endif
|
||||
|
||||
/* Adds the trapezoid, if any, of the left edge to the cairo_traps_t
|
||||
/* Adds the trapezoid, if any, of the left edge to the #cairo_traps_t
|
||||
* of bo_traps. */
|
||||
static cairo_status_t
|
||||
_cairo_bo_edge_end_trap (cairo_bo_edge_t *left,
|
||||
|
|
|
|||
|
|
@ -46,8 +46,8 @@
|
|||
* cairo_cache_entry_t:
|
||||
*
|
||||
* A #cairo_cache_entry_t contains both a key and a value for
|
||||
* cairo_cache_t. User-derived types for cairo_cache_entry_t must
|
||||
* have a cairo_cache_entry_t as their first field. For example:
|
||||
* cairo_cache_t. User-derived types for #cairo_cache_entry_t must
|
||||
* have a #cairo_cache_entry_t as their first field. For example:
|
||||
*
|
||||
* typedef _my_entry {
|
||||
* cairo_cache_entry_t base;
|
||||
|
|
|
|||
|
|
@ -97,7 +97,7 @@ _cairo_cache_fini (cairo_cache_t *cache)
|
|||
* the equality of entries.
|
||||
*
|
||||
* Data is provided to the cache in the form of user-derived version
|
||||
* of cairo_cache_entry_t. A cache entry must be able to hold hash
|
||||
* of #cairo_cache_entry_t. A cache entry must be able to hold hash
|
||||
* code, a size, and the key/value pair being stored in the
|
||||
* cache. Sometimes only the key will be necessary, (as in
|
||||
* _cairo_cache_lookup()), and in these cases the value portion of the
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ typedef cairo_int128_t cairo_fixed_96_32_t;
|
|||
/* A signed type %CAIRO_FIXED_BITS in size; the main fixed point type */
|
||||
typedef int32_t cairo_fixed_t;
|
||||
|
||||
/* An unsigned type of the same size as cairo_fixed_t */
|
||||
/* An unsigned type of the same size as #cairo_fixed_t */
|
||||
typedef uint32_t cairo_fixed_unsigned_t;
|
||||
|
||||
#endif /* CAIRO_FIXED_TYPE_PRIVATE_H */
|
||||
|
|
|
|||
|
|
@ -256,10 +256,10 @@ _cairo_toy_font_face_keys_equal (const void *key_a,
|
|||
const void *key_b);
|
||||
|
||||
/* We maintain a hash table from family/weight/slant =>
|
||||
* cairo_font_face_t for cairo_toy_font_t. The primary purpose of
|
||||
* this mapping is to provide unique cairo_font_face_t values so that
|
||||
* our cache and mapping from cairo_font_face_t => cairo_scaled_font_t
|
||||
* works. Once the corresponding cairo_font_face_t objects fall out of
|
||||
* cairo_font_face_t for #cairo_toy_font_t. The primary purpose of
|
||||
* this mapping is to provide unique #cairo_font_face_t values so that
|
||||
* our cache and mapping from #cairo_font_face_t => #cairo_scaled_font_t
|
||||
* works. Once the corresponding #cairo_font_face_t objects fall out of
|
||||
* downstream caches, we don't need them in this hash table anymore.
|
||||
*
|
||||
* Modifications to this hash table are protected by
|
||||
|
|
@ -295,11 +295,11 @@ _cairo_toy_font_face_hash_table_unlock (void)
|
|||
/**
|
||||
* _cairo_toy_font_face_init_key:
|
||||
*
|
||||
* Initialize those portions of cairo_toy_font_face_t needed to use
|
||||
* Initialize those portions of #cairo_toy_font_face_t needed to use
|
||||
* it as a hash table key, including the hash code buried away in
|
||||
* font_face->base.hash_entry. No memory allocation is performed here
|
||||
* so that no fini call is needed. We do this to make it easier to use
|
||||
* an automatic cairo_toy_font_face_t variable as a key.
|
||||
* an automatic #cairo_toy_font_face_t variable as a key.
|
||||
**/
|
||||
static void
|
||||
_cairo_toy_font_face_init_key (cairo_toy_font_face_t *key,
|
||||
|
|
|
|||
|
|
@ -241,7 +241,7 @@ slim_hidden_def (cairo_font_options_equal);
|
|||
* @options: a #cairo_font_options_t
|
||||
*
|
||||
* Compute a hash for the font options object; this value will
|
||||
* be useful when storing an object containing a cairo_font_options_t
|
||||
* be useful when storing an object containing a #cairo_font_options_t
|
||||
* in a hash table.
|
||||
*
|
||||
* Return value: the hash value for the font options object.
|
||||
|
|
|
|||
|
|
@ -140,11 +140,11 @@ struct _cairo_ft_font_face {
|
|||
static const cairo_unscaled_font_backend_t cairo_ft_unscaled_font_backend;
|
||||
|
||||
/*
|
||||
* We maintain a hash table to map file/id => cairo_ft_unscaled_font_t.
|
||||
* We maintain a hash table to map file/id => #cairo_ft_unscaled_font_t.
|
||||
* The hash table itself isn't limited in size. However, we limit the
|
||||
* number of FT_Face objects we keep around; when we've exceeded that
|
||||
* limit and need to create a new FT_Face, we dump the FT_Face from a
|
||||
* random cairo_ft_unscaled_font_t which has an unlocked FT_Face, (if
|
||||
* random #cairo_ft_unscaled_font_t which has an unlocked FT_Face, (if
|
||||
* there are any).
|
||||
*/
|
||||
|
||||
|
|
@ -295,9 +295,9 @@ _cairo_ft_unscaled_font_init_key (cairo_ft_unscaled_font_t *key,
|
|||
/**
|
||||
* _cairo_ft_unscaled_font_init:
|
||||
*
|
||||
* Initialize a cairo_ft_unscaled_font_t.
|
||||
* Initialize a #cairo_ft_unscaled_font_t.
|
||||
*
|
||||
* There are two basic flavors of cairo_ft_unscaled_font_t, one
|
||||
* There are two basic flavors of #cairo_ft_unscaled_font_t, one
|
||||
* created from an FT_Face and the other created from a filename/id
|
||||
* pair. These two flavors are identified as from_face and !from_face.
|
||||
*
|
||||
|
|
@ -309,7 +309,7 @@ _cairo_ft_unscaled_font_init_key (cairo_ft_unscaled_font_t *key,
|
|||
*
|
||||
* Note that the code handles these two flavors in very distinct
|
||||
* ways. For example there is a hash_table mapping
|
||||
* filename/id->cairo_unscaled_font_t in the !from_face case, but no
|
||||
* filename/id->#cairo_unscaled_font_t in the !from_face case, but no
|
||||
* parallel in the from_face case, (where the calling code would have
|
||||
* to do its own mapping to ensure similar sharing).
|
||||
**/
|
||||
|
|
@ -358,7 +358,7 @@ _cairo_unscaled_font_is_ft (cairo_unscaled_font_t *unscaled_font)
|
|||
/**
|
||||
* _cairo_ft_unscaled_font_fini:
|
||||
*
|
||||
* Free all data associated with a cairo_ft_unscaled_font_t.
|
||||
* Free all data associated with a #cairo_ft_unscaled_font_t.
|
||||
*
|
||||
* CAUTION: The unscaled->face field must be %NULL before calling this
|
||||
* function. This is because the cairo_ft_unscaled_font_map keeps a
|
||||
|
|
|
|||
|
|
@ -219,10 +219,10 @@ _cairo_gstate_destroy (cairo_gstate_t *gstate)
|
|||
*
|
||||
* Create a new #cairo_gstate_t setting all graphics state parameters
|
||||
* to the same values as contained in @other. gstate->next will be set
|
||||
* to %NULL and may be used by the caller to chain cairo_gstate_t
|
||||
* to %NULL and may be used by the caller to chain #cairo_gstate_t
|
||||
* objects together.
|
||||
*
|
||||
* Return value: a new cairo_gstate_t or %NULL if there is insufficient
|
||||
* Return value: a new #cairo_gstate_t or %NULL if there is insufficient
|
||||
* memory.
|
||||
**/
|
||||
static cairo_gstate_t*
|
||||
|
|
@ -422,7 +422,7 @@ _cairo_gstate_get_original_target (cairo_gstate_t *gstate)
|
|||
* _cairo_gstate_get_clip:
|
||||
* @gstate: a #cairo_gstate_t
|
||||
*
|
||||
* Return value: a pointer to the gstate's cairo_clip_t structure.
|
||||
* Return value: a pointer to the gstate's #cairo_clip_t structure.
|
||||
*/
|
||||
cairo_clip_t *
|
||||
_cairo_gstate_get_clip (cairo_gstate_t *gstate)
|
||||
|
|
@ -1469,7 +1469,7 @@ _cairo_gstate_get_scaled_font (cairo_gstate_t *gstate,
|
|||
* and then ignored by the "scaled-font" layer.
|
||||
*
|
||||
* In order to perform any action on a font, we must build an object
|
||||
* called a cairo_font_scale_t; this contains the central 2x2 matrix
|
||||
* called a #cairo_font_scale_t; this contains the central 2x2 matrix
|
||||
* resulting from "font matrix * CTM" (sans the font matrix translation
|
||||
* components as stated in the previous paragraph).
|
||||
*
|
||||
|
|
|
|||
|
|
@ -133,7 +133,7 @@ struct _cairo_hash_table {
|
|||
*
|
||||
* Creates a new hash table which will use the keys_equal() function
|
||||
* to compare hash keys. Data is provided to the hash table in the
|
||||
* form of user-derived versions of cairo_hash_entry_t. A hash entry
|
||||
* form of user-derived versions of #cairo_hash_entry_t. A hash entry
|
||||
* must be able to hold both a key (including a hash code) and a
|
||||
* value. Sometimes only the key will be necessary, (as in
|
||||
* _cairo_hash_table_remove), and other times both a key and a value
|
||||
|
|
|
|||
|
|
@ -280,7 +280,7 @@ _pixman_format_to_masks (pixman_format_code_t pixman_format,
|
|||
/* XXX: This function really should be eliminated. We don't really
|
||||
* want to advertise a cairo image surface that supports any possible
|
||||
* format. A minimal step would be to replace this function with one
|
||||
* that accepts a cairo_internal_format_t rather than mask values. */
|
||||
* that accepts a #cairo_internal_format_t rather than mask values. */
|
||||
cairo_surface_t *
|
||||
_cairo_image_surface_create_with_masks (unsigned char *data,
|
||||
cairo_format_masks_t *masks,
|
||||
|
|
@ -396,7 +396,7 @@ _cairo_image_surface_create_with_content (cairo_content_t content,
|
|||
|
||||
/**
|
||||
* cairo_format_stride_for_width:
|
||||
* @format: A cairo_format_t value
|
||||
* @format: A #cairo_format_t value
|
||||
* @width: The desired width of an image surface to be created.
|
||||
*
|
||||
* Return value: the appropriate stride to use given the desired
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ slim_hidden_def(cairo_matrix_init_identity);
|
|||
|
||||
/**
|
||||
* cairo_matrix_init:
|
||||
* @matrix: a cairo_matrix_t
|
||||
* @matrix: a #cairo_matrix_t
|
||||
* @xx: xx component of the affine transformation
|
||||
* @yx: yx component of the affine transformation
|
||||
* @xy: xy component of the affine transformation
|
||||
|
|
@ -137,7 +137,7 @@ _cairo_matrix_get_affine (const cairo_matrix_t *matrix,
|
|||
|
||||
/**
|
||||
* cairo_matrix_init_translate:
|
||||
* @matrix: a cairo_matrix_t
|
||||
* @matrix: a #cairo_matrix_t
|
||||
* @tx: amount to translate in the X direction
|
||||
* @ty: amount to translate in the Y direction
|
||||
*
|
||||
|
|
@ -157,7 +157,7 @@ slim_hidden_def(cairo_matrix_init_translate);
|
|||
|
||||
/**
|
||||
* cairo_matrix_translate:
|
||||
* @matrix: a cairo_matrix_t
|
||||
* @matrix: a #cairo_matrix_t
|
||||
* @tx: amount to translate in the X direction
|
||||
* @ty: amount to translate in the Y direction
|
||||
*
|
||||
|
|
@ -179,7 +179,7 @@ slim_hidden_def (cairo_matrix_translate);
|
|||
|
||||
/**
|
||||
* cairo_matrix_init_scale:
|
||||
* @matrix: a cairo_matrix_t
|
||||
* @matrix: a #cairo_matrix_t
|
||||
* @sx: scale factor in the X direction
|
||||
* @sy: scale factor in the Y direction
|
||||
*
|
||||
|
|
@ -220,7 +220,7 @@ slim_hidden_def(cairo_matrix_scale);
|
|||
|
||||
/**
|
||||
* cairo_matrix_init_rotate:
|
||||
* @matrix: a cairo_matrix_t
|
||||
* @matrix: a #cairo_matrix_t
|
||||
* @radians: angle of rotation, in radians. The direction of rotation
|
||||
* is defined such that positive angles rotate in the direction from
|
||||
* the positive X axis toward the positive Y axis. With the default
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ CAIRO_BEGIN_DECLS
|
|||
* on a win32 system even if you do not compile the win32
|
||||
* surface/backend.
|
||||
*
|
||||
* - typedef cairo_mutex_t to the proper mutex type on your target
|
||||
* - typedef #cairo_mutex_t to the proper mutex type on your target
|
||||
* system. Note that you may or may not need to use a pointer,
|
||||
* depending on what kinds of initialization your mutex
|
||||
* implementation supports. No trailing semicolon needed.
|
||||
|
|
@ -90,7 +90,7 @@ CAIRO_BEGIN_DECLS
|
|||
* %CAIRO_MUTEX_UNLOCK (_cairo_some_mutex);
|
||||
*
|
||||
* - #define %CAIRO_MUTEX_NIL_INITIALIZER to something that can
|
||||
* initialize the cairo_mutex_t type you defined. Most of the
|
||||
* initialize the #cairo_mutex_t type you defined. Most of the
|
||||
* time one of 0, %NULL, or {} works. At this point
|
||||
* you should be able to compile the following snippet:
|
||||
*
|
||||
|
|
@ -134,7 +134,7 @@ CAIRO_BEGIN_DECLS
|
|||
* #define CAIRO_MUTEX_FINALIZE() CAIRO_MUTEX_NOOP
|
||||
*
|
||||
* - That is all. If for any reason you think the above API is
|
||||
* not enough to implement cairo_mutex_t on your system, please
|
||||
* not enough to implement #cairo_mutex_t on your system, please
|
||||
* stop and write to the cairo mailing list about it. DO NOT
|
||||
* poke around cairo-mutex-private.h for possible solutions.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -389,7 +389,7 @@ _cairo_pattern_create_in_error (cairo_status_t status)
|
|||
* @green: green component of the color
|
||||
* @blue: blue component of the color
|
||||
*
|
||||
* Creates a new cairo_pattern_t corresponding to an opaque color. The
|
||||
* Creates a new #cairo_pattern_t corresponding to an opaque color. The
|
||||
* color components are floating point numbers in the range 0 to 1.
|
||||
* If the values passed in are outside that range, they will be
|
||||
* clamped.
|
||||
|
|
@ -433,7 +433,7 @@ slim_hidden_def (cairo_pattern_create_rgb);
|
|||
* @blue: blue component of the color
|
||||
* @alpha: alpha component of the color
|
||||
*
|
||||
* Creates a new cairo_pattern_t corresponding to a translucent color.
|
||||
* Creates a new #cairo_pattern_t corresponding to a translucent color.
|
||||
* The color components are floating point numbers in the range 0 to
|
||||
* 1. If the values passed in are outside that range, they will be
|
||||
* clamped.
|
||||
|
|
@ -476,7 +476,7 @@ slim_hidden_def (cairo_pattern_create_rgba);
|
|||
* cairo_pattern_create_for_surface:
|
||||
* @surface: the surface
|
||||
*
|
||||
* Create a new cairo_pattern_t for the given surface.
|
||||
* Create a new #cairo_pattern_t for the given surface.
|
||||
*
|
||||
* Return value: the newly created #cairo_pattern_t if successful, or
|
||||
* an error pattern in case of no memory. The caller owns the
|
||||
|
|
@ -519,7 +519,7 @@ slim_hidden_def (cairo_pattern_create_for_surface);
|
|||
* @x1: x coordinate of the end point
|
||||
* @y1: y coordinate of the end point
|
||||
*
|
||||
* Create a new linear gradient cairo_pattern_t along the line defined
|
||||
* Create a new linear gradient #cairo_pattern_t along the line defined
|
||||
* by (x0, y0) and (x1, y1). Before using the gradient pattern, a
|
||||
* number of color stops should be defined using
|
||||
* cairo_pattern_add_color_stop_rgb() or
|
||||
|
|
@ -565,7 +565,7 @@ cairo_pattern_create_linear (double x0, double y0, double x1, double y1)
|
|||
* @cy1: y coordinate for the center of the end circle
|
||||
* @radius1: radius of the end circle
|
||||
*
|
||||
* Creates a new radial gradient cairo_pattern_t between the two
|
||||
* Creates a new radial gradient #cairo_pattern_t between the two
|
||||
* circles defined by (cx0, cy0, radius0) and (cx1, cy1, radius1). Before using the
|
||||
* gradient pattern, a number of color stops should be defined using
|
||||
* cairo_pattern_add_color_stop_rgb() or
|
||||
|
|
|
|||
|
|
@ -424,7 +424,7 @@ _extract_pdf_surface (cairo_surface_t *surface,
|
|||
|
||||
/**
|
||||
* cairo_pdf_surface_set_size:
|
||||
* @surface: a PDF cairo_surface_t
|
||||
* @surface: a PDF #cairo_surface_t
|
||||
* @width_in_points: new surface width, in points (1 point == 1/72.0 inch)
|
||||
* @height_in_points: new surface height, in points (1 point == 1/72.0 inch)
|
||||
*
|
||||
|
|
|
|||
|
|
@ -84,7 +84,7 @@ convert_data_to_bytes (png_structp png, png_row_infop row_info, png_bytep data)
|
|||
}
|
||||
|
||||
/* Use a couple of simple error callbacks that do not print anything to
|
||||
* stderr and rely on the user to check for errors via the cairo_status_t
|
||||
* stderr and rely on the user to check for errors via the #cairo_status_t
|
||||
* return.
|
||||
*/
|
||||
static void
|
||||
|
|
|
|||
|
|
@ -1205,7 +1205,7 @@ cairo_ps_level_to_string (cairo_ps_level_t level)
|
|||
|
||||
/**
|
||||
* cairo_ps_surface_set_eps:
|
||||
* @surface: a PostScript cairo_surface_t
|
||||
* @surface: a PostScript #cairo_surface_t
|
||||
* @eps: %TRUE to output EPS format PostScript
|
||||
*
|
||||
* If @eps is %TRUE, the PostScript surface will output Encapsulated
|
||||
|
|
@ -1237,7 +1237,7 @@ cairo_ps_surface_set_eps (cairo_surface_t *surface,
|
|||
|
||||
/**
|
||||
* cairo_ps_surface_get_eps:
|
||||
* @surface: a PostScript cairo_surface_t
|
||||
* @surface: a PostScript #cairo_surface_t
|
||||
*
|
||||
* Check whether the PostScript surface will output Encapsulated PostScript.
|
||||
*
|
||||
|
|
@ -1262,7 +1262,7 @@ cairo_ps_surface_get_eps (cairo_surface_t *surface)
|
|||
|
||||
/**
|
||||
* cairo_ps_surface_set_size:
|
||||
* @surface: a PostScript cairo_surface_t
|
||||
* @surface: a PostScript #cairo_surface_t
|
||||
* @width_in_points: new surface width, in points (1 point == 1/72.0 inch)
|
||||
* @height_in_points: new surface height, in points (1 point == 1/72.0 inch)
|
||||
*
|
||||
|
|
@ -1302,7 +1302,7 @@ cairo_ps_surface_set_size (cairo_surface_t *surface,
|
|||
|
||||
/**
|
||||
* cairo_ps_surface_dsc_comment:
|
||||
* @surface: a PostScript cairo_surface_t
|
||||
* @surface: a PostScript #cairo_surface_t
|
||||
* @comment: a comment string to be emitted into the PostScript output
|
||||
*
|
||||
* Emit a comment into the PostScript output for the given surface.
|
||||
|
|
@ -1430,7 +1430,7 @@ cairo_ps_surface_dsc_comment (cairo_surface_t *surface,
|
|||
|
||||
/**
|
||||
* cairo_ps_surface_dsc_begin_setup:
|
||||
* @surface: a PostScript cairo_surface_t
|
||||
* @surface: a PostScript #cairo_surface_t
|
||||
*
|
||||
* This function indicates that subsequent calls to
|
||||
* cairo_ps_surface_dsc_comment() should direct comments to the Setup
|
||||
|
|
@ -1464,7 +1464,7 @@ cairo_ps_surface_dsc_begin_setup (cairo_surface_t *surface)
|
|||
|
||||
/**
|
||||
* cairo_ps_surface_dsc_begin_page_setup:
|
||||
* @surface: a PostScript cairo_surface_t
|
||||
* @surface: a PostScript #cairo_surface_t
|
||||
*
|
||||
* This function indicates that subsequent calls to
|
||||
* cairo_ps_surface_dsc_comment() should direct comments to the
|
||||
|
|
|
|||
|
|
@ -393,7 +393,7 @@ CreateGradientFunction (cairo_gradient_pattern_t *gpat)
|
|||
&callbacks);
|
||||
}
|
||||
|
||||
/* generic cairo surface -> cairo_quartz_surface_t function */
|
||||
/* generic cairo surface -> #cairo_quartz_surface_t function */
|
||||
static cairo_int_status_t
|
||||
_cairo_quartz_surface_to_quartz (cairo_surface_t *target,
|
||||
cairo_surface_t *pat_surf,
|
||||
|
|
|
|||
|
|
@ -39,15 +39,15 @@
|
|||
#include "cairoint.h"
|
||||
|
||||
/* XXX We currently have a confusing mix of boxes and rectangles as
|
||||
* exemplified by this function. A cairo_box_t is a rectangular area
|
||||
* exemplified by this function. A #cairo_box_t is a rectangular area
|
||||
* represented by the coordinates of the upper left and lower right
|
||||
* corners, expressed in fixed point numbers. A cairo_rectangle_int_t is
|
||||
* corners, expressed in fixed point numbers. A #cairo_rectangle_int_t is
|
||||
* also a rectangular area, but represented by the upper left corner
|
||||
* and the width and the height, as integer numbers.
|
||||
*
|
||||
* This function converts a cairo_box_t to a cairo_rectangle_int_t by
|
||||
* This function converts a #cairo_box_t to a #cairo_rectangle_int_t by
|
||||
* increasing the area to the nearest integer coordinates. We should
|
||||
* standardize on cairo_rectangle_fixed_t and cairo_rectangle_int_t, and
|
||||
* standardize on #cairo_rectangle_fixed_t and #cairo_rectangle_int_t, and
|
||||
* this function could be renamed to the more reasonable
|
||||
* _cairo_rectangle_fixed_round.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -149,7 +149,7 @@ _cairo_region_boxes_fini (cairo_region_t *region, cairo_box_int_t *boxes)
|
|||
* @region: a #cairo_region_t
|
||||
* @rect: rectangle into which to store the extents
|
||||
*
|
||||
* Gets the bounding box of a region as a cairo_rectangle_int_t
|
||||
* Gets the bounding box of a region as a #cairo_rectangle_int_t
|
||||
**/
|
||||
void
|
||||
_cairo_region_get_extents (cairo_region_t *region, cairo_rectangle_int_t *extents)
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ typedef struct _cairo_scaled_font_subsets_glyph {
|
|||
* _cairo_scaled_font_subsets_create_scaled:
|
||||
*
|
||||
* Create a new #cairo_scaled_font_subsets_t object which can be used
|
||||
* to create subsets of any number of cairo_scaled_font_t
|
||||
* to create subsets of any number of #cairo_scaled_font_t
|
||||
* objects. This allows the (arbitrarily large and sparse) glyph
|
||||
* indices of a cairo_scaled_font to be mapped to one or more font
|
||||
* subsets with glyph indices packed into the range
|
||||
|
|
@ -74,7 +74,7 @@ _cairo_scaled_font_subsets_create_scaled (void);
|
|||
*
|
||||
* Glyphs with an outline path available will be mapped to one font
|
||||
* subset for each font face. Glyphs from bitmap fonts will mapped to
|
||||
* separate font subsets for each cairo_scaled_font_t object.
|
||||
* separate font subsets for each #cairo_scaled_font_t object.
|
||||
*
|
||||
* The maximum number of glyphs per subset is 256. Each subset
|
||||
* reserves the first glyph for the .notdef glyph.
|
||||
|
|
@ -98,7 +98,7 @@ _cairo_scaled_font_subsets_create_simple (void);
|
|||
* 65536 glyphs except for Type1 fonts which have a maximum of 256 glyphs.
|
||||
*
|
||||
* Glyphs from bitmap fonts will mapped to separate font subsets for
|
||||
* each cairo_scaled_font_t object. Each unscaled subset has a maximum
|
||||
* each #cairo_scaled_font_t object. Each unscaled subset has a maximum
|
||||
* of 256 glyphs.
|
||||
*
|
||||
* Each subset reserves the first glyph for the .notdef glyph.
|
||||
|
|
@ -167,7 +167,7 @@ _cairo_scaled_font_subsets_destroy (cairo_scaled_font_subsets_t *font_subsets);
|
|||
* used by #cairo_scaled_font_subset_t as provided by
|
||||
* _cairo_scaled_font_subsets_foreach.
|
||||
*
|
||||
* The returned values in the cairo_scaled_font_subsets_glyph_t struct are:
|
||||
* The returned values in the #cairo_scaled_font_subsets_glyph_t struct are:
|
||||
*
|
||||
* @font_id: The font ID of the mapped glyph
|
||||
* @subset_id : The subset ID of the mapped glyph within the @font_id
|
||||
|
|
|
|||
|
|
@ -271,12 +271,12 @@ cairo_scaled_font_status (cairo_scaled_font_t *scaled_font)
|
|||
slim_hidden_def (cairo_scaled_font_status);
|
||||
|
||||
/* Here we keep a unique mapping from
|
||||
* cairo_font_face_t/matrix/ctm/options => cairo_scaled_font_t.
|
||||
* cairo_font_face_t/matrix/ctm/options => #cairo_scaled_font_t.
|
||||
*
|
||||
* Here are the things that we want to map:
|
||||
*
|
||||
* a) All otherwise referenced cairo_scaled_font_t's
|
||||
* b) Some number of not otherwise referenced cairo_scaled_font_t's
|
||||
* a) All otherwise referenced #cairo_scaled_font_t's
|
||||
* b) Some number of not otherwise referenced #cairo_scaled_font_t's
|
||||
*
|
||||
* The implementation uses a hash table which covers (a)
|
||||
* completely. Then, for (b) we have an array of otherwise
|
||||
|
|
@ -453,7 +453,7 @@ _cairo_scaled_font_keys_equal (const void *abstract_key_a, const void *abstract_
|
|||
#define MAX_GLYPHS_CACHED_PER_FONT 256
|
||||
|
||||
/*
|
||||
* Basic cairo_scaled_font_t object management
|
||||
* Basic #cairo_scaled_font_t object management
|
||||
*/
|
||||
|
||||
cairo_status_t
|
||||
|
|
|
|||
|
|
@ -92,7 +92,7 @@ _cairo_traps_fini (cairo_traps_t *traps)
|
|||
* @box: a box that will be converted to a single trapezoid
|
||||
* to store in @traps.
|
||||
*
|
||||
* Initializes a cairo_traps_t to contain a single rectangular
|
||||
* Initializes a #cairo_traps_t to contain a single rectangular
|
||||
* trapezoid.
|
||||
**/
|
||||
cairo_status_t
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ typedef cairo_array_t cairo_user_data_array_t;
|
|||
* cairo_hash_entry_t:
|
||||
*
|
||||
* A #cairo_hash_entry_t contains both a key and a value for
|
||||
* cairo_hash_table_t. User-derived types for cairo_hash_entry_t must
|
||||
* cairo_hash_table_t. User-derived types for #cairo_hash_entry_t must
|
||||
* be type-compatible with this structure (eg. they must have an
|
||||
* unsigned long as the first parameter. The easiest way to get this
|
||||
* is to use:
|
||||
|
|
|
|||
|
|
@ -1890,7 +1890,7 @@ cairo_win32_surface_get_dc (cairo_surface_t *surface)
|
|||
* as the DIB of the Win32 surface. If the passed-in win32 surface
|
||||
* is not a DIB surface, %NULL is returned.
|
||||
*
|
||||
* Return value: a #cairo_surface_t (owned by the win32 cairo_surface_t),
|
||||
* Return value: a #cairo_surface_t (owned by the win32 #cairo_surface_t),
|
||||
* or %NULL if the win32 surface is not a DIB.
|
||||
*
|
||||
* Since: 1.4
|
||||
|
|
|
|||
|
|
@ -2857,7 +2857,7 @@ typedef void (*cairo_xrender_composite_text_func_t)
|
|||
_Xconst XGlyphElt8 *elts,
|
||||
int nelt);
|
||||
|
||||
/* Build a struct of the same size of cairo_glyph_t that can be used both as
|
||||
/* Build a struct of the same size of #cairo_glyph_t that can be used both as
|
||||
* an input glyph with double coordinates, and as "working" glyph with
|
||||
* integer from-current-point offsets. */
|
||||
typedef struct {
|
||||
|
|
@ -2874,7 +2874,7 @@ typedef struct {
|
|||
} p;
|
||||
} cairo_xlib_glyph_t;
|
||||
|
||||
/* compile-time assert that cairo_xlib_glyph_t is the same size as cairo_glyph_t */
|
||||
/* compile-time assert that #cairo_xlib_glyph_t is the same size as #cairo_glyph_t */
|
||||
typedef int cairo_xlib_glyph_t_size_assertion [sizeof (cairo_xlib_glyph_t) == sizeof (cairo_glyph_t) ? 1 : -1];
|
||||
|
||||
#define GLYPH_INDEX_SKIP ((unsigned long) -1)
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ static const cairo_t _cairo_nil = {
|
|||
|
||||
#include <assert.h>
|
||||
|
||||
/* This has to be updated whenever cairo_status_t is extended. That's
|
||||
/* This has to be updated whenever #cairo_status_t is extended. That's
|
||||
* a bit of a pain, but it should be easy to always catch as long as
|
||||
* one adds a new test case to test a trigger of the new status value.
|
||||
*/
|
||||
|
|
@ -461,7 +461,7 @@ slim_hidden_def(cairo_push_group);
|
|||
/**
|
||||
* cairo_push_group_with_content:
|
||||
* @cr: a cairo context
|
||||
* @content: a %cairo_content_t indicating the type of group that
|
||||
* @content: a %#cairo_content_t indicating the type of group that
|
||||
* will be created
|
||||
*
|
||||
* Temporarily redirects drawing to an intermediate surface known as a
|
||||
|
|
|
|||
16
src/cairo.h
16
src/cairo.h
|
|
@ -184,7 +184,7 @@ typedef struct _cairo_user_data_key {
|
|||
* @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_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
|
||||
|
|
@ -193,8 +193,8 @@ typedef struct _cairo_user_data_key {
|
|||
* @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_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
|
||||
|
|
@ -251,8 +251,8 @@ typedef enum _cairo_status {
|
|||
* 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
|
||||
* 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.
|
||||
**/
|
||||
typedef enum _cairo_content {
|
||||
|
|
@ -734,7 +734,7 @@ cairo_rectangle_list_destroy (cairo_rectangle_list_t *rectangle_list);
|
|||
* 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
|
||||
* 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.
|
||||
*
|
||||
|
|
@ -1346,8 +1346,8 @@ typedef enum _cairo_path_data_type {
|
|||
*
|
||||
* <informalexample><programlisting>
|
||||
* int i;
|
||||
* cairo_path_t *path;
|
||||
* cairo_path_data_t *data;
|
||||
* #cairo_path_t *path;
|
||||
* #cairo_path_data_t *data;
|
||||
*
|
||||
* path = cairo_copy_path (cr);
|
||||
*
|
||||
|
|
|
|||
|
|
@ -244,7 +244,7 @@ _cairo_hash_string (const char *c);
|
|||
typedef struct _cairo_unscaled_font_backend cairo_unscaled_font_backend_t;
|
||||
|
||||
/*
|
||||
* A cairo_unscaled_font_t is just an opaque handle we use in the
|
||||
* A #cairo_unscaled_font_t is just an opaque handle we use in the
|
||||
* glyph cache.
|
||||
*/
|
||||
typedef struct _cairo_unscaled_font {
|
||||
|
|
@ -1770,7 +1770,7 @@ _cairo_surface_has_device_transform (cairo_surface_t *surface);
|
|||
* things like cairo_image_surface_create.
|
||||
*
|
||||
* Since 1.2.0 we ran into the same situtation with X servers with BGR
|
||||
* visuals. This time we invented cairo_internal_format_t instead,
|
||||
* visuals. This time we invented #cairo_internal_format_t instead,
|
||||
* (see it for more discussion).
|
||||
*
|
||||
* The punchline is that %CAIRO_FORMAT_VALID must not conside any
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue