XSetClipMask() XSetClipMask()
Name
XSetClipMask - set pixmap pixmap in a graphics context.
Synopsis
XSetClipMask(display, gc, pixmap)
Display *display;
GC gc;
Pixmap pixmap;
Arguments
display Specifies a connection to an X server; returned from XOpenDisplay().
gc Specifies the graphics context.
pixmap Specifies 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 as the clip mask component of a GC. The clip mask 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 clip mask to a set of
rectangles, or XSetRegion() to set the clip mask to a region.
For more information, see Volume One, Chapter 5, The Graphics Context.
Errors
BadAlloc
BadGC
BadMatch
BadPixmap
See Also
XDefaultGC(), XChangeGC(), XCopyGC(), XCreateGC(), XFreeGC(), XGContextFromGC(), XSetArcMode(), XSetBackground(), XSetClipOrigin(), XSet-
ClipRectangles(), XSetDashes(), XSetFillRule(), XSetFillStyle(), XSetForeground(), XSetFunction(), XSetGraphicsExposures(), XSetLineAt-
tributes(), XSetPlaneMask(), XSetState(), XSetStipple(), XSetSubwindowMode(), XSetTSOrigin().
Xlib - Graphics Context XSetClipMask()
