NAME
XmbTextPerCharExtents, XwcTextPerCharExtents, Xutf8TextPerCharExtents -
obtain per-character information for a text string SYNTAX Status XmbTextPerCharExtents(XFontSet fontset, char *string, int numbytes, XRectangle *inkarrayreturn, XRectangle *logi‐ calarrayreturn, int arraysize, int *numcharsreturn, XRect‐ angle *overallinkreturn, XRectangle *overalllogicalreturn); Status XwcTextPerCharExtents(XFontSet fontset, wchart *string, int numwchars, XRectangle *inkarrayreturn, XRectangle *logi‐ calarrayreturn, int arraysize, int *numcharsreturn, XRect‐ angle *overallinkreturn, XRectangle *overalllogicalreturn); Status Xutf8TextPerCharExtents(XFontSet fontset, char *string, int numbytes, XRectangle *inkarrayreturn, XRectangle *logi‐ calarrayreturn, int arraysize, int *numcharsreturn, XRect‐ angle *overallinkreturn, XRectangle *overalllogicalreturn); ARGUMENTS arraysize Specifies the size of inkarrayreturn and logi‐ calarrayreturn. The caller must pass in arrays of this size. fontset Specifies the font set. inkarrayreturn Returns the ink dimensions for each character. logicalarrayreturn Returns the logical dimensions for each character. numbytes Specifies the number of bytes in the string argument. numcharsreturn Returns the number of characters in the string argument. numwchars Specifies the number of characters in the string argument. overallinkreturn Returns the overall ink extents of the entire string. overalllogicalreturn Returns the overall logical extents of the entire string. string Specifies the character string. DESCRIPTION The XmbTextPerCharExtents, XwcTextPerCharExtents and Xutf8TextPer‐ CharExtents functions return the text dimensions of each character of the specified text, using the fonts loaded for the specified font set. Each successive element of inkarrayreturn and logicalarrayreturn is set to the successive character's drawn metrics, relative to the draw‐ ing origin of the string and one rectangle for each character in the supplied text string. The number of elements of inkarrayreturn and logicalarrayreturn that have been set is returned to numcharsreturn. Each element of inkarrayreturn is set to the bounding box of the cor‐ responding character's drawn foreground color. Each element of logi‐ calarrayreturn is set to the bounding box that provides minimum spac‐ ing to other graphical features for the corresponding character. Other graphical features should not intersect any of the logicalarrayreturn rectangles. Note that an XRectangle represents the effective drawing dimensions of the character, regardless of the number of font glyphs that are used to draw the character or the direction in which the character is drawn. If multiple characters map to a single character glyph, the dimensions of all the XRectangles of those characters are the same. When the XFontSet has missing charsets, metrics for each unavailable character are taken from the default string returned by XCreateFontSet so that the metrics represent the text as it will actually be drawn. The behavior for an invalid codepoint is undefined. If the arraysize is too small for the number of characters in the sup‐ plied text, the functions return zero and numcharsreturn is set to the number of rectangles required. Otherwise, the functions return a nonzero value.
If the overallinkreturn or overalllogicalreturn argument is non- NULL, XmbTextPerCharExtents, XwcTextPerCharExtents and Xutf8TextPer‐ CharExtents return the maximum extent of the string's metrics to over‐ allinkreturn or overalllogicalreturn, as returned by XmbTextEx‐ tents, XwcTextExtents or Xutf8TextExtents. The function Xutf8TextPerCharExtents is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro XHAVEUTF8STRING. SEE ALSO
XmbTextEscapement(3), XmbTextExtents(3) Xlib - C Language X Interface X Version 11 libX11 1.6.5 XmbTextPerCharExtents(3)