home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / X11 / XSetClipOrigin.z / XSetClipOrigin
Encoding:
Text File  |  2002-10-03  |  7.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXSSSSeeeettttCCCClllliiiippppOOOOrrrriiiiggggiiiinnnn((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSeeeettttCCCClllliiiippppOOOOrrrriiiiggggiiiinnnn((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XSetClipOrigin, XSetClipMask, XSetClipRectangles - GC
  10.           convenience routines
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           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)
  14.                 Display *_d_i_s_p_l_a_y;
  15.                 GC _g_c;
  16.                 int _c_l_i_p__x__o_r_i_g_i_n, _c_l_i_p__y__o_r_i_g_i_n;
  17.  
  18.           XSetClipMask(_d_i_s_p_l_a_y, _g_c, _p_i_x_m_a_p)
  19.                 Display *_d_i_s_p_l_a_y;
  20.                 GC _g_c;
  21.                 Pixmap _p_i_x_m_a_p;
  22.  
  23.           XSetClipRectangles(_d_i_s_p_l_a_y, _g_c, _c_l_i_p__x__o_r_i_g_i_n,
  24.           _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)
  25.                 Display *_d_i_s_p_l_a_y;
  26.                 GC _g_c;
  27.                 int _c_l_i_p__x__o_r_i_g_i_n, _c_l_i_p__y__o_r_i_g_i_n;
  28.                 XRectangle _r_e_c_t_a_n_g_l_e_s[];
  29.                 int _n;
  30.                 int _o_r_d_e_r_i_n_g;
  31.  
  32.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  33.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  34.  
  35.           _c_l_i_p__x__o_r_i_g_i_n
  36.           _c_l_i_p__y__o_r_i_g_i_n
  37.                     Specify the x and y coordinates of the clip-mask
  38.                     origin.
  39.  
  40.           _g_c        Specifies the GC.
  41.  
  42.           _n         Specifies the number of rectangles.
  43.  
  44.           _o_r_d_e_r_i_n_g  Specifies the ordering relations on the
  45.                     rectangles.  You can pass _U_n_s_o_r_t_e_d, _Y_S_o_r_t_e_d,
  46.                     _Y_X_S_o_r_t_e_d, or _Y_X_B_a_n_d_e_d.
  47.  
  48.           _p_i_x_m_a_p    Specifies the pixmap or _N_o_n_e.
  49.  
  50.           _r_e_c_t_a_n_g_l_e_s
  51.                     Specifies an array of rectangles that define the
  52.                     clip-mask.
  53.  
  54.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  55.           The _X_S_e_t_C_l_i_p_O_r_i_g_i_n function sets the clip origin in the
  56.           specified GC.  The clip-mask origin is interpreted relative
  57.           to the origin of whatever destination drawable is specified
  58.           in the graphics request.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXSSSSeeeettttCCCClllliiiippppOOOOrrrriiiiggggiiiinnnn((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSeeeettttCCCClllliiiippppOOOOrrrriiiiggggiiiinnnn((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           _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.
  75.  
  76.           The _X_S_e_t_C_l_i_p_M_a_s_k function sets the clip-mask in the
  77.           specified GC to the specified pixmap.  If the clip-mask is
  78.           set to _N_o_n_e, the pixels are are always drawn (regardless of
  79.           the clip-origin).
  80.  
  81.           _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
  82.           _B_a_d_V_a_l_u_e errors.
  83.  
  84.           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 the
  85.           specified GC to the specified list of rectangles and sets
  86.           the clip origin.  The output is clipped to remain contained
  87.           within the rectangles.  The clip-origin is interpreted
  88.           relative to the origin of whatever destination drawable is
  89.           specified in a graphics request. The rectangle coordinates
  90.           are interpreted relative to the clip-origin. The rectangles
  91.           should be nonintersecting, or the graphics results will be
  92.           undefined.  Note that the list of rectangles can be empty,
  93.           which effectively disables output.  This is the opposite of
  94.           passing _N_o_n_e as the clip-mask in _X_C_r_e_a_t_e_G_C, _X_C_h_a_n_g_e_G_C, and
  95.           _X_S_e_t_C_l_i_p_M_a_s_k.
  96.  
  97.           If known by the client, ordering relations on the rectangles
  98.           can be specified with the ordering argument. This may
  99.           provide faster operation by the server. If an incorrect
  100.           ordering is specified, the X server may generate a _B_a_d_M_a_t_c_h
  101.           error, but it is not required to do so.  If no error is
  102.           generated, the graphics results are undefined.  _U_n_s_o_r_t_e_d
  103.           means the rectangles are in arbitrary order.  _Y_S_o_r_t_e_d means
  104.           that the rectangles are nondecreasing in their Y origin.
  105.           _Y_X_S_o_r_t_e_d additionally constrains _Y_S_o_r_t_e_d order in that all
  106.           rectangles with an equal Y origin are nondecreasing in their
  107.           X origin. _Y_X_B_a_n_d_e_d additionally constrains _Y_X_S_o_r_t_e_d by
  108.           requiring that, for every possible Y scanline, all
  109.           rectangles that include that scanline have an identical Y
  110.           origins and Y extents.
  111.  
  112.           _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,
  113.           and _B_a_d_V_a_l_u_e errors.
  114.  
  115.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  116.           _B_a_d_A_l_l_o_c  The server failed to allocate the requested
  117.                     resource or server memory.
  118.  
  119.           _B_a_d_G_C     A value for a GContext argument does not name a
  120.                     defined GContext.
  121.  
  122.           _B_a_d_M_a_t_c_h  Some argument or pair of arguments has the correct
  123.                     type and range but fails to match in some other
  124.                     way required by the request.
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXSSSSeeeettttCCCClllliiiippppOOOOrrrriiiiggggiiiinnnn((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSeeeettttCCCClllliiiippppOOOOrrrriiiiggggiiiinnnn((((3333XXXX11111111))))
  137.  
  138.  
  139.  
  140.           _B_a_d_V_a_l_u_e  Some numeric value falls outside the range of
  141.                     values accepted by the request.  Unless a specific
  142.                     range is specified for an argument, the full range
  143.                     defined by the argument's type is accepted.  Any
  144.                     argument defined as a set of alternatives can
  145.                     generate this error.
  146.  
  147.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  148.           XCreateGC(3X11), XDrawRectangle(3X11), XQueryBestSize(3X11),
  149.           XSetArcMode(3X11), XSetFillStyle(3X11), XSetFont(3X11),
  150.           XSetLineAttributes(3X11), XSetState(3X11), XSetTile(3X11)
  151.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  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.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.