TICKIT_RECT_SUBTRACT(3)

💖 TICKIT_RECT_SUBTRACT 💖

okay bestie, this one is from the tickit library, and it's literally just ✨rectangle math✨ — specifically, how to cut a hole out of a rectangle. no cap.

✨ NAME ✨

tickit_rect_subtract — obtain the difference of two rectangles 🦋

✨ SYNOPSIS ✨

#include <tickit.h>

int tickit_rect_subtract(TickitRect dst[4],
    const TickitRect *orig, const TickitRect *hole);

Link with -ltickit. 💅

✨ DESCRIPTION ✨

tickit_rect_subtract() initialises the rectangle structures given by dst — and bestie, listen, dst must be an array capable of containing at least four rectangle structures, like that is not optional, that is the vibe — with a set of non-overlapping rectangles covering the same area as the one given by orig without covering hole. 💖

Depending on the geometry of the given rectangles it will create from zero to four resultant rectangles. she's flexible like that 🧚

It returns the number of rectangular regions initialised into the result array.

Now for the tea, the actual behaviour cases ☕:

• If hole completely covers orig then the result will contain no rectangles. rip orig, she's gone 😭
• If they do not intersect then just orig will be returned. untouched, unbothered, main character energy 👑
• Otherwise, the result will contain non-overlapping horizontal stripes of orig without hole. yes queen, stripes ✨

✨ RETURN VALUE ✨

tickit_rect_subtract() returns the number of rectangles written to dst. that's it, that's the number, periodt 💅

✨ SEE ALSO ✨

• tickit_rect_init_sized(3)
• tickit_rect_init_bounded(3)
• tickit_rect_intersect(3)
• tickit_rect_add(3)
• tickit_rect(7)
• tickit(7)

and that's the whole page, bestie!! 🫶 this was TICKIT_RECT_SUBTRACT(3), from the Library Functions Manual — go forth and subtract your rectangles, ily, bye 💜🎀