[pango/matthiasc/for-master: 201/202] docs: Add some details




commit b83e3ba78ea3466c001b465e9f0620c7ef5d7a5a
Author: Matthias Clasen <mclasen redhat com>
Date:   Sat Apr 3 09:36:19 2021 -0400

    docs: Add some details
    
    Mainly for my own education.

 pango/pango-renderer.c | 12 ++++++++++++
 1 file changed, 12 insertions(+)
---
diff --git a/pango/pango-renderer.c b/pango/pango-renderer.c
index 2d676782..8f3c9846 100644
--- a/pango/pango-renderer.c
+++ b/pango/pango-renderer.c
@@ -157,6 +157,9 @@ pango_renderer_finalize (GObject *gobject)
  *
  * Draws @layout with the specified `PangoRenderer`.
  *
+ * This is equivalent to drawing the lines of the layout, at their
+ * respective positions relative to @x, @y.
+ *
  * Since: 1.8
  */
 void
@@ -558,6 +561,10 @@ draw_shaped_glyphs (PangoRenderer    *renderer,
  *
  * Draws @line with the specified `PangoRenderer`.
  *
+ * This draws the glyph items that make up the line, as well as
+ * shapes, backgrounds and lines that are specified by the attributes
+ * of those items.
+ *
  * Since: 1.8
  */
 void
@@ -807,6 +814,11 @@ pango_renderer_default_draw_glyphs (PangoRenderer    *renderer,
  *
  * This is useful for rendering text in PDF.
  *
+ * Note that this method does not handle attributes in @glyph_item.
+ * If you want colors, shapes and lines handled automatically according
+ * to those attributes, you need to use pango_renderer_draw_layout_line()
+ * or pango_renderer_draw_layout().
+ *
  * Note that @text is the start of the text for layout, which is then
  * indexed by `glyph_item->item->offset`.
  *


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]