fdo-mirrors/cairo
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/cairo/cairo.git synced 2026-05-09 07:18:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Remove trailing whitespace from lines that look like comments.

Browse source 
This patch was produced with the following (GNU) sed script:

	sed -i -r -e '/^[ \t]*\/?\*/ s/[ \t]+$//'

run on all *.[ch] files within cairo, (though I manually excluded
src/cairo-atsui-font.c which has a code line that appears as a comment
to this script).
This commit is contained in:
Carl Worth 2006-06-06 15:35:48 -07:00
parent 80b8deb1e4
commit 4670366ede
57 changed files with 446 additions and 446 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/tutorial/src/include/cairo-tutorial-xlib.h
View file

@ -1,5 +1,5 @@
/* cairo-tutorial-xlib.h - a tutorial framework for cairo with xlib /* cairo-tutorial-xlib.h - a tutorial framework for cairo with xlib
* *
* Copyright © 2005, Keith Packard * Copyright © 2005, Keith Packard
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify

8
pixman/src/fbmmx.c
View file

@ -24,7 +24,7 @@
* *
* Author: Søren Sandmann (sandmann@redhat.com) * Author: Søren Sandmann (sandmann@redhat.com)
* Minor Improvements: Nicholas Miell (nmiell@gmail.com) * Minor Improvements: Nicholas Miell (nmiell@gmail.com)
* MMX code paths for fbcompose.c by Lars Knoll (lars@trolltech.com) * MMX code paths for fbcompose.c by Lars Knoll (lars@trolltech.com)
* *
* Based on work by Owen Taylor * Based on work by Owen Taylor
*/ */
@ -286,14 +286,14 @@ store8888 (__m64 v)
/* Expand 16 bits positioned at @pos (0-3) of a mmx register into /* Expand 16 bits positioned at @pos (0-3) of a mmx register into
* *
* 00RR00GG00BB * 00RR00GG00BB
* *
* --- Expanding 565 in the low word --- * --- Expanding 565 in the low word ---
* *
* m = (m << (32 - 3)) | (m << (16 - 5)) | m; * m = (m << (32 - 3)) | (m << (16 - 5)) | m;
* m = m & (01f0003f001f); * m = m & (01f0003f001f);
* m = m * (008404100840); * m = m * (008404100840);
* m = m >> 8; * m = m >> 8;
* *
* Note the trick here - the top word is shifted by another nibble to * Note the trick here - the top word is shifted by another nibble to
* avoid it bumping into the middle word * avoid it bumping into the middle word
*/ */

2
pixman/src/fbmmx.h
View file

@ -23,7 +23,7 @@
* *
* Author: Søren Sandmann (sandmann@redhat.com) * Author: Søren Sandmann (sandmann@redhat.com)
* Lars Knoll (lars@trolltech.com) * Lars Knoll (lars@trolltech.com)
* *
* Based on work by Owen Taylor * Based on work by Owen Taylor
*/ */
#ifdef USE_MMX #ifdef USE_MMX

10
pixman/src/icbltone.c
View file

@ -37,7 +37,7 @@
* Example: srcX = 0 dstX = 8 (FB unit 32 dstBpp 8) * Example: srcX = 0 dstX = 8 (FB unit 32 dstBpp 8)
* *
* **** **** **** **** **** **** **** **** * **** **** **** **** **** **** **** ****
* ^ * ^
* ******** ******** ******** ******** * ******** ******** ******** ********
* ^ * ^
* *
@ -190,7 +190,7 @@ fbBltOne (FbStip *src,
pixelsPerDst = FB_UNIT / dstBpp; pixelsPerDst = FB_UNIT / dstBpp;
/* /*
* Number of source stipple patterns in FbStip * Number of source stipple patterns in FbStip
*/ */
unitsPerSrc = FB_STIP_UNIT / pixelsPerDst; unitsPerSrc = FB_STIP_UNIT / pixelsPerDst;
@ -243,8 +243,8 @@ fbBltOne (FbStip *src,
#endif #endif
/* /*
* Compute total number of destination words written, but * Compute total number of destination words written, but
* don't count endmask * don't count endmask
*/ */
nDst = nmiddle; nDst = nmiddle;
if (startmask) if (startmask)
@ -633,7 +633,7 @@ fbBltOne24 (FbStip *srcLine,
while (nl--) while (nl--)
{ {
mask = fbStipple24Bits[rot>>3][stip]; mask = fbStipple24Bits[rot>>3][stip];
*dst = FbOpaqueStipple (mask, *dst = FbOpaqueStipple (mask,
FbRot24(fgxor, rot), FbRot24(fgxor, rot),
FbRot24(bgxor, rot)); FbRot24(bgxor, rot));
dst++; dst++;

2
pixman/src/iccolor.c
View file

@ -15,7 +15,7 @@
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL SuSE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL SuSE
* BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
* OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
* *
* Author: Keith Packard, SuSE, Inc. * Author: Keith Packard, SuSE, Inc.

2
pixman/src/icformat.c
View file

@ -15,7 +15,7 @@
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL SuSE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL SuSE
* BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
* OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
* *
* Author: Keith Packard, SuSE, Inc. * Author: Keith Packard, SuSE, Inc.

4
pixman/src/icimage.c
View file

@ -15,7 +15,7 @@
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL SuSE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL SuSE
* BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
* OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
* *
* Author: Keith Packard, SuSE, Inc. * Author: Keith Packard, SuSE, Inc.
@ -304,7 +304,7 @@ pixman_image_init (pixman_image_t *image)
image->subWindowMode = ClipByChildren; image->subWindowMode = ClipByChildren;
image->polyEdge = PolyEdgeSharp; image->polyEdge = PolyEdgeSharp;
image->polyMode = PolyModePrecise; image->polyMode = PolyModePrecise;
/* /*
* In the server this was 0 because the composite clip list * In the server this was 0 because the composite clip list
* can be referenced from a window (and often is) * can be referenced from a window (and often is)
*/ */

8
pixman/src/icint.h
View file

@ -966,7 +966,7 @@ typedef struct _PictFormat *PictFormatPtr;
#define PICT_g1 PICT_FORMAT(1,PICT_TYPE_GRAY,0,0,0,0) #define PICT_g1 PICT_FORMAT(1,PICT_TYPE_GRAY,0,0,0,0)
/* /*
* For dynamic indexed visuals (GrayScale and PseudoColor), these control the * For dynamic indexed visuals (GrayScale and PseudoColor), these control the
* selection of colors allocated for drawing to Pictures. The default * selection of colors allocated for drawing to Pictures. The default
* policy depends on the size of the colormap: * policy depends on the size of the colormap:
* *
@ -997,7 +997,7 @@ typedef struct _PictFormat *PictFormatPtr;
* 4x4x4 cube allocates another two and nine more are allocated to fill * 4x4x4 cube allocates another two and nine more are allocated to fill
* in the 13 levels. When the 4x4x4 cube is not allocated, a total of * in the 13 levels. When the 4x4x4 cube is not allocated, a total of
* 11 cells are allocated. * 11 cells are allocated.
*/ */
#define PictureCmapPolicyInvalid -1 #define PictureCmapPolicyInvalid -1
#define PictureCmapPolicyDefault 0 #define PictureCmapPolicyDefault 0
@ -1037,8 +1037,8 @@ typedef uint32_t xFixed_1_16;
typedef int32_t xFixed_16_16; typedef int32_t xFixed_16_16;
/* /*
* An unadorned "xFixed" is the same as xFixed_16_16, * An unadorned "xFixed" is the same as xFixed_16_16,
* (since it's quite common in the code) * (since it's quite common in the code)
*/ */
typedef xFixed_16_16 xFixed; typedef xFixed_16_16 xFixed;
#define XFIXED_BITS 16 #define XFIXED_BITS 16

2
pixman/src/icrop.h
View file

@ -94,7 +94,7 @@ extern const FbMergeRopRec FbMergeRopBits[16] pixman_private;
#define fbAndStip(rop,fg,pm) fbAndT(rop,fg,pm,FbStip) #define fbAndStip(rop,fg,pm) fbAndT(rop,fg,pm,FbStip)
/* /*
* Stippling operations; * Stippling operations;
*/ */
/* half of table */ /* half of table */

2
pixman/src/ictransform.c
View file

@ -15,7 +15,7 @@
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL SuSE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL SuSE
* BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
* OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
* *
* Author: Keith Packard, SuSE, Inc. * Author: Keith Packard, SuSE, Inc.

12
pixman/src/pixregion.c
View file

@ -109,9 +109,9 @@ slim_hidden_proto(pixman_region_union)
* there is no separate list of band start pointers. * there is no separate list of band start pointers.
* *
* The y-x band representation does not minimize rectangles. In particular, * The y-x band representation does not minimize rectangles. In particular,
* if a rectangle vertically crosses a band (the rectangle has scanlines in * if a rectangle vertically crosses a band (the rectangle has scanlines in
* the y1 to y2 area spanned by the band), then the rectangle may be broken * the y1 to y2 area spanned by the band), then the rectangle may be broken
* down into two or more smaller rectangles stacked one atop the other. * down into two or more smaller rectangles stacked one atop the other.
* *
* ----------- ----------- * ----------- -----------
* | | | | band 0 * | | | | band 0
@ -137,7 +137,7 @@ slim_hidden_proto(pixman_region_union)
* pixman_region_validateTree. Bob Scheifler changed the representation to be more * pixman_region_validateTree. Bob Scheifler changed the representation to be more
* compact when empty or a single rectangle, and did a bunch of gratuitous * compact when empty or a single rectangle, and did a bunch of gratuitous
* reformatting. Carl Worth did further gratuitous reformatting while re-merging * reformatting. Carl Worth did further gratuitous reformatting while re-merging
* the server and client region code into libpixregion. * the server and client region code into libpixregion.
*/ */
/* true iff two Boxes overlap */ /* true iff two Boxes overlap */
@ -1249,7 +1249,7 @@ slim_hidden_def(pixman_region_union);
/*- /*-
*----------------------------------------------------------------------- *-----------------------------------------------------------------------
* pixman_region_append -- * pixman_region_append --
* *
* "Append" the rgn rectangles onto the end of dstrgn, maintaining * "Append" the rgn rectangles onto the end of dstrgn, maintaining
* knowledge of YX-banding when it's easy. Otherwise, dstrgn just * knowledge of YX-banding when it's easy. Otherwise, dstrgn just
* becomes a non-y-x-banded random collection of rectangles, and not * becomes a non-y-x-banded random collection of rectangles, and not
@ -1420,7 +1420,7 @@ QuickSortRects(
/*- /*-
*----------------------------------------------------------------------- *-----------------------------------------------------------------------
* pixman_region_validate -- * pixman_region_validate --
* *
* Take a ``region'' which is a non-y-x-banded random collection of * Take a ``region'' which is a non-y-x-banded random collection of
* rectangles, and compute a nice region which is the union of all the * rectangles, and compute a nice region which is the union of all the
* rectangles. * rectangles.
@ -2421,7 +2421,7 @@ pixman_region16_clip_spans(
if (!prgnDst->data) if (!prgnDst->data)
{ {
/* Do special fast code with clip boundaries in registers(?) */ /* Do special fast code with clip boundaries in registers(?) */
/* It doesn't pay much to make use of fSorted in this case, /* It doesn't pay much to make use of fSorted in this case,
so we lump everything together. */ so we lump everything together. */
int clipx1, clipx2, clipy1, clipy2; int clipx1, clipx2, clipy1, clipy2;

2
pixman/src/slim_internal.h
View file

@ -12,7 +12,7 @@
* Richard Henderson makes no representations about the suitability of this * Richard Henderson makes no representations about the suitability of this
* software for any purpose. It is provided "as is" without express * software for any purpose. It is provided "as is" without express
* or implied warranty. * or implied warranty.
* *
* RICHARD HENDERSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, * RICHARD HENDERSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
* NO EVENT SHALL RICHARD HENDERSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR * NO EVENT SHALL RICHARD HENDERSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR

4
src/cairo-arc.c
View file

@ -238,7 +238,7 @@ _cairo_arc_in_direction (cairo_t *cr,
* @radius: the radius of the arc * @radius: the radius of the arc
* @angle1: the start angle, in radians * @angle1: the start angle, in radians
* @angle2: the end angle, in radians * @angle2: the end angle, in radians
* *
* Compute a path for the given arc and append it onto the current * Compute a path for the given arc and append it onto the current
* path within @cr. The arc will be accurate within the current * path within @cr. The arc will be accurate within the current
* tolerance and given the current transformation. * tolerance and given the current transformation.
@ -267,7 +267,7 @@ _cairo_arc_path (cairo_t *cr,
* @ctm: the current transformation matrix * @ctm: the current transformation matrix
* @tolerance: the current tolerance value * @tolerance: the current tolerance value
* @path: the path onto which th earc will be appended * @path: the path onto which th earc will be appended
* *
* Compute a path for the given arc (defined in the negative * Compute a path for the given arc (defined in the negative
* direction) and append it onto the current path within @cr. The arc * direction) and append it onto the current path within @cr. The arc
* will be accurate within the current tolerance and given the current * will be accurate within the current tolerance and given the current

32
src/cairo-array.c
View file

@ -39,7 +39,7 @@
/** /**
* _cairo_array_init: * _cairo_array_init:
* *
* Initialize a new cairo_array object to store objects each of size * Initialize a new cairo_array object to store objects each of size
* @element_size. * @element_size.
* *
@ -66,7 +66,7 @@ _cairo_array_init (cairo_array_t *array, int element_size)
* _cairo_array_init_snapshot: * _cairo_array_init_snapshot:
* @array: A #cairo_array_t to be initialized as a snapshot * @array: A #cairo_array_t to be initialized as a snapshot
* @other: The #cairo_array_t from which to create the snapshot * @other: The #cairo_array_t from which to create the snapshot
* *
* Initialize @array as an immutable copy of @other. It is an error to * Initialize @array as an immutable copy of @other. It is an error to
* call an array-modifying function (other than _cairo_array_fini) on * call an array-modifying function (other than _cairo_array_fini) on
* @array after calling this function. * @array after calling this function.
@ -104,7 +104,7 @@ _cairo_array_fini (cairo_array_t *array)
/** /**
* _cairo_array_grow_by: * _cairo_array_grow_by:
* *
* Increase the size of @array (if needed) so that there are at least * Increase the size of @array (if needed) so that there are at least
* @additional free spaces in the array. The actual size of the array * @additional free spaces in the array. The actual size of the array
* is always increased by doubling as many times as necessary. * is always increased by doubling as many times as necessary.
@ -153,7 +153,7 @@ _cairo_array_grow_by (cairo_array_t *array, int additional)
/** /**
* _cairo_array_truncate: * _cairo_array_truncate:
* *
* Truncate size of the array to @num_elements if less than the * Truncate size of the array to @num_elements if less than the
* current size. No memory is actually freed. The stored objects * current size. No memory is actually freed. The stored objects
* beyond @num_elements are simply "forgotten". * beyond @num_elements are simply "forgotten".
@ -169,7 +169,7 @@ _cairo_array_truncate (cairo_array_t *array, int num_elements)
/** /**
* _cairo_array_index: * _cairo_array_index:
* *
* Return value: A pointer to object stored at @index. If the * Return value: A pointer to object stored at @index. If the
* resulting value is assigned to a pointer to an object of the same * resulting value is assigned to a pointer to an object of the same
* element_size as initially passed to _cairo_array_init() then that * element_size as initially passed to _cairo_array_init() then that
@ -210,7 +210,7 @@ _cairo_array_index (cairo_array_t *array, int index)
/** /**
* _cairo_array_copy_element: * _cairo_array_copy_element:
* *
* Copy a single element out of the array from index @index into the * Copy a single element out of the array from index @index into the
* location pointed to by @dst. * location pointed to by @dst.
**/ **/
@ -222,7 +222,7 @@ _cairo_array_copy_element (cairo_array_t *array, int index, void *dst)
/** /**
* _cairo_array_append: * _cairo_array_append:
* *
* Append a single item onto the array by growing the array by at * Append a single item onto the array by growing the array by at
* least one element, then copying element_size bytes from @element * least one element, then copying element_size bytes from @element
* into the array. The address of the resulting object within the * into the array. The address of the resulting object within the
@ -245,7 +245,7 @@ _cairo_array_append (cairo_array_t *array,
/** /**
* _cairo_array_append: * _cairo_array_append:
* *
* Append one or more items onto the array by growing the array by * Append one or more items onto the array by growing the array by
* @num_elements, then copying @num_elements * element_size bytes from * @num_elements, then copying @num_elements * element_size bytes from
* @elements into the array. * @elements into the array.
@ -275,12 +275,12 @@ _cairo_array_append_multiple (cairo_array_t *array,
/** /**
* _cairo_array_allocate: * _cairo_array_allocate:
* *
* Allocate space at the end of the array for @num_elements additional * Allocate space at the end of the array for @num_elements additional
* elements, providing the address of the new memory chunk in * elements, providing the address of the new memory chunk in
* @elements. This memory will be unitialized, but will be accounted * @elements. This memory will be unitialized, but will be accounted
* for in the return value of _cairo_array_num_elements(). * for in the return value of _cairo_array_num_elements().
* *
* Return value: CAIRO_STATUS_SUCCESS if successful or * Return value: CAIRO_STATUS_SUCCESS if successful or
* CAIRO_STATUS_NO_MEMORY if insufficient memory is available for the * CAIRO_STATUS_NO_MEMORY if insufficient memory is available for the
* operation. * operation.
@ -309,7 +309,7 @@ _cairo_array_allocate (cairo_array_t *array,
/** /**
* _cairo_array_num_elements: * _cairo_array_num_elements:
* *
* Return value: The number of elements stored in @array. * Return value: The number of elements stored in @array.
**/ **/
int int
@ -329,7 +329,7 @@ typedef struct {
/** /**
* _cairo_user_data_array_init: * _cairo_user_data_array_init:
* @array: a #cairo_user_data_array_t * @array: a #cairo_user_data_array_t
* *
* Initializes a #cairo_user_data_array_t structure for future * Initializes a #cairo_user_data_array_t structure for future
* use. After initialization, the array has no keys. Call * use. After initialization, the array has no keys. Call
* _cairo_user_data_array_fini() to free any allocated memory * _cairo_user_data_array_fini() to free any allocated memory
@ -344,7 +344,7 @@ _cairo_user_data_array_init (cairo_user_data_array_t *array)
/** /**
* _cairo_user_data_array_fini: * _cairo_user_data_array_fini:
* @array: a #cairo_user_data_array_t * @array: a #cairo_user_data_array_t
* *
* Destroys all current keys in the user data array and deallocates * Destroys all current keys in the user data array and deallocates
* any memory allocated for the array itself. * any memory allocated for the array itself.
**/ **/
@ -369,11 +369,11 @@ _cairo_user_data_array_fini (cairo_user_data_array_t *array)
* @array: a #cairo_user_data_array_t * @array: a #cairo_user_data_array_t
* @key: the address of the #cairo_user_data_key_t the user data was * @key: the address of the #cairo_user_data_key_t the user data was
* attached to * attached to
* *
* Returns user data previously attached using the specified * Returns user data previously attached using the specified
* key. If no user data has been attached with the given key this * key. If no user data has been attached with the given key this
* function returns %NULL. * function returns %NULL.
* *
* Return value: the user data previously attached or %NULL. * Return value: the user data previously attached or %NULL.
**/ **/
void * void *
@ -406,7 +406,7 @@ _cairo_user_data_array_get_data (cairo_user_data_array_t *array,
* @destroy: a #cairo_destroy_func_t which will be called when the * @destroy: a #cairo_destroy_func_t which will be called when the
* user data array is destroyed or when new user data is attached using the * user data array is destroyed or when new user data is attached using the
* same key. * same key.
* *
* Attaches user data to a user data array. To remove user data, * Attaches user data to a user data array. To remove user data,
* call this function with the key that was used to set it and %NULL * call this function with the key that was used to set it and %NULL
* for @data. * for @data.

2
src/cairo-base85-stream.c
View file

@ -1,5 +1,5 @@
/* cairo_output_stream.c: Output stream abstraction /* cairo_output_stream.c: Output stream abstraction
* *
* Copyright © 2005 Red Hat, Inc * Copyright © 2005 Red Hat, Inc
* *
* This library is free software; you can redistribute it and/or * This library is free software; you can redistribute it and/or

30
src/cairo-cache.c
View file

@ -104,7 +104,7 @@ _cairo_cache_fini (cairo_cache_t *cache)
* @keys_equal: a function to return %TRUE if two keys are equal * @keys_equal: a function to return %TRUE if two keys are equal
* @entry_destroy: destroy notifier for cache entries * @entry_destroy: destroy notifier for cache entries
* @max_size: the maximum size for this cache * @max_size: the maximum size for this cache
* *
* Creates a new cache using the keys_equal() function to determine * Creates a new cache using the keys_equal() function to determine
* the equality of entries. * the equality of entries.
* *
@ -131,8 +131,8 @@ _cairo_cache_fini (cairo_cache_t *cache)
* _cairo_cache_freeze() and _cairo_cache_thaw() calls can be * _cairo_cache_freeze() and _cairo_cache_thaw() calls can be
* used to establish a window during which no automatic removal of * used to establish a window during which no automatic removal of
* entries will occur. * entries will occur.
* *
* Return value: * Return value:
**/ **/
cairo_cache_t * cairo_cache_t *
_cairo_cache_create (cairo_cache_keys_equal_func_t keys_equal, _cairo_cache_create (cairo_cache_keys_equal_func_t keys_equal,
@ -158,7 +158,7 @@ _cairo_cache_create (cairo_cache_keys_equal_func_t keys_equal,
/** /**
* _cairo_cache_destroy: * _cairo_cache_destroy:
* @cache: a cache to destroy * @cache: a cache to destroy
* *
* Immediately destroys the given cache, freeing all resources * Immediately destroys the given cache, freeing all resources
* associated with it. As part of this process, the entry_destroy() * associated with it. As part of this process, the entry_destroy()
* function, (as passed to _cairo_cache_create()), will be called for * function, (as passed to _cairo_cache_create()), will be called for
@ -176,7 +176,7 @@ _cairo_cache_destroy (cairo_cache_t *cache)
* _cairo_cache_freeze: * _cairo_cache_freeze:
* @cache: a cache with some precious entries in it (or about to be * @cache: a cache with some precious entries in it (or about to be
* added) * added)
* *
* Disable the automatic ejection of entries from the cache. For as * Disable the automatic ejection of entries from the cache. For as
* long as the cache is "frozen", calls to _cairo_cache_insert() will * long as the cache is "frozen", calls to _cairo_cache_insert() will
* add new entries to the cache regardless of how large the cache * add new entries to the cache regardless of how large the cache
@ -198,7 +198,7 @@ _cairo_cache_freeze (cairo_cache_t *cache)
* _cairo_cache_thaw: * _cairo_cache_thaw:
* @cache: a cache, just after the entries in it have become less * @cache: a cache, just after the entries in it have become less
* precious * precious
* *
* Cancels the effects of _cairo_cache_freeze(). * Cancels the effects of _cairo_cache_freeze().
* *
* When a number of calls to _cairo_cache_thaw() is made corresponding * When a number of calls to _cairo_cache_thaw() is made corresponding
@ -224,11 +224,11 @@ _cairo_cache_thaw (cairo_cache_t *cache)
* @cache: a cache * @cache: a cache
* @key: the key of interest * @key: the key of interest
* @entry_return: pointer for return value * @entry_return: pointer for return value
* *
* Performs a lookup in @cache looking for an entry which has a key * Performs a lookup in @cache looking for an entry which has a key
* that matches @key, (as determined by the keys_equal() function * that matches @key, (as determined by the keys_equal() function
* passed to _cairo_cache_create()). * passed to _cairo_cache_create()).
* *
* Return value: %TRUE if there is an entry in the cache that matches * Return value: %TRUE if there is an entry in the cache that matches
* @key, (which will now be in *entry_return). %FALSE otherwise, (in * @key, (which will now be in *entry_return). %FALSE otherwise, (in
* which case *entry_return will be %NULL). * which case *entry_return will be %NULL).
@ -246,9 +246,9 @@ _cairo_cache_lookup (cairo_cache_t *cache,
/** /**
* _cairo_cache_remove_random: * _cairo_cache_remove_random:
* @cache: a cache * @cache: a cache
* *
* Remove a random entry from the cache. * Remove a random entry from the cache.
* *
* Return value: CAIRO_STATUS_SUCCESS if an entry was successfully * Return value: CAIRO_STATUS_SUCCESS if an entry was successfully
* removed. CAIRO_INT_STATUS_CACHE_EMPTY if there are no entries that * removed. CAIRO_INT_STATUS_CACHE_EMPTY if there are no entries that
* can be removed. * can be removed.
@ -271,7 +271,7 @@ _cairo_cache_remove_random (cairo_cache_t *cache)
* _cairo_cache_shrink_to_accomodate: * _cairo_cache_shrink_to_accomodate:
* @cache: a cache * @cache: a cache
* @additional: additional size requested in bytes * @additional: additional size requested in bytes
* *
* If cache is not frozen, eject entries randomly until the size of * If cache is not frozen, eject entries randomly until the size of
* the cache is at least @additional bytes less than * the cache is at least @additional bytes less than
* cache->max_size. That is, make enough room to accomodate a new * cache->max_size. That is, make enough room to accomodate a new
@ -300,11 +300,11 @@ _cairo_cache_shrink_to_accomodate (cairo_cache_t *cache,
* _cairo_cache_insert: * _cairo_cache_insert:
* @cache: a cache * @cache: a cache
* @entry: an entry to be inserted * @entry: an entry to be inserted
* *
* Insert @entry into the cache. If an entry exists in the cache with * Insert @entry into the cache. If an entry exists in the cache with
* a matching key, then the old entry will be removed first, (and the * a matching key, then the old entry will be removed first, (and the
* entry_destroy() callback will be called on it). * entry_destroy() callback will be called on it).
* *
* Return value: CAIRO_STATUS_SUCCESS if successful or * Return value: CAIRO_STATUS_SUCCESS if successful or
* CAIRO_STATUS_NO_MEMORY if insufficient memory is available. * CAIRO_STATUS_NO_MEMORY if insufficient memory is available.
**/ **/
@ -330,7 +330,7 @@ _cairo_cache_insert (cairo_cache_t *cache,
* _cairo_cache_remove: * _cairo_cache_remove:
* @cache: a cache * @cache: a cache
* @entry: an entry that exists in the cache * @entry: an entry that exists in the cache
* *
* Remove an existing entry from the cache. * Remove an existing entry from the cache.
* *
* (NOTE: If any caller wanted access to a non-static version of this * (NOTE: If any caller wanted access to a non-static version of this
@ -356,7 +356,7 @@ _cairo_cache_remove (cairo_cache_t *cache,
* @cache: a cache * @cache: a cache
* @cache_callback: function to be called for each entry * @cache_callback: function to be called for each entry
* @closure: additional argument to be passed to @cache_callback * @closure: additional argument to be passed to @cache_callback
* *
* Call @cache_callback for each entry in the cache, in a * Call @cache_callback for each entry in the cache, in a
* non-specified order. * non-specified order.
**/ **/

2
src/cairo-clip-private.h
View file

@ -51,7 +51,7 @@ struct _cairo_clip {
cairo_clip_mode_t mode; cairo_clip_mode_t mode;
/* /*
* Mask-based clipping for cases where the backend * Mask-based clipping for cases where the backend
* clipping isn't sufficiently able. * clipping isn't sufficiently able.
* *
* The rectangle here represents the * The rectangle here represents the

2
src/cairo-debug.c
View file

@ -37,7 +37,7 @@
/** /**
* cairo_debug_reset_static_data: * cairo_debug_reset_static_data:
* *
* Resets all static data within cairo to its original state, * Resets all static data within cairo to its original state,
* (ie. identical to the state at the time of program invocation). For * (ie. identical to the state at the time of program invocation). For
* example, all caches within cairo will be flushed empty. * example, all caches within cairo will be flushed empty.

46
src/cairo-font-options.c
View file

@ -46,7 +46,7 @@ static const cairo_font_options_t cairo_font_options_nil = {
/** /**
* _cairo_font_options_init_default: * _cairo_font_options_init_default:
* @options: a #cairo_font_options_t * @options: a #cairo_font_options_t
* *
* Initializes all fileds of the font options object to default values. * Initializes all fileds of the font options object to default values.
**/ **/
void void
@ -76,7 +76,7 @@ _cairo_font_options_init_copy (cairo_font_options_t *options,
* *
* Allocates a new font options object with all options initialized * Allocates a new font options object with all options initialized
* to default values. * to default values.
* *
* Return value: a newly allocated #cairo_font_options_t. Free with * Return value: a newly allocated #cairo_font_options_t. Free with
* cairo_font_options_destroy(). This function always returns a * cairo_font_options_destroy(). This function always returns a
* valid pointer; if memory cannot be allocated, then a special * valid pointer; if memory cannot be allocated, then a special
@ -102,7 +102,7 @@ cairo_font_options_create (void)
* *
* Allocates a new font options object copying the option values from * Allocates a new font options object copying the option values from
* @original. * @original.
* *
* Return value: a newly allocated #cairo_font_options_t. Free with * Return value: a newly allocated #cairo_font_options_t. Free with
* cairo_font_options_destroy(). This function always returns a * cairo_font_options_destroy(). This function always returns a
* valid pointer; if memory cannot be allocated, then a special * valid pointer; if memory cannot be allocated, then a special
@ -125,7 +125,7 @@ cairo_font_options_copy (const cairo_font_options_t *original)
/** /**
* cairo_font_options_destroy: * cairo_font_options_destroy:
* @options: a #cairo_font_options_t * @options: a #cairo_font_options_t
* *
* Destroys a #cairo_font_options_t object created with with * Destroys a #cairo_font_options_t object created with with
* cairo_font_options_create() or cairo_font_options_copy(). * cairo_font_options_create() or cairo_font_options_copy().
**/ **/
@ -141,10 +141,10 @@ cairo_font_options_destroy (cairo_font_options_t *options)
/** /**
* cairo_font_options_status: * cairo_font_options_status:
* @options: a #cairo_font_options_t * @options: a #cairo_font_options_t
* *
* Checks whether an error has previously occurred for this * Checks whether an error has previously occurred for this
* font options object * font options object
* *
* Return value: %CAIRO_STATUS_SUCCESS or %CAIRO_STATUS_NO_MEMORY * Return value: %CAIRO_STATUS_SUCCESS or %CAIRO_STATUS_NO_MEMORY
**/ **/
cairo_status_t cairo_status_t
@ -160,7 +160,7 @@ cairo_font_options_status (cairo_font_options_t *options)
* cairo_font_options_merge: * cairo_font_options_merge:
* @options: a #cairo_font_options_t * @options: a #cairo_font_options_t
* @other: another #cairo_font_options_t * @other: another #cairo_font_options_t
* *
* Merges non-default options from @other into @options, replacing * Merges non-default options from @other into @options, replacing
* existing values. This operation can be thought of as somewhat * existing values. This operation can be thought of as somewhat
* similar to compositing @other onto @options with the operation * similar to compositing @other onto @options with the operation
@ -187,9 +187,9 @@ cairo_font_options_merge (cairo_font_options_t *options,
* cairo_font_options_equal: * cairo_font_options_equal:
* @options: a #cairo_font_options_t * @options: a #cairo_font_options_t
* @other: another #cairo_font_options_t * @other: another #cairo_font_options_t
* *
* Compares two font options objects for equality. * Compares two font options objects for equality.
* *
* Return value: %TRUE if all fields of the two font options objects match * Return value: %TRUE if all fields of the two font options objects match
**/ **/
cairo_bool_t cairo_bool_t
@ -205,11 +205,11 @@ cairo_font_options_equal (const cairo_font_options_t *options,
/** /**
* cairo_font_options_hash: * cairo_font_options_hash:
* @options: a #cairo_font_options_t * @options: a #cairo_font_options_t
* *
* Compute a hash for the font options object; this value will * 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. * in a hash table.
* *
* Return value: the hash value for the font options object. * Return value: the hash value for the font options object.
* The return value can be cast to a 32-bit type if a * The return value can be cast to a 32-bit type if a
* 32-bit hash value is needed. * 32-bit hash value is needed.
@ -227,7 +227,7 @@ cairo_font_options_hash (const cairo_font_options_t *options)
* cairo_font_options_set_antialias: * cairo_font_options_set_antialias:
* @options: a #cairo_font_options_t * @options: a #cairo_font_options_t
* @antialias: the new antialiasing mode * @antialias: the new antialiasing mode
* *
* Sets the antiliasing mode for the font options object. This * Sets the antiliasing mode for the font options object. This
* specifies the type of antialiasing to do when rendering text. * specifies the type of antialiasing to do when rendering text.
**/ **/
@ -244,9 +244,9 @@ cairo_font_options_set_antialias (cairo_font_options_t *options,
/** /**
* cairo_font_options_get_antialias: * cairo_font_options_get_antialias:
* @options: a #cairo_font_options_t * @options: a #cairo_font_options_t
* *
* Gets the antialising mode for the font options object. * Gets the antialising mode for the font options object.
* *
* Return value: the antialiasing mode * Return value: the antialiasing mode
**/ **/
cairo_antialias_t cairo_antialias_t
@ -259,7 +259,7 @@ cairo_font_options_get_antialias (const cairo_font_options_t *options)
* cairo_font_options_set_subpixel_order: * cairo_font_options_set_subpixel_order:
* @options: a #cairo_font_options_t * @options: a #cairo_font_options_t
* @subpixel_order: the new subpixel order * @subpixel_order: the new subpixel order
* *
* Sets the subpixel order for the font options object. The subpixel * Sets the subpixel order for the font options object. The subpixel
* order specifies the order of color elements within each pixel on * order specifies the order of color elements within each pixel on
* the display device when rendering with an antialiasing mode of * the display device when rendering with an antialiasing mode of
@ -279,10 +279,10 @@ cairo_font_options_set_subpixel_order (cairo_font_options_t *options,
/** /**
* cairo_font_options_get_subpixel_order: * cairo_font_options_get_subpixel_order:
* @options: a #cairo_font_options_t * @options: a #cairo_font_options_t
* *
* Gets the subpixel order for the font options object. * Gets the subpixel order for the font options object.
* See the documentation for #cairo_subpixel_order_t for full details. * See the documentation for #cairo_subpixel_order_t for full details.
* *
* Return value: the subpixel order for the font options object * Return value: the subpixel order for the font options object
**/ **/
cairo_subpixel_order_t cairo_subpixel_order_t
@ -295,7 +295,7 @@ cairo_font_options_get_subpixel_order (const cairo_font_options_t *options)
* cairo_font_options_set_hint_style: * cairo_font_options_set_hint_style:
* @options: a #cairo_font_options_t * @options: a #cairo_font_options_t
* @hint_style: the new hint style * @hint_style: the new hint style
* *
* Sets the hint style for font outlines for the font options object. * Sets the hint style for font outlines for the font options object.
* This controls whether to fit font outlines to the pixel grid, * This controls whether to fit font outlines to the pixel grid,
* and if so, whether to optimize for fidelity or contrast. * and if so, whether to optimize for fidelity or contrast.
@ -314,10 +314,10 @@ cairo_font_options_set_hint_style (cairo_font_options_t *options,
/** /**
* cairo_font_options_get_hint_style: * cairo_font_options_get_hint_style:
* @options: a #cairo_font_options_t * @options: a #cairo_font_options_t
* *
* Gets the hint style for font outlines for the font options object. * Gets the hint style for font outlines for the font options object.
* See the documentation for #cairo_hint_style_t for full details. * See the documentation for #cairo_hint_style_t for full details.
* *
* Return value: the hint style for the font options object * Return value: the hint style for the font options object
**/ **/
cairo_hint_style_t cairo_hint_style_t
@ -330,7 +330,7 @@ cairo_font_options_get_hint_style (const cairo_font_options_t *options)
* cairo_font_options_set_hint_metrics: * cairo_font_options_set_hint_metrics:
* @options: a #cairo_font_options_t * @options: a #cairo_font_options_t
* @hint_metrics: the new metrics hinting mode * @hint_metrics: the new metrics hinting mode
* *
* Sets the metrics hinting mode for the font options object. This * Sets the metrics hinting mode for the font options object. This
* controls whether metrics are quantized to integer values in * controls whether metrics are quantized to integer values in
* device units. * device units.
@ -349,10 +349,10 @@ cairo_font_options_set_hint_metrics (cairo_font_options_t *options,
/** /**
* cairo_font_options_get_hint_metrics: * cairo_font_options_get_hint_metrics:
* @options: a #cairo_font_options_t * @options: a #cairo_font_options_t
* *
* Gets the metrics hinting mode for the font options object. * Gets the metrics hinting mode for the font options object.
* See the documentation for #cairo_hint_metrics_t for full details. * See the documentation for #cairo_hint_metrics_t for full details.
* *
* Return value: the metrics hinting mode for the font options object * Return value: the metrics hinting mode for the font options object
**/ **/
cairo_hint_metrics_t cairo_hint_metrics_t

22
src/cairo-font.c
View file

@ -69,7 +69,7 @@ _cairo_font_face_init (cairo_font_face_t *font_face,
* cairo_font_face_reference: * cairo_font_face_reference:
* @font_face: a #cairo_font_face_t, (may be NULL in which case this * @font_face: a #cairo_font_face_t, (may be NULL in which case this
* function does nothing). * function does nothing).
* *
* Increases the reference count on @font_face by one. This prevents * Increases the reference count on @font_face by one. This prevents
* @font_face from being destroyed until a matching call to * @font_face from being destroyed until a matching call to
* cairo_font_face_destroy() is made. * cairo_font_face_destroy() is made.
@ -97,7 +97,7 @@ cairo_font_face_reference (cairo_font_face_t *font_face)
/** /**
* cairo_font_face_destroy: * cairo_font_face_destroy:
* @font_face: a #cairo_font_face_t * @font_face: a #cairo_font_face_t
* *
* Decreases the reference count on @font_face by one. If the result * Decreases the reference count on @font_face by one. If the result
* is zero, then @font_face and all associated resources are freed. * is zero, then @font_face and all associated resources are freed.
* See cairo_font_face_reference(). * See cairo_font_face_reference().
@ -133,7 +133,7 @@ cairo_font_face_destroy (cairo_font_face_t *font_face)
/** /**
* cairo_font_face_get_type: * cairo_font_face_get_type:
* @font_face: a #cairo_font_face_t * @font_face: a #cairo_font_face_t
* *
* Return value: The type of @font_face. See #cairo_font_type_t. * Return value: The type of @font_face. See #cairo_font_type_t.
**/ **/
cairo_font_type_t cairo_font_type_t
@ -145,10 +145,10 @@ cairo_font_face_get_type (cairo_font_face_t *font_face)
/** /**
* cairo_font_face_status: * cairo_font_face_status:
* @font_face: a #cairo_font_face_t * @font_face: a #cairo_font_face_t
* *
* Checks whether an error has previously occurred for this * Checks whether an error has previously occurred for this
* font face * font face
* *
* Return value: %CAIRO_STATUS_SUCCESS or another error such as * Return value: %CAIRO_STATUS_SUCCESS or another error such as
* %CAIRO_STATUS_NO_MEMORY. * %CAIRO_STATUS_NO_MEMORY.
**/ **/
@ -163,11 +163,11 @@ cairo_font_face_status (cairo_font_face_t *font_face)
* @font_face: a #cairo_font_face_t * @font_face: a #cairo_font_face_t
* @key: the address of the #cairo_user_data_key_t the user data was * @key: the address of the #cairo_user_data_key_t the user data was
* attached to * attached to
* *
* Return user data previously attached to @font_face using the specified * Return user data previously attached to @font_face using the specified
* key. If no user data has been attached with the given key this * key. If no user data has been attached with the given key this
* function returns %NULL. * function returns %NULL.
* *
* Return value: the user data previously attached or %NULL. * Return value: the user data previously attached or %NULL.
**/ **/
void * void *
@ -186,7 +186,7 @@ cairo_font_face_get_user_data (cairo_font_face_t *font_face,
* @destroy: a #cairo_destroy_func_t which will be called when the * @destroy: a #cairo_destroy_func_t which will be called when the
* font face is destroyed or when new user data is attached using the * font face is destroyed or when new user data is attached using the
* same key. * same key.
* *
* Attach user data to @font_face. To remove user data from a font face, * Attach user data to @font_face. To remove user data from a font face,
* call this function with the key that was used to set it and %NULL * call this function with the key that was used to set it and %NULL
* for @data. * for @data.
@ -252,7 +252,7 @@ _cairo_toy_font_face_hash_table_unlock (void)
/** /**
* _cairo_toy_font_face_init_key: * _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 * it as a hash table key, including the hash code buried away in
* font_face->base.hash_entry. No memory allocation is performed here * font_face->base.hash_entry. No memory allocation is performed here
@ -328,11 +328,11 @@ _cairo_toy_font_face_keys_equal (const void *key_a,
* @family: a font family name, encoded in UTF-8 * @family: a font family name, encoded in UTF-8
* @slant: the slant for the font * @slant: the slant for the font
* @weight: the weight for the font * @weight: the weight for the font
* *
* Creates a font face from a triplet of family, slant, and weight. * Creates a font face from a triplet of family, slant, and weight.
* These font faces are used in implementation of the the #cairo_t "toy" * These font faces are used in implementation of the the #cairo_t "toy"
* font API. * font API.
* *
* Return value: a newly created #cairo_font_face_t, destroy with * Return value: a newly created #cairo_font_face_t, destroy with
* cairo_font_face_destroy() * cairo_font_face_destroy()
**/ **/

22
src/cairo-ft-font.c
View file

@ -71,7 +71,7 @@ typedef struct _cairo_ft_font_transform {
double shape[2][2]; double shape[2][2];
} cairo_ft_font_transform_t; } cairo_ft_font_transform_t;
/* /*
* We create an object that corresponds to a single font on the disk; * We create an object that corresponds to a single font on the disk;
* (identified by a filename/id pair) these are shared between all * (identified by a filename/id pair) these are shared between all
* fonts using that file. For cairo_ft_font_face_create_for_ft_face(), we * fonts using that file. For cairo_ft_font_face_create_for_ft_face(), we
@ -282,7 +282,7 @@ _cairo_ft_unscaled_font_init_key (cairo_ft_unscaled_font_t *key,
/** /**
* _cairo_ft_unscaled_font_init: * _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
@ -344,7 +344,7 @@ _cairo_unscaled_font_is_ft (cairo_unscaled_font_t *unscaled_font)
/** /**
* _cairo_ft_unscaled_font_fini: * _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 * CAUTION: The unscaled->face field must be NULL before calling this
@ -898,7 +898,7 @@ _get_bitmap_surface (FT_Bitmap *bitmap,
} }
/* Converts an outline FT_GlyphSlot into an image /* Converts an outline FT_GlyphSlot into an image
* *
* This could go through _render_glyph_bitmap as well, letting * This could go through _render_glyph_bitmap as well, letting
* FreeType convert the outline to a bitmap, but doing it ourselves * FreeType convert the outline to a bitmap, but doing it ourselves
* has two minor advantages: first, we save a copy of the bitmap * has two minor advantages: first, we save a copy of the bitmap
@ -1033,7 +1033,7 @@ _render_glyph_outline (FT_Face face,
} }
/* Converts a bitmap (or other) FT_GlyphSlot into an image /* Converts a bitmap (or other) FT_GlyphSlot into an image
* *
* This could go through _render_glyph_bitmap as well, letting * This could go through _render_glyph_bitmap as well, letting
* FreeType convert the outline to a bitmap, but doing it ourselves * FreeType convert the outline to a bitmap, but doing it ourselves
* has two minor advantages: first, we save a copy of the bitmap * has two minor advantages: first, we save a copy of the bitmap
@ -2068,7 +2068,7 @@ _cairo_ft_font_face_create (cairo_ft_unscaled_font_t *unscaled,
* cairo_ft_font_options_substitute: * cairo_ft_font_options_substitute:
* @options: a #cairo_font_options_t object * @options: a #cairo_font_options_t object
* @pattern: an existing #FcPattern * @pattern: an existing #FcPattern
* *
* Add options to a #FcPattern based on a #cairo_font_options_t font * Add options to a #FcPattern based on a #cairo_font_options_t font
* options object. Options that are already in the pattern, are not overriden, * options object. Options that are already in the pattern, are not overriden,
* so you should call this function after calling FcConfigSubstitute() (the * so you should call this function after calling FcConfigSubstitute() (the
@ -2160,7 +2160,7 @@ cairo_ft_font_options_substitute (const cairo_font_options_t *options,
* pattern, so you should not further modify the pattern, but you can * pattern, so you should not further modify the pattern, but you can
* release your reference to the pattern with FcPatternDestroy() if * release your reference to the pattern with FcPatternDestroy() if
* you no longer need to access it. * you no longer need to access it.
* *
* Creates a new font face for the FreeType font backend based on a * Creates a new font face for the FreeType font backend based on a
* fontconfig pattern. This font can then be used with * fontconfig pattern. This font can then be used with
* cairo_set_font_face() or cairo_scaled_font_create(). The * cairo_set_font_face() or cairo_scaled_font_create(). The
@ -2216,14 +2216,14 @@ cairo_ft_font_face_create_for_pattern (FcPattern *pattern)
* as %FT_LOAD_VERTICAL_LAYOUT, and %FT_LOAD_FORCE_AUTOHINT * as %FT_LOAD_VERTICAL_LAYOUT, and %FT_LOAD_FORCE_AUTOHINT
* are useful. You should not pass any of the flags affecting * are useful. You should not pass any of the flags affecting
* the load target, such as %FT_LOAD_TARGET_LIGHT. * the load target, such as %FT_LOAD_TARGET_LIGHT.
* *
* Creates a new font face for the FreeType font backend from a * Creates a new font face for the FreeType font backend from a
* pre-opened FreeType face. This font can then be used with * pre-opened FreeType face. This font can then be used with
* cairo_set_font_face() or cairo_scaled_font_create(). The * cairo_set_font_face() or cairo_scaled_font_create(). The
* #cairo_scaled_font_t returned from cairo_scaled_font_create() is * #cairo_scaled_font_t returned from cairo_scaled_font_create() is
* also for the FreeType backend and can be used with functions such * also for the FreeType backend and can be used with functions such
* as cairo_ft_font_lock_face(). * as cairo_ft_font_lock_face().
* *
* Return value: a newly created #cairo_font_face_t. Free with * Return value: a newly created #cairo_font_face_t. Free with
* cairo_font_face_destroy() when you are done using it. * cairo_font_face_destroy() when you are done using it.
**/ **/
@ -2261,7 +2261,7 @@ cairo_ft_font_face_create_for_ft_face (FT_Face face,
* object can be created by calling cairo_scaled_font_create() on a * object can be created by calling cairo_scaled_font_create() on a
* FreeType backend font face (see cairo_ft_font_face_create_for_pattern(), * FreeType backend font face (see cairo_ft_font_face_create_for_pattern(),
* cairo_ft_font_face_create_for_face()). * cairo_ft_font_face_create_for_face()).
* *
* cairo_ft_font_lock_face() gets the #FT_Face object from a FreeType * cairo_ft_font_lock_face() gets the #FT_Face object from a FreeType
* backend font and scales it appropriately for the font. You must * backend font and scales it appropriately for the font. You must
* release the face with cairo_ft_font_unlock_face() * release the face with cairo_ft_font_unlock_face()
@ -2311,7 +2311,7 @@ cairo_ft_scaled_font_lock_face (cairo_scaled_font_t *abstract_font)
* object can be created by calling cairo_scaled_font_create() on a * object can be created by calling cairo_scaled_font_create() on a
* FreeType backend font face (see cairo_ft_font_face_create_for_pattern(), * FreeType backend font face (see cairo_ft_font_face_create_for_pattern(),
* cairo_ft_font_face_create_for_ft_face()). * cairo_ft_font_face_create_for_ft_face()).
* *
* Releases a face obtained with cairo_ft_scaled_font_lock_face(). * Releases a face obtained with cairo_ft_scaled_font_lock_face().
**/ **/
void void

14
src/cairo-gstate.c
View file

@ -704,7 +704,7 @@ _cairo_gstate_backend_to_user (cairo_gstate_t *gstate, double *x, double *y)
cairo_matrix_transform_point (&gstate->ctm_inverse, x, y); cairo_matrix_transform_point (&gstate->ctm_inverse, x, y);
} }
/* XXX: NYI /* XXX: NYI
cairo_status_t cairo_status_t
_cairo_gstate_stroke_to_path (cairo_gstate_t *gstate) _cairo_gstate_stroke_to_path (cairo_gstate_t *gstate)
{ {
@ -787,7 +787,7 @@ _cairo_gstate_paint (cairo_gstate_t *gstate)
/** /**
* _cairo_operator_bounded_by_mask: * _cairo_operator_bounded_by_mask:
* @op: a #cairo_operator_t * @op: a #cairo_operator_t
* *
* A bounded operator is one where mask pixel * A bounded operator is one where mask pixel
* of zero results in no effect on the destination image. * of zero results in no effect on the destination image.
* *
@ -826,7 +826,7 @@ _cairo_operator_bounded_by_mask (cairo_operator_t op)
/** /**
* _cairo_operator_bounded_by_source: * _cairo_operator_bounded_by_source:
* @op: a #cairo_operator_t * @op: a #cairo_operator_t
* *
* A bounded operator is one where source pixels of zero * A bounded operator is one where source pixels of zero
* (in all four components, r, g, b and a) effect no change * (in all four components, r, g, b and a) effect no change
* in the resulting destination image. * in the resulting destination image.
@ -1219,7 +1219,7 @@ _cairo_gstate_get_font_face (cairo_gstate_t *gstate,
return CAIRO_STATUS_SUCCESS; return CAIRO_STATUS_SUCCESS;
} }
/* /*
* Like everything else in this file, fonts involve Too Many Coordinate Spaces; * Like everything else in this file, fonts involve Too Many Coordinate Spaces;
* it is easy to get confused about what's going on. * it is easy to get confused about what's going on.
* *
@ -1236,7 +1236,7 @@ _cairo_gstate_get_font_face (cairo_gstate_t *gstate,
* Metrics are returned in user space, whether they are obtained from * Metrics are returned in user space, whether they are obtained from
* the currently selected font in a #cairo_t or from a #cairo_scaled_font_t * the currently selected font in a #cairo_t or from a #cairo_scaled_font_t
* which is a font specialized to a particular scale matrix, CTM, and target * which is a font specialized to a particular scale matrix, CTM, and target
* surface. * surface.
* *
* The font's view * The font's view
* --------------- * ---------------
@ -1270,9 +1270,9 @@ _cairo_gstate_get_font_face (cairo_gstate_t *gstate,
* around. * around.
* *
* In order to perform any action on a font, we must build an object * 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". * resulting from "font matrix * CTM".
* *
* We pass this to the font when making requests of it, which causes it to * We pass this to the font when making requests of it, which causes it to
* reply for a particular [user request, device] combination, under the CTM * reply for a particular [user request, device] combination, under the CTM
* (to accomodate the "zoom in" == "bigger fonts" issue above). * (to accomodate the "zoom in" == "bigger fonts" issue above).

30
src/cairo-hash.c
View file

@ -47,7 +47,7 @@
* DEAD: Entry had been live in the past. A dead entry can be reused * DEAD: Entry had been live in the past. A dead entry can be reused
* but does not terminate a search for an exact entry. * but does not terminate a search for an exact entry.
* Appears in the table as a pointer to DEAD_ENTRY. * Appears in the table as a pointer to DEAD_ENTRY.
* *
* LIVE: Entry is currently being used. * LIVE: Entry is currently being used.
* Appears in the table as any non-NULL, non-DEAD_ENTRY pointer. * Appears in the table as any non-NULL, non-DEAD_ENTRY pointer.
*/ */
@ -130,7 +130,7 @@ struct _cairo_hash_table {
/** /**
* _cairo_hash_table_create: * _cairo_hash_table_create:
* @keys_equal: a function to return TRUE if two keys are equal * @keys_equal: a function to return TRUE if two keys are equal
* *
* Creates a new hash table which will use the keys_equal() function * 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 * 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
@ -140,7 +140,7 @@ struct _cairo_hash_table {
* will be necessary, (as in _cairo_hash_table_insert). * will be necessary, (as in _cairo_hash_table_insert).
* *
* See #cairo_hash_entry_t for more details. * See #cairo_hash_entry_t for more details.
* *
* Return value: the new hash table or NULL if out of memory. * Return value: the new hash table or NULL if out of memory.
**/ **/
cairo_hash_table_t * cairo_hash_table_t *
@ -172,7 +172,7 @@ _cairo_hash_table_create (cairo_hash_keys_equal_func_t keys_equal)
/** /**
* _cairo_hash_table_destroy: * _cairo_hash_table_destroy:
* @hash_table: an empty hash table to destroy * @hash_table: an empty hash table to destroy
* *
* Immediately destroys the given hash table, freeing all resources * Immediately destroys the given hash table, freeing all resources
* associated with it. * associated with it.
* *
@ -212,7 +212,7 @@ _cairo_hash_table_destroy (cairo_hash_table_t *hash_table)
* @key_unique: If TRUE, then caller asserts that no key already * @key_unique: If TRUE, then caller asserts that no key already
* exists that will compare equal to #key, so search can be * exists that will compare equal to #key, so search can be
* optimized. If unsure, set to FALSE and the code will always work. * optimized. If unsure, set to FALSE and the code will always work.
* *
* Search the hashtable for a live entry for which * Search the hashtable for a live entry for which
* hash_table->keys_equal returns true. If no such entry exists then * hash_table->keys_equal returns true. If no such entry exists then
* return the first available (free or dead entry). * return the first available (free or dead entry).
@ -275,7 +275,7 @@ _cairo_hash_table_lookup_internal (cairo_hash_table_t *hash_table,
idx -= table_size; idx -= table_size;
} }
/* /*
* The table should not have permitted you to get here if you were just * The table should not have permitted you to get here if you were just
* looking for a free slot: there should have been room. * looking for a free slot: there should have been room.
*/ */
@ -287,11 +287,11 @@ _cairo_hash_table_lookup_internal (cairo_hash_table_t *hash_table,
/** /**
* _cairo_hash_table_resize: * _cairo_hash_table_resize:
* @hash_table: a hash table * @hash_table: a hash table
* *
* Resize the hash table if the number of entries has gotten much * Resize the hash table if the number of entries has gotten much
* bigger or smaller than the ideal number of entries for the current * bigger or smaller than the ideal number of entries for the current
* size. * size.
* *
* Return value: CAIRO_STATUS_SUCCESS if successful or * Return value: CAIRO_STATUS_SUCCESS if successful or
* CAIRO_STATUS_NO_MEMORY if out of memory. * CAIRO_STATUS_NO_MEMORY if out of memory.
**/ **/
@ -353,11 +353,11 @@ _cairo_hash_table_resize (cairo_hash_table_t *hash_table)
* @hash_table: a hash table * @hash_table: a hash table
* @key: the key of interest * @key: the key of interest
* @entry_return: pointer for return value. * @entry_return: pointer for return value.
* *
* Performs a lookup in @hash_table looking for an entry which has a * Performs a lookup in @hash_table looking for an entry which has a
* key that matches @key, (as determined by the keys_equal() function * key that matches @key, (as determined by the keys_equal() function
* passed to _cairo_hash_table_create). * passed to _cairo_hash_table_create).
* *
* Return value: TRUE if there is an entry in the hash table that * Return value: TRUE if there is an entry in the hash table that
* matches the given key, (which will now be in *entry_return). FALSE * matches the given key, (which will now be in *entry_return). FALSE
* otherwise, (in which case *entry_return will be NULL). * otherwise, (in which case *entry_return will be NULL).
@ -384,7 +384,7 @@ _cairo_hash_table_lookup (cairo_hash_table_t *hash_table,
* _cairo_hash_table_random_entry: * _cairo_hash_table_random_entry:
* @hash_table: a hash table * @hash_table: a hash table
* @predicate: a predicate function, or NULL for any entry. * @predicate: a predicate function, or NULL for any entry.
* *
* Find a random entry in the hash table satisfying the given * Find a random entry in the hash table satisfying the given
* @predicate. A NULL @predicate is taken as equivalent to a function * @predicate. A NULL @predicate is taken as equivalent to a function
* which always returns TRUE, (eg. any entry in the table will do). * which always returns TRUE, (eg. any entry in the table will do).
@ -442,7 +442,7 @@ _cairo_hash_table_random_entry (cairo_hash_table_t *hash_table,
* _cairo_hash_table_insert: * _cairo_hash_table_insert:
* @hash_table: a hash table * @hash_table: a hash table
* @key_and_value: an entry to be inserted * @key_and_value: an entry to be inserted
* *
* Insert the entry #key_and_value into the hash table. * Insert the entry #key_and_value into the hash table.
* *
* WARNING: It is a fatal error if an entry exists in the hash table * WARNING: It is a fatal error if an entry exists in the hash table
@ -454,7 +454,7 @@ _cairo_hash_table_random_entry (cairo_hash_table_t *hash_table,
* Instead of using insert to replace an entry, consider just editing * Instead of using insert to replace an entry, consider just editing
* the entry obtained with _cairo_hash_table_lookup. Or if absolutely * the entry obtained with _cairo_hash_table_lookup. Or if absolutely
* necessary, use _cairo_hash_table_remove first. * necessary, use _cairo_hash_table_remove first.
* *
* Return value: CAIRO_STATUS_SUCCESS if successful or * Return value: CAIRO_STATUS_SUCCESS if successful or
* CAIRO_STATUS_NO_MEMORY if insufficient memory is available. * CAIRO_STATUS_NO_MEMORY if insufficient memory is available.
**/ **/
@ -491,7 +491,7 @@ _cairo_hash_table_insert (cairo_hash_table_t *hash_table,
* _cairo_hash_table_remove: * _cairo_hash_table_remove:
* @hash_table: a hash table * @hash_table: a hash table
* @key: key of entry to be removed * @key: key of entry to be removed
* *
* Remove an entry from the hash table which has a key that matches * Remove an entry from the hash table which has a key that matches
* @key, if any (as determined by the keys_equal() function passed to * @key, if any (as determined by the keys_equal() function passed to
* _cairo_hash_table_create). * _cairo_hash_table_create).
@ -529,7 +529,7 @@ _cairo_hash_table_remove (cairo_hash_table_t *hash_table,
* @hash_table: a hash table * @hash_table: a hash table
* @hash_callback: function to be called for each live entry * @hash_callback: function to be called for each live entry
* @closure: additional argument to be passed to @hash_callback * @closure: additional argument to be passed to @hash_callback
* *
* Call @hash_callback for each live entry in the hash table, in a * Call @hash_callback for each live entry in the hash table, in a
* non-specified order. * non-specified order.
* *

2
src/cairo-hull.c
View file

@ -105,7 +105,7 @@ _cairo_hull_vertex_compare (const void *av, const void *bv)
/* /*
* Use the point's ids to ensure a total ordering. * Use the point's ids to ensure a total ordering.
* a well-defined ordering, and avoid setting discard on * a well-defined ordering, and avoid setting discard on
* both points. * both points.
*/ */
if (a_dist < b_dist || (a_dist == b_dist && a->id < b->id)) { if (a_dist < b_dist || (a_dist == b_dist && a->id < b->id)) {
a->discard = 1; a->discard = 1;

30
src/cairo-image-surface.c
View file

@ -184,10 +184,10 @@ _create_pixman_format (cairo_format_t format)
/** /**
* cairo_image_surface_create: * cairo_image_surface_create:
* @format: format of pixels in the surface to create * @format: format of pixels in the surface to create
* @width: width of the surface, in pixels * @width: width of the surface, in pixels
* @height: height of the surface, in pixels * @height: height of the surface, in pixels
* *
* Creates an image surface of the specified format and * Creates an image surface of the specified format and
* dimensions. Initially the surface contents are all * dimensions. Initially the surface contents are all
* 0. (Specifically, within each pixel, each color or alpha channel * 0. (Specifically, within each pixel, each color or alpha channel
@ -257,7 +257,7 @@ _cairo_image_surface_create_with_content (cairo_content_t content,
* in the buffer. Having this be specified separate from @width * in the buffer. Having this be specified separate from @width
* allows for padding at the end of rows, or for writing * allows for padding at the end of rows, or for writing
* to a subportion of a larger image. * to a subportion of a larger image.
* *
* Creates an image surface for the provided pixel data. The output * Creates an image surface for the provided pixel data. The output
* buffer must be kept around until the #cairo_surface_t is destroyed * buffer must be kept around until the #cairo_surface_t is destroyed
* or cairo_surface_finish() is called on the surface. The initial * or cairo_surface_finish() is called on the surface. The initial
@ -331,10 +331,10 @@ _cairo_image_surface_create_for_data_with_content (unsigned char *data,
/** /**
* cairo_image_surface_get_data: * cairo_image_surface_get_data:
* @surface: a #cairo_image_surface_t * @surface: a #cairo_image_surface_t
* *
* Get a pointer to the data of the image surface, for direct * Get a pointer to the data of the image surface, for direct
* inspection or modification. * inspection or modification.
* *
* Return value: a pointer to the image data of this surface or NULL * Return value: a pointer to the image data of this surface or NULL
* if @surface is not an image surface. * if @surface is not an image surface.
**/ **/
@ -354,9 +354,9 @@ cairo_image_surface_get_data (cairo_surface_t *surface)
/** /**
* cairo_image_surface_get_format: * cairo_image_surface_get_format:
* @surface: a #cairo_image_surface_t * @surface: a #cairo_image_surface_t
* *
* Get the format of the surface. * Get the format of the surface.
* *
* Return value: the format of the surface * Return value: the format of the surface
**/ **/
cairo_format_t cairo_format_t
@ -375,9 +375,9 @@ cairo_image_surface_get_format (cairo_surface_t *surface)
/** /**
* cairo_image_surface_get_width: * cairo_image_surface_get_width:
* @surface: a #cairo_image_surface_t * @surface: a #cairo_image_surface_t
* *
* Get the width of the image surface in pixels. * Get the width of the image surface in pixels.
* *
* Return value: the width of the surface in pixels. * Return value: the width of the surface in pixels.
**/ **/
int int
@ -396,9 +396,9 @@ cairo_image_surface_get_width (cairo_surface_t *surface)
/** /**
* cairo_image_surface_get_height: * cairo_image_surface_get_height:
* @surface: a #cairo_image_surface_t * @surface: a #cairo_image_surface_t
* *
* Get the height of the image surface in pixels. * Get the height of the image surface in pixels.
* *
* Return value: the height of the surface in pixels. * Return value: the height of the surface in pixels.
**/ **/
int int
@ -417,9 +417,9 @@ cairo_image_surface_get_height (cairo_surface_t *surface)
/** /**
* cairo_image_surface_get_stride: * cairo_image_surface_get_stride:
* @surface: a #cairo_image_surface_t * @surface: a #cairo_image_surface_t
* *
* Get the stride of the image surface in bytes * Get the stride of the image surface in bytes
* *
* Return value: the stride of the image surface in bytes (or 0 if * Return value: the stride of the image surface in bytes (or 0 if
* @surface is not an image surface). The stride is the distance in * @surface is not an image surface). The stride is the distance in
* bytes from the beginning of one row of the image data to the * bytes from the beginning of one row of the image data to the
@ -965,9 +965,9 @@ _cairo_image_surface_get_extents (void *abstract_surface,
/** /**
* _cairo_surface_is_image: * _cairo_surface_is_image:
* @surface: a #cairo_surface_t * @surface: a #cairo_surface_t
* *
* Checks if a surface is an #cairo_image_surface_t * Checks if a surface is an #cairo_image_surface_t
* *
* Return value: TRUE if the surface is an image surface * Return value: TRUE if the surface is an image surface
**/ **/
cairo_bool_t cairo_bool_t

28
src/cairo-matrix.c
View file

@ -48,7 +48,7 @@ _cairo_matrix_compute_adjoint (cairo_matrix_t *matrix);
/** /**
* cairo_matrix_init_identity: * cairo_matrix_init_identity:
* @matrix: a #cairo_matrix_t * @matrix: a #cairo_matrix_t
* *
* Modifies @matrix to be an identity transformation. * Modifies @matrix to be an identity transformation.
**/ **/
void void
@ -70,7 +70,7 @@ slim_hidden_def(cairo_matrix_init_identity);
* @yy: yy component of the affine transformation * @yy: yy component of the affine transformation
* @x0: X translation component of the affine transformation * @x0: X translation component of the affine transformation
* @y0: Y translation component of the affine transformation * @y0: Y translation component of the affine transformation
* *
* Sets @matrix to be the affine transformation given by * Sets @matrix to be the affine transformation given by
* @xx, @yx, @xy, @yy, @x0, @y0. The transformation is given * @xx, @yx, @xy, @yy, @x0, @y0. The transformation is given
* by: * by:
@ -101,7 +101,7 @@ slim_hidden_def(cairo_matrix_init);
* @yy: location to store yy component of matrix * @yy: location to store yy component of matrix
* @x0: location to store x0 (X-translation component) of matrix, or %NULL * @x0: location to store x0 (X-translation component) of matrix, or %NULL
* @y0: location to store y0 (Y-translation component) of matrix, or %NULL * @y0: location to store y0 (Y-translation component) of matrix, or %NULL
* *
* Gets the matrix values for the affine tranformation that @matrix represents. * Gets the matrix values for the affine tranformation that @matrix represents.
* See cairo_matrix_init(). * See cairo_matrix_init().
* *
@ -135,7 +135,7 @@ _cairo_matrix_get_affine (const cairo_matrix_t *matrix,
* @matrix: a cairo_matrix_t * @matrix: a cairo_matrix_t
* @tx: amount to translate in the X direction * @tx: amount to translate in the X direction
* @ty: amount to translate in the Y direction * @ty: amount to translate in the Y direction
* *
* Initializes @matrix to a transformation that translates by @tx and * Initializes @matrix to a transformation that translates by @tx and
* @ty in the X and Y dimensions, respectively. * @ty in the X and Y dimensions, respectively.
**/ **/
@ -155,7 +155,7 @@ slim_hidden_def(cairo_matrix_init_translate);
* @matrix: a cairo_matrix_t * @matrix: a cairo_matrix_t
* @tx: amount to translate in the X direction * @tx: amount to translate in the X direction
* @ty: amount to translate in the Y direction * @ty: amount to translate in the Y direction
* *
* Applies a translation by @tx, @ty to the transformation in * Applies a translation by @tx, @ty to the transformation in
* @matrix. The effect of the new transformation is to first translate * @matrix. The effect of the new transformation is to first translate
* the coordinates by @tx and @ty, then apply the original transformation * the coordinates by @tx and @ty, then apply the original transformation
@ -176,7 +176,7 @@ cairo_matrix_translate (cairo_matrix_t *matrix, double tx, double ty)
* @matrix: a cairo_matrix_t * @matrix: a cairo_matrix_t
* @sx: scale factor in the X direction * @sx: scale factor in the X direction
* @sy: scale factor in the Y direction * @sy: scale factor in the Y direction
* *
* Initializes @matrix to a transformation that scales by @sx and @sy * Initializes @matrix to a transformation that scales by @sx and @sy
* in the X and Y dimensions, respectively. * in the X and Y dimensions, respectively.
**/ **/
@ -196,7 +196,7 @@ slim_hidden_def(cairo_matrix_init_scale);
* @matrix: a #cairo_matrix_t * @matrix: a #cairo_matrix_t
* @sx: scale factor in the X direction * @sx: scale factor in the X direction
* @sy: scale factor in the Y direction * @sy: scale factor in the Y direction
* *
* Applies scaling by @tx, @ty to the transformation in @matrix. The * Applies scaling by @tx, @ty to the transformation in @matrix. The
* effect of the new transformation is to first scale the coordinates * effect of the new transformation is to first scale the coordinates
* by @sx and @sy, then apply the original transformation to the coordinates. * by @sx and @sy, then apply the original transformation to the coordinates.
@ -220,7 +220,7 @@ slim_hidden_def(cairo_matrix_scale);
* the positive X axis toward the positive Y axis. With the default * the positive X axis toward the positive Y axis. With the default
* axis orientation of cairo, positive angles rotate in a clockwise * axis orientation of cairo, positive angles rotate in a clockwise
* direction. * direction.
* *
* Initialized @matrix to a transformation that rotates by @radians. * Initialized @matrix to a transformation that rotates by @radians.
**/ **/
void void
@ -248,7 +248,7 @@ slim_hidden_def(cairo_matrix_init_rotate);
* the positive X axis toward the positive Y axis. With the default * the positive X axis toward the positive Y axis. With the default
* axis orientation of cairo, positive angles rotate in a clockwise * axis orientation of cairo, positive angles rotate in a clockwise
* direction. * direction.
* *
* Applies rotation by @radians to the transformation in * Applies rotation by @radians to the transformation in
* @matrix. The effect of the new transformation is to first rotate the * @matrix. The effect of the new transformation is to first rotate the
* coordinates by @radians, then apply the original transformation * coordinates by @radians, then apply the original transformation
@ -269,7 +269,7 @@ cairo_matrix_rotate (cairo_matrix_t *matrix, double radians)
* @result: a @cairo_matrix_t in which to store the result * @result: a @cairo_matrix_t in which to store the result
* @a: a @cairo_matrix_t * @a: a @cairo_matrix_t
* @b: a @cairo_matrix_t * @b: a @cairo_matrix_t
* *
* Multiplies the affine transformations in @a and @b together * Multiplies the affine transformations in @a and @b together
* and stores the result in @result. The effect of the resulting * and stores the result in @result. The effect of the resulting
* transformation is to first apply the transformation in @a to the * transformation is to first apply the transformation in @a to the
@ -307,7 +307,7 @@ slim_hidden_def(cairo_matrix_multiply);
* @matrix: a @cairo_matrix_t * @matrix: a @cairo_matrix_t
* @dx: X component of a distance vector. An in/out parameter * @dx: X component of a distance vector. An in/out parameter
* @dy: Y component of a distance vector. An in/out parameter * @dy: Y component of a distance vector. An in/out parameter
* *
* Transforms the distance vector (@dx,@dy) by @matrix. This is * Transforms the distance vector (@dx,@dy) by @matrix. This is
* similar to cairo_matrix_transform() except that the translation * similar to cairo_matrix_transform() except that the translation
* components of the transformation are ignored. The calculation of * components of the transformation are ignored. The calculation of
@ -341,7 +341,7 @@ slim_hidden_def(cairo_matrix_transform_distance);
* @matrix: a @cairo_matrix_t * @matrix: a @cairo_matrix_t
* @x: X position. An in/out parameter * @x: X position. An in/out parameter
* @y: Y position. An in/out parameter * @y: Y position. An in/out parameter
* *
* Transforms the point (@x, @y) by @matrix. * Transforms the point (@x, @y) by @matrix.
**/ **/
void void
@ -443,12 +443,12 @@ _cairo_matrix_compute_adjoint (cairo_matrix_t *matrix)
/** /**
* cairo_matrix_invert: * cairo_matrix_invert:
* @matrix: a @cairo_matrix_t * @matrix: a @cairo_matrix_t
* *
* Changes @matrix to be the inverse of it's original value. Not * Changes @matrix to be the inverse of it's original value. Not
* all transformation matrices have inverses; if the matrix * all transformation matrices have inverses; if the matrix
* collapses points together (it is <firstterm>degenerate</firstterm>), * collapses points together (it is <firstterm>degenerate</firstterm>),
* then it has no inverse and this function will fail. * then it has no inverse and this function will fail.
* *
* Returns: If @matrix has an inverse, modifies @matrix to * Returns: If @matrix has an inverse, modifies @matrix to
* be the inverse matrix and returns %CAIRO_STATUS_SUCCESS. Otherwise, * be the inverse matrix and returns %CAIRO_STATUS_SUCCESS. Otherwise,
* returns %CAIRO_STATUS_INVALID_MATRIX. * returns %CAIRO_STATUS_INVALID_MATRIX.

6
src/cairo-meta-surface.c
View file

@ -231,7 +231,7 @@ _cairo_meta_surface_paint (void *abstract_surface,
cairo_command_paint_t *command; cairo_command_paint_t *command;
/* An optimisation that takes care to not replay what was done /* An optimisation that takes care to not replay what was done
* before surface is cleared. We don't erase recorded commands * before surface is cleared. We don't erase recorded commands
* since we may have earlier snapshots of this surface. */ * since we may have earlier snapshots of this surface. */
if (op == CAIRO_OPERATOR_CLEAR && !meta->is_clipped) if (op == CAIRO_OPERATOR_CLEAR && !meta->is_clipped)
meta->replay_start_idx = meta->commands.num_elements; meta->replay_start_idx = meta->commands.num_elements;
@ -560,9 +560,9 @@ _cairo_meta_surface_get_extents (void *abstract_surface,
/** /**
* _cairo_surface_is_meta: * _cairo_surface_is_meta:
* @surface: a #cairo_surface_t * @surface: a #cairo_surface_t
* *
* Checks if a surface is a #cairo_meta_surface_t * Checks if a surface is a #cairo_meta_surface_t
* *
* Return value: TRUE if the surface is a meta surface * Return value: TRUE if the surface is a meta surface
**/ **/
cairo_bool_t cairo_bool_t

2
src/cairo-output-stream.c
View file

@ -1,5 +1,5 @@
/* cairo_output_stream.c: Output stream abstraction /* cairo_output_stream.c: Output stream abstraction
* *
* Copyright © 2005 Red Hat, Inc * Copyright © 2005 Red Hat, Inc
* *
* This library is free software; you can redistribute it and/or * This library is free software; you can redistribute it and/or

14
src/cairo-path-data.c
View file

@ -369,7 +369,7 @@ _cairo_path_data_create_real (cairo_path_fixed_t *path_fixed,
* cairo_path_destroy: * cairo_path_destroy:
* @path: a path previously returned by either cairo_copy_path() or * @path: a path previously returned by either cairo_copy_path() or
* cairo_copy_path_flat(). * cairo_copy_path_flat().
* *
* Immediately releases all memory associated with @path. After a call * Immediately releases all memory associated with @path. After a call
* to cairo_path_destroy() the @path pointer is no longer valid and * to cairo_path_destroy() the @path pointer is no longer valid and
* should not be used further. * should not be used further.
@ -394,11 +394,11 @@ cairo_path_destroy (cairo_path_t *path)
* _cairo_path_data_create: * _cairo_path_data_create:
* @path: a fixed-point, device-space path to be converted and copied * @path: a fixed-point, device-space path to be converted and copied
* @gstate: the current graphics state * @gstate: the current graphics state
* *
* Creates a user-space #cairo_path_t copy of the given device-space * Creates a user-space #cairo_path_t copy of the given device-space
* @path. The @gstate parameter provides the inverse CTM for the * @path. The @gstate parameter provides the inverse CTM for the
* conversion. * conversion.
* *
* Return value: the new copy of the path. If there is insufficient * Return value: the new copy of the path. If there is insufficient
* memory a pointer to a special static cairo_path_nil will be * memory a pointer to a special static cairo_path_nil will be
* returned instead with status==CAIRO_STATUS_NO_MEMORY and * returned instead with status==CAIRO_STATUS_NO_MEMORY and
@ -415,12 +415,12 @@ _cairo_path_data_create (cairo_path_fixed_t *path,
* _cairo_path_data_create_flat: * _cairo_path_data_create_flat:
* @path: a fixed-point, device-space path to be flattened, converted and copied * @path: a fixed-point, device-space path to be flattened, converted and copied
* @gstate: the current graphics state * @gstate: the current graphics state
* *
* Creates a flattened, user-space #cairo_path_t copy of the given * Creates a flattened, user-space #cairo_path_t copy of the given
* device-space @path. The @gstate parameter provide the inverse CTM * device-space @path. The @gstate parameter provide the inverse CTM
* for the conversion, as well as the tolerance value to control the * for the conversion, as well as the tolerance value to control the
* accuracy of the flattening. * accuracy of the flattening.
* *
* Return value: the flattened copy of the path. If there is insufficient * Return value: the flattened copy of the path. If there is insufficient
* memory a pointer to a special static cairo_path_nil will be * memory a pointer to a special static cairo_path_nil will be
* returned instead with status==CAIRO_STATUS_NO_MEMORY and * returned instead with status==CAIRO_STATUS_NO_MEMORY and
@ -437,9 +437,9 @@ _cairo_path_data_create_flat (cairo_path_fixed_t *path,
* _cairo_path_data_append_to_context: * _cairo_path_data_append_to_context:
* @path: the path data to be appended * @path: the path data to be appended
* @cr: a cairo context * @cr: a cairo context
* *
* Append @path to the current path within @cr. * Append @path to the current path within @cr.
* *
* Return value: CAIRO_STATUS_INVALID_PATH_DATA if the data in @path * Return value: CAIRO_STATUS_INVALID_PATH_DATA if the data in @path
* is invalid, and CAIRO_STATUS_SUCCESS otherwise. * is invalid, and CAIRO_STATUS_SUCCESS otherwise.
**/ **/

6
src/cairo-path-stroke.c
View file

@ -286,7 +286,7 @@ _cairo_stroker_join (cairo_stroker_t *stroker, cairo_stroke_face_t *in, cairo_st
* in · out = cos (psi) * in · out = cos (psi)
* *
* 2 <= ml² (1 - in · out) * 2 <= ml² (1 - in · out)
* *
*/ */
if (2 <= ml * ml * (1 - in_dot_out)) { if (2 <= ml * ml * (1 - in_dot_out)) {
double x1, y1, x2, y2; double x1, y1, x2, y2;
@ -295,7 +295,7 @@ _cairo_stroker_join (cairo_stroker_t *stroker, cairo_stroke_face_t *in, cairo_st
cairo_polygon_t polygon; cairo_polygon_t polygon;
cairo_point_t outer; cairo_point_t outer;
/* /*
* we've got the points already transformed to device * we've got the points already transformed to device
* space, but need to do some computation with them and * space, but need to do some computation with them and
* also need to transform the slope from user space to * also need to transform the slope from user space to
@ -507,7 +507,7 @@ _compute_face (cairo_point_t *point, cairo_slope_t *slope, cairo_stroker_t *stro
usr_vector.x = line_dx; usr_vector.x = line_dx;
usr_vector.y = line_dy; usr_vector.y = line_dy;
/* /*
* rotate to get a line_width/2 vector along the face, note that * rotate to get a line_width/2 vector along the face, note that
* the vector must be rotated the right direction in device space, * the vector must be rotated the right direction in device space,
* but by 90° in user space. So, the rotation depends on * but by 90° in user space. So, the rotation depends on

60
src/cairo-pattern.c
View file

@ -86,7 +86,7 @@ _cairo_pattern_nil_for_status (cairo_status_t status)
* @pattern: a pattern * @pattern: a pattern
* @status: a status value indicating an error, (eg. not * @status: a status value indicating an error, (eg. not
* CAIRO_STATUS_SUCCESS) * CAIRO_STATUS_SUCCESS)
* *
* Sets pattern->status to @status and calls _cairo_error; * Sets pattern->status to @status and calls _cairo_error;
* *
* All assignments of an error status to pattern->status should happen * All assignments of an error status to pattern->status should happen
@ -298,12 +298,12 @@ _cairo_pattern_create_solid (const cairo_color_t *color)
* @red: red component of the color * @red: red component of the color
* @green: green component of the color * @green: green component of the color
* @blue: blue 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. * color components are floating point numbers in the range 0 to 1.
* If the values passed in are outside that range, they will be * If the values passed in are outside that range, they will be
* clamped. * clamped.
* *
* Return value: the newly created #cairo_pattern_t if succesful, or * Return value: the newly created #cairo_pattern_t if succesful, or
* an error pattern in case of no memory. The caller owns the * an error pattern in case of no memory. The caller owns the
* returned object and should call cairo_pattern_destroy() when * returned object and should call cairo_pattern_destroy() when
@ -338,12 +338,12 @@ cairo_pattern_create_rgb (double red, double green, double blue)
* @green: green component of the color * @green: green component of the color
* @blue: blue component of the color * @blue: blue component of the color
* @alpha: alpha 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 * 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 * 1. If the values passed in are outside that range, they will be
* clamped. * clamped.
* *
* Return value: the newly created #cairo_pattern_t if succesful, or * Return value: the newly created #cairo_pattern_t if succesful, or
* an error pattern in case of no memory. The caller owns the * an error pattern in case of no memory. The caller owns the
* returned object and should call cairo_pattern_destroy() when * returned object and should call cairo_pattern_destroy() when
@ -376,10 +376,10 @@ cairo_pattern_create_rgba (double red, double green, double blue,
/** /**
* cairo_pattern_create_for_surface: * cairo_pattern_create_for_surface:
* @surface: the 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 succesful, or * Return value: the newly created #cairo_pattern_t if succesful, or
* an error pattern in case of no memory. The caller owns the * an error pattern in case of no memory. The caller owns the
* returned object and should call cairo_pattern_destroy() when * returned object and should call cairo_pattern_destroy() when
@ -413,11 +413,11 @@ cairo_pattern_create_for_surface (cairo_surface_t *surface)
/** /**
* cairo_pattern_create_linear: * cairo_pattern_create_linear:
* @x0: x coordinate of the start point * @x0: x coordinate of the start point
* @y0: y coordinate of the start point * @y0: y coordinate of the start point
* @x1: x coordinate of the end point * @x1: x coordinate of the end point
* @y1: y 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 * by (x0, y0) and (x1, y1). Before using the gradient pattern, a
* number of color stops should be defined using * number of color stops should be defined using
@ -427,7 +427,7 @@ cairo_pattern_create_for_surface (cairo_surface_t *surface)
* Note: The coordinates here are in pattern space. For a new pattern, * Note: The coordinates here are in pattern space. For a new pattern,
* pattern space is identical to user space, but the relationship * pattern space is identical to user space, but the relationship
* between the spaces can be changed with cairo_pattern_set_matrix(). * between the spaces can be changed with cairo_pattern_set_matrix().
* *
* Return value: the newly created #cairo_pattern_t if succesful, or * Return value: the newly created #cairo_pattern_t if succesful, or
* an error pattern in case of no memory. The caller owns the * an error pattern in case of no memory. The caller owns the
* returned object and should call cairo_pattern_destroy() when * returned object and should call cairo_pattern_destroy() when
@ -461,7 +461,7 @@ cairo_pattern_create_linear (double x0, double y0, double x1, double y1)
* @cx1: x coordinate for the center of the end circle * @cx1: x coordinate for the center of the end circle
* @cy1: y coordinate for the center of the end circle * @cy1: y coordinate for the center of the end circle
* @radius1: radius of the end cirle * @radius1: radius of the end cirle
* *
* 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 (x0, y0, c0) and (x1, y1, c0). Before using the * circles defined by (x0, y0, c0) and (x1, y1, c0). Before using the
* gradient pattern, a number of color stops should be defined using * gradient pattern, a number of color stops should be defined using
@ -471,7 +471,7 @@ cairo_pattern_create_linear (double x0, double y0, double x1, double y1)
* Note: The coordinates here are in pattern space. For a new pattern, * Note: The coordinates here are in pattern space. For a new pattern,
* pattern space is identical to user space, but the relationship * pattern space is identical to user space, but the relationship
* between the spaces can be changed with cairo_pattern_set_matrix(). * between the spaces can be changed with cairo_pattern_set_matrix().
* *
* Return value: the newly created #cairo_pattern_t if succesful, or * Return value: the newly created #cairo_pattern_t if succesful, or
* an error pattern in case of no memory. The caller owns the * an error pattern in case of no memory. The caller owns the
* returned object and should call cairo_pattern_destroy() when * returned object and should call cairo_pattern_destroy() when
@ -501,7 +501,7 @@ cairo_pattern_create_radial (double cx0, double cy0, double radius0,
/** /**
* cairo_pattern_reference: * cairo_pattern_reference:
* @pattern: a #cairo_pattern_t * @pattern: a #cairo_pattern_t
* *
* Increases the reference count on @pattern by one. This prevents * Increases the reference count on @pattern by one. This prevents
* @pattern from being destroyed until a matching call to * @pattern from being destroyed until a matching call to
* cairo_pattern_destroy() is made. * cairo_pattern_destroy() is made.
@ -527,7 +527,7 @@ cairo_pattern_reference (cairo_pattern_t *pattern)
/** /**
* cairo_pattern_get_type: * cairo_pattern_get_type:
* @pattern: a #cairo_pattern_t * @pattern: a #cairo_pattern_t
* *
* Return value: The type of @pattern. See #cairo_pattern_type_t. * Return value: The type of @pattern. See #cairo_pattern_type_t.
**/ **/
cairo_pattern_type_t cairo_pattern_type_t
@ -539,10 +539,10 @@ cairo_pattern_get_type (cairo_pattern_t *pattern)
/** /**
* cairo_pattern_status: * cairo_pattern_status:
* @pattern: a #cairo_pattern_t * @pattern: a #cairo_pattern_t
* *
* Checks whether an error has previously occurred for this * Checks whether an error has previously occurred for this
* pattern. * pattern.
* *
* Return value: %CAIRO_STATUS_SUCCESS, %CAIRO_STATUS_NO_MEMORY, or * Return value: %CAIRO_STATUS_SUCCESS, %CAIRO_STATUS_NO_MEMORY, or
* %CAIRO_STATUS_PATTERN_TYPE_MISMATCH. * %CAIRO_STATUS_PATTERN_TYPE_MISMATCH.
**/ **/
@ -555,7 +555,7 @@ cairo_pattern_status (cairo_pattern_t *pattern)
/** /**
* cairo_pattern_destroy: * cairo_pattern_destroy:
* @pattern: a #cairo_pattern_t * @pattern: a #cairo_pattern_t
* *
* Decreases the reference count on @pattern by one. If the result is * Decreases the reference count on @pattern by one. If the result is
* zero, then @pattern and all associated resources are freed. See * zero, then @pattern and all associated resources are freed. See
* cairo_pattern_reference(). * cairo_pattern_reference().
@ -630,7 +630,7 @@ _cairo_pattern_add_color_stop (cairo_gradient_pattern_t *pattern,
* @red: red component of color * @red: red component of color
* @green: green component of color * @green: green component of color
* @blue: blue component of color * @blue: blue component of color
* *
* Adds an opaque color stop to a gradient pattern. The offset * Adds an opaque color stop to a gradient pattern. The offset
* specifies the location along the gradient's control vector. For * specifies the location along the gradient's control vector. For
* example, a linear gradient's control vector is from (x0,y0) to * example, a linear gradient's control vector is from (x0,y0) to
@ -677,7 +677,7 @@ cairo_pattern_add_color_stop_rgb (cairo_pattern_t *pattern,
* @green: green component of color * @green: green component of color
* @blue: blue component of color * @blue: blue component of color
* @alpha: alpha component of color * @alpha: alpha component of color
* *
* Adds a translucent color stop to a gradient pattern. The offset * Adds a translucent color stop to a gradient pattern. The offset
* specifies the location along the gradient's control vector. For * specifies the location along the gradient's control vector. For
* example, a linear gradient's control vector is from (x0,y0) to * example, a linear gradient's control vector is from (x0,y0) to
@ -722,7 +722,7 @@ cairo_pattern_add_color_stop_rgba (cairo_pattern_t *pattern,
* cairo_pattern_set_matrix: * cairo_pattern_set_matrix:
* @pattern: a #cairo_pattern_t * @pattern: a #cairo_pattern_t
* @matrix: a #cairo_matrix_t * @matrix: a #cairo_matrix_t
* *
* Sets the pattern's transformation matrix to @matrix. This matrix is * Sets the pattern's transformation matrix to @matrix. This matrix is
* a transformation from user space to pattern space. * a transformation from user space to pattern space.
* *
@ -764,7 +764,7 @@ cairo_pattern_set_matrix (cairo_pattern_t *pattern,
* cairo_pattern_get_matrix: * cairo_pattern_get_matrix:
* @pattern: a #cairo_pattern_t * @pattern: a #cairo_pattern_t
* @matrix: return value for the matrix * @matrix: return value for the matrix
* *
* Stores the pattern's transformation matrix into @matrix. * Stores the pattern's transformation matrix into @matrix.
**/ **/
void void
@ -813,7 +813,7 @@ cairo_pattern_set_extend (cairo_pattern_t *pattern, cairo_extend_t extend)
* *
* Gets the current extend mode for a pattern. See #cairo_extend_t * Gets the current extend mode for a pattern. See #cairo_extend_t
* for details on the semantics of each extend strategy. * for details on the semantics of each extend strategy.
* *
* Return value: the current extend strategy used for drawing the * Return value: the current extend strategy used for drawing the
* pattern. * pattern.
**/ **/
@ -1178,10 +1178,10 @@ _cairo_pattern_acquire_surface_for_surface (cairo_surface_pattern_t *pattern,
* @surface_out: location to store a pointer to a surface * @surface_out: location to store a pointer to a surface
* @attributes: surface attributes that destination backend should apply to * @attributes: surface attributes that destination backend should apply to
* the returned surface * the returned surface
* *
* A convenience function to obtain a surface to use as the source for * A convenience function to obtain a surface to use as the source for
* drawing on @dst. * drawing on @dst.
* *
* Return value: %CAIRO_STATUS_SUCCESS if a surface was stored in @surface_out. * Return value: %CAIRO_STATUS_SUCCESS if a surface was stored in @surface_out.
**/ **/
cairo_int_status_t cairo_int_status_t
@ -1275,7 +1275,7 @@ _cairo_pattern_acquire_surface (cairo_pattern_t *pattern,
* @pattern: a #cairo_pattern_t * @pattern: a #cairo_pattern_t
* @surface: a surface obtained by _cairo_pattern_acquire_surface * @surface: a surface obtained by _cairo_pattern_acquire_surface
* @attributes: attributes obtained by _cairo_pattern_acquire_surface * @attributes: attributes obtained by _cairo_pattern_acquire_surface
* *
* Releases resources obtained by _cairo_pattern_acquire_surface. * Releases resources obtained by _cairo_pattern_acquire_surface.
**/ **/
void void
@ -1383,7 +1383,7 @@ _cairo_pattern_acquire_surfaces (cairo_pattern_t *src,
/** /**
* _cairo_pattern_get_extents: * _cairo_pattern_get_extents:
* *
* Return the "target-space" extents of @pattern in @extents. * Return the "target-space" extents of @pattern in @extents.
* *
* For unbounded patterns, the @extents will be initialized with * For unbounded patterns, the @extents will be initialized with

2
src/cairo-pdf-surface.c
View file

@ -2031,7 +2031,7 @@ static cairo_bool_t cairo_pdf_force_fallbacks = FALSE;
* *
* Force the PDF surface backend to use image fallbacks for every * Force the PDF surface backend to use image fallbacks for every
* operation. * operation.
* *
* <note> * <note>
* This function is <emphasis>only</emphasis> intended for internal * This function is <emphasis>only</emphasis> intended for internal
* testing use within the cairo distribution. It is not installed in * testing use within the cairo distribution. It is not installed in

2
src/cairo-pen.c
View file

@ -247,7 +247,7 @@ _cairo_pen_vertices_needed (double tolerance,
double radius, double radius,
cairo_matrix_t *matrix) cairo_matrix_t *matrix)
{ {
/* /*
* the pen is a circle that gets transformed to an ellipse by matrix. * the pen is a circle that gets transformed to an ellipse by matrix.
* compute major axis length for a pen with the specified radius. * compute major axis length for a pen with the specified radius.
* we don't need the minor axis length. * we don't need the minor axis length.

20
src/cairo-png.c
View file

@ -214,10 +214,10 @@ stdio_write_func (png_structp png, png_bytep data, png_size_t size)
* cairo_surface_write_to_png: * cairo_surface_write_to_png:
* @surface: a #cairo_surface_t with pixel contents * @surface: a #cairo_surface_t with pixel contents
* @filename: the name of a file to write to * @filename: the name of a file to write to
* *
* Writes the contents of @surface to a new file @filename as a PNG * Writes the contents of @surface to a new file @filename as a PNG
* image. * image.
* *
* Return value: CAIRO_STATUS_SUCCESS if the PNG file was written * Return value: CAIRO_STATUS_SUCCESS if the PNG file was written
* successfully. Otherwise, CAIRO_STATUS_NO_MEMORY if memory could not * successfully. Otherwise, CAIRO_STATUS_NO_MEMORY if memory could not
* be allocated for the operation or * be allocated for the operation or
@ -266,9 +266,9 @@ stream_write_func (png_structp png, png_bytep data, png_size_t size)
* @surface: a #cairo_surface_t with pixel contents * @surface: a #cairo_surface_t with pixel contents
* @write_func: a #cairo_write_func_t * @write_func: a #cairo_write_func_t
* @closure: closure data for the write function * @closure: closure data for the write function
* *
* Writes the image surface to the write function. * Writes the image surface to the write function.
* *
* Return value: CAIRO_STATUS_SUCCESS if the PNG file was written * Return value: CAIRO_STATUS_SUCCESS if the PNG file was written
* successfully. Otherwise, CAIRO_STATUS_NO_MEMORY is returned if * successfully. Otherwise, CAIRO_STATUS_NO_MEMORY is returned if
* memory could not be allocated for the operation, * memory could not be allocated for the operation,
@ -447,15 +447,15 @@ stdio_read_func (png_structp png, png_bytep data, png_size_t size)
/** /**
* cairo_image_surface_create_from_png: * cairo_image_surface_create_from_png:
* @filename: name of PNG file to load * @filename: name of PNG file to load
* *
* Creates a new image surface and initializes the contents to the * Creates a new image surface and initializes the contents to the
* given PNG file. * given PNG file.
* *
* Return value: a new #cairo_surface_t initialized with the contents * Return value: a new #cairo_surface_t initialized with the contents
* of the PNG file, or a "nil" surface if any error occurred. A nil * of the PNG file, or a "nil" surface if any error occurred. A nil
* surface can be checked for with cairo_surface_status(surface) which * surface can be checked for with cairo_surface_status(surface) which
* may return one of the following values: * may return one of the following values:
* *
* CAIRO_STATUS_NO_MEMORY * CAIRO_STATUS_NO_MEMORY
* CAIRO_STATUS_FILE_NOT_FOUND * CAIRO_STATUS_FILE_NOT_FOUND
@ -510,10 +510,10 @@ stream_read_func (png_structp png, png_bytep data, png_size_t size)
* cairo_image_surface_create_from_png_stream: * cairo_image_surface_create_from_png_stream:
* @read_func: function called to read the data of the file * @read_func: function called to read the data of the file
* @closure: data to pass to @read_func. * @closure: data to pass to @read_func.
* *
* Creates a new image surface from PNG data read incrementally * Creates a new image surface from PNG data read incrementally
* via the @read_func function. * via the @read_func function.
* *
* Return value: a new #cairo_surface_t initialized with the contents * Return value: a new #cairo_surface_t initialized with the contents
* of the PNG file or %NULL if the data read is not a valid PNG image or * of the PNG file or %NULL if the data read is not a valid PNG image or
* memory could not be allocated for the operation. * memory could not be allocated for the operation.

16
src/cairo-ps-surface.c
View file

@ -410,7 +410,7 @@ _cairo_ps_surface_create_for_stream_internal (cairo_output_stream_t *stream,
* @filename: a filename for the PS output (must be writable) * @filename: a filename for the PS output (must be writable)
* @width_in_points: width of the surface, in points (1 point == 1/72.0 inch) * @width_in_points: width of the surface, in points (1 point == 1/72.0 inch)
* @height_in_points: height of the surface, in points (1 point == 1/72.0 inch) * @height_in_points: height of the surface, in points (1 point == 1/72.0 inch)
* *
* Creates a PostScript surface of the specified size in points to be * Creates a PostScript surface of the specified size in points to be
* written to @filename. See cairo_ps_surface_create_for_stream() for * written to @filename. See cairo_ps_surface_create_for_stream() for
* a more flexible mechanism for handling the PostScript output than * a more flexible mechanism for handling the PostScript output than
@ -453,7 +453,7 @@ cairo_ps_surface_create (const char *filename,
* @closure: the closure argument for @write * @closure: the closure argument for @write
* @width_in_points: width of the surface, in points (1 point == 1/72.0 inch) * @width_in_points: width of the surface, in points (1 point == 1/72.0 inch)
* @height_in_points: height of the surface, in points (1 point == 1/72.0 inch) * @height_in_points: height of the surface, in points (1 point == 1/72.0 inch)
* *
* Creates a PostScript surface of the specified size in points to be * Creates a PostScript surface of the specified size in points to be
* written incrementally to the stream represented by @write and * written incrementally to the stream represented by @write and
* @closure. See cairo_ps_surface_create() for a more convenient way * @closure. See cairo_ps_surface_create() for a more convenient way
@ -525,7 +525,7 @@ _extract_ps_surface (cairo_surface_t *surface,
* @surface: a PostScript cairo_surface_t * @surface: a PostScript cairo_surface_t
* @x_dpi: horizontal dpi * @x_dpi: horizontal dpi
* @y_dpi: vertical dpi * @y_dpi: vertical dpi
* *
* Set the horizontal and vertical resolution for image fallbacks. * Set the horizontal and vertical resolution for image fallbacks.
* When the ps backend needs to fall back to image overlays, it will * When the ps backend needs to fall back to image overlays, it will
* use this resolution. These DPI values are not used for any other * use this resolution. These DPI values are not used for any other
@ -555,7 +555,7 @@ cairo_ps_surface_set_dpi (cairo_surface_t *surface,
* @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) * @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) * @height_in_points: new surface height, in points (1 point == 1/72.0 inch)
* *
* Changes the size of a PostScript surface for the current (and * Changes the size of a PostScript surface for the current (and
* subsequent) pages. * subsequent) pages.
* *
@ -587,7 +587,7 @@ cairo_ps_surface_set_size (cairo_surface_t *surface,
* cairo_ps_surface_dsc_comment: * 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 * @comment: a comment string to be emitted into the PostScript output
* *
* Emit a comment into the PostScript output for the given surface. * Emit a comment into the PostScript output for the given surface.
* *
* The comment is expected to conform to the PostScript Language * The comment is expected to conform to the PostScript Language
@ -714,13 +714,13 @@ cairo_ps_surface_dsc_comment (cairo_surface_t *surface,
/** /**
* cairo_ps_surface_dsc_begin_setup: * 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 * This function indicates that subsequent calls to
* cairo_ps_surface_dsc_comment() should direct comments to the Setup * cairo_ps_surface_dsc_comment() should direct comments to the Setup
* section of the PostScript output. * section of the PostScript output.
* *
* This function should be called at most once per surface, and must * This function should be called at most once per surface, and must
* be called before any call to cairo_ps_surface_dsc_begin_page_setup() * be called before any call to cairo_ps_surface_dsc_begin_page_setup()
* and before any drawing is performed to the surface. * and before any drawing is performed to the surface.
* *
* See cairo_ps_surface_dsc_comment() for more details. * See cairo_ps_surface_dsc_comment() for more details.
@ -746,7 +746,7 @@ cairo_ps_surface_dsc_begin_setup (cairo_surface_t *surface)
/** /**
* cairo_ps_surface_dsc_begin_setup: * 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 * This function indicates that subsequent calls to
* cairo_ps_surface_dsc_comment() should direct comments to the * cairo_ps_surface_dsc_comment() should direct comments to the
* PageSetup section of the PostScript output. * PageSetup section of the PostScript output.

6
src/cairo-region.c
View file

@ -38,10 +38,10 @@
/** /**
* _cairo_region_create_from_rectangle: * _cairo_region_create_from_rectangle:
* @rect: a #cairo_rectangle_fixed_t * @rect: a #cairo_rectangle_fixed_t
* *
* Creates a region with extents initialized from the given * Creates a region with extents initialized from the given
* rectangle. * rectangle.
* *
* Return value: a newly created #pixman_region16_t or %NULL if * Return value: a newly created #pixman_region16_t or %NULL if
* memory couldn't a allocated. * memory couldn't a allocated.
**/ **/
@ -66,7 +66,7 @@ _cairo_region_create_from_rectangle (cairo_rectangle_fixed_t *rect)
* _cairo_region_extents_rectangle: * _cairo_region_extents_rectangle:
* @region: a #pixman_region16_t * @region: a #pixman_region16_t
* @rect: rectangle into which to store the extents * @rect: rectangle into which to store the extents
* *
* Gets the bounding box of a region as a cairo_rectangle_fixed_t * Gets the bounding box of a region as a cairo_rectangle_fixed_t
**/ **/
void void

12
src/cairo-scaled-font-subsets-private.h
View file

@ -58,14 +58,14 @@ typedef struct _cairo_scaled_font_subset {
* @max_glyphs_per_subset: the maximum number of glyphs that should * @max_glyphs_per_subset: the maximum number of glyphs that should
* appear in any subset. A value of 0 indicates that there is no limit * appear in any subset. A value of 0 indicates that there is no limit
* to the number of glyphs per subset. * to the number of glyphs per subset.
* *
* Create a new #cairo_scaled_font_subsets_t object which can be used * 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 * objects. This allows the (arbitrarily large and sparse) glyph
* indices of a cairo_scaled_font to be mapped to one or more font * indices of a cairo_scaled_font to be mapped to one or more font
* subsets with glyph indices packed into the range * subsets with glyph indices packed into the range
* [0 .. max_glyphs_per_subset). * [0 .. max_glyphs_per_subset).
* *
* Return value: a pointer to the newly creates font subsets. The * Return value: a pointer to the newly creates font subsets. The
* caller owns this object and should call * caller owns this object and should call
* _cairo_scaled_font_subsets_destroy() when done with it. * _cairo_scaled_font_subsets_destroy() when done with it.
@ -76,7 +76,7 @@ _cairo_scaled_font_subsets_create (int max_glyphs_per_subset);
/** /**
* _cairo_scaled_font_subsets_destroy: * _cairo_scaled_font_subsets_destroy:
* @font_subsets: a #cairo_scaled_font_subsets_t object to be destroyed * @font_subsets: a #cairo_scaled_font_subsets_t object to be destroyed
* *
* Destroys @font_subsets and all resources associated with it. * Destroys @font_subsets and all resources associated with it.
**/ **/
cairo_private void cairo_private void
@ -90,7 +90,7 @@ _cairo_scaled_font_subsets_destroy (cairo_scaled_font_subsets_t *font_subsets);
* @font_id_ret: return value giving the font ID of the mapped glyph * @font_id_ret: return value giving the font ID of the mapped glyph
* @subset_id_ret: return value giving the subset ID of the mapped glyph within the @font_id_ret * @subset_id_ret: return value giving the subset ID of the mapped glyph within the @font_id_ret
* @subset_glyph_index_ret: return value giving the index of the mapped glyph within the @subset_id_ret subset * @subset_glyph_index_ret: return value giving the index of the mapped glyph within the @subset_id_ret subset
* *
* Map a glyph from a #cairo_scaled_font to a new index within a * Map a glyph from a #cairo_scaled_font to a new index within a
* subset of that font. The mapping performed is from the tuple: * subset of that font. The mapping performed is from the tuple:
* *
@ -149,7 +149,7 @@ typedef void
* @font_subsets: a #cairo_scaled_font_subsets_t * @font_subsets: a #cairo_scaled_font_subsets_t
* @font_subset_callback: a function to be called for each font subset * @font_subset_callback: a function to be called for each font subset
* @closure: closure data for the callback function * @closure: closure data for the callback function
* *
* Iterate over each unique font subset as created by calls to * Iterate over each unique font subset as created by calls to
* _cairo_scaled_font_subsets_map_glyph(). A subset is determined by * _cairo_scaled_font_subsets_map_glyph(). A subset is determined by
* unique pairs of (font_id, subset_id) as returned by * unique pairs of (font_id, subset_id) as returned by
@ -169,7 +169,7 @@ typedef void
* returned by _cairo_scaled_font_subsets_map_glyph() while the * returned by _cairo_scaled_font_subsets_map_glyph() while the
* values of the array correspond to the scaled_font_glyph_index * values of the array correspond to the scaled_font_glyph_index
* values passed as input to the same function. * values passed as input to the same function.
* *
* Return value: CAIRO_STATUS_SUCCESS if successful, or a non-zero * Return value: CAIRO_STATUS_SUCCESS if successful, or a non-zero
* value indicating an error. Possible errors include * value indicating an error. Possible errors include
* CAIRO_STATUS_NO_MEMORY. * CAIRO_STATUS_NO_MEMORY.

38
src/cairo-scaled-font.c
View file

@ -94,7 +94,7 @@ static const cairo_scaled_font_t _cairo_scaled_font_nil = {
* @scaled_font: a scaled_font * @scaled_font: a scaled_font
* @status: a status value indicating an error, (eg. not * @status: a status value indicating an error, (eg. not
* CAIRO_STATUS_SUCCESS) * CAIRO_STATUS_SUCCESS)
* *
* Sets scaled_font->status to @status and calls _cairo_error; * Sets scaled_font->status to @status and calls _cairo_error;
* *
* All assignments of an error status to scaled_font->status should happen * All assignments of an error status to scaled_font->status should happen
@ -121,7 +121,7 @@ _cairo_scaled_font_set_error (cairo_scaled_font_t *scaled_font,
/** /**
* cairo_scaled_font_get_type: * cairo_scaled_font_get_type:
* @scaled_font: a #cairo_scaled_font_t * @scaled_font: a #cairo_scaled_font_t
* *
* Return value: The type of @scaled_font. See #cairo_font_type_t. * Return value: The type of @scaled_font. See #cairo_font_type_t.
**/ **/
cairo_font_type_t cairo_font_type_t
@ -133,10 +133,10 @@ cairo_scaled_font_get_type (cairo_scaled_font_t *scaled_font)
/** /**
* cairo_scaled_font_status: * cairo_scaled_font_status:
* @scaled_font: a #cairo_scaled_font_t * @scaled_font: a #cairo_scaled_font_t
* *
* Checks whether an error has previously occurred for this * Checks whether an error has previously occurred for this
* scaled_font. * scaled_font.
* *
* Return value: %CAIRO_STATUS_SUCCESS or another error such as * Return value: %CAIRO_STATUS_SUCCESS or another error such as
* %CAIRO_STATUS_NO_MEMORY. * %CAIRO_STATUS_NO_MEMORY.
**/ **/
@ -247,7 +247,7 @@ _cairo_scaled_font_map_destroy (void)
} }
/* Fowler / Noll / Vo (FNV) Hash (http://www.isthe.com/chongo/tech/comp/fnv/) /* Fowler / Noll / Vo (FNV) Hash (http://www.isthe.com/chongo/tech/comp/fnv/)
* *
* Not necessarily better than a lot of other hashes, but should be OK, and * Not necessarily better than a lot of other hashes, but should be OK, and
* well tested with binary data. * well tested with binary data.
*/ */
@ -358,7 +358,7 @@ _cairo_scaled_font_set_metrics (cairo_scaled_font_t *scaled_font,
&font_scale_x, &font_scale_y, &font_scale_x, &font_scale_y,
/* XXX */ 1); /* XXX */ 1);
/* /*
* The font responded in unscaled units, scale by the font * The font responded in unscaled units, scale by the font
* matrix scale factors to get to user space * matrix scale factors to get to user space
*/ */
@ -399,11 +399,11 @@ _cairo_scaled_font_fini (cairo_scaled_font_t *scaled_font)
* be used. * be used.
* @options: options to use when getting metrics for the font and * @options: options to use when getting metrics for the font and
* rendering with it. * rendering with it.
* *
* Creates a #cairo_scaled_font_t object from a font face and matrices that * Creates a #cairo_scaled_font_t object from a font face and matrices that
* describe the size of the font and the environment in which it will * describe the size of the font and the environment in which it will
* be used. * be used.
* *
* Return value: a newly created #cairo_scaled_font_t. Destroy with * Return value: a newly created #cairo_scaled_font_t. Destroy with
* cairo_scaled_font_destroy() * cairo_scaled_font_destroy()
**/ **/
@ -466,7 +466,7 @@ UNWIND:
* cairo_scaled_font_reference: * cairo_scaled_font_reference:
* @scaled_font: a #cairo_scaled_font_t, (may be NULL in which case * @scaled_font: a #cairo_scaled_font_t, (may be NULL in which case
* this function does nothing) * this function does nothing)
* *
* Increases the reference count on @scaled_font by one. This prevents * Increases the reference count on @scaled_font by one. This prevents
* @scaled_font from being destroyed until a matching call to * @scaled_font from being destroyed until a matching call to
* cairo_scaled_font_destroy() is made. * cairo_scaled_font_destroy() is made.
@ -523,7 +523,7 @@ cairo_scaled_font_reference (cairo_scaled_font_t *scaled_font)
/** /**
* cairo_scaled_font_destroy: * cairo_scaled_font_destroy:
* @scaled_font: a #cairo_scaled_font_t * @scaled_font: a #cairo_scaled_font_t
* *
* Decreases the reference count on @font by one. If the result * Decreases the reference count on @font by one. If the result
* is zero, then @font and all associated resources are freed. * is zero, then @font and all associated resources are freed.
* See cairo_scaled_font_reference(). * See cairo_scaled_font_reference().
@ -586,8 +586,8 @@ cairo_scaled_font_destroy (cairo_scaled_font_t *scaled_font)
* cairo_scaled_font_extents: * cairo_scaled_font_extents:
* @scaled_font: a #cairo_scaled_font_t * @scaled_font: a #cairo_scaled_font_t
* @extents: a #cairo_font_extents_t which to store the retrieved extents. * @extents: a #cairo_font_extents_t which to store the retrieved extents.
* *
* Gets the metrics for a #cairo_scaled_font_t. * Gets the metrics for a #cairo_scaled_font_t.
**/ **/
void void
cairo_scaled_font_extents (cairo_scaled_font_t *scaled_font, cairo_scaled_font_extents (cairo_scaled_font_t *scaled_font,
@ -1062,9 +1062,9 @@ _cairo_scaled_font_glyph_path (cairo_scaled_font_t *scaled_font,
* @scaled_glyph: a #cairo_scaled_glyph_t * @scaled_glyph: a #cairo_scaled_glyph_t
* @scaled_font: a #cairo_scaled_font_t * @scaled_font: a #cairo_scaled_font_t
* @fs_metrics: a #cairo_text_extents_t in font space * @fs_metrics: a #cairo_text_extents_t in font space
* *
* _cairo_scaled_glyph_set_metrics() stores user space metrics * _cairo_scaled_glyph_set_metrics() stores user space metrics
* for the specified glyph given font space metrics. It is * for the specified glyph given font space metrics. It is
* called by the font backend when initializing a glyph with * called by the font backend when initializing a glyph with
* CAIRO_SCALED_GLYPH_INFO_METRICS. * CAIRO_SCALED_GLYPH_INFO_METRICS.
**/ **/
@ -1159,7 +1159,7 @@ _cairo_scaled_glyph_set_path (cairo_scaled_glyph_t *scaled_glyph,
* the glyph should be filled in. * the glyph should be filled in.
* @scaled_glyph_ret: a #cairo_scaled_glyph_t * where the glyph * @scaled_glyph_ret: a #cairo_scaled_glyph_t * where the glyph
* is returned. * is returned.
* *
* Returns a glyph with the requested portions filled in. Glyph * Returns a glyph with the requested portions filled in. Glyph
* lookup is cached and glyph will be automatically freed along * lookup is cached and glyph will be automatically freed along
* with the scaled_font so no explicit free is required. * with the scaled_font so no explicit free is required.
@ -1260,7 +1260,7 @@ _cairo_scaled_glyph_lookup (cairo_scaled_font_t *scaled_font,
/** /**
* cairo_scaled_font_get_font_face: * cairo_scaled_font_get_font_face:
* @scaled_font: a #cairo_scaled_font_t * @scaled_font: a #cairo_scaled_font_t
* *
* Return value: The #cairo_font_face_t with which @scaled_font was * Return value: The #cairo_font_face_t with which @scaled_font was
* created. * created.
**/ **/
@ -1277,7 +1277,7 @@ cairo_scaled_font_get_font_face (cairo_scaled_font_t *scaled_font)
* cairo_scaled_font_get_font_matrix: * cairo_scaled_font_get_font_matrix:
* @scaled_font: a #cairo_scaled_font_t * @scaled_font: a #cairo_scaled_font_t
* @font_matrix: return value for the matrix * @font_matrix: return value for the matrix
* *
* Stores the font matrix with which @scaled_font was created into * Stores the font matrix with which @scaled_font was created into
* @matrix. * @matrix.
**/ **/
@ -1297,7 +1297,7 @@ cairo_scaled_font_get_font_matrix (cairo_scaled_font_t *scaled_font,
* cairo_scaled_font_get_ctm: * cairo_scaled_font_get_ctm:
* @scaled_font: a #cairo_scaled_font_t * @scaled_font: a #cairo_scaled_font_t
* @ctm: return value for the CTM * @ctm: return value for the CTM
* *
* Stores the CTM with which @scaled_font was created into @ctm. * Stores the CTM with which @scaled_font was created into @ctm.
**/ **/
void void
@ -1316,7 +1316,7 @@ cairo_scaled_font_get_ctm (cairo_scaled_font_t *scaled_font,
* cairo_scaled_font_get_font_options: * cairo_scaled_font_get_font_options:
* @scaled_font: a #cairo_scaled_font_t * @scaled_font: a #cairo_scaled_font_t
* @options: return value for the font options * @options: return value for the font options
* *
* Stores the font options with which @scaled_font was created into * Stores the font options with which @scaled_font was created into
* @ctm. * @ctm.
**/ **/

6
src/cairo-surface-fallback.c
View file

@ -48,10 +48,10 @@ typedef struct {
/** /**
* _fallback_init: * _fallback_init:
* *
* Acquire destination image surface needed for an image-based * Acquire destination image surface needed for an image-based
* fallback. * fallback.
* *
* Return value: CAIRO_INT_STATUS_NOTHING_TO_DO if the extents are not * Return value: CAIRO_INT_STATUS_NOTHING_TO_DO if the extents are not
* visible, CAIRO_STATUS_SUCCESS if some portion is visible and all * visible, CAIRO_STATUS_SUCCESS if some portion is visible and all
* went well, or some error status otherwise. * went well, or some error status otherwise.
@ -343,7 +343,7 @@ _cairo_rectangle_empty (const cairo_rectangle_fixed_t *rect)
* *
* @draw_func is to called to draw the mask; it will be called no more * @draw_func is to called to draw the mask; it will be called no more
* than once. * than once.
* *
* Return value: %CAIRO_STATUS_SUCCESS if the drawing succeeded. * Return value: %CAIRO_STATUS_SUCCESS if the drawing succeeded.
**/ **/
static cairo_status_t static cairo_status_t

68
src/cairo-surface.c
View file

@ -108,7 +108,7 @@ static void _cairo_surface_copy_pattern_for_destination (const cairo_pattern_t *
* @surface: a surface * @surface: a surface
* @status: a status value indicating an error, (eg. not * @status: a status value indicating an error, (eg. not
* CAIRO_STATUS_SUCCESS) * CAIRO_STATUS_SUCCESS)
* *
* Sets surface->status to @status and calls _cairo_error; * Sets surface->status to @status and calls _cairo_error;
* *
* All assignments of an error status to surface->status should happen * All assignments of an error status to surface->status should happen
@ -135,7 +135,7 @@ _cairo_surface_set_error (cairo_surface_t *surface,
/** /**
* cairo_surface_get_type: * cairo_surface_get_type:
* @surface: a #cairo_surface_t * @surface: a #cairo_surface_t
* *
* Return value: The type of @surface. See #cairo_surface_type_t. * Return value: The type of @surface. See #cairo_surface_type_t.
**/ **/
cairo_surface_type_t cairo_surface_type_t
@ -151,7 +151,7 @@ cairo_surface_get_type (cairo_surface_t *surface)
/** /**
* cairo_surface_get_content: * cairo_surface_get_content:
* @surface: a #cairo_surface_t * @surface: a #cairo_surface_t
* *
* Return value: The content type of @surface which indicates whether * Return value: The content type of @surface which indicates whether
* the surface contains color and/or alpha information. See * the surface contains color and/or alpha information. See
* #cairo_content_t. * #cairo_content_t.
@ -165,10 +165,10 @@ cairo_surface_get_content (cairo_surface_t *surface)
/** /**
* cairo_surface_status: * cairo_surface_status:
* @surface: a #cairo_surface_t * @surface: a #cairo_surface_t
* *
* Checks whether an error has previously occurred for this * Checks whether an error has previously occurred for this
* surface. * surface.
* *
* Return value: %CAIRO_STATUS_SUCCESS, %CAIRO_STATUS_NULL_POINTER, * Return value: %CAIRO_STATUS_SUCCESS, %CAIRO_STATUS_NULL_POINTER,
* %CAIRO_STATUS_NO_MEMORY, %CAIRO_STATUS_READ_ERROR, * %CAIRO_STATUS_NO_MEMORY, %CAIRO_STATUS_READ_ERROR,
* %CAIRO_STATUS_INVALID_CONTENT, %CAIRO_STATUS_INVALUE_FORMAT, or * %CAIRO_STATUS_INVALID_CONTENT, %CAIRO_STATUS_INVALUE_FORMAT, or
@ -230,12 +230,12 @@ _cairo_surface_create_similar_scratch (cairo_surface_t *other,
* @content: the content for the new surface * @content: the content for the new surface
* @width: width of the new surface, (in device-space units) * @width: width of the new surface, (in device-space units)
* @height: height of the new surface (in device-space units) * @height: height of the new surface (in device-space units)
* *
* Create a new surface that is as compatible as possible with an * Create a new surface that is as compatible as possible with an
* existing surface. The new surface will use the same backend as * existing surface. The new surface will use the same backend as
* @other unless that is not possible for some reason. The type of the * @other unless that is not possible for some reason. The type of the
* returned surface may be examined with cairo_surface_get_type(). * returned surface may be examined with cairo_surface_get_type().
* *
* Return value: a pointer to the newly allocated surface. The caller * Return value: a pointer to the newly allocated surface. The caller
* owns the surface and should call cairo_surface_destroy when done * owns the surface and should call cairo_surface_destroy when done
* with it. * with it.
@ -318,7 +318,7 @@ _cairo_surface_get_clip_mode (cairo_surface_t *surface)
/** /**
* cairo_surface_reference: * cairo_surface_reference:
* @surface: a #cairo_surface_t * @surface: a #cairo_surface_t
* *
* Increases the reference count on @surface by one. This prevents * Increases the reference count on @surface by one. This prevents
* @surface from being destroyed until a matching call to * @surface from being destroyed until a matching call to
* cairo_surface_destroy() is made. * cairo_surface_destroy() is made.
@ -344,7 +344,7 @@ cairo_surface_reference (cairo_surface_t *surface)
/** /**
* cairo_surface_destroy: * cairo_surface_destroy:
* @surface: a #cairo_t * @surface: a #cairo_t
* *
* Decreases the reference count on @surface by one. If the result is * Decreases the reference count on @surface by one. If the result is
* zero, then @surface and all associated resources are freed. See * zero, then @surface and all associated resources are freed. See
* cairo_surface_reference(). * cairo_surface_reference().
@ -375,7 +375,7 @@ slim_hidden_def(cairo_surface_destroy);
/** /**
* cairo_surface_finish: * cairo_surface_finish:
* @surface: the #cairo_surface_t to finish * @surface: the #cairo_surface_t to finish
* *
* This function finishes the surface and drops all references to * This function finishes the surface and drops all references to
* external resources. For example, for the Xlib backend it means * external resources. For example, for the Xlib backend it means
* that cairo will no longer access the drawable, which can be freed. * that cairo will no longer access the drawable, which can be freed.
@ -427,11 +427,11 @@ cairo_surface_finish (cairo_surface_t *surface)
* @surface: a #cairo_surface_t * @surface: a #cairo_surface_t
* @key: the address of the #cairo_user_data_key_t the user data was * @key: the address of the #cairo_user_data_key_t the user data was
* attached to * attached to
* *
* Return user data previously attached to @surface using the specified * Return user data previously attached to @surface using the specified
* key. If no user data has been attached with the given key this * key. If no user data has been attached with the given key this
* function returns %NULL. * function returns %NULL.
* *
* Return value: the user data previously attached or %NULL. * Return value: the user data previously attached or %NULL.
**/ **/
void * void *
@ -450,7 +450,7 @@ cairo_surface_get_user_data (cairo_surface_t *surface,
* @destroy: a #cairo_destroy_func_t which will be called when the * @destroy: a #cairo_destroy_func_t which will be called when the
* surface is destroyed or when new user data is attached using the * surface is destroyed or when new user data is attached using the
* same key. * same key.
* *
* Attach user data to @surface. To remove user data from a surface, * Attach user data to @surface. To remove user data from a surface,
* call this function with the key that was used to set it and %NULL * call this function with the key that was used to set it and %NULL
* for @data. * for @data.
@ -476,7 +476,7 @@ cairo_surface_set_user_data (cairo_surface_t *surface,
* @surface: a #cairo_surface_t * @surface: a #cairo_surface_t
* @options: a #cairo_font_options_t object into which to store * @options: a #cairo_font_options_t object into which to store
* the retrieved options. All existing values are overwritten * the retrieved options. All existing values are overwritten
* *
* Retrieves the default font rendering options for the surface. * Retrieves the default font rendering options for the surface.
* This allows display surfaces to report the correct subpixel order * This allows display surfaces to report the correct subpixel order
* for rendering on them, print surfaces to disable hinting of * for rendering on them, print surfaces to disable hinting of
@ -497,7 +497,7 @@ cairo_surface_get_font_options (cairo_surface_t *surface,
/** /**
* cairo_surface_flush: * cairo_surface_flush:
* @surface: a #cairo_surface_t * @surface: a #cairo_surface_t
* *
* Do any pending drawing for the surface and also restore any * Do any pending drawing for the surface and also restore any
* temporary modification's cairo has made to the surface's * temporary modification's cairo has made to the surface's
* state. This function must be called before switching from * state. This function must be called before switching from
@ -600,7 +600,7 @@ cairo_surface_mark_dirty_rectangle (cairo_surface_t *surface,
* @surface: a #cairo_surface_t * @surface: a #cairo_surface_t
* @x_offset: the offset in the X direction, in device units * @x_offset: the offset in the X direction, in device units
* @y_offset: the offset in the Y direction, in device units * @y_offset: the offset in the Y direction, in device units
* *
* Sets an offset that is added to the device coordinates determined * Sets an offset that is added to the device coordinates determined
* by the CTM when drawing to @surface. One use case for this function * by the CTM when drawing to @surface. One use case for this function
* is when we want to create a #cairo_surface_t that redirects drawing * is when we want to create a #cairo_surface_t that redirects drawing
@ -666,11 +666,11 @@ _cairo_surface_has_device_offset_or_scale (cairo_surface_t *surface)
* itself, a surface held internal to @surface, or it could be a new * itself, a surface held internal to @surface, or it could be a new
* surface with a copy of the relevant portion of @surface. * surface with a copy of the relevant portion of @surface.
* @image_extra: location to store image specific backend data * @image_extra: location to store image specific backend data
* *
* Gets an image surface to use when drawing as a fallback when drawing with * Gets an image surface to use when drawing as a fallback when drawing with
* @surface as a source. _cairo_surface_release_source_image() must be called * @surface as a source. _cairo_surface_release_source_image() must be called
* when finished. * when finished.
* *
* Return value: %CAIRO_STATUS_SUCCESS if a an image was stored in @image_out. * Return value: %CAIRO_STATUS_SUCCESS if a an image was stored in @image_out.
* %CAIRO_INT_STATUS_UNSUPPORTED if an image cannot be retrieved for the specified * %CAIRO_INT_STATUS_UNSUPPORTED if an image cannot be retrieved for the specified
* surface. Or %CAIRO_STATUS_NO_MEMORY. * surface. Or %CAIRO_STATUS_NO_MEMORY.
@ -690,7 +690,7 @@ _cairo_surface_acquire_source_image (cairo_surface_t *surface,
* _cairo_surface_release_source_image: * _cairo_surface_release_source_image:
* @surface: a #cairo_surface_t * @surface: a #cairo_surface_t
* @image_extra: same as return from the matching _cairo_surface_acquire_source_image() * @image_extra: same as return from the matching _cairo_surface_acquire_source_image()
* *
* Releases any resources obtained with _cairo_surface_acquire_source_image() * Releases any resources obtained with _cairo_surface_acquire_source_image()
**/ **/
void void
@ -716,10 +716,10 @@ _cairo_surface_release_source_image (cairo_surface_t *surface,
* or it could be a new surface with a copy of the relevant portion of @surface. * or it could be a new surface with a copy of the relevant portion of @surface.
* If a new surface is created, it should have the same channels and depth * If a new surface is created, it should have the same channels and depth
* as @surface so that copying to and from it is exact. * as @surface so that copying to and from it is exact.
* @image_rect: location to store area of the original surface occupied * @image_rect: location to store area of the original surface occupied
* by the surface stored in @image. * by the surface stored in @image.
* @image_extra: location to store image specific backend data * @image_extra: location to store image specific backend data
* *
* Retrieves a local image for a surface for implementing a fallback drawing * Retrieves a local image for a surface for implementing a fallback drawing
* operation. After calling this function, the implementation of the fallback * operation. After calling this function, the implementation of the fallback
* drawing operation draws the primitive to the surface stored in @image_out * drawing operation draws the primitive to the surface stored in @image_out
@ -756,7 +756,7 @@ _cairo_surface_acquire_dest_image (cairo_surface_t *surface,
* @image: same as returned from the matching _cairo_surface_acquire_dest_image() * @image: same as returned from the matching _cairo_surface_acquire_dest_image()
* @image_rect: same as returned from the matching _cairo_surface_acquire_dest_image() * @image_rect: same as returned from the matching _cairo_surface_acquire_dest_image()
* @image_extra: same as return from the matching _cairo_surface_acquire_dest_image() * @image_extra: same as return from the matching _cairo_surface_acquire_dest_image()
* *
* Finishes the operation started with _cairo_surface_acquire_dest_image(), by, if * Finishes the operation started with _cairo_surface_acquire_dest_image(), by, if
* necessary, copying the image from @image back to @surface and freeing any * necessary, copying the image from @image back to @surface and freeing any
* resources that were allocated. * resources that were allocated.
@ -782,11 +782,11 @@ _cairo_surface_release_dest_image (cairo_surface_t *surface,
* @clone_out: location to store a surface compatible with @surface * @clone_out: location to store a surface compatible with @surface
* and with contents identical to @src. The caller must call * and with contents identical to @src. The caller must call
* cairo_surface_destroy() on the result. * cairo_surface_destroy() on the result.
* *
* Creates a surface with contents identical to @src but that * Creates a surface with contents identical to @src but that
* can be used efficiently with @surface. If @surface and @src are * can be used efficiently with @surface. If @surface and @src are
* already compatible then it may return a new reference to @src. * already compatible then it may return a new reference to @src.
* *
* Return value: %CAIRO_STATUS_SUCCESS if a surface was created and stored * Return value: %CAIRO_STATUS_SUCCESS if a surface was created and stored
* in @clone_out. Otherwise %CAIRO_INT_STATUS_UNSUPPORTED or another * in @clone_out. Otherwise %CAIRO_INT_STATUS_UNSUPPORTED or another
* error like %CAIRO_STATUS_NO_MEMORY. * error like %CAIRO_STATUS_NO_MEMORY.
@ -923,10 +923,10 @@ _cairo_surface_composite (cairo_operator_t op,
* @y: Y coordinate of rectangle, in backend coordinates * @y: Y coordinate of rectangle, in backend coordinates
* @width: width of rectangle, in backend coordinates * @width: width of rectangle, in backend coordinates
* @height: height of rectangle, in backend coordinates * @height: height of rectangle, in backend coordinates
* *
* Applies an operator to a rectangle using a solid color as the source. * Applies an operator to a rectangle using a solid color as the source.
* See _cairo_surface_fill_rectangles() for full details. * See _cairo_surface_fill_rectangles() for full details.
* *
* Return value: %CAIRO_STATUS_SUCCESS or the error that occurred * Return value: %CAIRO_STATUS_SUCCESS or the error that occurred
**/ **/
cairo_status_t cairo_status_t
@ -962,11 +962,11 @@ _cairo_surface_fill_rectangle (cairo_surface_t *surface,
* @op: the operator to apply to the region * @op: the operator to apply to the region
* @color: the source color * @color: the source color
* @region: the region to modify, in backend coordinates * @region: the region to modify, in backend coordinates
* *
* Applies an operator to a set of rectangles specified as a * Applies an operator to a set of rectangles specified as a
* #pixman_region16_t using a solid color as the source. * #pixman_region16_t using a solid color as the source.
* See _cairo_surface_fill_rectangles() for full details. * See _cairo_surface_fill_rectangles() for full details.
* *
* Return value: %CAIRO_STATUS_SUCCESS or the error that occurred * Return value: %CAIRO_STATUS_SUCCESS or the error that occurred
**/ **/
cairo_status_t cairo_status_t
@ -1012,13 +1012,13 @@ _cairo_surface_fill_region (cairo_surface_t *surface,
* @color: the source color * @color: the source color
* @rects: the rectangles to modify, in backend coordinates * @rects: the rectangles to modify, in backend coordinates
* @num_rects: the number of rectangles in @rects * @num_rects: the number of rectangles in @rects
* *
* Applies an operator to a set of rectangles using a solid color * Applies an operator to a set of rectangles using a solid color
* as the source. Note that even if the operator is an unbounded operator * as the source. Note that even if the operator is an unbounded operator
* such as %CAIRO_OPERATOR_IN, only the given set of rectangles * such as %CAIRO_OPERATOR_IN, only the given set of rectangles
* is affected. This differs from _cairo_surface_composite_trapezoids() * is affected. This differs from _cairo_surface_composite_trapezoids()
* where the entire destination rectangle is cleared. * where the entire destination rectangle is cleared.
* *
* Return value: %CAIRO_STATUS_SUCCESS or the error that occurred * Return value: %CAIRO_STATUS_SUCCESS or the error that occurred
**/ **/
cairo_status_t cairo_status_t
@ -1460,7 +1460,7 @@ _cairo_surface_set_clip_path_recursive (cairo_surface_t *surface,
* @surface: the #cairo_surface_t to set the clip on * @surface: the #cairo_surface_t to set the clip on
* @clip_path: the clip path to set * @clip_path: the clip path to set
* @serial: the clip serial number associated with the clip path * @serial: the clip serial number associated with the clip path
* *
* Sets the given clipping path for the surface and assigns the * Sets the given clipping path for the surface and assigns the
* clipping serial to the surface. * clipping serial to the surface.
**/ **/
@ -1542,7 +1542,7 @@ _cairo_surface_set_clip (cairo_surface_t *surface, cairo_clip_t *clip)
* *
* This function returns a bounding box for the surface. The * This function returns a bounding box for the surface. The
* surface bounds are defined as a region beyond which no * surface bounds are defined as a region beyond which no
* rendering will possibly be recorded, in otherwords, * rendering will possibly be recorded, in otherwords,
* it is the maximum extent of potentially usable * it is the maximum extent of potentially usable
* coordinates. For simple pixel-based surfaces, * coordinates. For simple pixel-based surfaces,
* it can be a close bound on the retained pixel * it can be a close bound on the retained pixel
@ -1743,7 +1743,7 @@ _cairo_surface_composite_fixup_unbounded_internal (cairo_surface_t *dst,
* @dst_y: @dst_y from _cairo_surface_composite() * @dst_y: @dst_y from _cairo_surface_composite()
* @width: @width from _cairo_surface_composite() * @width: @width from _cairo_surface_composite()
* @height: @height_x from _cairo_surface_composite() * @height: @height_x from _cairo_surface_composite()
* *
* Eeek! Too many parameters! This is a helper function to take care of fixing * Eeek! Too many parameters! This is a helper function to take care of fixing
* up for bugs in libpixman and RENDER where, when asked to composite an * up for bugs in libpixman and RENDER where, when asked to composite an
* untransformed surface with an unbounded operator (like CLEAR or SOURCE) * untransformed surface with an unbounded operator (like CLEAR or SOURCE)
@ -1819,7 +1819,7 @@ _cairo_surface_composite_fixup_unbounded (cairo_surface_t *dst,
* @dst_y: @dst_y from _cairo_surface_composite() * @dst_y: @dst_y from _cairo_surface_composite()
* @width: @width from _cairo_surface_composite() * @width: @width from _cairo_surface_composite()
* @height: @height_x from _cairo_surface_composite() * @height: @height_x from _cairo_surface_composite()
* *
* Like _cairo_surface_composite_fixup_unbounded(), but instead of * Like _cairo_surface_composite_fixup_unbounded(), but instead of
* handling the case where we have a source pattern and a mask * handling the case where we have a source pattern and a mask
* pattern, handle the case where we are compositing a source pattern * pattern, handle the case where we are compositing a source pattern

18
src/cairo-svg-surface.c
View file

@ -169,7 +169,7 @@ static const cairo_paginated_surface_backend_t cairo_svg_surface_paginated_backe
* @closure: the closure argument for @write * @closure: the closure argument for @write
* @width_in_points: width of the surface, in points (1 point == 1/72.0 inch) * @width_in_points: width of the surface, in points (1 point == 1/72.0 inch)
* @height_in_points: height of the surface, in points (1 point == 1/72.0 inch) * @height_in_points: height of the surface, in points (1 point == 1/72.0 inch)
* *
* Creates a SVG surface of the specified size in points to be written * Creates a SVG surface of the specified size in points to be written
* incrementally to the stream represented by @write and @closure. * incrementally to the stream represented by @write and @closure.
* *
@ -205,10 +205,10 @@ cairo_svg_surface_create_for_stream (cairo_write_func_t write,
* @filename: a filename for the SVG output (must be writable) * @filename: a filename for the SVG output (must be writable)
* @width_in_points: width of the surface, in points (1 point == 1/72.0 inch) * @width_in_points: width of the surface, in points (1 point == 1/72.0 inch)
* @height_in_points: height of the surface, in points (1 point == 1/72.0 inch) * @height_in_points: height of the surface, in points (1 point == 1/72.0 inch)
* *
* Creates a SVG surface of the specified size in points to be written * Creates a SVG surface of the specified size in points to be written
* to @filename. * to @filename.
* *
* Return value: a pointer to the newly created surface. The caller * Return value: a pointer to the newly created surface. The caller
* owns the surface and should call cairo_surface_destroy when done * owns the surface and should call cairo_surface_destroy when done
* with it. * with it.
@ -270,7 +270,7 @@ _extract_svg_surface (cairo_surface_t *surface,
* @surface: a svg cairo_surface_t * @surface: a svg cairo_surface_t
* @x_dpi: horizontal dpi * @x_dpi: horizontal dpi
* @y_dpi: vertical dpi * @y_dpi: vertical dpi
* *
* Set the horizontal and vertical resolution for image fallbacks. * Set the horizontal and vertical resolution for image fallbacks.
* When the svg backend needs to fall back to image overlays, it will * When the svg backend needs to fall back to image overlays, it will
* use this resolution. These DPI values are not used for any other * use this resolution. These DPI values are not used for any other
@ -334,7 +334,7 @@ cairo_svg_surface_restrict_to_version (cairo_surface_t *abstract_surface,
* @version: supported version list * @version: supported version list
* @num_versions: list length * @num_versions: list length
* *
* Returns the list of supported versions. See * Returns the list of supported versions. See
* cairo_svg_surface_restrict_to_version(). * cairo_svg_surface_restrict_to_version().
**/ **/
@ -349,7 +349,7 @@ cairo_svg_get_versions (cairo_svg_version_t const **versions,
*num_versions = CAIRO_SVG_VERSION_LAST; *num_versions = CAIRO_SVG_VERSION_LAST;
} }
/** /**
* cairo_svg_version_to_string: * cairo_svg_version_to_string:
* @version: a version id * @version: a version id
* *
@ -406,7 +406,7 @@ _cairo_svg_surface_create_for_document (cairo_svg_document_t *document,
_cairo_dtostr (buffer, sizeof buffer, height); _cairo_dtostr (buffer, sizeof buffer, height);
xmlSetProp (rect, CC2XML ("height"), C2XML (buffer)); xmlSetProp (rect, CC2XML ("height"), C2XML (buffer));
/* Use of xlink namespace requires node to be linked to tree. /* Use of xlink namespace requires node to be linked to tree.
* So by default we link surface main node to document svg node. * So by default we link surface main node to document svg node.
* For surfaces that don't own document, their main node will be * For surfaces that don't own document, their main node will be
* unlinked and freed in surface finish. */ * unlinked and freed in surface finish. */
@ -1453,12 +1453,12 @@ _cairo_svg_surface_paint (void *abstract_surface,
/* Emulation of clear and source operators, when no clipping region /* Emulation of clear and source operators, when no clipping region
* is defined. We just delete existing content of surface root node, * is defined. We just delete existing content of surface root node,
* and exit early if operator is clear. * and exit early if operator is clear.
* XXX: optimization of SOURCE operator doesn't work, since analyze * XXX: optimization of SOURCE operator doesn't work, since analyze
* above always return FALSE. In order to make it work, we need a way * above always return FALSE. In order to make it work, we need a way
* to know if there's an active clipping path. * to know if there's an active clipping path.
* Optimization of CLEAR works because of a test in paginated surface, * Optimization of CLEAR works because of a test in paginated surface,
* and an optimiszation in meta surface. */ * and an optimiszation in meta surface. */
if (surface->clip_level == 0 && if (surface->clip_level == 0 &&
(op == CAIRO_OPERATOR_CLEAR || (op == CAIRO_OPERATOR_CLEAR ||
op == CAIRO_OPERATOR_SOURCE)) { op == CAIRO_OPERATOR_SOURCE)) {

2
src/cairo-svg.h
View file

@ -1,7 +1,7 @@
/* cairo - a vector graphics library with display and print output /* cairo - a vector graphics library with display and print output
* *
* cairo-svg.h * cairo-svg.h
* *
* Copyright © 2005 Emmanuel Pacaud <emmanuel.pacaud@univ-poitiers.fr> * Copyright © 2005 Emmanuel Pacaud <emmanuel.pacaud@univ-poitiers.fr>
* *
* This library is free software; you can redistribute it and/or * This library is free software; you can redistribute it and/or

8
src/cairo-traps.c
View file

@ -93,7 +93,7 @@ _cairo_traps_fini (cairo_traps_t *traps)
* @traps: a #cairo_traps_t * @traps: a #cairo_traps_t
* @box: a box that will be converted to a single trapezoid * @box: a box that will be converted to a single trapezoid
* to store in @traps. * 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. * trapezoid.
**/ **/
@ -577,7 +577,7 @@ _line_segs_intersect_ceil (cairo_line_t *l1, cairo_line_t *l2, cairo_fixed_t *y_
_cairo_int32_to_int64 (1)); _cairo_int32_to_int64 (1));
} }
/* /*
* Now convert from 32.32 to 48.16 and take the ceiling; * Now convert from 32.32 to 48.16 and take the ceiling;
* this requires adding in 15 1 bits and shifting the result * this requires adding in 15 1 bits and shifting the result
*/ */
@ -860,10 +860,10 @@ _cairo_traps_extents (cairo_traps_t *traps, cairo_box_t *extents)
* exactly representable as a pixman region, otherwise a * exactly representable as a pixman region, otherwise a
* a pointer to such a region, newly allocated. * a pointer to such a region, newly allocated.
* (free with pixman region destroy) * (free with pixman region destroy)
* *
* Determines if a set of trapezoids are exactly representable as a * Determines if a set of trapezoids are exactly representable as a
* pixman region, and if so creates such a region. * pixman region, and if so creates such a region.
* *
* Return value: %CAIRO_STATUS_SUCCESS or %CAIRO_STATUS_NO_MEMORY * Return value: %CAIRO_STATUS_SUCCESS or %CAIRO_STATUS_NO_MEMORY
**/ **/
cairo_status_t cairo_status_t

10
src/cairo-unicode.c
View file

@ -1,5 +1,5 @@
/* cairo_unicode.c: Unicode conversion routines /* cairo_unicode.c: Unicode conversion routines
* *
* The code in this file is derived from GLib's gutf8.c and * The code in this file is derived from GLib's gutf8.c and
* ultimately from libunicode. It is relicensed under the * ultimately from libunicode. It is relicensed under the
* dual LGPL/MPL with permission of the original authors. * dual LGPL/MPL with permission of the original authors.
@ -208,13 +208,13 @@ _utf8_get_char_extended (const unsigned char *p,
* @result: location to store a pointer to a newly allocated UTF-32 * @result: location to store a pointer to a newly allocated UTF-32
* string (always native endian). Free with free(). A 0 * string (always native endian). Free with free(). A 0
* word will be written after the last character. * word will be written after the last character.
* @items_written: location to store number of 32-bit words * @items_written: location to store number of 32-bit words
* written. (Not including the trailing 0) * written. (Not including the trailing 0)
* *
* Converts a UTF-8 string to UCS-4. UCS-4 is an encoding of Unicode * Converts a UTF-8 string to UCS-4. UCS-4 is an encoding of Unicode
* with 1 32-bit word per character. The string is validated to * with 1 32-bit word per character. The string is validated to
* consist entirely of valid Unicode characters. * consist entirely of valid Unicode characters.
* *
* Return value: %CAIRO_STATUS_SUCCESS if the entire string was * Return value: %CAIRO_STATUS_SUCCESS if the entire string was
* succesfully converted. %CAIRO_STATUS_INVALID_STRING if an * succesfully converted. %CAIRO_STATUS_INVALID_STRING if an
* an invalid sequence was found. * an invalid sequence was found.
@ -271,14 +271,14 @@ _cairo_utf8_to_ucs4 (const unsigned char *str,
* @result: location to store a pointer to a newly allocated UTF-16 * @result: location to store a pointer to a newly allocated UTF-16
* string (always native endian). Free with free(). A 0 * string (always native endian). Free with free(). A 0
* word will be written after the last character. * word will be written after the last character.
* @items_written: location to store number of 16-bit words * @items_written: location to store number of 16-bit words
* written. (Not including the trailing 0) * written. (Not including the trailing 0)
* *
* Converts a UTF-8 string to UTF-16. UTF-16 is an encoding of Unicode * Converts a UTF-8 string to UTF-16. UTF-16 is an encoding of Unicode
* where characters are represented either as a single 16-bit word, or * where characters are represented either as a single 16-bit word, or
* as a pair of 16-bit "surrogates". The string is validated to * as a pair of 16-bit "surrogates". The string is validated to
* consist entirely of valid Unicode characters. * consist entirely of valid Unicode characters.
* *
* Return value: %CAIRO_STATUS_SUCCESS if the entire string was * Return value: %CAIRO_STATUS_SUCCESS if the entire string was
* succesfully converted. %CAIRO_STATUS_INVALID_STRING if an * succesfully converted. %CAIRO_STATUS_INVALID_STRING if an
* an invalid sequence was found. * an invalid sequence was found.

14
src/cairo-win32-font.c
View file

@ -244,7 +244,7 @@ _win32_scaled_font_create (LOGFONTW *logfont,
* order in the Win32 font API, so we ignore those parts of * order in the Win32 font API, so we ignore those parts of
* cairo_font_options_t. We use the 'antialias' field to set * cairo_font_options_t. We use the 'antialias' field to set
* the 'quality'. * the 'quality'.
* *
* XXX: The other option we could pay attention to, but don't * XXX: The other option we could pay attention to, but don't
* here is the hint_metrics options. * here is the hint_metrics options.
*/ */
@ -1151,7 +1151,7 @@ _cairo_win32_scaled_font_show_glyphs (void *abstract_font,
return status; return status;
} else { } else {
/* Otherwise, we need to draw using software fallbacks. We create a mask /* Otherwise, we need to draw using software fallbacks. We create a mask
* surface by drawing the the glyphs onto a DIB, black-on-white then * surface by drawing the the glyphs onto a DIB, black-on-white then
* inverting. GDI outputs gamma-corrected images so inverted black-on-white * inverting. GDI outputs gamma-corrected images so inverted black-on-white
* is very different from white-on-black. We favor the more common * is very different from white-on-black. We favor the more common
@ -1414,7 +1414,7 @@ static const cairo_font_face_backend_t _cairo_win32_font_face_backend = {
* @logfont: A #LOGFONTW structure specifying the font to use. * @logfont: A #LOGFONTW structure specifying the font to use.
* The lfHeight, lfWidth, lfOrientation and lfEscapement * The lfHeight, lfWidth, lfOrientation and lfEscapement
* fields of this structure are ignored. * fields of this structure are ignored.
* *
* Creates a new font for the Win32 font backend based on a * Creates a new font for the Win32 font backend based on a
* #LOGFONT. This font can then be used with * #LOGFONT. This font can then be used with
* cairo_set_font_face() or cairo_font_create(). The #cairo_scaled_font_t * cairo_set_font_face() or cairo_font_create(). The #cairo_scaled_font_t
@ -1481,7 +1481,7 @@ cairo_win32_font_face_create_for_hfont (HFONT font)
* *
* Normally, calls to SaveDC() and RestoreDC() would be made around * Normally, calls to SaveDC() and RestoreDC() would be made around
* the use of this function to preserve the original graphics state. * the use of this function to preserve the original graphics state.
* *
* Return value: %CAIRO_STATUS_SUCCESS if the operation succeeded. * Return value: %CAIRO_STATUS_SUCCESS if the operation succeeded.
* otherwise an error such as %CAIRO_STATUS_NO_MEMORY and * otherwise an error such as %CAIRO_STATUS_NO_MEMORY and
* the device context is unchanged. * the device context is unchanged.
@ -1528,7 +1528,7 @@ cairo_win32_scaled_font_select_font (cairo_scaled_font_t *scaled_font,
/** /**
* cairo_win32_scaled_font_done_font: * cairo_win32_scaled_font_done_font:
* @scaled_font: A #cairo_scaled_font_t from the Win32 font backend. * @scaled_font: A #cairo_scaled_font_t from the Win32 font backend.
* *
* Releases any resources allocated by cairo_win32_scaled_font_select_font() * Releases any resources allocated by cairo_win32_scaled_font_select_font()
**/ **/
void void
@ -1539,12 +1539,12 @@ cairo_win32_scaled_font_done_font (cairo_scaled_font_t *scaled_font)
/** /**
* cairo_win32_scaled_font_get_metrics_factor: * cairo_win32_scaled_font_get_metrics_factor:
* @scaled_font: a #cairo_scaled_font_t from the Win32 font backend * @scaled_font: a #cairo_scaled_font_t from the Win32 font backend
* *
* Gets a scale factor between logical coordinates in the coordinate * Gets a scale factor between logical coordinates in the coordinate
* space used by cairo_win32_scaled_font_select_font() (that is, the * space used by cairo_win32_scaled_font_select_font() (that is, the
* coordinate system used by the Windows functions to return metrics) and * coordinate system used by the Windows functions to return metrics) and
* font space coordinates. * font space coordinates.
* *
* Return value: factor to multiply logical units by to get font space * Return value: factor to multiply logical units by to get font space
* coordinates. * coordinates.
**/ **/

16
src/cairo-win32-surface.c
View file

@ -53,7 +53,7 @@ static const cairo_surface_backend_t cairo_win32_surface_backend;
/** /**
* _cairo_win32_print_gdi_error: * _cairo_win32_print_gdi_error:
* @context: context string to display along with the error * @context: context string to display along with the error
* *
* Helper function to dump out a human readable form of the * Helper function to dump out a human readable form of the
* current error code. * current error code.
* *
@ -1088,13 +1088,13 @@ FAIL:
/** /**
* cairo_win32_surface_create: * cairo_win32_surface_create:
* @hdc: the DC to create a surface for * @hdc: the DC to create a surface for
* *
* Creates a cairo surface that targets the given DC. The DC will be * Creates a cairo surface that targets the given DC. The DC will be
* queried for its initial clip extents, and this will be used as the * queried for its initial clip extents, and this will be used as the
* size of the cairo surface. Also, if the DC is a raster DC, it will * size of the cairo surface. Also, if the DC is a raster DC, it will
* be queried for its pixel format and the cairo surface format will * be queried for its pixel format and the cairo surface format will
* be set appropriately. * be set appropriately.
* *
* Return value: the newly created surface * Return value: the newly created surface
**/ **/
cairo_surface_t * cairo_surface_t *
@ -1175,14 +1175,14 @@ cairo_win32_surface_create (HDC hdc)
/** /**
* cairo_win32_surface_create_with_dib: * cairo_win32_surface_create_with_dib:
* @format: format of pixels in the surface to create * @format: format of pixels in the surface to create
* @width: width of the surface, in pixels * @width: width of the surface, in pixels
* @height: height of the surface, in pixels * @height: height of the surface, in pixels
* *
* Creates a device-independent-bitmap surface not associated with * Creates a device-independent-bitmap surface not associated with
* any particular existing surface or device context. The created * any particular existing surface or device context. The created
* bitmap will be unititialized. * bitmap will be unititialized.
* *
* Return value: the newly created surface * Return value: the newly created surface
* *
**/ **/
@ -1198,9 +1198,9 @@ cairo_win32_surface_create_with_dib (cairo_format_t format,
/** /**
* _cairo_surface_is_win32: * _cairo_surface_is_win32:
* @surface: a #cairo_surface_t * @surface: a #cairo_surface_t
* *
* Checks if a surface is an #cairo_win32_surface_t * Checks if a surface is an #cairo_win32_surface_t
* *
* Return value: True if the surface is an win32 surface * Return value: True if the surface is an win32 surface
**/ **/
int int

20
src/cairo-xcb-surface.c
View file

@ -588,7 +588,7 @@ _draw_image_surface (cairo_xcb_surface_t *surface,
image->width, image->width,
image->height, image->height,
dst_x, dst_y, dst_x, dst_y,
/* left_pad */ 0, image->depth, /* left_pad */ 0, image->depth,
data_len, image->data); data_len, image->data);
return CAIRO_STATUS_SUCCESS; return CAIRO_STATUS_SUCCESS;
@ -1078,9 +1078,9 @@ static const cairo_surface_backend_t cairo_xcb_surface_backend = {
/** /**
* _cairo_surface_is_xcb: * _cairo_surface_is_xcb:
* @surface: a #cairo_surface_t * @surface: a #cairo_surface_t
* *
* Checks if a surface is a #cairo_xcb_surface_t * Checks if a surface is a #cairo_xcb_surface_t
* *
* Return value: True if the surface is an xcb surface * Return value: True if the surface is an xcb surface
**/ **/
static cairo_bool_t static cairo_bool_t
@ -1216,7 +1216,7 @@ _cairo_xcb_surface_create_internal (XCBConnection *dpy,
* Currently, only TrueColor visuals are fully supported. * Currently, only TrueColor visuals are fully supported.
* @width: the current width of @drawable. * @width: the current width of @drawable.
* @height: the current height of @drawable. * @height: the current height of @drawable.
* *
* Creates an XCB surface that draws to the given drawable. * Creates an XCB surface that draws to the given drawable.
* The way that colors are represented in the drawable is specified * The way that colors are represented in the drawable is specified
* by the provided visual. * by the provided visual.
@ -1224,7 +1224,7 @@ _cairo_xcb_surface_create_internal (XCBConnection *dpy,
* NOTE: If @drawable is a window, then the function * NOTE: If @drawable is a window, then the function
* cairo_xcb_surface_set_size must be called whenever the size of the * cairo_xcb_surface_set_size must be called whenever the size of the
* window changes. * window changes.
* *
* Return value: the newly created surface * Return value: the newly created surface
**/ **/
cairo_surface_t * cairo_surface_t *
@ -1248,7 +1248,7 @@ cairo_xcb_surface_create (XCBConnection *c,
* *
* Creates an XCB surface that draws to the given bitmap. * Creates an XCB surface that draws to the given bitmap.
* This will be drawn to as a CAIRO_FORMAT_A1 object. * This will be drawn to as a CAIRO_FORMAT_A1 object.
* *
* Return value: the newly created surface * Return value: the newly created surface
**/ **/
cairo_surface_t * cairo_surface_t *
@ -1272,7 +1272,7 @@ cairo_xcb_surface_create_for_bitmap (XCBConnection *c,
* depth of @format mush match the depth of the drawable. * depth of @format mush match the depth of the drawable.
* @width: the current width of @drawable * @width: the current width of @drawable
* @height: the current height of @drawable * @height: the current height of @drawable
* *
* Creates an XCB surface that draws to the given drawable. * Creates an XCB surface that draws to the given drawable.
* The way that colors are represented in the drawable is specified * The way that colors are represented in the drawable is specified
* by the provided picture format. * by the provided picture format.
@ -1280,8 +1280,8 @@ cairo_xcb_surface_create_for_bitmap (XCBConnection *c,
* NOTE: If @drawable is a Window, then the function * NOTE: If @drawable is a Window, then the function
* cairo_xlib_surface_set_size must be called whenever the size of the * cairo_xlib_surface_set_size must be called whenever the size of the
* window changes. * window changes.
* *
* Return value: the newly created surface. * Return value: the newly created surface.
**/ **/
cairo_surface_t * cairo_surface_t *
cairo_xcb_surface_create_with_xrender_format (XCBConnection *c, cairo_xcb_surface_create_with_xrender_format (XCBConnection *c,
@ -1300,7 +1300,7 @@ cairo_xcb_surface_create_with_xrender_format (XCBConnection *c,
* @surface: a #cairo_surface_t for the XCB backend * @surface: a #cairo_surface_t for the XCB backend
* @width: the new width of the surface * @width: the new width of the surface
* @height: the new height of the surface * @height: the new height of the surface
* *
* Informs cairo of the new size of the XCB drawable underlying the * Informs cairo of the new size of the XCB drawable underlying the
* surface. For a surface created for a window (rather than a pixmap), * surface. For a surface created for a window (rather than a pixmap),
* this function must be called each time the size of the window * this function must be called each time the size of the window

24
src/cairo-xlib-surface.c
View file

@ -112,7 +112,7 @@ struct _cairo_xlib_surface {
* *
* Both are fixed in xorg >= 6.9 and hopefully in > 6.8.2, so * Both are fixed in xorg >= 6.9 and hopefully in > 6.8.2, so
* we can reuse the test for now. * we can reuse the test for now.
*/ */
cairo_bool_t buggy_repeat; cairo_bool_t buggy_repeat;
int width; int width;
@ -157,7 +157,7 @@ static cairo_bool_t cairo_xlib_render_disabled = FALSE;
* cairo_xlib_test_disable_render: * cairo_xlib_test_disable_render:
* *
* Disables the use of the RENDER extension. * Disables the use of the RENDER extension.
* *
* <note> * <note>
* This function is <emphasis>only</emphasis> intended for internal * This function is <emphasis>only</emphasis> intended for internal
* testing use within the cairo distribution. It is not installed in * testing use within the cairo distribution. It is not installed in
@ -609,7 +609,7 @@ _get_image_surface (cairo_xlib_surface_t *surface,
_swap_ximage_to_native (ximage); _swap_ximage_to_native (ximage);
/* /*
* Compute the pixel format masks from either a visual or a * Compute the pixel format masks from either a visual or a
* XRenderFormat, failing we assume the drawable is an * XRenderFormat, failing we assume the drawable is an
* alpha-only pixmap as it could only have been created * alpha-only pixmap as it could only have been created
* that way through the cairo_xlib_surface_create_for_bitmap * that way through the cairo_xlib_surface_create_for_bitmap
@ -655,8 +655,8 @@ _get_image_surface (cairo_xlib_surface_t *surface,
} }
else else
{ {
/* /*
* XXX This can't work. We must convert the data to one of the * XXX This can't work. We must convert the data to one of the
* supported pixman formats. Pixman needs another function * supported pixman formats. Pixman needs another function
* which takes data in an arbitrary format and converts it * which takes data in an arbitrary format and converts it
* to something supported by that library. * to something supported by that library.
@ -1775,9 +1775,9 @@ static const cairo_surface_backend_t cairo_xlib_surface_backend = {
/** /**
* _cairo_surface_is_xlib: * _cairo_surface_is_xlib:
* @surface: a #cairo_surface_t * @surface: a #cairo_surface_t
* *
* Checks if a surface is a #cairo_xlib_surface_t * Checks if a surface is a #cairo_xlib_surface_t
* *
* Return value: True if the surface is an xlib surface * Return value: True if the surface is an xlib surface
**/ **/
static cairo_bool_t static cairo_bool_t
@ -1954,7 +1954,7 @@ cairo_xlib_surface_create (Display *dpy,
* @screen: the X Screen associated with @bitmap * @screen: the X Screen associated with @bitmap
* @width: the current width of @bitmap. * @width: the current width of @bitmap.
* @height: the current height of @bitmap. * @height: the current height of @bitmap.
* *
* Creates an Xlib surface that draws to the given bitmap. * Creates an Xlib surface that draws to the given bitmap.
* This will be drawn to as a CAIRO_FORMAT_A1 object. * This will be drawn to as a CAIRO_FORMAT_A1 object.
* *
@ -2008,7 +2008,7 @@ cairo_xlib_surface_create_with_xrender_format (Display *dpy,
* @surface: a #cairo_surface_t for the XLib backend * @surface: a #cairo_surface_t for the XLib backend
* @width: the new width of the surface * @width: the new width of the surface
* @height: the new height of the surface * @height: the new height of the surface
* *
* Informs cairo of the new size of the X Drawable underlying the * Informs cairo of the new size of the X Drawable underlying the
* surface. For a surface created for a Window (rather than a Pixmap), * surface. For a surface created for a Window (rather than a Pixmap),
* this function must be called each time the size of the window * this function must be called each time the size of the window
@ -2041,7 +2041,7 @@ cairo_xlib_surface_set_size (cairo_surface_t *abstract_surface,
* @drawable: the new drawable for the surface * @drawable: the new drawable for the surface
* @width: the width of the new drawable * @width: the width of the new drawable
* @height: the height of the new drawable * @height: the height of the new drawable
* *
* Informs cairo of a new X Drawable underlying the * Informs cairo of a new X Drawable underlying the
* surface. The drawable must match the display, screen * surface. The drawable must match the display, screen
* and format of the existing drawable or the application * and format of the existing drawable or the application
@ -2258,7 +2258,7 @@ _cairo_xlib_surface_add_glyph (Display *dpy,
* an origin at (0,0) and an x and y bounding box "offset" which * an origin at (0,0) and an x and y bounding box "offset" which
* extends possibly off into negative coordinates, like so: * extends possibly off into negative coordinates, like so:
* *
* *
* (x,y) <-- probably negative numbers * (x,y) <-- probably negative numbers
* +----------------+ * +----------------+
* | . | * | . |
@ -2286,7 +2286,7 @@ _cairo_xlib_surface_add_glyph (Display *dpy,
* (width,height) * (width,height)
* *
* Luckily, this is just the negation of the numbers we already have * Luckily, this is just the negation of the numbers we already have
* sitting around for x and y. * sitting around for x and y.
*/ */
glyph_info.x = - (int) floor(glyph_surface->base.device_x_offset + 0.5); glyph_info.x = - (int) floor(glyph_surface->base.device_x_offset + 0.5);

166
src/cairo.c
View file

@ -68,7 +68,7 @@ static const cairo_t cairo_nil = {
* _cairo_error: * _cairo_error:
* @status: a status value indicating an error, (eg. not * @status: a status value indicating an error, (eg. not
* CAIRO_STATUS_SUCCESS) * CAIRO_STATUS_SUCCESS)
* *
* Checks that status is an error status, but does nothing else. * Checks that status is an error status, but does nothing else.
* *
* All assignments of an error status to any user-visible object * All assignments of an error status to any user-visible object
@ -91,7 +91,7 @@ _cairo_error (cairo_status_t status)
* @cr: a cairo context * @cr: a cairo context
* @status: a status value indicating an error, (eg. not * @status: a status value indicating an error, (eg. not
* CAIRO_STATUS_SUCCESS) * CAIRO_STATUS_SUCCESS)
* *
* Sets cr->status to @status and calls _cairo_error; * Sets cr->status to @status and calls _cairo_error;
* *
* All assignments of an error status to cr->status should happen * All assignments of an error status to cr->status should happen
@ -116,7 +116,7 @@ _cairo_set_error (cairo_t *cr, cairo_status_t status)
/** /**
* cairo_version: * cairo_version:
* *
* Returns the version of the cairo library encoded in a single * Returns the version of the cairo library encoded in a single
* integer as per CAIRO_VERSION_ENCODE. The encoding ensures that * integer as per CAIRO_VERSION_ENCODE. The encoding ensures that
* later versions compare greater than earlier versions. * later versions compare greater than earlier versions.
@ -130,7 +130,7 @@ _cairo_set_error (cairo_t *cr, cairo_status_t status)
* *
* See also cairo_version_string() as well as the compile-time * See also cairo_version_string() as well as the compile-time
* equivalents %CAIRO_VERSION and %CAIRO_VERSION_STRING. * equivalents %CAIRO_VERSION and %CAIRO_VERSION_STRING.
* *
* Return value: the encoded version. * Return value: the encoded version.
**/ **/
int int
@ -141,13 +141,13 @@ cairo_version (void)
/** /**
* cairo_version_string: * cairo_version_string:
* *
* Returns the version of the cairo library as a human-readable string * Returns the version of the cairo library as a human-readable string
* of the form "X.Y.Z". * of the form "X.Y.Z".
* *
* See also cairo_version() as well as the compile-time equivalents * See also cairo_version() as well as the compile-time equivalents
* %CAIRO_VERSION_STRING and %CAIRO_VERSION. * %CAIRO_VERSION_STRING and %CAIRO_VERSION.
* *
* Return value: a string containing the version. * Return value: a string containing the version.
**/ **/
const char* const char*
@ -159,7 +159,7 @@ cairo_version_string (void)
/** /**
* cairo_create: * cairo_create:
* @target: target surface for the context * @target: target surface for the context
* *
* Creates a new #cairo_t with all graphics state parameters set to * Creates a new #cairo_t with all graphics state parameters set to
* default values and with @target as a target surface. The target * default values and with @target as a target surface. The target
* surface should be constructed with a backend-specific function such * surface should be constructed with a backend-specific function such
@ -169,7 +169,7 @@ cairo_version_string (void)
* This function references @target, so you can immediately * This function references @target, so you can immediately
* call cairo_surface_destroy() on it if you don't need to * call cairo_surface_destroy() on it if you don't need to
* maintain a separate reference to it. * maintain a separate reference to it.
* *
* Return value: a newly allocated #cairo_t with a reference * Return value: a newly allocated #cairo_t with a reference
* count of 1. The initial reference count should be released * count of 1. The initial reference count should be released
* with cairo_destroy() when you are done using the #cairo_t. * with cairo_destroy() when you are done using the #cairo_t.
@ -210,9 +210,9 @@ cairo_create (cairo_surface_t *target)
/** /**
* cairo_reference: * cairo_reference:
* @cr: a #cairo_t * @cr: a #cairo_t
* *
* Increases the reference count on @cr by one. This prevents * Increases the reference count on @cr by one. This prevents
* @cr from being destroyed until a matching call to cairo_destroy() * @cr from being destroyed until a matching call to cairo_destroy()
* is made. * is made.
* *
* Return value: the referenced #cairo_t. * Return value: the referenced #cairo_t.
@ -236,7 +236,7 @@ cairo_reference (cairo_t *cr)
/** /**
* cairo_destroy: * cairo_destroy:
* @cr: a #cairo_t * @cr: a #cairo_t
* *
* Decreases the reference count on @cr by one. If the result * Decreases the reference count on @cr by one. If the result
* is zero, then @cr and all associated resources are freed. * is zero, then @cr and all associated resources are freed.
* See cairo_reference(). * See cairo_reference().
@ -271,7 +271,7 @@ cairo_destroy (cairo_t *cr)
/** /**
* cairo_save: * cairo_save:
* @cr: a #cairo_t * @cr: a #cairo_t
* *
* Makes a copy of the current state of @cr and saves it * Makes a copy of the current state of @cr and saves it
* on an internal stack of saved states for @cr. When * on an internal stack of saved states for @cr. When
* cairo_restore() is called, @cr will be restored to * cairo_restore() is called, @cr will be restored to
@ -307,7 +307,7 @@ slim_hidden_def(cairo_save);
/** /**
* cairo_restore: * cairo_restore:
* @cr: a #cairo_t * @cr: a #cairo_t
* *
* Restores @cr to the state saved by a preceding call to * Restores @cr to the state saved by a preceding call to
* cairo_save() and removes that state from the stack of * cairo_save() and removes that state from the stack of
* saved states. * saved states.
@ -545,7 +545,7 @@ slim_hidden_def(cairo_pop_group_to_source);
* cairo_set_operator: * cairo_set_operator:
* @cr: a #cairo_t * @cr: a #cairo_t
* @op: a compositing operator, specified as a #cairo_operator_t * @op: a compositing operator, specified as a #cairo_operator_t
* *
* Sets the compositing operator to be used for all drawing * Sets the compositing operator to be used for all drawing
* operations. See #cairo_operator_t for details on the semantics of * operations. See #cairo_operator_t for details on the semantics of
* each available compositing operator. * each available compositing operator.
@ -571,7 +571,7 @@ cairo_set_operator (cairo_t *cr, cairo_operator_t op)
* @red: red component of color * @red: red component of color
* @green: green component of color * @green: green component of color
* @blue: blue component of color * @blue: blue component of color
* *
* Sets the source pattern within @cr to an opaque color. This opaque * Sets the source pattern within @cr to an opaque color. This opaque
* color will then be used for any subsequent drawing operation until * color will then be used for any subsequent drawing operation until
* a new source pattern is set. * a new source pattern is set.
@ -600,7 +600,7 @@ cairo_set_source_rgb (cairo_t *cr, double red, double green, double blue)
* @green: green component of color * @green: green component of color
* @blue: blue component of color * @blue: blue component of color
* @alpha: alpha component of color * @alpha: alpha component of color
* *
* Sets the source pattern within @cr to a translucent color. This * Sets the source pattern within @cr to a translucent color. This
* color will then be used for any subsequent drawing operation until * color will then be used for any subsequent drawing operation until
* a new source pattern is set. * a new source pattern is set.
@ -630,7 +630,7 @@ cairo_set_source_rgba (cairo_t *cr,
* @surface: a surface to be used to set the source pattern * @surface: a surface to be used to set the source pattern
* @x: User-space X coordinate for surface origin * @x: User-space X coordinate for surface origin
* @y: User-space Y coordinate for surface origin * @y: User-space Y coordinate for surface origin
* *
* This is a convenience function for creating a pattern from @surface * This is a convenience function for creating a pattern from @surface
* and setting it as the source in @cr with cairo_set_source(). * and setting it as the source in @cr with cairo_set_source().
* *
@ -673,7 +673,7 @@ cairo_set_source_surface (cairo_t *cr,
* @cr: a cairo context * @cr: a cairo context
* @source: a #cairo_pattern_t to be used as the source for * @source: a #cairo_pattern_t to be used as the source for
* subsequent drawing operations. * subsequent drawing operations.
* *
* Sets the source pattern within @cr to @source. This pattern * Sets the source pattern within @cr to @source. This pattern
* will then be used for any subsequent drawing operation until a new * will then be used for any subsequent drawing operation until a new
* source pattern is set. * source pattern is set.
@ -711,9 +711,9 @@ cairo_set_source (cairo_t *cr, cairo_pattern_t *source)
/** /**
* cairo_get_source: * cairo_get_source:
* @cr: a cairo context * @cr: a cairo context
* *
* Gets the current source pattern for @cr. * Gets the current source pattern for @cr.
* *
* Return value: the current source pattern. This object is owned by * Return value: the current source pattern. This object is owned by
* cairo. To keep a reference to it, you must call * cairo. To keep a reference to it, you must call
* cairo_pattern_reference(). * cairo_pattern_reference().
@ -731,7 +731,7 @@ cairo_get_source (cairo_t *cr)
* cairo_set_tolerance: * cairo_set_tolerance:
* @cr: a #cairo_t * @cr: a #cairo_t
* @tolerance: the tolerance, in device units (typically pixels) * @tolerance: the tolerance, in device units (typically pixels)
* *
* Sets the tolerance used when converting paths into trapezoids. * Sets the tolerance used when converting paths into trapezoids.
* Curved segments of the path will be subdivided until the maximum * Curved segments of the path will be subdivided until the maximum
* deviation between the original path and the polygonal approximation * deviation between the original path and the polygonal approximation
@ -757,7 +757,7 @@ cairo_set_tolerance (cairo_t *cr, double tolerance)
* cairo_set_antialias: * cairo_set_antialias:
* @cr: a #cairo_t * @cr: a #cairo_t
* @antialias: the new antialiasing mode * @antialias: the new antialiasing mode
* *
* Set the antialiasing mode of the rasterizer used for drawing shapes. * Set the antialiasing mode of the rasterizer used for drawing shapes.
* This value is a hint, and a particular backend may or may not support * This value is a hint, and a particular backend may or may not support
* a particular value. At the current time, no backend supports * a particular value. At the current time, no backend supports
@ -781,7 +781,7 @@ cairo_set_antialias (cairo_t *cr, cairo_antialias_t antialias)
* cairo_set_fill_rule: * cairo_set_fill_rule:
* @cr: a #cairo_t * @cr: a #cairo_t
* @fill_rule: a fill rule, specified as a #cairo_fill_rule_t * @fill_rule: a fill rule, specified as a #cairo_fill_rule_t
* *
* Set the current fill rule within the cairo context. The fill rule * Set the current fill rule within the cairo context. The fill rule
* is used to determine which regions are inside or outside a complex * is used to determine which regions are inside or outside a complex
* (potentially self-intersecting) path. The current fill rule affects * (potentially self-intersecting) path. The current fill rule affects
@ -803,7 +803,7 @@ cairo_set_fill_rule (cairo_t *cr, cairo_fill_rule_t fill_rule)
* cairo_set_line_width: * cairo_set_line_width:
* @cr: a #cairo_t * @cr: a #cairo_t
* @width: a line width * @width: a line width
* *
* Sets the current line width within the cairo context. The line * Sets the current line width within the cairo context. The line
* width value specifies the diameter of a pen that is circular in * width value specifies the diameter of a pen that is circular in
* user space, (though device-space pen may be an ellipse in general * user space, (though device-space pen may be an ellipse in general
@ -842,7 +842,7 @@ cairo_set_line_width (cairo_t *cr, double width)
* cairo_set_line_cap: * cairo_set_line_cap:
* @cr: a cairo context, as a #cairo_t * @cr: a cairo context, as a #cairo_t
* @line_cap: a line cap style, as a #cairo_line_cap_t * @line_cap: a line cap style, as a #cairo_line_cap_t
* *
* Sets the current line cap style within the cairo context. See * Sets the current line cap style within the cairo context. See
* #cairo_line_cap_t for details about how the available line cap * #cairo_line_cap_t for details about how the available line cap
* styles are drawn. * styles are drawn.
@ -894,7 +894,7 @@ cairo_set_line_join (cairo_t *cr, cairo_line_join_t line_join)
* @dashes: an array specifying alternate lengths of on and off stroke portions * @dashes: an array specifying alternate lengths of on and off stroke portions
* @num_dashes: the length of the dashes array * @num_dashes: the length of the dashes array
* @offset: an offset into the dash pattern at which the stroke should start * @offset: an offset into the dash pattern at which the stroke should start
* *
* Sets the dash pattern to be used by cairo_stroke(). A dash pattern * Sets the dash pattern to be used by cairo_stroke(). A dash pattern
* is specified by @dashes, an array of positive values. Each value * is specified by @dashes, an array of positive values. Each value
* provides the length of alternate "on" and "off" portions of the * provides the length of alternate "on" and "off" portions of the
@ -947,7 +947,7 @@ cairo_set_miter_limit (cairo_t *cr, double limit)
* @cr: a cairo context * @cr: a cairo context
* @tx: amount to translate in the X direction * @tx: amount to translate in the X direction
* @ty: amount to translate in the Y direction * @ty: amount to translate in the Y direction
* *
* Modifies the current transformation matrix (CTM) by translating the * Modifies the current transformation matrix (CTM) by translating the
* user-space origin by (@tx, @ty). This offset is interpreted as a * user-space origin by (@tx, @ty). This offset is interpreted as a
* user-space coordinate according to the CTM in place before the new * user-space coordinate according to the CTM in place before the new
@ -970,7 +970,7 @@ cairo_translate (cairo_t *cr, double tx, double ty)
* @cr: a cairo context * @cr: a cairo context
* @sx: scale factor for the X dimension * @sx: scale factor for the X dimension
* @sy: scale factor for the Y dimension * @sy: scale factor for the Y dimension
* *
* Modifies the current transformation matrix (CTM) by scaling the X * Modifies the current transformation matrix (CTM) by scaling the X
* and Y user-space axes by @sx and @sy respectively. The scaling of * and Y user-space axes by @sx and @sy respectively. The scaling of
* the axes takes place after any existing transformation of user * the axes takes place after any existing transformation of user
@ -993,7 +993,7 @@ cairo_scale (cairo_t *cr, double sx, double sy)
* @cr: a cairo context * @cr: a cairo context
* @angle: angle (in radians) by which the user-space axes will be * @angle: angle (in radians) by which the user-space axes will be
* rotated * rotated
* *
* Modifies the current transformation matrix (CTM) by rotating the * Modifies the current transformation matrix (CTM) by rotating the
* user-space axes by @angle radians. The rotation of the axes takes * user-space axes by @angle radians. The rotation of the axes takes
* places after any existing transformation of user space. The * places after any existing transformation of user space. The
@ -1015,7 +1015,7 @@ cairo_rotate (cairo_t *cr, double angle)
* cairo_transform: * cairo_transform:
* @cr: a cairo context * @cr: a cairo context
* @matrix: a transformation to be applied to the user-space axes * @matrix: a transformation to be applied to the user-space axes
* *
* Modifies the current transformation matrix (CTM) by applying * Modifies the current transformation matrix (CTM) by applying
* @matrix as an additional transformation. The new transformation of * @matrix as an additional transformation. The new transformation of
* user space takes place after any existing transformation. * user space takes place after any existing transformation.
@ -1036,7 +1036,7 @@ cairo_transform (cairo_t *cr,
* cairo_set_matrix: * cairo_set_matrix:
* @cr: a cairo context * @cr: a cairo context
* @matrix: a transformation matrix from user space to device space * @matrix: a transformation matrix from user space to device space
* *
* Modifies the current transformation matrix (CTM) by setting it * Modifies the current transformation matrix (CTM) by setting it
* equal to @matrix. * equal to @matrix.
**/ **/
@ -1055,7 +1055,7 @@ cairo_set_matrix (cairo_t *cr,
/** /**
* cairo_identity_matrix: * cairo_identity_matrix:
* @cr: a cairo context * @cr: a cairo context
* *
* Resets the current transformation matrix (CTM) by setting it equal * Resets the current transformation matrix (CTM) by setting it equal
* to the identity matrix. That is, the user-space and device-space * to the identity matrix. That is, the user-space and device-space
* axes will be aligned and one user-space unit will transform to one * axes will be aligned and one user-space unit will transform to one
@ -1077,7 +1077,7 @@ cairo_identity_matrix (cairo_t *cr)
* @cr: a cairo context * @cr: a cairo context
* @x: X value of coordinate (in/out parameter) * @x: X value of coordinate (in/out parameter)
* @y: Y value of coordinate (in/out parameter) * @y: Y value of coordinate (in/out parameter)
* *
* Transform a coordinate from user space to device space by * Transform a coordinate from user space to device space by
* multiplying the given point by the current transformation matrix * multiplying the given point by the current transformation matrix
* (CTM). * (CTM).
@ -1098,7 +1098,7 @@ cairo_user_to_device (cairo_t *cr, double *x, double *y)
* @cr: a cairo context * @cr: a cairo context
* @dx: X component of a distance vector (in/out parameter) * @dx: X component of a distance vector (in/out parameter)
* @dy: Y component of a distance vector (in/out parameter) * @dy: Y component of a distance vector (in/out parameter)
* *
* Transform a distance vector from user space to device space. This * Transform a distance vector from user space to device space. This
* function is similar to cairo_user_to_device() except that the * function is similar to cairo_user_to_device() except that the
* translation components of the CTM will be ignored when transforming * translation components of the CTM will be ignored when transforming
@ -1120,7 +1120,7 @@ cairo_user_to_device_distance (cairo_t *cr, double *dx, double *dy)
* @cr: a cairo * @cr: a cairo
* @x: X value of coordinate (in/out parameter) * @x: X value of coordinate (in/out parameter)
* @y: Y value of coordinate (in/out parameter) * @y: Y value of coordinate (in/out parameter)
* *
* Transform a coordinate from device space to user space by * Transform a coordinate from device space to user space by
* multiplying the given point by the inverse of the current * multiplying the given point by the inverse of the current
* transformation matrix (CTM). * transformation matrix (CTM).
@ -1141,7 +1141,7 @@ cairo_device_to_user (cairo_t *cr, double *x, double *y)
* @cr: a cairo context * @cr: a cairo context
* @dx: X component of a distance vector (in/out parameter) * @dx: X component of a distance vector (in/out parameter)
* @dy: Y component of a distance vector (in/out parameter) * @dy: Y component of a distance vector (in/out parameter)
* *
* Transform a distance vector from device space to user space. This * Transform a distance vector from device space to user space. This
* function is similar to cairo_device_to_user() except that the * function is similar to cairo_device_to_user() except that the
* translation components of the inverse CTM will be ignored when * translation components of the inverse CTM will be ignored when
@ -1205,7 +1205,7 @@ slim_hidden_def(cairo_move_to);
/** /**
* cairo_new_sub_path: * cairo_new_sub_path:
* @cr: a cairo context * @cr: a cairo context
* *
* Begin a new subpath. Note that the existing path is not * Begin a new subpath. Note that the existing path is not
* affected. After this call there will be no current point. * affected. After this call there will be no current point.
* *
@ -1318,7 +1318,7 @@ cairo_curve_to (cairo_t *cr,
* @radius: the radius of the arc * @radius: the radius of the arc
* @angle1: the start angle, in radians * @angle1: the start angle, in radians
* @angle2: the end angle, in radians * @angle2: the end angle, in radians
* *
* Adds a circular arc of the given @radius to the current path. The * Adds a circular arc of the given @radius to the current path. The
* arc is centered at (@xc, @yc), begins at @angle1 and proceeds in * arc is centered at (@xc, @yc), begins at @angle1 and proceeds in
* the direction of increasing angles to end at @angle2. If @angle2 is * the direction of increasing angles to end at @angle2. If @angle2 is
@ -1388,7 +1388,7 @@ cairo_arc (cairo_t *cr,
* @radius: the radius of the arc * @radius: the radius of the arc
* @angle1: the start angle, in radians * @angle1: the start angle, in radians
* @angle2: the end angle, in radians * @angle2: the end angle, in radians
* *
* Adds a circular arc of the given @radius to the current path. The * Adds a circular arc of the given @radius to the current path. The
* arc is centered at (@xc, @yc), begins at @angle1 and proceeds in * arc is centered at (@xc, @yc), begins at @angle1 and proceeds in
* the direction of decreasing angles to end at @angle2. If @angle2 is * the direction of decreasing angles to end at @angle2. If @angle2 is
@ -1619,7 +1619,7 @@ cairo_stroke_to_path (cairo_t *cr)
/** /**
* cairo_close_path: * cairo_close_path:
* @cr: a cairo context * @cr: a cairo context
* *
* Adds a line segment to the path from the current point to the * Adds a line segment to the path from the current point to the
* beginning of the current subpath, (the most recent point passed to * beginning of the current subpath, (the most recent point passed to
* cairo_move_to()), and closes this subpath. After this call the * cairo_move_to()), and closes this subpath. After this call the
@ -1649,7 +1649,7 @@ slim_hidden_def(cairo_close_path);
/** /**
* cairo_paint: * cairo_paint:
* @cr: a cairo context * @cr: a cairo context
* *
* A drawing operator that paints the current source everywhere within * A drawing operator that paints the current source everywhere within
* the current clip region. * the current clip region.
**/ **/
@ -1668,7 +1668,7 @@ cairo_paint (cairo_t *cr)
* cairo_paint_with_alpha: * cairo_paint_with_alpha:
* @cr: a cairo context * @cr: a cairo context
* @alpha: alpha value, between 0 (transparent) and 1 (opaque) * @alpha: alpha value, between 0 (transparent) and 1 (opaque)
* *
* A drawing operator that paints the current source everywhere within * A drawing operator that paints the current source everywhere within
* the current clip region using a mask of constant alpha value * the current clip region using a mask of constant alpha value
* @alpha. The effect is similar to cairo_paint(), but the drawing * @alpha. The effect is similar to cairo_paint(), but the drawing
@ -1745,7 +1745,7 @@ cairo_mask (cairo_t *cr,
* A drawing operator that paints the current source * A drawing operator that paints the current source
* using the alpha channel of @surface as a mask. (Opaque * using the alpha channel of @surface as a mask. (Opaque
* areas of @surface are painted with the source, transparent * areas of @surface are painted with the source, transparent
* areas are not painted.) * areas are not painted.)
*/ */
void void
cairo_mask_surface (cairo_t *cr, cairo_mask_surface (cairo_t *cr,
@ -1772,7 +1772,7 @@ cairo_mask_surface (cairo_t *cr,
/** /**
* cairo_stroke: * cairo_stroke:
* @cr: a cairo context * @cr: a cairo context
* *
* A drawing operator that strokes the current path according to the * A drawing operator that strokes the current path according to the
* current line width, line join, line cap, and dash settings. After * current line width, line join, line cap, and dash settings. After
* cairo_stroke, the current path will be cleared from the cairo * cairo_stroke, the current path will be cleared from the cairo
@ -1791,7 +1791,7 @@ cairo_stroke (cairo_t *cr)
/** /**
* cairo_stroke_preserve: * cairo_stroke_preserve:
* @cr: a cairo context * @cr: a cairo context
* *
* A drawing operator that strokes the current path according to the * A drawing operator that strokes the current path according to the
* current line width, line join, line cap, and dash settings. Unlike * current line width, line join, line cap, and dash settings. Unlike
* cairo_stroke(), cairo_stroke_preserve preserves the path within the * cairo_stroke(), cairo_stroke_preserve preserves the path within the
@ -1816,7 +1816,7 @@ slim_hidden_def(cairo_stroke_preserve);
/** /**
* cairo_fill: * cairo_fill:
* @cr: a cairo context * @cr: a cairo context
* *
* A drawing operator that fills the current path according to the * A drawing operator that fills the current path according to the
* current fill rule, (each sub-path is implicitly closed before being * current fill rule, (each sub-path is implicitly closed before being
* filled). After cairo_fill, the current path will be cleared from * filled). After cairo_fill, the current path will be cleared from
@ -1834,7 +1834,7 @@ cairo_fill (cairo_t *cr)
/** /**
* cairo_fill_preserve: * cairo_fill_preserve:
* @cr: a cairo context * @cr: a cairo context
* *
* A drawing operator that fills the current path according to the * A drawing operator that fills the current path according to the
* current fill rule, (each sub-path is implicitly closed before being * current fill rule, (each sub-path is implicitly closed before being
* filled). Unlike cairo_fill(), cairo_fill_preserve preserves the * filled). Unlike cairo_fill(), cairo_fill_preserve preserves the
@ -1943,7 +1943,7 @@ cairo_fill_extents (cairo_t *cr,
/** /**
* cairo_clip: * cairo_clip:
* @cr: a cairo context * @cr: a cairo context
* *
* Establishes a new clip region by intersecting the current clip * Establishes a new clip region by intersecting the current clip
* region with the current path as it would be filled by cairo_fill() * region with the current path as it would be filled by cairo_fill()
* and according to the current fill rule (see cairo_set_fill_rule()). * and according to the current fill rule (see cairo_set_fill_rule()).
@ -1973,7 +1973,7 @@ cairo_clip (cairo_t *cr)
/** /**
* cairo_clip_preserve: * cairo_clip_preserve:
* @cr: a cairo context * @cr: a cairo context
* *
* Establishes a new clip region by intersecting the current clip * Establishes a new clip region by intersecting the current clip
* region with the current path as it would be filled by cairo_fill() * region with the current path as it would be filled by cairo_fill()
* and according to the current fill rule (see cairo_set_fill_rule()). * and according to the current fill rule (see cairo_set_fill_rule()).
@ -2007,7 +2007,7 @@ slim_hidden_def(cairo_clip_preserve);
/** /**
* cairo_reset_clip: * cairo_reset_clip:
* @cr: a cairo context * @cr: a cairo context
* *
* Reset the current clip region to its original, unrestricted * Reset the current clip region to its original, unrestricted
* state. That is, set the clip region to an infinitely large shape * state. That is, set the clip region to an infinitely large shape
* containing the target surface. Equivalently, if infinity is too * containing the target surface. Equivalently, if infinity is too
@ -2037,7 +2037,7 @@ cairo_reset_clip (cairo_t *cr)
* @family: a font family name, encoded in UTF-8 * @family: a font family name, encoded in UTF-8
* @slant: the slant for the font * @slant: the slant for the font
* @weight: the weight for the font * @weight: the weight for the font
* *
* Selects a family and style of font from a simplified description as * Selects a family and style of font from a simplified description as
* a family name, slant and weight. This function is meant to be used * a family name, slant and weight. This function is meant to be used
* only for applications with simple font needs: Cairo doesn't provide * only for applications with simple font needs: Cairo doesn't provide
@ -2063,7 +2063,7 @@ cairo_select_font_face (cairo_t *cr,
/** /**
* cairo_get_font_face: * cairo_get_font_face:
* @cr: a #cairo_t * @cr: a #cairo_t
* *
* Gets the current font face for a #cairo_t. * Gets the current font face for a #cairo_t.
* *
* Return value: the current font object. Can return %NULL * Return value: the current font object. Can return %NULL
@ -2093,7 +2093,7 @@ cairo_get_font_face (cairo_t *cr)
* @cr: a #cairo_t * @cr: a #cairo_t
* @extents: a #cairo_font_extents_t object into which the results * @extents: a #cairo_font_extents_t object into which the results
* will be stored. * will be stored.
* *
* Gets the font extents for the currently selected font. * Gets the font extents for the currently selected font.
**/ **/
void void
@ -2133,7 +2133,7 @@ cairo_set_font_face (cairo_t *cr,
* cairo_set_font_size: * cairo_set_font_size:
* @cr: a #cairo_t * @cr: a #cairo_t
* @size: the new font size, in user space units * @size: the new font size, in user space units
* *
* Sets the current font matrix to a scale by a factor of @size, replacing * Sets the current font matrix to a scale by a factor of @size, replacing
* any font matrix previously set with cairo_set_font_size() or * any font matrix previously set with cairo_set_font_size() or
* cairo_set_font_matrix(). This results in a font size of @size user space * cairo_set_font_matrix(). This results in a font size of @size user space
@ -2194,7 +2194,7 @@ cairo_get_font_matrix (cairo_t *cr, cairo_matrix_t *matrix)
* cairo_set_font_options: * cairo_set_font_options:
* @cr: a #cairo_t * @cr: a #cairo_t
* @options: font options to use * @options: font options to use
* *
* Sets a set of custom font rendering options for the #cairo_t. * Sets a set of custom font rendering options for the #cairo_t.
* Rendering options are derived by merging these options with the * Rendering options are derived by merging these options with the
* options derived from underlying surface; if the value in @options * options derived from underlying surface; if the value in @options
@ -2218,7 +2218,7 @@ cairo_set_font_options (cairo_t *cr,
* @cr: a #cairo_t * @cr: a #cairo_t
* @options: a #cairo_font_options_t object into which to store * @options: a #cairo_font_options_t object into which to store
* the retrieved options. All existing values are overwritten * the retrieved options. All existing values are overwritten
* *
* Retrieves font rendering options set via #cairo_set_font_options. * Retrieves font rendering options set via #cairo_set_font_options.
* Note that the returned options do not include any options derived * Note that the returned options do not include any options derived
* from the underlying surface; they are literally the options * from the underlying surface; they are literally the options
@ -2277,7 +2277,7 @@ BAIL:
* @utf8: a string of text, encoded in UTF-8 * @utf8: a string of text, encoded in UTF-8
* @extents: a #cairo_text_extents_t object into which the results * @extents: a #cairo_text_extents_t object into which the results
* will be stored * will be stored
* *
* Gets the extents for a string of text. The extents describe a * Gets the extents for a string of text. The extents describe a
* user-space rectangle that encloses the "inked" portion of the text, * user-space rectangle that encloses the "inked" portion of the text,
* (as it would be drawn by cairo_show_text()). Additionally, the * (as it would be drawn by cairo_show_text()). Additionally, the
@ -2341,14 +2341,14 @@ cairo_text_extents (cairo_t *cr,
* @num_glyphs: the number of elements in @glyphs * @num_glyphs: the number of elements in @glyphs
* @extents: a #cairo_text_extents_t object into which the results * @extents: a #cairo_text_extents_t object into which the results
* will be stored * will be stored
* *
* Gets the extents for an array of glyphs. The extents describe a * Gets the extents for an array of glyphs. The extents describe a
* user-space rectangle that encloses the "inked" portion of the * user-space rectangle that encloses the "inked" portion of the
* glyphs, (as they would be drawn by cairo_show_glyphs()). * glyphs, (as they would be drawn by cairo_show_glyphs()).
* Additionally, the x_advance and y_advance values indicate the * Additionally, the x_advance and y_advance values indicate the
* amount by which the current point would be advanced by * amount by which the current point would be advanced by
* cairo_show_glyphs. * cairo_show_glyphs.
* *
* Note that whitespace glyphs do not contribute to the size of the * Note that whitespace glyphs do not contribute to the size of the
* rectangle (extents.width and extents.height). * rectangle (extents.width and extents.height).
**/ **/
@ -2371,7 +2371,7 @@ cairo_glyph_extents (cairo_t *cr,
* cairo_show_text: * cairo_show_text:
* @cr: a cairo context * @cr: a cairo context
* @utf8: a string of text encoded in UTF-8 * @utf8: a string of text encoded in UTF-8
* *
* A drawing operator that generates the shape from a string of UTF-8 * A drawing operator that generates the shape from a string of UTF-8
* characters, rendered according to the current font_face, font_size * characters, rendered according to the current font_face, font_size
* (font_matrix), and font_options. * (font_matrix), and font_options.
@ -2505,9 +2505,9 @@ cairo_glyph_path (cairo_t *cr, cairo_glyph_t *glyphs, int num_glyphs)
/** /**
* cairo_get_operator: * cairo_get_operator:
* @cr: a cairo context * @cr: a cairo context
* *
* Gets the current compositing operator for a cairo context. * Gets the current compositing operator for a cairo context.
* *
* Return value: the current compositing operator. * Return value: the current compositing operator.
**/ **/
cairo_operator_t cairo_operator_t
@ -2519,9 +2519,9 @@ cairo_get_operator (cairo_t *cr)
/** /**
* cairo_get_tolerance: * cairo_get_tolerance:
* @cr: a cairo context * @cr: a cairo context
* *
* Gets the current tolerance value, as set by cairo_set_tolerance(). * Gets the current tolerance value, as set by cairo_set_tolerance().
* *
* Return value: the current tolerance value. * Return value: the current tolerance value.
**/ **/
double double
@ -2533,9 +2533,9 @@ cairo_get_tolerance (cairo_t *cr)
/** /**
* cairo_get_antialias: * cairo_get_antialias:
* @cr: a cairo context * @cr: a cairo context
* *
* Gets the current shape antialiasing mode, as set by cairo_set_shape_antialias(). * Gets the current shape antialiasing mode, as set by cairo_set_shape_antialias().
* *
* Return value: the current shape antialiasing mode. * Return value: the current shape antialiasing mode.
**/ **/
cairo_antialias_t cairo_antialias_t
@ -2549,7 +2549,7 @@ cairo_get_antialias (cairo_t *cr)
* @cr: a cairo context * @cr: a cairo context
* @x: return value for X coordinate of the current point * @x: return value for X coordinate of the current point
* @y: return value for Y coordinate of the current point * @y: return value for Y coordinate of the current point
* *
* Gets the current point of the current path, which is * Gets the current point of the current path, which is
* conceptually the final point reached by the path so far. * conceptually the final point reached by the path so far.
* *
@ -2592,9 +2592,9 @@ slim_hidden_def(cairo_get_current_point);
/** /**
* cairo_get_fill_rule: * cairo_get_fill_rule:
* @cr: a cairo context * @cr: a cairo context
* *
* Gets the current fill rule, as set by cairo_set_fill_rule(). * Gets the current fill rule, as set by cairo_set_fill_rule().
* *
* Return value: the current fill rule. * Return value: the current fill rule.
**/ **/
cairo_fill_rule_t cairo_fill_rule_t
@ -2606,7 +2606,7 @@ cairo_get_fill_rule (cairo_t *cr)
/** /**
* cairo_get_line_width: * cairo_get_line_width:
* @cr: a cairo context * @cr: a cairo context
* *
* Return value: the current line width value exactly as set by * Return value: the current line width value exactly as set by
* cairo_set_line_width(). Note that the value is unchanged even if * cairo_set_line_width(). Note that the value is unchanged even if
* the CTM has changed between the calls to cairo_set_line_width() and * the CTM has changed between the calls to cairo_set_line_width() and
@ -2621,9 +2621,9 @@ cairo_get_line_width (cairo_t *cr)
/** /**
* cairo_get_line_cap: * cairo_get_line_cap:
* @cr: a cairo context * @cr: a cairo context
* *
* Gets the current line cap style, as set by cairo_set_line_cap(). * Gets the current line cap style, as set by cairo_set_line_cap().
* *
* Return value: the current line cap style. * Return value: the current line cap style.
**/ **/
cairo_line_cap_t cairo_line_cap_t
@ -2635,9 +2635,9 @@ cairo_get_line_cap (cairo_t *cr)
/** /**
* cairo_get_line_join: * cairo_get_line_join:
* @cr: a cairo context * @cr: a cairo context
* *
* Gets the current line join style, as set by cairo_set_line_join(). * Gets the current line join style, as set by cairo_set_line_join().
* *
* Return value: the current line join style. * Return value: the current line join style.
**/ **/
cairo_line_join_t cairo_line_join_t
@ -2649,9 +2649,9 @@ cairo_get_line_join (cairo_t *cr)
/** /**
* cairo_get_miter_limit: * cairo_get_miter_limit:
* @cr: a cairo context * @cr: a cairo context
* *
* Gets the current miter limit, as set by cairo_set_miter_limit(). * Gets the current miter limit, as set by cairo_set_miter_limit().
* *
* Return value: the current miter limit. * Return value: the current miter limit.
**/ **/
double double
@ -2676,7 +2676,7 @@ cairo_get_matrix (cairo_t *cr, cairo_matrix_t *matrix)
/** /**
* cairo_get_target: * cairo_get_target:
* @cr: a cairo context * @cr: a cairo context
* *
* Gets the target surface for the cairo context as passed to * Gets the target surface for the cairo context as passed to
* cairo_create(). * cairo_create().
* *
@ -2685,7 +2685,7 @@ cairo_get_matrix (cairo_t *cr, cairo_matrix_t *matrix)
* (ie. cairo_status() <literal>!=</literal> %CAIRO_STATUS_SUCCESS). * (ie. cairo_status() <literal>!=</literal> %CAIRO_STATUS_SUCCESS).
* A nil surface is indicated by cairo_surface_status() * A nil surface is indicated by cairo_surface_status()
* <literal>!=</literal> %CAIRO_STATUS_SUCCESS. * <literal>!=</literal> %CAIRO_STATUS_SUCCESS.
* *
* Return value: the target surface. This object is owned by cairo. To * Return value: the target surface. This object is owned by cairo. To
* keep a reference to it, you must call cairo_surface_reference(). * keep a reference to it, you must call cairo_surface_reference().
**/ **/
@ -2726,11 +2726,11 @@ cairo_get_group_target (cairo_t *cr)
/** /**
* cairo_copy_path: * cairo_copy_path:
* @cr: a cairo context * @cr: a cairo context
* *
* Creates a copy of the current path and returns it to the user as a * Creates a copy of the current path and returns it to the user as a
* #cairo_path_t. See #cairo_path_data_t for hints on how to iterate * #cairo_path_t. See #cairo_path_data_t for hints on how to iterate
* over the returned data structure. * over the returned data structure.
* *
* This function will always return a valid pointer, but the result * This function will always return a valid pointer, but the result
* will have no data (<literal>data==NULL</literal> and * will have no data (<literal>data==NULL</literal> and
* <literal>num_data==0</literal>), if either of the following * <literal>num_data==0</literal>), if either of the following
@ -2761,7 +2761,7 @@ cairo_copy_path (cairo_t *cr)
/** /**
* cairo_copy_path_flat: * cairo_copy_path_flat:
* @cr: a cairo context * @cr: a cairo context
* *
* Gets a flattened copy of the current path and returns it to the * Gets a flattened copy of the current path and returns it to the
* user as a #cairo_path_t. See #cairo_path_data_t for hints on * user as a #cairo_path_t. See #cairo_path_data_t for hints on
* how to iterate over the returned data structure. * how to iterate over the returned data structure.
@ -2786,7 +2786,7 @@ cairo_copy_path (cairo_t *cr)
* <literal>path->status</literal> will contain the same status that * <literal>path->status</literal> will contain the same status that
* would be returned by cairo_status().</listitem> * would be returned by cairo_status().</listitem>
* </orderedlist> * </orderedlist>
* *
* Return value: the copy of the current path. The caller owns the * Return value: the copy of the current path. The caller owns the
* returned object and should call cairo_path_destroy() when finished * returned object and should call cairo_path_destroy() when finished
* with it. * with it.
@ -2804,7 +2804,7 @@ cairo_copy_path_flat (cairo_t *cr)
* cairo_append_path: * cairo_append_path:
* @cr: a cairo context * @cr: a cairo context
* @path: path to be appended * @path: path to be appended
* *
* Append the @path onto the current path. The @path may be either the * Append the @path onto the current path. The @path may be either the
* return value from one of cairo_copy_path() or * return value from one of cairo_copy_path() or
* cairo_copy_path_flat() or it may be constructed manually. See * cairo_copy_path_flat() or it may be constructed manually. See

6
src/cairo.h
View file

@ -341,7 +341,7 @@ cairo_set_tolerance (cairo_t *cr, double tolerance);
* @CAIRO_ANTIALIAS_SUBPIXEL: Perform antialiasing by taking * @CAIRO_ANTIALIAS_SUBPIXEL: Perform antialiasing by taking
* advantage of the order of subpixel elements on devices * advantage of the order of subpixel elements on devices
* such as LCD panels * such as LCD panels
* *
* Specifies the type of antialiasing to do when rendering text or shapes. * Specifies the type of antialiasing to do when rendering text or shapes.
**/ **/
typedef enum _cairo_antialias { typedef enum _cairo_antialias {
@ -693,7 +693,7 @@ typedef struct {
* or <firstterm>external leading</firstterm>. When space * or <firstterm>external leading</firstterm>. When space
* is at a premium, most fonts can be set with only * is at a premium, most fonts can be set with only
* a distance of @ascent+@descent between lines. * a distance of @ascent+@descent between lines.
* @max_x_advance: the maximum distance in the X direction that * @max_x_advance: the maximum distance in the X direction that
* the the origin is advanced for any glyph in the font. * the the origin is advanced for any glyph in the font.
* @max_y_advance: the maximum distance in the Y direction that * @max_y_advance: the maximum distance in the Y direction that
* the the origin is advanced for any glyph in the font. * the the origin is advanced for any glyph in the font.
@ -744,7 +744,7 @@ typedef enum _cairo_font_weight {
* with red at the top * with red at the top
* @CAIRO_SUBPIXEL_ORDER_VBGR: Subpixel elements are arranged vertically * @CAIRO_SUBPIXEL_ORDER_VBGR: Subpixel elements are arranged vertically
* with blue at the top * with blue at the top
* *
* The subpixel order specifies the order of color elements within * The subpixel order specifies the order of color elements within
* each pixel on the display device when rendering with an * each pixel on the display device when rendering with an
* antialiasing mode of %CAIRO_ANTIALIAS_SUBPIXEL. * antialiasing mode of %CAIRO_ANTIALIAS_SUBPIXEL.

8
src/cairoint.h
View file

@ -339,7 +339,7 @@ cairo_private void
_cairo_rectangle_intersect (cairo_rectangle_fixed_t *dest, cairo_rectangle_fixed_t *src); _cairo_rectangle_intersect (cairo_rectangle_fixed_t *dest, cairo_rectangle_fixed_t *src);
/* cairo_array.c structures and functions */ /* cairo_array.c structures and functions */
typedef struct _cairo_array cairo_array_t; typedef struct _cairo_array cairo_array_t;
struct _cairo_array { struct _cairo_array {
@ -751,11 +751,11 @@ struct _cairo_surface_backend {
(*get_extents) (void *surface, (*get_extents) (void *surface,
cairo_rectangle_fixed_t *rectangle); cairo_rectangle_fixed_t *rectangle);
/* /*
* This is an optional entry to let the surface manage its own glyph * This is an optional entry to let the surface manage its own glyph
* resources. If null, render against this surface, using image * resources. If null, render against this surface, using image
* surfaces as glyphs. * surfaces as glyphs.
*/ */
cairo_int_status_t cairo_int_status_t
(*old_show_glyphs) (cairo_scaled_font_t *font, (*old_show_glyphs) (cairo_scaled_font_t *font,
cairo_operator_t op, cairo_operator_t op,

2
test/buffer-diff.c
View file

@ -12,7 +12,7 @@
* Richard Worth makes no representations about the suitability of this * Richard Worth makes no representations about the suitability of this
* software for any purpose. It is provided "as is" without express * software for any purpose. It is provided "as is" without express
* or implied warranty. * or implied warranty.
* *
* RICHARD WORTH DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, * RICHARD WORTH DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
* NO EVENT SHALL RICHARD WORTH BE LIABLE FOR ANY SPECIAL, INDIRECT OR * NO EVENT SHALL RICHARD WORTH BE LIABLE FOR ANY SPECIAL, INDIRECT OR

2
test/buffer-diff.h
View file

@ -12,7 +12,7 @@
* Richard Worth makes no representations about the suitability of this * Richard Worth makes no representations about the suitability of this
* software for any purpose. It is provided "as is" without express * software for any purpose. It is provided "as is" without express
* or implied warranty. * or implied warranty.
* *
* RICHARD WORTH DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, * RICHARD WORTH DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
* NO EVENT SHALL RICHARD WORTH BE LIABLE FOR ANY SPECIAL, INDIRECT OR * NO EVENT SHALL RICHARD WORTH BE LIABLE FOR ANY SPECIAL, INDIRECT OR

4
test/cairo-test.c
View file

@ -1326,7 +1326,7 @@ cleanup_pdf (void *closure)
#include "cairo-svg.h" #include "cairo-svg.h"
static const char *svg_ignored_tests[] = { static const char *svg_ignored_tests[] = {
/* rectangle-rounding-error uses CAIRO_ANTIALIAS_NONE, /* rectangle-rounding-error uses CAIRO_ANTIALIAS_NONE,
* which is not supported */ * which is not supported */
"rectangle-rounding-error", "rectangle-rounding-error",
NULL NULL
@ -1859,7 +1859,7 @@ cairo_test_create_surface_from_png (const char *filename)
image = cairo_image_surface_create_from_png (filename); image = cairo_image_surface_create_from_png (filename);
if (cairo_surface_status(image)) { if (cairo_surface_status(image)) {
/* expect not found when running with srcdir != builddir /* expect not found when running with srcdir != builddir
* such as when 'make distcheck' is run * such as when 'make distcheck' is run
*/ */
if (srcdir) { if (srcdir) {

2
test/cairo-test.h
View file

@ -83,7 +83,7 @@ typedef cairo_test_status_t (*cairo_test_draw_function_t) (cairo_t *cr, int wid
* *
* cairo_test() accepts a draw function which will be called once for * cairo_test() accepts a draw function which will be called once for
* each testable backend. The following checks will be performed for * each testable backend. The following checks will be performed for
* each backend: * each backend:
* *
* 1) If draw() does not return CAIRO_TEST_SUCCESS then this backend * 1) If draw() does not return CAIRO_TEST_SUCCESS then this backend
* fails. * fails.

2
test/imagediff.c
View file

@ -12,7 +12,7 @@
* Richard Worth makes no representations about the suitability of this * Richard Worth makes no representations about the suitability of this
* software for any purpose. It is provided "as is" without express * software for any purpose. It is provided "as is" without express
* or implied warranty. * or implied warranty.
* *
* RICHARD WORTH DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, * RICHARD WORTH DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
* NO EVENT SHALL RICHARD WORTH BE LIABLE FOR ANY SPECIAL, INDIRECT OR * NO EVENT SHALL RICHARD WORTH BE LIABLE FOR ANY SPECIAL, INDIRECT OR

8
test/rectangle-rounding-error.c
View file

@ -25,10 +25,10 @@
#include "cairo-test.h" #include "cairo-test.h"
/* Test case for: /* Test case for:
* *
* https://bugs.freedesktop.org/show_bug.cgi?id=4137 * https://bugs.freedesktop.org/show_bug.cgi?id=4137
*/ */
cairo_test_t test = { cairo_test_t test = {
"rectangle-rounding-error", "rectangle-rounding-error",