home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xsetcliprectangles.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  5.9 KB  |  199 lines
  1.  
  2.  
  3.  
  4. XSetClipOrigin(3X11)      XLIB FUNCTIONS     XSetClipOrigin(3X11)
  5.  
  6.  
  7. NNAAMMEE
  8.        XSetClipOrigin, XSetClipMask, XSetClipRectangles - GC con-
  9.        venience routines
  10.  
  11. SSYYNNTTAAXX
  12.        XSetClipOrigin(_d_i_s_p_l_a_y, _g_c, _c_l_i_p___x___o_r_i_g_i_n, _c_l_i_p___y___o_r_i_g_i_n)
  13.          Display *_d_i_s_p_l_a_y;
  14.          GC _g_c;
  15.          int _c_l_i_p___x___o_r_i_g_i_n, _c_l_i_p___y___o_r_i_g_i_n;
  16.  
  17.        XSetClipMask(_d_i_s_p_l_a_y, _g_c, _p_i_x_m_a_p)
  18.          Display *_d_i_s_p_l_a_y;
  19.          GC _g_c;
  20.          Pixmap _p_i_x_m_a_p;
  21.  
  22.        XSetClipRectangles(_d_i_s_p_l_a_y, _g_c, _c_l_i_p___x___o_r_i_g_i_n,
  23.        _c_l_i_p___y___o_r_i_g_i_n, _r_e_c_t_a_n_g_l_e_s, _n, _o_r_d_e_r_i_n_g)
  24.          Display *_d_i_s_p_l_a_y;
  25.          GC _g_c;
  26.          int _c_l_i_p___x___o_r_i_g_i_n, _c_l_i_p___y___o_r_i_g_i_n;
  27.          XRectangle _r_e_c_t_a_n_g_l_e_s[];
  28.          int _n;
  29.          int _o_r_d_e_r_i_n_g;
  30.  
  31. AARRGGUUMMEENNTTSS
  32.        _d_i_s_p_l_a_y     Specifies the connection to the X server.
  33.  
  34.        _c_l_i_p___x___o_r_i_g_i_n
  35.        _c_l_i_p___y___o_r_i_g_i_n
  36.          Specify the x and y coordinates of the clip-mask
  37.          origin.
  38.  
  39.        _g_c     Specifies the GC.
  40.  
  41.        _n     Specifies the number of rectangles.
  42.  
  43.        _o_r_d_e_r_i_n_g     Specifies the ordering relations on the rectan-
  44.          gles.    You can pass _U_n_s_o_r_t_e_d, _Y_S_o_r_t_e_d, _Y_X_S_o_r_t_e_d,
  45.          or _Y_X_B_a_n_d_e_d.
  46.  
  47.        _p_i_x_m_a_p     Specifies the pixmap or _N_o_n_e.
  48.  
  49.        _r_e_c_t_a_n_g_l_e_s
  50.          Specifies an array of rectangles that define the
  51.          clip-mask.
  52.  
  53. DDEESSCCRRIIPPTTIIOONN
  54.        The _X_S_e_t_C_l_i_p_O_r_i_g_i_n function sets the clip origin in the
  55.        specified GC.  The clip-mask origin is interpreted rela-
  56.        tive to the origin of whatever destination drawable is
  57.        specified in the graphics request.
  58.  
  59.        _X_S_e_t_C_l_i_p_O_r_i_g_i_n can generate _B_a_d_A_l_l_o_c and _B_a_d_G_C errors.
  60.  
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XSetClipOrigin(3X11)      XLIB FUNCTIONS     XSetClipOrigin(3X11)
  71.  
  72.  
  73.        The _X_S_e_t_C_l_i_p_M_a_s_k function sets the clip-mask in the speci-
  74.        fied GC to the specified pixmap.     If the clip-mask is set
  75.        to _N_o_n_e, the pixels are are always drawn (regardless of
  76.        the clip-origin).
  77.  
  78.        _X_S_e_t_C_l_i_p_M_a_s_k can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, _B_a_d_M_a_t_c_h, and
  79.        _B_a_d_V_a_l_u_e errors.
  80.  
  81.        The _X_S_e_t_C_l_i_p_R_e_c_t_a_n_g_l_e_s function changes the clip-mask in
  82.        the specified GC to the specified list of rectangles and
  83.        sets the clip origin.  The output is clipped to remain
  84.        contained within the rectangles.     The clip-origin is
  85.        interpreted relative to the origin of whatever destination
  86.        drawable is specified in a graphics request.  The rectan-
  87.        gle coordinates are interpreted relative to the clip-
  88.        origin.    The rectangles should be nonintersecting, or the
  89.        graphics results will be undefined.  Note that the list of
  90.        rectangles can be empty, which effectively disables out-
  91.        put.  This is the opposite of passing _N_o_n_e as the clip-
  92.        mask in _X_C_r_e_a_t_e_G_C, _X_C_h_a_n_g_e_G_C, and _X_S_e_t_C_l_i_p_M_a_s_k.
  93.  
  94.        If known by the client, ordering relations on the rectan-
  95.        gles can be specified with the ordering argument.  This
  96.        may provide faster operation by the server.  If an incor-
  97.        rect ordering is specified, the X server may generate a
  98.        _B_a_d_M_a_t_c_h error, but it is not required to do so.     If no
  99.        error is generated, the graphics results are undefined.
  100.        _U_n_s_o_r_t_e_d means the rectangles are in arbitrary order.
  101.        _Y_S_o_r_t_e_d means that the rectangles are nondecreasing in
  102.        their Y origin.    _Y_X_S_o_r_t_e_d additionally constrains _Y_S_o_r_t_e_d
  103.        order in that all rectangles with an equal Y origin are
  104.        nondecreasing in their X origin.     _Y_X_B_a_n_d_e_d additionally
  105.        constrains _Y_X_S_o_r_t_e_d by requiring that, for every possible
  106.        Y scanline, all rectangles that include that scanline have
  107.        an identical Y origins and Y extents.
  108.  
  109.        _X_S_e_t_C_l_i_p_R_e_c_t_a_n_g_l_e_s can generate _B_a_d_A_l_l_o_c, _B_a_d_G_C, _B_a_d_M_a_t_c_h,
  110.        and _B_a_d_V_a_l_u_e errors.
  111.  
  112. DDIIAAGGNNOOSSTTIICCSS
  113.        _B_a_d_A_l_l_o_c     The server failed to allocate the requested
  114.          resource or server memory.
  115.  
  116.        _B_a_d_G_C     A value for a GContext argument does not name a
  117.          defined GContext.
  118.  
  119.        _B_a_d_M_a_t_c_h     Some argument or pair of arguments has the cor-
  120.          rect type and range but fails to match in some
  121.          other way required by the request.
  122.  
  123.        _B_a_d_V_a_l_u_e     Some numeric value falls outside the range of
  124.          values accepted by the request.  Unless a spe-
  125.          cific range is specified for an argument, the
  126.          full range defined by the argument's type is
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XSetClipOrigin(3X11)      XLIB FUNCTIONS     XSetClipOrigin(3X11)
  137.  
  138.  
  139.          accepted.  Any argument defined as a set of
  140.          alternatives can generate this error.
  141.  
  142. SSEEEE AALLSSOO
  143.        XCreateGC(3X11), XDrawRectangle(3X11), XQueryBest-
  144.        Size(3X11), XSetArcMode(3X11), XSetFillStyle(3X11), XSet-
  145.        Font(3X11), XSetLineAttributes(3X11), XSetState(3X11),
  146.        XSetTile(3X11)
  147.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  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.