---
name: "Xutf8TextEscapement"
section: "3x"
platform: "linux"
package: "libx11-dev"
version: "4.3.0.dfsg.1-14sarge7"
release: "Debian 3.1 (Sarge)"
platforms: ["linux"]
url: "https://new.carta.tech/XmbTextEscapement/3x"
---

# Xutf8TextEscapement(3x)

obtain the escapement of text

Part of [XmbTextEscapement(3x)](/XmbTextEscapement/3x.md).

## NAME

XmbTextEscapement, XwcTextEscapement, Xutf8TextEscapement - obtain the escapement of text

## SYNTAX

int XmbTextEscapement(XFontSet *font\_set*, char \**string*, int *num\_bytes*);

int XwcTextEscapement(XFontSet *font\_set*, wchar\_t \**string*, int *num\_wchars*);

int Xutf8TextEscapement(XFontSet *font\_set*, char \**string*,  int *num\_bytes*);

## ARGUMENTS

- *font\_set*

  Specifies the font set.

- *num\_bytes*

  Specifies the number of bytes in the string argument.

- *num\_wchars*

  Specifies the number of characters in the string argument.

- *string*

  Specifies the character string.

## DESCRIPTION

The *XmbTextEscapement*, *XwcTextEscapement* and *Xutf8TextEscapement* functions return the escapement in pixels of the specified string as a value, using the fonts loaded for the specified font set. The escapement is the distance in pixels in the primary draw direction from the drawing origin to the origin of the next character to be drawn, assuming that the rendering of the next character is not dependent on the supplied string.

Regardless of the character rendering order, the escapement is always positive.

The function *Xutf8TextEscapement* is an XFree86 extension introduced in XFree86 4.0.2. Its presence is indicated by the macro *X\_HAVE\_UTF8\_STRING*.

## SEE ALSO

XmbTextExtents(3X11), XmbTextPerCharExtents(3X11) *Xlib - C Language X Interface*