summaryrefslogtreecommitdiff
path: root/pango/pango-glyph.h
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2021-08-27 11:25:49 -0400
committerMatthias Clasen <mclasen@redhat.com>2021-08-27 12:18:26 -0400
commit9979612c72ebee4674bfd99eaabb373034b5efe4 (patch)
tree6e758a314a97d1fef909657af3ef4eff522c236d /pango/pango-glyph.h
parentc9f3cc464c4f06cc31c2b42e5c305a7fd7ae5879 (diff)
downloadpango-9979612c72ebee4674bfd99eaabb373034b5efe4.tar.gz
docs: Some detail for PangoGlyphGeometry
Diffstat (limited to 'pango/pango-glyph.h')
-rw-r--r--pango/pango-glyph.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/pango/pango-glyph.h b/pango/pango-glyph.h
index 4dc77fd1..2094fa53 100644
--- a/pango/pango-glyph.h
+++ b/pango/pango-glyph.h
@@ -58,6 +58,19 @@ typedef gint32 PangoGlyphUnit;
*
* The `PangoGlyphGeometry` structure contains width and positioning
* information for a single glyph.
+ *
+ * Note that @width is not guaranteed to be the same as the glyph
+ * extents. Kerning and other positioning applied during shaping will
+ * affect both the @width and the @x_offset for the glyphs in the
+ * glyph string that results from shaping.
+ *
+ * The information in this struct is intended for rendering the glyphs,
+ * as follows:
+ *
+ * 1. Render the current glyph at (x + x_offset, y + y_offset),
+ * where (x, y) is the current point
+ * 2. Advance the current point to (x + xoffset, y)
+ * 3. Render the next glyph...
*/
struct _PangoGlyphGeometry
{