home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xcopyarea.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  6.4 KB  |  199 lines
  1.  
  2.  
  3.  
  4. XCopyArea(3X11)          XLIB FUNCTIONS      XCopyArea(3X11)
  5.  
  6.  
  7. NNAAMMEE
  8.        XCopyArea, XCopyPlane - copy areas
  9.  
  10. SSYYNNTTAAXX
  11.        XCopyArea(_d_i_s_p_l_a_y, _s_r_c, _d_e_s_t, _g_c, _s_r_c___x, _s_r_c___y, _w_i_d_t_h,
  12.        _h_e_i_g_h_t,    _d_e_s_t___x, _d_e_s_t___y)
  13.          Display *_d_i_s_p_l_a_y;
  14.          Drawable _s_r_c, _d_e_s_t;
  15.          GC _g_c;
  16.          int _s_r_c___x, _s_r_c___y;
  17.          unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
  18.          int _d_e_s_t___x, _d_e_s_t___y;
  19.  
  20.        XCopyPlane(_d_i_s_p_l_a_y, _s_r_c, _d_e_s_t, _g_c, _s_r_c___x, _s_r_c___y, _w_i_d_t_h,
  21.        _h_e_i_g_h_t, _d_e_s_t___x, _d_e_s_t___y, _p_l_a_n_e)
  22.          Display *_d_i_s_p_l_a_y;
  23.          Drawable _s_r_c, _d_e_s_t;
  24.          GC _g_c;
  25.          int _s_r_c___x, _s_r_c___y;
  26.          unsigned int _w_i_d_t_h, _h_e_i_g_h_t;
  27.          int _d_e_s_t___x, _d_e_s_t___y;
  28.          unsigned long _p_l_a_n_e;
  29.  
  30. AARRGGUUMMEENNTTSS
  31.        _d_e_s_t___x
  32.        _d_e_s_t___y     Specify the x and y coordinates, which are rela-
  33.          tive to the origin of the destination rectangle
  34.          and specify its upper-left corner.
  35.  
  36.        _d_i_s_p_l_a_y     Specifies the connection to the X server.
  37.  
  38.        _g_c     Specifies the GC.
  39.  
  40.        _p_l_a_n_e     Specifies the bit plane.  You must set exactly
  41.          one bit to 1.
  42.  
  43.        _s_r_c
  44.        _d_e_s_t     Specify the source and destination rectangles to
  45.          be combined.
  46.  
  47.        _s_r_c___x
  48.        _s_r_c___y     Specify the x and y coordinates, which are rela-
  49.          tive to the origin of the source rectangle and
  50.          specify its upper-left corner.
  51.  
  52.        _w_i_d_t_h
  53.        _h_e_i_g_h_t     Specify the width and height, which are the
  54.          dimensions of both the source and destination
  55.          rectangles.
  56.  
  57. DDEESSCCRRIIPPTTIIOONN
  58.        The _X_C_o_p_y_A_r_e_a function combines the specified rectangle of
  59.        src with the specified rectangle of dest.  The drawables
  60.        must have the same root and depth, or a _B_a_d_M_a_t_c_h error
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XCopyArea(3X11)          XLIB FUNCTIONS      XCopyArea(3X11)
  71.  
  72.  
  73.        results.
  74.  
  75.        If regions of the source rectangle are obscured and have
  76.        not been retained in backing store or if regions outside
  77.        the boundaries of the source drawable are specified, those
  78.        regions are not copied.    Instead, the following occurs on
  79.        all corresponding destination regions that are either vis-
  80.        ible or are retained in backing store.  If the destination
  81.        is a window with a background other than _N_o_n_e, correspond-
  82.        ing regions of the destination are tiled with that back-
  83.        ground (with plane-mask of all ones and _G_X_c_o_p_y function).
  84.        Regardless of tiling or whether the destination is a win-
  85.        dow or a pixmap, if graphics-exposures is _T_r_u_e, then
  86.        _G_r_a_p_h_i_c_s_E_x_p_o_s_e events for all corresponding destination
  87.        regions are generated.  If graphics-exposures is _T_r_u_e but
  88.        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
  89.        is generated.  Note that by default graphics-exposures is
  90.        _T_r_u_e in new GCs.
  91.  
  92.        This function uses these GC components: function, plane-
  93.        mask, subwindow-mode, graphics-exposures, clip-x-origin,
  94.        clip-y-origin, and clip-mask.
  95.  
  96.        _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
  97.        errors.
  98.  
  99.        The _X_C_o_p_y_P_l_a_n_e function uses a single bit plane of the
  100.        specified source rectangle combined with the specified GC
  101.        to modify the specified rectangle of dest.  The drawables
  102.        must have the same root but need not have the same depth.
  103.        If the drawables do not have the same root, a _B_a_d_M_a_t_c_h
  104.        error results.  If plane does not have exactly one bit set
  105.        to 1 and the value of plane is not less than %2 sup n%,
  106.        where _n is the depth of src, a _B_a_d_V_a_l_u_e error results.
  107.  
  108.        Effectively, _X_C_o_p_y_P_l_a_n_e forms a pixmap of the same depth
  109.        as the rectangle of dest and with a size specified by the
  110.        source region.  It uses the foreground/background pixels
  111.        in the GC (foreground everywhere the bit plane in src con-
  112.        tains a bit set to 1, background everywhere the bit plane
  113.        in src contains a bit set to 0) and the equivalent of a
  114.        _C_o_p_y_A_r_e_a protocol request is performed with all the same
  115.        exposure semantics.  This can also be thought of as using
  116.        the specified region of the source bit plane as a stipple
  117.        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
  118.        rectangular area of the destination.
  119.  
  120.        This function uses these GC components: function, plane-
  121.        mask, foreground, background, subwindow-mode, graphics-
  122.        exposures, clip-x-origin, clip-y-origin, and clip-mask.
  123.  
  124.        _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
  125.        _B_a_d_V_a_l_u_e errors.
  126.  
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XCopyArea(3X11)          XLIB FUNCTIONS      XCopyArea(3X11)
  137.  
  138.  
  139. DDIIAAGGNNOOSSTTIICCSS
  140.        _B_a_d_D_r_a_w_a_b_l_e
  141.          A value for a Drawable argument does not name a
  142.          defined Window or Pixmap.
  143.  
  144.        _B_a_d_G_C     A value for a GContext argument does not name a
  145.          defined GContext.
  146.  
  147.        _B_a_d_M_a_t_c_h     An _I_n_p_u_t_O_n_l_y window is used as a Drawable.
  148.  
  149.        _B_a_d_M_a_t_c_h     Some argument or pair of arguments has the cor-
  150.          rect type and range but fails to match in some
  151.          other way required by the request.
  152.  
  153.        _B_a_d_V_a_l_u_e     Some numeric value falls outside the range of
  154.          values accepted by the request.  Unless a spe-
  155.          cific range is specified for an argument, the
  156.          full range defined by the argument's type is
  157.          accepted.  Any argument defined as a set of
  158.          alternatives can generate this error.
  159.  
  160. SSEEEE AALLSSOO
  161.        XClearArea(3X11)
  162.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196. X Version 11           Release 6.1                3
  197.  
  198.  
  199.