XSetClipOrigin(3X) — X Version 11

NAME

XSetClipOrigin, XSetClipMask, XSetClipRectangles − GC convience routines

SYNTAX

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

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

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

displaySpecifies the connection to the X server.

clip_x_origin

clip_y_origin
Specify the x and y coordinates of the clip origin.

gcSpecifies the graphics context.

nSpecifies the number of rectangles.

orderingSpecifies the ordering relations on the rectangles. Possible values are Unsorted, YSorted, YXSorted, or YXBanded.

pixmapSpecifies the pixmap.

rectanglesSpecifies an array of rectangles.

DESCRIPTION

The XSetClipOrigin function sets the clip origin in the specified graphics context. .PN XSetClipOrigin can generate a BadGC error.

The XSetClipMask function sets the clip_mask in the specified graphics context to the specified pixmap. .PN XSetClipMask can generate BadGC, BadMatch, and BadValue errors.

The XSetClipRectangles function changes the clip_mask in the specified graphics context to the specified list of rectangles and sets the clip origin. .PN XSetClipRectangles can generate BadAlloc, BadGC, BadMatch, and BadValue errors.

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 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.

Museum