TextExtents

class TextExtents(tuple)

class cairo.TextExtents(x_bearing, y_bearing, width, height, x_advance, y_advance)
Parameters:
  • x_bearing (float) – the horizontal distance from the origin to the leftmost part of the glyphs as drawn. Positive if the glyphs lie entirely to the right of the origin.
  • y_bearing (float) – the vertical distance from the origin to the topmost part of the glyphs as drawn. Positive only if the glyphs lie completely below the origin; will usually be negative.
  • width (float) – width of the glyphs as drawn
  • height (float) – height of the glyphs as drawn
  • x_advance (float) – distance to advance in the X direction after drawing these glyphs
  • y_advance (float) – distance to advance in the Y direction after drawing these glyphs. Will typically be zero except for vertical text layout as found in East-Asian languages.
Return type:

TextExtents

New in version 1.15: In prior versions a (float, float, float, float, float, float) tuple was used instead of TextExtents.

The TextExtents class stores the extents of a single glyph or a string of glyphs in user-space coordinates. Because text extents are in user-space coordinates, they are mostly, but not entirely, independent of the current transformation matrix. If you call context.scale(2.0, 2.0), text will be drawn twice as big, but the reported text extents will not be doubled. They will change slightly due to hinting (so you can’t assume that metrics are independent of the transformation matrix), but otherwise will remain unchanged.

x_bearing

float

y_bearing

float

width

float

height

float

x_advance

float

y_advance

float