XCopyArea

Syntax

XCopyArea(display, src, dest, gc, src_x, src_y, width, height,  dest_x, dest_y)
      Display *display;
      Drawable src, dest;
      GC gc;
      int src_x, src_y;
      unsigned int width, height;
      int dest_x, dest_y;

Arguments

display Specifies the connection to the X server.
src
dest
Specify the source and destination rectangles to be combined.
gc Specifies the GC.
src_x
src_y
Specify the x and y coordinates, which are relative to the origin of the source rectangle and specify its upper-left corner.
width
height Specify the width and height, which are the dimensions of both the source and destination rectangles.
dest_x
dest_y
Specify the x and y coordinates, which are relative to the origin of the destination rectangle and specify its upper-left corner

Description

The XCopyArea() function combines the specified rectangle of src with the specified rectangle of dest. The drawables must have the same root and depth, or a BadMatch error results.

If regions of the source rectangle are obscured and have not been retained in backing store or if regions outside the boundaries of the source drawable are specified, those regions are not copied. Instead, the following occurs on all corresponding destination regions that are either visible or are retained in backing store. If the destination is a window with a background other than None, corresponding regions of the destination are tiled with that background (with plane-mask of all ones and GXcopy function). Regardless of tiling or whether the destination is a window or a pixmap, if graphics-exposures is True, then GraphicsExpose events for all corresponding destination regions are generated. If graphics-exposures is True but no GraphicsExpose events are generated, a NoExpose event is generated. Note that by default graphics-exposures is True in new GCs.

This function uses these GC components: function, plane-mask, subwindow-mode, graphics-exposure, clip-x-origin, clip-y-origin, and clip-mask.

XCopyArea() can generate BadDrawable, BadGC, and BadMatch errors.

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.

See also

XClearArea(), XCopyPlane(), "Copying Areas".
Christophe Tronche, ch@tronche.com