NAME

XCopyArea, XCopyPlane - copy areas

SYNTAX

int XCopyArea(Display *_d_i_s_p_l_a_y, Drawable _s_r_c, Drawable _d_e_s_t, GC _g_c, int _s_r_c___x, int _s_r_c___y, unsigned int _w_i_d_t_h, unsigned _h_e_i_g_h_t, int _d_e_s_t___x, int _d_e_s_t___y); int XCopyPlane(Display *_d_i_s_p_l_a_y, Drawable _s_r_c, Drawable _d_e_s_t, GC _g_c, int _s_r_c___x, int _s_r_c___y, unsigned _w_i_d_t_h, int _h_e_i_g_h_t, int _d_e_s_t___x, int _d_e_s_t___y, unsigned long _p_l_a_n_e);

ARGUMENTS

and specify its upper-left corner
_d_e_s_t___x
_d_e_s_t___y Specify the x and y coordinates, which are relative to the origin of the destination rectangle.
_d_i_s_p_l_a_y Specifies the connection to the X server.
_g_c Specifies the GC.
_p_l_a_n_e Specifies the bit plane.
You must set exactly one bit to 1.
_s_r_c
_d_e_s_t Specify the source and destination rectangles to be combined.
_s_r_c___x
_s_r_c___y Specify the x and y coordinates,
which are relative to the origin of the source rectangle and specify its upper-left corner. and destination rectangles
_w_i_d_t_h
_h_e_i_g_h_t Specify the width and height, which are the dimensions of both the source.

DESCRIPTION

The _X_C_o_p_y_A_r_e_a function combines the specified rectangle of src with the specified rectangle of dest. The drawables must have the same root and depth, or a _B_a_d_M_a_t_c_h 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 _N_o_n_e, corresponding regions of the destination are tiled with that background (with plane-mask of all ones and _G_X_c_o_p_y function). Regardless of tiling or whether the destination is a window or a pixmap, if graphics-exposures is _T_r_u_e, then _G_r_a_p_h_i_c_s_E_x_p_o_s_e events for all corresponding destination regions are generated. If graphics-exposures is _T_r_u_e but no _G_r_a_p_h_i_c_s_E_x_p_o_s_e events are generated, a _N_o_E_x_p_o_s_e event is generated. Note that by default graphics-exposures is _T_r_u_e in new GCs.

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

_X_C_o_p_y_A_r_e_a can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_G_C, and _B_a_d_M_a_t_c_h errors.

The _X_C_o_p_y_P_l_a_n_e function uses a single bit plane of the specified source rectangle combined with the specified GC to modify the specified rectangle of dest. The drawables must have the same root but need not have the same depth. If the drawables do not have the same root, a _B_a_d_M_a_t_c_h error results. If plane does not have exactly one bit set to 1 and the value of plane is not less than %2 sup n%, where _n is the depth of src, a _B_a_d_V_a_l_u_e error results.

Effectively, _X_C_o_p_y_P_l_a_n_e forms a pixmap of the same depth as the rectangle of dest and with a size specified by the source region. It uses the foreground/background pixels in the GC (foreground everywhere the bit plane in src contains a bit set to 1, background everywhere the bit plane in src contains a bit set to 0) and the equivalent of a _C_o_p_y_A_r_e_a protocol request is performed with all the same exposure semantics. This can also be thought of as using the specified region of the source bit plane as a stipple with a fill-style of _F_i_l_l_O_p_a_q_u_e_S_t_i_p_p_l_e_d for filling a rectangular area of the destination.

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

_X_C_o_p_y_P_l_a_n_e can generate _B_a_d_D_r_a_w_a_b_l_e, _B_a_d_G_C, _B_a_d_M_a_t_c_h, and _B_a_d_V_a_l_u_e errors.

DIAGNOSTICS

_B_a_d_D_r_a_w_a_b_l_e
A value for a Drawable argument does not name a defined Window or Pixmap.
_B_a_d_G_C
A value for a GContext argument does not name a defined GContext.
_B_a_d_M_a_t_c_h
An _I_n_p_u_t_O_n_l_y window is used as a Drawable.
_B_a_d_M_a_t_c_h
Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request.
_B_a_d_V_a_l_u_e
Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error.

SEE ALSO

XClearArea(3X11)
_X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e