text_get_extents_font

Description:

public bool text_get_extents_font (string text, double size, Font font, out int width, out int height, out int ascent, out int descent)

Get extents of the bounding box for the specified text.

This tool returns the width and height of a bounding box for the specified text rendered with the specified font information. Ascent and descent of the glyph extents are returned as well. The ascent is the distance from the baseline to the highest point of the character. This is positive if the glyph ascends above the baseline. The descent is the distance from the baseline to the lowest point of the character. This is positive if the glyph descends below the baseline. The size is always in pixels. If you need to set a font in points, divide the size in points by 72.0 and multiply it by the vertical resolution of the image you are taking into account.

Parameters:

text	The text to generate (in UTF-8 encoding).
size	The size of text in either pixels or points.
font	The name of the font.
width	The width of the glyph extents.
height	The height of the glyph extents.
ascent	The ascent of the glyph extents.
descent	The descent of the glyph extents.

Returns:

TRUE on success.

Namespace: Gimp

Package: gimp-3.0