NAME¶

XSetClipOrigin, XSetClipMask, XSetClipRectangles - GC convenience routines

SYNTAX¶

int XSetClipOrigin(Display *display, GC gc, int clip_x_origin, int clip_y_origin);

int XSetClipMask(Display *display, GC gc, Pixmap pixmap);

int XSetClipRectangles(Display *display, GC gc, int clip_x_origin, int clip_y_origin, XRectangle rectangles[], int n, int ordering);

ARGUMENTS¶

display

Specifies the connection to the X server.

clip_x_origin

clip_y_origin

Specify the x and y coordinates of the clip-mask origin.

gc

Specifies the GC.

n

Specifies the number of rectangles.

ordering

Specifies the ordering relations on the rectangles.You can passUnsorted,YSorted,YXSorted,orYXBanded.

pixmap

Specifies the pixmap orNone.

rectangles

Specifies an array of rectangles that define the clip-mask.

DESCRIPTION¶

TheXSetClipOriginfunction sets the clip origin in the specified GC.The clip-mask origin is interpreted relative to the origin of whateverdestination drawable is specified in the graphics request.

XSetClipOrigincan generateBadAllocandBadGCerrors.

TheXSetClipMaskfunction sets the clip-mask in the specified GC to the specified pixmap.If the clip-mask is set toNone,the pixels are are always drawn (regardless of the clip-origin).

XSetClipMaskcan generateBadAlloc,BadGC,BadMatch,andBadValueerrors.

TheXSetClipRectanglesfunction changes the clip-mask in the specified GCto the specified list of rectangles and sets the clip origin.The output is clipped to remain contained within therectangles.The clip-origin is interpreted relative to the origin ofwhatever 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 beundefined.Note that the list of rectangles can be empty,which effectively disables output.This is the opposite of passingNoneas the clip-mask inXCreateGC,XChangeGC,andXSetClipMask.

If known by the client, ordering relations on the rectangles can bespecified with the ordering argument.This may provide faster operationby the server.If an incorrect ordering is specified, the X server may generate aBadMatcherror, but it is not required to do so.If no error is generated, the graphicsresults are undefined.Unsortedmeans the rectangles are in arbitrary order.YSortedmeans that the rectangles are nondecreasing in their Y origin.YXSortedadditionally constrainsYSortedorder in that allrectangles with an equal Y origin are nondecreasing in their Xorigin.YXBandedadditionally constrainsYXSortedby requiring that,for every possible Y scanline, all rectangles that include thatscanline have an identical Y origins and Y extents.

XSetClipRectanglescan generateBadAlloc,BadGC,BadMatch,andBadValueerrors.

DIAGNOSTICS¶

BadAlloc

The server failed to allocate the requested resource or server memory.

BadGC

A value for a GContext argument does not name a defined GContext.

BadMatch

Some argument or pair of arguments has the correct type and range but failsto 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 definedby the argument's type is accepted.Any argument defined as a set ofalternatives can generate this error.

SEE ALSO¶

XCreateGC(3),XDrawRectangle(3),XQueryBestSize(3),XSetArcMode(3),XSetFillStyle(3),XSetFont(3),XSetLineAttributes(3),XSetState(3),XSetTile(3)
Xlib - C Language X Interface