XmbDrawImageString

Section: XLIB FUNCTIONS (3)
Updated: libX11 1.6.4
Index Return to Main Contents

NAME

XmbDrawImageString, XwcDrawImageString, Xutf8DrawImageString - draw image text using a single font set

SYNTAX

: void XmbDrawImageString(Display *display, Drawable d, XFontSet font_set, GC gc, int x, int y, char *string, int num_bytes);
: void XwcDrawImageString(Display *display, Drawable d, XFontSet font_set, GC gc, int x, int y, wchar_t *string, int num_wchars);
: void Xutf8DrawImageString(Display *display, Drawable d, XFontSet font_set, GC gc, int x, int y, char *string, int num_bytes);

ARGUMENTS

d: Specifies the drawable.
display: Specifies the connection to the X server.
font_set: Specifies the font set.
gc: Specifies the GC.
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.
x
y: Specify the x and y coordinates.

DESCRIPTION

The XmbDrawImageString, XwcDrawImageString and Xutf8DrawImageString functions fill a destination rectangle with the background pixel defined in the GC and then paint the text with the foreground pixel. The filled rectangle is the rectangle returned to overall_logical_return by XmbTextExtents, XwcTextExtents or Xutf8TextExtents for the same text and XFontSet.

When the XFontSet has missing charsets, each unavailable character is drawn with the default string returned by XCreateFontSet. The behavior for an invalid codepoint is undefined.

The function Xutf8TextExtents is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro X_HAVE_UTF8_STRING.