XSetClipMask

Syntax

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

Arguments

display Specifies the connection to the X server.
gc Specifies the GC.
pixmap Specifies the pixmap or None .

Description

If the clip-mask is set to None , the pixels are are always drawn (regardless of the clip-origin).

XSetClipMask() can generate BadAlloc, BadGC, BadMatch, and BadPixmap errors.

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.
BadPixmap A value for a Pixmap argument does not name a defined Pixmap.

See also

XCreateGC(), XDrawRectangle(), XQueryBestSize(), XSetArcMode(), XSetClipOrigin(), XSetClipRectangles(), XSetFillStyle(), XSetFont(), XSetLineAttributes(), XSetState(), XSetTile(), "Setting the Clip Region".
Christophe Tronche, ch@tronche.com