1XmbTextEscapement(3)            XLIB FUNCTIONS            XmbTextEscapement(3)
2
3
4

NAME

6       XmbTextEscapement,  XwcTextEscapement, Xutf8TextEscapement - obtain the
7       escapement of text
8

SYNTAX

10       int XmbTextEscapement(XFontSet font_set, char *string, int num_bytes);
11
12       int   XwcTextEscapement(XFontSet   font_set,   wchar_t   *string,   int
13              num_wchars);
14
15       int    Xutf8TextEscapement(XFontSet   font_set,   char   *string,   int
16              num_bytes);
17

ARGUMENTS

19       font_set  Specifies the font set.
20
21       num_bytes Specifies the number of bytes in the string argument.
22
23       num_wchars
24                 Specifies the number of characters in the string argument.
25
26       string    Specifies the character string.
27

DESCRIPTION

29       The XmbTextEscapement, XwcTextEscapement and Xutf8TextEscapement  func‐
30       tions  return  the  escapement  in  pixels of the specified string as a
31       value, using the fonts loaded for the specified font set.  The  escape‐
32       ment  is  the distance in pixels in the primary draw direction from the
33       drawing origin to the origin of the next character to be drawn,  assum‐
34       ing  that  the  rendering of the next character is not dependent on the
35       supplied string.
36
37       Regardless of the character rendering order, the escapement  is  always
38       positive.
39
40       The  function  Xutf8TextEscapement  is  an  extension introduced by The
41       XFree86 Project, Inc., in their 4.0.2 release.  Its presence  is  indi‐
42       cated by the macro X_HAVE_UTF8_STRING.
43

SEE ALSO

45       XmbTextExtents(3),  XmbTextPerCharExtents(3) Xlib - C Language X Inter‐
46       face
47
48
49
50X Version 11                     libX11 1.6.9             XmbTextEscapement(3)
Impressum