XDrawImageString(3X)                         XDrawImageString(3X)



NAME
     XDrawImageString, XDrawImageString16 - draw image text

SYNOPSIS
     XDrawImageString (display, d, gc, x, y, string, length)
     Display *display;
     Drawable d;
     GC gc;
     int x,y;
     char *string;
     int length;

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

DESCRIPTION
     The XDrawImageString and XDrawImageString16 functions draw
     8-bit and 16-bit image text characters in the specified
     drawable.  These functions also modify both the foreground
     and background pixels in the characters.  The effect is
     first to fill a destination rectangle with the background
     pixel defined in the graphic context and then to paint the
     text with the foreground pixel.  The upper-left corner of
     the filled rectangle is at [x, y - font-ascent].  The width
     is overall-width, and the height is font-ascent + font-
     descent.  The values for overall-width, font-ascent, and
     font-descent are as would be returned by XQueryTextExtents
     using gc and string.  The function and fill_style defined in
     the graphic context are ignored for these functions. The ef-
     fective function is GXcopy, and the effective fill_style is
     FillSolid.

     For fonts defined with 2-byte matrix indexing and used with
     XDrawImageString, each byte is used as a byte2 with a byte1
     of 0.

     Both functions use these graphic context components: plane-
     mask, foreground, background, font, subwindow-mode, clip-x-
     origin, clip-y-origin, and clip-mask.

   Arguments
     These functions accept the following arguments:

     d       Specifies the drawable.

     display Specifies the connection to the X server.




November, 1990                                                  1

XDrawImageString(3X)                         XDrawImageString(3X)



     gc      Specifies the graphic context.

     length  Specifies the number of characters in the string ar-
             gument.

     string  Specifies the character string.

     x, y    Specify the x and y coordinates.

ERRORS
     BadDrawable
             A value for a Drawable argument does not name a de-
             fined window or pixel map.

     BadGC   A value for a GC argument does not name a defined
             graphic context.

     BadMatch
             An InputOnly window is used as a drawable; or, an
             argument or pair of arguments has the correct type
             and range but fails to match in some other required
             way.

     Both functions can generate BadDrawable, BadGC, and
     BadMatch errors.

SEE ALSO
     XCreateGC(3X), XDrawString(3X), XDrawText(3X),
     XLoadFont(3X), XTextExtents(3X)

     Xlib - C Language Interface

























2                                                  November, 1990