SDL_GetRectA...rsectionFloat(3)

💖 SDL_GetRectAndLineIntersectionFloat 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, this one's a banger 🎀

✨ NAME ✨

SDL_GetRectAndLineIntersectionFloat — figure out where a rectangle and a line segment actually cross, but make it float precision 💅

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_rect.h>

bool SDL_GetRectAndLineIntersectionFloat(const SDL_FRect *rect, float *X1, float *Y1, float *X2, float *Y2);

---

🦋 DESCRIPTION 🦋

so the whole vibe here is clipping a line segment to a rectangle. that's it, that's the job 🫶

here's the tea tho, three possible outcomes and they're all lowkey different:

• a line segment that's fully inside the rectangle? untouched. unchanged. no notes. 💖
• a line segment that doesn't intersect at all? also just chillin', stays exactly how it was 😌
• a line segment that crosses the rectangle at either or both ends? that one gets clipped to the boundary of the rectangle, and the new coordinates get saved into X1, Y1, X2, and/or Y2 as necessary ✨

like it's giving "we trimmed your line, you're welcome" 💅

---

👑 FUNCTION PARAMETERS 👑

• rect — an SDL_FRect structure representing the rectangle you wanna intersect with. this is the rectangle in question, the main character of the rect situation 🌈
• X1 — a pointer to the starting X-coordinate of the line 🎀
• Y1 — a pointer to the starting Y-coordinate of the line 🎀
• X2 — a pointer to the ending X-coordinate of the line 🎀
• Y2 — a pointer to the ending Y-coordinate of the line 🎀

---

💀 RETURN VALUE 💀

returns true if there is an intersection, false otherwise. simple as that fr fr 🍓

---

🧚 THREAD SAFETY 🧚

it is safe to call this function from any thread. go off, multithreaded icon 👑

---

⭐ AVAILABILITY ⭐

this function is available since SDL 3.2.0 💜

---

not me writing a whole manpage and it's literally just "clip line to rect" 😭 anyway slay

okay that's the whole page bestie, thanks for reading, mwah 💖✨🌸🦋🎀💅🫶

— with love from the Simple Directmedia Layer girlies, SDL 3.4.18 era, SDL_GetRectAndLineIntersectionFloat(3), signing off 👑🌈💜