summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarl Worth <cworth@cworth.org>2008-04-06 02:56:19 -0700
committerCarl Worth <cworth@cworth.org>2008-04-06 02:56:19 -0700
commitc08e2ba974ad7f5d9343d0d815a00a8e9ad51f81 (patch)
tree9b30ab963c0c9815a40477b2e3d613cdae95eb8c
parente07e1b7bbbac59ae2ea25ed762c017b477e22cc4 (diff)
downloadcairo-c08e2ba974ad7f5d9343d0d815a00a8e9ad51f81.tar.gz
Document default opaque black source pattern.
-rw-r--r--src/cairo.c12
1 files changed, 9 insertions, 3 deletions
diff --git a/src/cairo.c b/src/cairo.c
index bb943da12..346f0901e 100644
--- a/src/cairo.c
+++ b/src/cairo.c
@@ -664,6 +664,9 @@ slim_hidden_def (cairo_set_operator);
* The color components are floating point numbers in the range 0 to
* 1. If the values passed in are outside that range, they will be
* clamped.
+ *
+ * The default source pattern is opaque black, (that is, it is
+ * equivalent to cairo_set_source_rgb (cr, 0.0, 0.0, 0.0)).
**/
void
cairo_set_source_rgb (cairo_t *cr, double red, double green, double blue)
@@ -696,6 +699,9 @@ cairo_set_source_rgb (cairo_t *cr, double red, double green, double blue)
* The color and alpha components are floating point numbers in the
* range 0 to 1. If the values passed in are outside that range, they
* will be clamped.
+ *
+ * The default source pattern is opaque black, (that is, it is
+ * equivalent to cairo_set_source_rgba (cr, 0.0, 0.0, 0.0, 1.0)).
**/
void
cairo_set_source_rgba (cairo_t *cr,
@@ -778,9 +784,9 @@ slim_hidden_def (cairo_set_source_surface);
* that further modifications of the current transformation matrix
* will not affect the source pattern. See cairo_pattern_set_matrix().
*
- * XXX: I'd also like to direct the reader's attention to some
- * (not-yet-written) section on cairo's imaging model. How would I do
- * that if such a section existed? (cworth).
+ * The default source pattern is a solid pattern that is opaque black,
+ * (that is, it is equivalent to cairo_set_source_rgb (cr, 0.0, 0.0,
+ * 0.0)).
**/
void
cairo_set_source (cairo_t *cr, cairo_pattern_t *source)