summaryrefslogtreecommitdiff
path: root/pango/pango-layout.c
diff options
context:
space:
mode:
Diffstat (limited to 'pango/pango-layout.c')
-rw-r--r--pango/pango-layout.c10
1 files changed, 9 insertions, 1 deletions
diff --git a/pango/pango-layout.c b/pango/pango-layout.c
index f91b91d3..ba81adf6 100644
--- a/pango/pango-layout.c
+++ b/pango/pango-layout.c
@@ -7510,9 +7510,17 @@ pango_layout_iter_get_baseline (PangoLayoutIter *iter)
}
/**
- * pango_layout_iter_get_run_baseline
+ * pango_layout_iter_get_run_baseline:
* @iter: a `PangoLayoutIter`
*
+ * Gets the Y position of the current run's baseline, in layout
+ * coordinates.
+ *
+ * Layout coordinates have the origin at the top left of the entire layout.
+ *
+ * The run baseline can be different from the line baseline, for
+ * example due to superscript or subscript positioning.
+ *
* Since: 1.50
*/
int