SDL_OpenStorage(3)

💖 SDL_OpenStorage 💖

okay bestie, welcome to the SDL_OpenStorage(3) page from the SDL3 FUNCTIONS collection 🎀 this one's a lil niche but it's lowkey iconic if you're out here building your own storage backend, so let's get into it ✨

---

🌸 NAME 🌸

SDL_OpenStorage — opens up a container using a client-provided storage interface 🫶

---

✨ SYNOPSIS ✨

#include <SDL3/SDL_storage.h>

SDL_Storage * SDL_OpenStorage(const SDL_StorageInterface *iface, void *userdata);

---

💅 DESCRIPTION 💅

so here's the tea ☕ — you do NOT need this function unless you're literally providing your own SDL_Storage implementation. like, if all you want is an SDL_Storage, pls just use the built-in implementations that SDL already ships, like SDL_OpenTitleStorage() or SDL_OpenUserStorage(). they exist, they're right there, use them 💖

the way this function works: it makes a copy of iface 🫶 so the caller does not need to keep it around after this call. you can let it go, bestie. it's safe. no cap.

---

🦋 FUNCTION PARAMETERS 🦋

• iface — the interface that implements this storage, initialized using SDL_INIT_INTERFACE(). yes, you gotta init it properly, don't skip that step 👑
• userdata — the pointer that will be passed to the interface functions. it just gets handed along, like a lil note you pass in class 📝

---

🎀 RETURN VALUE 🎀

Returns a storage container on success 🌈 or NULL on failure 😭 — and if you get that NULL, call SDL_GetError() for more information, fr fr. always check your errors, it's giving responsible dev energy.

---

⭐ AVAILABILITY ⭐

This function is available since SDL 3.2.0. so if you're on something older… girl, upgrade 💀

---

👑 SEE ALSO 👑

• SDL_CloseStorage(3)
• SDL_GetStorageFileSize(3)
• SDL_GetStorageSpaceRemaining(3)
• SDL_INIT_INTERFACE(3)
• SDL_ReadStorageFile(3)
• SDL_StorageReady(3)
• SDL_WriteStorageFile(3)

---

and that's the whole page, bestie 💜 this one came to you courtesy of Simple Directmedia Layer, version SDL 3.4.18 — mwah, go build something cute with it 🧚✨💖