Package: cairo

Function cairo:text-extents

Lambda List

cairo:text-extents (cr utf8)

Syntax

(cairo:text-extents cr utf8) => xbearing, ybearing, width, height xadvance, yadvance

Arguments

cr -- a cairo:context-t instance
utf8 -- a string of text encoded in UTF-8

Return Value

The double floats of the cairo:text-extents-t instance for the extents of utf8.

Details

Gets the extents for a string of text. The extents describe a user-space rectangle that encloses the "inked" portion of the text, as it would be drawn by the cairo:show-text function. Additionally, the xadvance and yadvance values indicate the amount by which the current point would be advanced by the cairo:show-text function.

Note that whitespace characters do not directly contribute to the size of the rectangle width and height values. They do contribute indirectly by changing the position of non-whitespace characters. In particular, trailing whitespace characters are likely to not affect the size of the rectangle, though they will affect the xadvance and yadvance values.
 

See also

2025-1-29