SDL_GetSurfaceImages(3)

💖 SDL_GetSurfaceImages 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, this one's called SDL_GetSurfaceImages and it's literally about collecting every version of a surface into one lil array. no cap. 🦋

---

✨ NAME ✨

SDL_GetSurfaceImages — get an array including all versions of a surface. yes, ALL of them, the whole girl squad. 👑

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_surface.h>

SDL_Surface ** SDL_GetSurfaceImages(SDL_Surface *surface, int *count);

---

💅 DESCRIPTION 💅

So basically this returns all versions of a surface, and the surface you're querying is the first element in the returned array. main character gets the front seat, as she should. 💖

Now listen, important part: freeing the array of surfaces does not affect the surfaces inside the array. They're still referenced by the surface you queried and they'll get cleaned up normally on their own. so like, free the array, don't panic, the surfaces are fine. 🫶

---

🎀 FUNCTION PARAMETERS 🎀

• surface — the SDL_Surface structure you wanna query. the one we're investigating. 🔍
• count — a pointer that gets filled in with the number of surface pointers returned. it may be NULL if you don't care, and honestly? valid. 💅

---

⭐ RETURN VALUE ⭐

Returns a NULL terminated array of SDL_Surface pointers, or NULL on failure. and if it fails? call SDL_GetError() for more info, she'll tell you what went wrong. 😭

This should be freed with SDL_free() when it is no longer needed. don't forget, bestie, that's a leak waiting to happen. 🚨

---

🧚 THREAD SAFETY 🧚

This function can be called on different threads with different surfaces. so you and your mutuals can each do your own thing with your own surfaces, no drama. ✨

---

🌈 AVAILABILITY 🌈

This function is available since SDL 3.2.0. if you're on something older... it's giving not yet, sorry babe. 💀

---

🔥 SEE ALSO 🔥

• SDL_AddSurfaceAlternateImage(3)
• SDL_RemoveSurfaceAlternateImages(3)
• SDL_SurfaceHasAlternateImages(3)

go read those too, they're all in the same friend group. 🫶

---

and that's the whole vibe check 💜 this page came to you from the Simple Directmedia Layer girlies, SDL 3.4.18, dated however old this doc is — mwah, stay slaying, and remember: free your arrays. 💅✨