summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorChris Wilson <chris@chris-wilson.co.uk>2009-02-13 10:03:22 +0000
committerChris Wilson <chris@chris-wilson.co.uk>2009-02-13 10:07:37 +0000
commitde7270cb1e9510cb230e80045c812fa68fcfa585 (patch)
tree0ee041ee584363ed8e5b144e3c1b9a899572bdf3 /src
parente7d4bc3d864b1b42bb1cae031036ddf6a4445d3c (diff)
[cairo] Describe the restrictions upon cairo_set_tolerance()
Truc Troung reported that the behaviour of cairo_set_tolerance()/cairo_get_tolerance() was inconsistent with the documentation, i.e. we failed to mention that the tolerance would be restricted to the smalled fixed-point value. Add a sentence to the documentation that describes the restriction without mentioning what that is... Hopefully that is sufficient detail to accommodate the reporter, without exposing internal implementation details. Fixes https://bugs.freedesktop.org/show_bug.cgi?id=20095 Bug 20095 - The cairo_set_tolerance() function behavior is inconsistency with the spec
Diffstat (limited to 'src')
-rw-r--r--src/cairo.c5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/cairo.c b/src/cairo.c
index cefc9253..5f8d2661 100644
--- a/src/cairo.c
+++ b/src/cairo.c
@@ -816,7 +816,10 @@ cairo_get_source (cairo_t *cr)
* is less than @tolerance. The default value is 0.1. A larger
* value will give better performance, a smaller value, better
* appearance. (Reducing the value from the default value of 0.1
- * is unlikely to improve appearance significantly.)
+ * is unlikely to improve appearance significantly.) The accuracy of paths
+ * within Cairo is limited by the precision of its internal arithmetic, and
+ * the prescribed @tolerance is restricted to the smallest
+ * representable internal value.
**/
void
cairo_set_tolerance (cairo_t *cr, double tolerance)