diff options
| author | Havoc Pennington <hp@pobox.com> | 2002-01-14 16:40:08 +0000 |
|---|---|---|
| committer | Havoc Pennington <hp@src.gnome.org> | 2002-01-14 16:40:08 +0000 |
| commit | 74e502e029aa1933b346235ba16e079a976a5f22 (patch) | |
| tree | f39f5aa7e7b4bda008e105c7c44a53b5e094696c /pango/pango-layout.c | |
| parent | 8937d47799697b7225d310657e8115b8aec6ff9b (diff) | |
| download | pango-74e502e029aa1933b346235ba16e079a976a5f22.tar.gz | |
slight correction to pango_layout_get_extents(), docs still need to be
2002-01-14 Havoc Pennington <hp@pobox.com>
* pango/pango-layout.c: slight correction to
pango_layout_get_extents(), docs still need to be clearer, but
at least they aren't a cut-and-paste of glyph string docs now.
* docs/tmpl/glyphs.sgml: add note about special-case use of
PANGO_SCALE with font sizes
* pango/fonts.c: fix docs to be correct about PANGO_SCALE
Diffstat (limited to 'pango/pango-layout.c')
| -rw-r--r-- | pango/pango-layout.c | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/pango/pango-layout.c b/pango/pango-layout.c index f26c8080..80d3f06c 100644 --- a/pango/pango-layout.c +++ b/pango/pango-layout.c @@ -1980,14 +1980,15 @@ pango_layout_get_extents_internal (PangoLayout *layout, /** * pango_layout_get_extents: * @layout: a #PangoLayout - * @ink_rect: rectangle used to store the extents of the glyph string as drawn + * @ink_rect: rectangle used to store the extents of the layout as drawn * or %NULL to indicate that the result is not needed. - * @logical_rect: rectangle used to store the logical extents of the glyph - * string or %NULL to indicate that the result is not needed. + * @logical_rect: rectangle used to store the logical extents of the layout + or %NULL to indicate that the result is not needed. * - * Compute the logical and ink extents of @layout. See the documentation - * for pango_font_get_glyph_extents() for details about the interpretation - * of the rectangles. + * Compute 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. */ void pango_layout_get_extents (PangoLayout *layout, @@ -2002,16 +2003,15 @@ pango_layout_get_extents (PangoLayout *layout, /** * pango_layout_get_pixel_extents: * @layout: a #PangoLayout - * @ink_rect: rectangle used to store the extents of the glyph string as drawn + * @ink_rect: rectangle used to store the extents of the layout as drawn * or %NULL to indicate that the result is not needed. - * @logical_rect: rectangle used to store the logical extents of the glyph - * string or %NULL to indicate that the result is not needed. + * @logical_rect: rectangle used to store the logical extents of the + * layout or %NULL to indicate that the result is not needed. * - * Compute the logical and ink extents of @layout. See the documentation - * for pango_font_get_glyph_extents() for details about the interpretation - * of the rectangles. The returned rectangles are in device units, as - * opposed to pango_layout_get_extents(), which returns the extents in - * units of device unit / PANGO_SCALE. + * Compute the logical and ink extents of @layout in device units. + * See pango_layout_get_extents(); this function just calls + * pango_layout_get_extents() and then converts the extents to + * pixels using the #PANGO_SCALE factor. **/ void pango_layout_get_pixel_extents (PangoLayout *layout, |