XSetClipRectangles
XSetClipRectangles(display, gc, clip_x_origin, clip_y_origin, rectangles, n, ordering)
Display *display;
GC gc;
int clip_x_origin, clip_y_origin;
XRectangle rectangles[];
int n;
int ordering;
Arguments
| display
| Specifies the connection to the X server.
|
| gc
| Specifies the GC.
|
| clip_x_origin
clip_y_origin
| Specify the x and y coordinates of the clip-mask origin.
|
| rectangles
| Specifies an array of rectangles that define the clip-mask.
|
| n
| Specifies the number of rectangles.
|
| ordering
| Specifies the ordering relations on the rectangles.
You can pass
Unsorted,
YSorted,
YXSorted,
or
YXBanded.
|
Description
The
XSetClipRectangles()
function changes the clip-mask in the specified GC
to the specified list of rectangles and sets the clip origin.
The output is clipped to remain contained within the
rectangles.
The clip-origin is interpreted relative to the origin of
whatever destination drawable is specified in a graphics request.
The rectangle coordinates are interpreted relative to the clip-origin.
The rectangles should be nonintersecting, or the graphics results will be
undefined.
Note that the list of rectangles can be empty,
which effectively disables output.
This is the opposite of passing
None
as the clip-mask in
XCreateGC(),
XChangeGC(),
and
XSetClipMask().
If known by the client, ordering relations on the rectangles can be
specified with the ordering argument.
This may provide faster operation
by the server.
If an incorrect ordering is specified, the X server may generate a
BadMatch
error, but it is not required to do so.
If no error is generated, the graphics
results are undefined.
Unsorted
means the rectangles are in arbitrary order.
YSorted
means that the rectangles are nondecreasing in their Y origin.
YXSorted
additionally constrains
YSorted
order in that all
rectangles with an equal Y origin are nondecreasing in their X
origin.
YXBanded
additionally constrains
YXSorted
by requiring that,
for every possible Y scanline, all rectangles that include that
scanline have an identical Y origins and Y extents.
XSetClipRectangles()
can generate
BadAlloc,
BadGC,
BadMatch,
and
BadValue
errors.
Syntax
Diagnostics
| BadAlloc
| The server failed to allocate the requested
source or server memory.
|
| BadGC
| A value for a GContext
argument does not name a defined
GContext.
|
| BadMatch
| An
InputOnly
window is used as a Drawable.
|
| BadMatch
| Some argument or pair of arguments has the correct type and range but fails
to match in some other way required by the request.
|
| BadValue
| 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
XCreateGC(),
XDrawRectangle(),
XQueryBestSize(),
XSetArcMode(),
XSetClipMask(),
XSetClipOrigin(),
XSetFillStyle(),
XSetFont(),
XSetLineAttributes(),
XSetState(),
XSetTile(),
"
Setting the Clip Region".
Christophe Tronche, [email protected]
