diff options
| author | Matthias Clasen <mclasen@redhat.com> | 2022-01-24 14:41:52 -0500 |
|---|---|---|
| committer | Matthias Clasen <mclasen@redhat.com> | 2022-01-25 15:30:55 -0500 |
| commit | 787f5c599c4c135187be237c7c805b385550eeb4 (patch) | |
| tree | 296a8a74243b3e3871d95a4df51e25abc8f4034c | |
| parent | 0ed8c5b7e5aa9c32e2da2a5c09063af8eb8b6e04 (diff) | |
| download | pango-787f5c599c4c135187be237c7c805b385550eeb4.tar.gz | |
layout-run: add docs
| -rw-r--r-- | pango/pango-layout-run.c | 29 |
1 files changed, 29 insertions, 0 deletions
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) { |