summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorBehdad Esfahbod <behdad@behdad.org>2006-08-08 02:17:43 -0400
committerBehdad Esfahbod <behdad@behdad.org>2006-08-08 02:24:16 -0400
commitcaba7f6bda9ba7c1a0738f3b34996c50bde60697 (patch)
tree0ee19b4c8d99df02063331143200a3c6a43c7b72 /src
parent789785cd357de14af23a4d2ae8ca49c4838426b9 (diff)
downloadcairo-caba7f6bda9ba7c1a0738f3b34996c50bde60697.tar.gz
Document a few more functions
cairo_show_page cairo_copy_page cairo_in_stroke cairo_in_fill
Diffstat (limited to 'src')
-rw-r--r--src/cairo.c42
1 files changed, 42 insertions, 0 deletions
diff --git a/src/cairo.c b/src/cairo.c
index b9d5b6d02..837976fd7 100644
--- a/src/cairo.c
+++ b/src/cairo.c
@@ -1887,6 +1887,15 @@ cairo_fill_preserve (cairo_t *cr)
}
slim_hidden_def(cairo_fill_preserve);
+/**
+ * cairo_copy_page:
+ * @cr: a cairo context
+ *
+ * Emits the current page for backends that support multiple pages, but
+ * doesn't clear it, so, the contents of the current page will be retained
+ * for the next page too. Use cairo_show_page() if you want to get an
+ * empty page after the emission.
+ **/
void
cairo_copy_page (cairo_t *cr)
{
@@ -1898,6 +1907,13 @@ cairo_copy_page (cairo_t *cr)
_cairo_set_error (cr, cr->status);
}
+/**
+ * cairo_show_page:
+ * @cr: a cairo context
+ *
+ * Emits and clears the current page for backends that support multiple
+ * pages. Use cairo_copy_page() if you don't want to clear the page.
+ **/
void
cairo_show_page (cairo_t *cr)
{
@@ -1909,6 +1925,20 @@ cairo_show_page (cairo_t *cr)
_cairo_set_error (cr, cr->status);
}
+/**
+ * cairo_in_stroke:
+ * @cr: a cairo context
+ * @x: X coordinate of the point to test
+ * @y: Y coordinate of the point to test
+ *
+ * Tests whether the given point is on the area stroked by doing a
+ * cairo_stroke() operation on @cr given the current path and stroking
+ * parameters.
+ *
+ * See cairo_stroke, cairo_set_line_width(), cairo_set_line_join(),
+ * cairo_set_line_cap(), cairo_set_dash(), and
+ * cairo_stroke_preserve().
+ **/
cairo_bool_t
cairo_in_stroke (cairo_t *cr, double x, double y)
{
@@ -1926,6 +1956,18 @@ cairo_in_stroke (cairo_t *cr, double x, double y)
return inside;
}
+/**
+ * cairo_in_fill:
+ * @cr: a cairo context
+ * @x: X coordinate of the point to test
+ * @y: Y coordinate of the point to test
+ *
+ * Tests whether the given point is on the area filled by doing a
+ * cairo_stroke() operation on @cr given the current path and filling
+ * parameters.
+ *
+ * See cairo_fill(), cairo_set_fill_rule() and cairo_fill_preserve().
+ **/
cairo_bool_t
cairo_in_fill (cairo_t *cr, double x, double y)
{