X Version 11 (Release 6.1)

XDrawString(X3xlib)

XDrawString -- draw text characters

Synopsis

   XDrawString(display, d, gc, x, y, string, length)
         Display *display;
         Drawable d;
         GC gc;
         int x, y;
         char *string;
         int length;
   
   XDrawString16(display, d, gc, x, y, string, length)
         Display *display;
         Drawable d;
         GC gc;
         int x, y;
         XChar2b *string;
         int length;

Arguments

d: Specifies the drawable.
display: Specifies the connection to the X server.
gc: Specifies the GC.
length: Specifies the number of characters in the string argument.
string: Specifies the character string.
x y: Specify the x and y coordinates, which are relative to the origin of the specified drawable and define the origin of the first character.

Description

Each character image, as defined by the font in the GC, is treated as an additional mask for a fill operation on the drawable. The drawable is modified only where the font character has a bit set to 1. For fonts defined with 2-byte matrix indexing and used with XDrawString16, each byte is used as a byte2 with a byte1 of zero. byte1 and byte2 are unsigned char in the XChar2b structure.

Both functions use these GC components: function, plane-mask, fill-style, font, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. They also use these GC mode-dependent components: foreground, background, tile, stipple, tile-stipple-x-origin, and tile-stipple-y-origin.

XDrawString and XDrawString16 can generate ``BadDrawable'', ``BadGC'', and ``BadMatch'' errors.

Structures

The XChar2b structure contains:

   typedef struct {
          unsigned char byte1;
          unsigned char byte2;
   } XChar2b;

byte1 and byte2 make up the 2-byte or 16-bit characters of the XChar2b structure. byte1 is the most significant byte.

Diagnostics

``BadDrawable'': A value for a Drawable argument does not name a defined Window or Pixmap.
``BadGC'': A value for a GContext argument does not name a defined GContext.
``BadMatch'': An InputOnly window is used as a Drawable.
``BadMatch'': Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request.

References

XDrawImageString(X3xlib), XDrawText(X3xlib), XLoadFont(X3xlib)
Xlib - C Language X Interface