NAME

XSetClipMask − set pixmap pixmap in a graphics context. 

Synopsis

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

Arguments

displaySpecifies a connection to an X server; returned from XOpenDisplay(). 

gcSpecifies the graphics context. 

pixmapSpecifies a pixmap of depth 1 to be used as the clip mask.  Pass the constant None if no clipping is desired. 

Description

XSetClipMask() sets the pixmap component of a GC to a pixmap.  The pixmap filters which pixels in the destination are drawn.  If pixmap is set to None, the pixels are always drawn, regardless of the clip origin.  Use XSetClipRectangles() to set pixmap to a set of rectangles, or XSetRegion() to set pixmap to a region.  For more information, see Volume One, Chapter 5, The Graphics Context. 

Errors

BadAlloc
BadGC
BadMatch
BadPixmap

See Also

DefaultGC(), XChangeGC(), XCopyGC(), XCreateGC(), XFreeGC(), XGContextFromGC(), XSetArcMode(), XSetBackground(), XSetClipOrigin(), XSetClipRectangles(), XSetDashes(), XSetFillRule(), XSetFillStyle(), XSetForeground(), XSetFunction(), XSetGraphicsExposures(), XSetLineAttributes(), XSetPlaneMask(), XSetState(), XSetStipple(), XSetSubwindowMode(), XSetTSOrigin(). 

Copyright O’Reilly & Assoc.  —