diff options
author | Behdad Esfahbod <behdad@gnome.org> | 2006-07-19 22:58:35 +0000 |
---|---|---|
committer | Behdad Esfahbod <behdad@src.gnome.org> | 2006-07-19 22:58:35 +0000 |
commit | ffe50c3b3fc4c50866d51fbafa7fff308b71b59b (patch) | |
tree | a8f658455a0dd4e85ff4716f914779be0ed9f980 /pango | |
parent | 31ba75138bff6e701a5473f0ffcd765781384eea (diff) | |
download | pango-ffe50c3b3fc4c50866d51fbafa7fff308b71b59b.tar.gz |
Improve docs.
2006-07-19 Behdad Esfahbod <behdad@gnome.org>
* pango/pango-layout.c (pango_layout_get_extents): Improve docs.
Diffstat (limited to 'pango')
-rw-r--r-- | pango/pango-layout.c | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/pango/pango-layout.c b/pango/pango-layout.c index bd76a265..11cd6035 100644 --- a/pango/pango-layout.c +++ b/pango/pango-layout.c @@ -2215,9 +2215,14 @@ pango_layout_get_extents_internal (PangoLayout *layout, or %NULL to indicate that the result is not needed. * * Computes the logical and ink extents of @layout. Logical extents - * are usually what you want for positioning things. The extents - * are given in layout coordinates; layout coordinates begin at the - * top left corner of the layout. + * are usually what you want for positioning things. Note that both extents + * may have non-zero x and y. You may want to use those to offset where you + * render the layout. Not doing that is a very typical bug that shows up as + * right-to-left layouts not being correctly positioned in a layout with + * a set width. + * + * The extents are given in layout coordinates and in Pango units; layout + * coordinates begin at the top left corner of the layout. */ void pango_layout_get_extents (PangoLayout *layout, |