XmbTextPerCharExtents man page on BSDi

Man page or keyword search:  
man Server   6284 pages
apropos Keyword Search (all sections)
Output format
BSDi logo
[printable version]



XmbTextPerCharExtents(3X11XLIB FUNCTIOXmbTextPerCharExtents(3X11)

NAME
       XmbTextPerCharExtents, XwcTextPerCharExtents,
       Xutf8TextPerCharExtents - obtain per-character information
       for a text string

SYNTAX
       Status XmbTextPerCharExtents(font_set, string, num_bytes,
       ink_array_return,
		  logical_array_return, array_size,
       num_chars_return, overall_ink_return,
       overall_logical_return)
	     XFontSet font_set;
	     char *string;
	     int num_bytes;
	     XRectangle *ink_array_return;
	     XRectangle *logical_array_return;
	     int array_size;
	     int *num_chars_return;
	     XRectangle *overall_ink_return;
	     XRectangle *overall_logical_return;

       Status XwcTextPerCharExtents(font_set, string, num_wchars,
       ink_array_return,
		 logical_array_return, array_size,
       num_chars_return, overall_ink_return,
       overall_logical_return)
	     XFontSet font_set;
	     wchar_t *string;
	     int num_wchars;
	     XRectangle *ink_array_return;
	     XRectangle *logical_array_return;
	     int array_size;
	     int *num_chars_return;
	     XRectangle *overall_ink_return;
	     XRectangle *overall_logical_return;

       Status Xutf8TextPerCharExtents(font_set, string,
       num_bytes, ink_array_return,
		  logical_array_return, array_size,
       num_chars_return, overall_ink_return,
       overall_logical_return)
	     XFontSet font_set;
	     char *string;
	     int num_bytes;
	     XRectangle *ink_array_return;
	     XRectangle *logical_array_return;
	     int array_size;
	     int *num_chars_return;
	     XRectangle *overall_ink_return;
	     XRectangle *overall_logical_return;

ARGUMENTS
       array_size
		 Specifies the size of ink_array_return and

X Version 11		Release 6.4				1

XmbTextPerCharExtents(3X11XLIB FUNCTIOXmbTextPerCharExtents(3X11)

		 logical_array_return.	The caller must pass in
		 arrays of this size.

       font_set Specifies the font set.

       ink_array_return
		 Returns the ink dimensions for each character.

       logical_array_return
		 Returns the logical dimensions for each charac-
		 ter.

       num_bytes Specifies the number of bytes in the string
		 argument.

       num_chars_return
		 Returns the number of characters in the string
		 argument.

       num_wchars
		 Specifies the number of characters in the string
		 argument.

       overall_ink_return
		 Returns the overall ink extents of the entire
		 string.

       overall_logical_return
		 Returns the overall logical extents of the
		 entire string.

       string	Specifies the character string.

DESCRIPTION
       The XmbTextPerCharExtents, XwcTextPerCharExtents and
       Xutf8TextPerCharExtents functions return the text dimen-
       sions of each character of the specified text, using the
       fonts loaded for the specified font set. Each successive
       element of ink_array_return and logical_array_return is
       set to the successive character's drawn metrics, relative
       to the drawing origin of the string and one rectangle for
       each character in the supplied text string.  The number of
       elements of ink_array_return and logical_array_return that
       have been set is returned to num_chars_return.

       Each element of ink_array_return is set to the bounding
       box of the corresponding character's drawn foreground
       color.  Each element of logical_array_return is set to the
       bounding box that provides minimum spacing to other graph-
       ical features for the corresponding character.  Other
       graphical features should not intersect any of the logi-
       cal_array_return rectangles.

       Note that an XRectangle represents the effective drawing

X Version 11		Release 6.4				2

XmbTextPerCharExtents(3X11XLIB FUNCTIOXmbTextPerCharExtents(3X11)

       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 array_size is too small for the number of charac-
       ters in the supplied text, the functions return zero and
       num_chars_return is set to the number of rectangles
       required.  Otherwise, the functions return a nonzero
       value.

       If the overall_ink_return or overall_logical_return argu-
       ment is non-NULL, XmbTextPerCharExtents, XwcTextPerCharEx-
       tents and Xutf8TextPerCharExtents return the maximum
       extent of the string's metrics to overall_ink_return or
       overall_logical_return, as returned by XmbTextExtents,
       XwcTextExtents or Xutf8TextExtents.

       The function Xutf8TextPerCharExtents is an XFree86 exten-
       sion introduced in XFree86 4.0.2. Its presence is indi-
       cated by the macro X_HAVE_UTF8_STRING.

SEE ALSO
       XmbTextEscapement(3X11), XmbTextExtents(3X11) Xlib - C
       Language X Interface

X Version 11		Release 6.4				3

[top]

List of man pages available for BSDi

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net