XDrawRectangle(3)

✨ NAME ✨

okay so this is the XLIB FUNCTIONS page for XDrawRectangle(3), and it's bringing XDrawRectangle, XDrawRectangles, and XRectangle together to draw rectangles and explain the rectangles structure. lowkey iconic trio behavior 💅

---

📐 SYNTAX 📐

int XDrawRectangle(Display *display, Drawable d, GC gc, int x, int y,
       unsigned int width, unsigned int height);

int XDrawRectangles(Display *display, Drawable d, GC gc, XRectangle
       rectangles[], int nrectangles);

---

🧾 ARGUMENTS 🧾

• d — tells it which drawable we're working with.
• display — the connection to the X server, aka the group chat line to the server.
• gc — says which GC to use.
• nrectangles — how many rectangles are in the array.
• rectangles — an array of rectangles, bestie.
• width, height — the width and the height, which specify the dimensions of the rectangle.
• x, y — the x and y coordinates, which specify the upper-left corner of the rectangle.

---

💫 DESCRIPTION 💫

so XDrawRectangle and XDrawRectangles draw the outlines of the rectangle or rectangles you specify, as if a five-point PolyLine protocol request were specified for each rectangle:

[x,y] [x+width,y] [x+width,y+height] [x,y+height] [x,y]

for the rectangle or rectangles you named, these functions do not draw a pixel more than once. no cap. XDrawRectangles draws the rectangles in the order listed in the array. and if rectangles intersect, the intersecting pixels are drawn multiple times — that's just the vibe, okay? 😭

both functions use these GC components: function, plane-mask, line-width, line-style, cap-style, join-style, fill-style, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. they also use these GC mode-dependent components: foreground, background, tile, stipple, tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, and dash-list. periodt ✨

XDrawRectangle and XDrawRectangles can generate BadDrawable, BadGC, and BadMatch errors. yes, those are the drama alarms to watch for 💀

---

🏗️ STRUCTURES 🏗️

the XRectangle structure contains:

typedef struct {
        short x, y;
        unsigned short width, height;
} XRectangle;

all x and y members are signed integers. the width and height members are 16-bit unsigned integers. you should be careful not to generate coordinates and sizes out of the 16-bit ranges, because the protocol only has 16-bit fields for these values.

bestie please respect the 16-bit range 🙏 this is not a "we'll fix it later" situation, the protocol literally only has 16-bit fields for these values 🎀

---

🚨 DIAGNOSTICS 🚨

• BadDrawable — a value for a Drawable argument does not name a defined Window or Pixmap.
• 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.

---

👀 SEE ALSO 👀

• XDrawArc(3)
• XDrawLine(3)
• XDrawPoint(3)
• Xlib - C Language X Interface

---

okay that's the whole page, bestie 💖 signed, sealed, and slayed by X Version 11 and libX11 1.8.14 — mwah 💋✨