From cf6b3e1e84fe35f9b4f15f02a3a28e6f15312b96 Mon Sep 17 00:00:00 2001
From: Matthias Clasen <mclasen@redhat.com>
Date: Thu, 26 Aug 2021 11:26:25 -0400
Subject: doc: Update pango_glyph_string_index_to_x

What the docs were saying is no longer strictly true,
now that we are using font metrics. Update them, and
add an illustration.
---
 pango/glyphstring.c | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

(limited to 'pango/glyphstring.c')

diff --git a/pango/glyphstring.c b/pango/glyphstring.c
index eb65875b..8d4aa604 100644
--- a/pango/glyphstring.c
+++ b/pango/glyphstring.c
@@ -370,8 +370,15 @@ pango_glyph_string_get_logical_widths (PangoGlyphString *glyphs,
  * Converts from character position to x position.
  *
  * The X position is measured from the left edge of the run.
- * Character positions are computed by dividing up each cluster
- * into equal portions.
+ * Character positions are obtained using font metrics for ligatures
+ * where available, and computed by dividing up each cluster
+ * into equal portions, otherwise.
+ *
+ * <picture>
+ *   <source srcset="glyphstring-positions-dark.png" media="(prefers-color-scheme: dark)">
+ *   <img alt="Glyph positions" src="glyphstring-positions-light.png">
+ * </picture>
+
  */
 void
 pango_glyph_string_index_to_x (PangoGlyphString *glyphs,
-- 
cgit v1.2.1