XSetClipOrigin(3)

✨ NAME ✨

Okay so this is the XSetClipOrigin(3) page from the Xlib besties 💖 — and the NAME section is: XSetClipOrigin, XSetClipMask, and XSetClipRectangles are the GC convenience routines. Three clip-mask besties, one page, no skips. Periodt. 💅

---

💅 SYNTAX 💅

No cap, here are the exact signatures — copy them like your life depends on it:

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 pass Unsorted, YSorted, YXSorted, or YXBanded 🧠
• pixmap — specifies the pixmap or None 🖼️
• rectangles — specifies an array of rectangles that define the clip-mask 🧩

---

🦋 DESCRIPTION 🦋

XSetClipOrigin sets the clip origin in the specified GC. The clip-mask origin is interpreted relative to the origin of whatever destination drawable is specified in the graphics request. It can generate BadAlloc and BadGC errors — lowkey keep those in mind 👀

XSetClipMask sets the clip-mask in the specified GC to the specified pixmap. If the clip-mask is set to None, the pixels are always drawn (regardless of the clip-origin) — yes, always, even when your brain wants to second-guess it 💀 It can generate BadAlloc, BadGC, BadMatch, and BadValue errors.

XSetClipRectangles changes the clip-mask in the specified GC to the specified list of rectangles and sets the clip origin. The output is clipped to remain contained within the rectangles. The clip-origin is interpreted relative to the origin of whatever 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 be undefined. That's the dramatic kind of undefined, bestie — do not test it for fun.

Note that the list of rectangles can be empty, which effectively disables output. This is the opposite of passing None as the clip-mask in XCreateGC, XChangeGC, and XSetClipMask. Yes, the flip is real and iconic in the worst way 😭

If known by the client, ordering relations on the rectangles can be specified with the ordering argument. This may provide faster operation by the server. If an incorrect ordering is specified, the X server may generate a BadMatch error, but it is not required to do so. If no error is generated, the graphics results are undefined. 🚨

• Unsorted means the rectangles are in arbitrary order.
• YSorted means that the rectangles are nondecreasing in their Y origin.
• YXSorted additionally constrains YSorted order in that all rectangles with an equal Y origin are nondecreasing in their X origin.
• YXBanded additionally constrains YXSorted by requiring that, for every possible Y scanline, all rectangles that include that scanline have an identical Y origins and Y extents.

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.

---

🌈 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

---

💖 Cute little sign-off, bestie: this page's footer energy is X Version 11 and libX11 1.8.14, under the manual name XSetClipOrigin(3). No separate date line on this one, so no invented date from me — just the source/version tags doing their thing. Slay, go clip something cute. 🎀💅