SDL_OUT_CAP(3)

💖 SDL_OUT_CAP 💖

okay so bestie, welcome to SDL_OUT_CAP — it's a macro from the SDL3 functions crew, and honestly? it's giving "quietly doing the most." it's the lil annotation that tells everyone your output buffer is big enough. no cap. (well, actually, cap. that's the whole point. 🎀)

---

✨ NAME ✨

SDL_OUT_CAP — a macro that annotates function params with output buffer size. that's it, that's the job. 💅

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_stdinc.h>

#define SDL_OUT_CAP(x) _Out_cap_(x)

---

🦋 DESCRIPTION 🦋

so like, imagine we wanted to annotate wcsncpy, right? it would look a lil something like this:

char *wcscpy(SDL_OUT_CAP(bufsize) wchar_t *dst, const wchar_t *src, size_t bufsize);

this is noting that dst should have a capacity of bufsize wchar_t in size, and that it's only written to by the function. then the compiler or other analysis tools can be the friend who tells you the truth and warn when that doesn't appear to be the case. 😭 so real of them.

⚠️ important, bestie: this operates on counts of objects, not bytes. if you're counting bytes instead, use SDL_OUT_BYTECAP for bytes. don't mix them up, i'm begging. 🙈

and for the compilers that simply do not have this annotation mechanism? iconic behaviour — on those, this is defined to nothing. it just vanishes. poof. no drama. 💀

---

👑 AVAILABILITY 👑

this macro is available since SDL 3.2.0. periodt. 💜

---

Simple Directmedia Layer — SDL 3.4.18 — SDL_OUT_CAP(3)

and that's the whole page, bestie 🫶 go annotate some buffers, stay hydrated, mwah 💖✨