[pango/pango2: 52/135] layout-run: add docs
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pango/pango2: 52/135] layout-run: add docs
- Date: Fri, 18 Feb 2022 20:11:00 +0000 (UTC)
commit d90267c97939c85570002ef5e34f81b7dd6f0d75
Author: Matthias Clasen <mclasen redhat com>
Date: Mon Jan 24 14:41:52 2022 -0500
layout-run: add docs
pango/pango-layout-run.c | 29 +++++++++++++++++++++++++++++
1 file changed, 29 insertions(+)
---
diff --git a/pango/pango-layout-run.c b/pango/pango-layout-run.c
index f17ca084..ff73bbf8 100644
--- a/pango/pango-layout-run.c
+++ b/pango/pango-layout-run.c
@@ -6,12 +6,41 @@
#include <math.h>
+/**
+ * PangoLayoutRun:
+ *
+ * A `PangoLayoutRun` represents a single run within a `PangoLayoutLine`.
+ *
+ * A run is a range of text with uniform script, font and attributes that
+ * is shaped as a unit.
+ *
+ * Script, font and attributes of a run can be accessed via
+ * [method@Pango.LayoutRun.get_item]. The glyphs that result from shaping
+ * the text of the run can be obtained via [method@Pango.LayoutRun.get_glyphs].
+ */
+
+/**
+ * pango_layout_run_get_item:
+ * @run: a `PangoLayoutRun`
+ *
+ * Gets the `PangoItem` for the run.
+ *
+ * Returns: (transfer none): the `PangoItem` of @run
+ */
PangoItem *
pango_layout_run_get_item (PangoLayoutRun *run)
{
return run->glyph_item.item;
}
+/**
+ * pango_layout_run_get_glyphs:
+ * @run: a `PangoLayoutRun`
+ *
+ * Gets the `PangoGlyphString` for the run.
+ *
+ * Returns: (transfer none): the `PangoGlyphString` of @run
+ */
PangoGlyphString *
pango_layout_run_get_glyphs (PangoLayoutRun *run)
{
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]