SDL_GetRectE...ngPointsFloat(3)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

💖 SDL_GetRectEnclosingPointsFloat(3) 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, where we're talking about SDL_GetRectEnclosingPointsFloat — she's a real one, no cap. 🎀

✨ NAME ✨

SDL_GetRectEnclosingPointsFloat — calculate a minimal rectangle enclosing a set of points with float precision. literally she draws the tightest little box around your pointies. 🦋

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_rect.h>

bool SDL_GetRectEnclosingPointsFloat(const SDL_FPoint *points, int count, const SDL_FRect *clip, SDL_FRect *result);

💅 DESCRIPTION 💅

So here's the tea: if clip is not NULL, then only the points inside of the clipping rectangle get considered. everyone else? not invited to the party. 🙈

🫶 FUNCTION PARAMETERS 🫶

  • points — an array of SDL_FPoint structures representing the points to be enclosed. your lil squad of coordinates, basically. 👑
  • count — the number of structures in the points array. how many besties are actually showing up. ⭐
  • clip — an SDL_FRect used for clipping, or NULL to enclose all the points. the VIP velvet rope, or no rope at all. 🌈
  • result — an SDL_FRect structure filled in with the minimal enclosing rectangle. this is where the finished box gets dropped off. 💜

🔥 RETURN VALUE 🔥

Returns true if any points were enclosed, or false if all the points were outside of the clipping rectangle. so like, false = nobody made it past the bouncer. 💀

🧚 THREAD SAFETY 🧚

It is safe to call this function from any thread. periodt. go off from wherever you want, she doesn't care. ✨

🌟 AVAILABILITY 🌟

This function is available since SDL 3.2.0. so if you're on something older… yeah, she's not there yet, sorry babe. 😭

lowkey important: that clip check is the whole vibe — NULL means every point counts, and a real rectangle means only the inside ones do. don't forget it or your box will be giving unexpected energy. 💅

okay that's the whole page bestie, you ate it up 🍓 — this was Simple Directmedia Layer, version SDL 3.4.18, dated with all the love of SDL_GetRectE...ngPointsFloat(3). mwah, go enclose some points, you icon. 💖🌈🎀

📦 where this page comes from