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,  _Xconst  char  *string,  int
11              num_bytes);
12
13       int  XwcTextEscapement(XFontSet  font_set, _Xconst wchar_t *string, int
14              num_wchars);
15
16       int Xutf8TextEscapement(XFontSet font_set, _Xconst  char  *string,  int
17              num_bytes);
18

ARGUMENTS

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

DESCRIPTION

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

SEE ALSO

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