1XCopyArea(3)                    XLIB FUNCTIONS                    XCopyArea(3)
2
3
4

NAME

6       XCopyArea, XCopyPlane - copy areas
7

SYNTAX

9       int XCopyArea(Display *display, Drawable src, Drawable dest, GC gc, int
10              src_x, int src_y,  unsigned  int  width,  unsigned  height,  int
11              dest_x, int dest_y);
12
13       int  XCopyPlane(Display  *display,  Drawable src, Drawable dest, GC gc,
14              int src_x, int  src_y,  unsigned  width,  unsigned  height,  int
15              dest_x, int dest_y, unsigned long plane);
16

ARGUMENTS

18       dest_x
19       dest_y    Specify  the  x  and y coordinates, which are relative to the
20                 origin of the destination rectangle and  specify  its  upper-
21                 left corner.
22
23       display   Specifies the connection to the X server.
24
25       gc        Specifies the GC.
26
27       plane     Specifies the bit plane.  You must set exactly one bit to 1.
28
29       src
30       dest      Specify the source and destination rectangles to be combined.
31
32       src_x
33       src_y     Specify  the  x  and y coordinates, which are relative to the
34                 origin of the source rectangle  and  specify  its  upper-left
35                 corner.
36
37       width
38       height    Specify  the  width  and  height, which are the dimensions of
39                 both the source and destination rectangles.
40

DESCRIPTION

42       The XCopyArea function combines the specified rectangle of src with the
43       specified rectangle of dest.  The drawables must have the same root and
44       depth, or a BadMatch error results.
45
46       If regions of the source rectangle are obscured and have not  been  re‐
47       tained  in  backing  store  or if regions outside the boundaries of the
48       source drawable are specified, those regions are not copied.   Instead,
49       the  following occurs on all corresponding destination regions that are
50       either visible or are retained in backing store.  If the destination is
51       a  window  with  a background other than None, corresponding regions of
52       the destination are tiled with that background (with plane-mask of  all
53       ones  and GXcopy function).  Regardless of tiling or whether the desti‐
54       nation is a window or a pixmap, if  graphics-exposures  is  True,  then
55       GraphicsExpose  events  for  all  corresponding destination regions are
56       generated.  If graphics-exposures is True but no GraphicsExpose  events
57       are  generated,  a  NoExpose  event is generated.  Note that by default
58       graphics-exposures is True in new GCs.
59
60       This function uses these GC components: function,  plane-mask,  subwin‐
61       dow-mode,  graphics-exposures,  clip-x-origin, clip-y-origin, and clip-
62       mask.
63
64       XCopyArea can generate BadDrawable, BadGC, and BadMatch errors.
65
66       The XCopyPlane function uses a single bit plane of the specified source
67       rectangle  combined  with the specified GC to modify the specified rec‐
68       tangle of dest.  The drawables must have the same  root  but  need  not
69       have  the  same  depth.   If the drawables do not have the same root, a
70       BadMatch error results.  If plane does not have exactly one bit set  to
71       1  and  the  value  of plane is not less than %2 sup n%, where n is the
72       depth of src, a BadValue error results.
73
74       Effectively, XCopyPlane forms a pixmap of the same depth as the rectan‐
75       gle  of  dest  and with a size specified by the source region.  It uses
76       the foreground/background pixels in the GC (foreground  everywhere  the
77       bit plane in src contains a bit set to 1, background everywhere the bit
78       plane in src contains a bit set to 0) and the equivalent of a  CopyArea
79       protocol  request  is  performed  with all the same exposure semantics.
80       This can also be thought of as using the specified region of the source
81       bit  plane  as  a  stipple  with a fill-style of FillOpaqueStippled for
82       filling a rectangular area of the destination.
83
84       This function uses these GC  components:  function,  plane-mask,  fore‐
85       ground,  background, subwindow-mode, graphics-exposures, clip-x-origin,
86       clip-y-origin, and clip-mask.
87
88       XCopyPlane can generate BadDrawable, BadGC, BadMatch, and BadValue  er‐
89       rors.
90

DIAGNOSTICS

92       BadDrawable
93                 A  value for a Drawable argument does not name a defined Win‐
94                 dow or Pixmap.
95
96       BadGC     A value for a GContext argument does not name a defined GCon‐
97                 text.
98
99       BadMatch  An InputOnly window is used as a Drawable.
100
101       BadMatch  Some  argument  or pair of arguments has the correct type and
102                 range but fails to match in some other way  required  by  the
103                 request.
104
105       BadValue  Some numeric value falls outside the range of values accepted
106                 by the request.  Unless a specific range is specified for  an
107                 argument,  the  full  range defined by the argument's type is
108                 accepted.  Any argument defined as a set of alternatives  can
109                 generate this error.
110

SEE ALSO

112       XClearArea(3)
113       Xlib - C Language X Interface
114
115
116
117X Version 11                     libX11 1.8.1                     XCopyArea(3)
Impressum