SDL_OUT_Z_CAP(3)

✨ SDL_OUT_Z_CAP ✨

okay so bestie, welcome to the SDL3 FUNCTIONS corner of the manual 💖 this one's a lil macro from SDL3 and it's honestly giving "quiet luxury" — tiny, does one job, slays at it.

---

🌸 NAME 🌸

SDL_OUT_Z_CAP — a macro that annotates your function params with the output string buffer size 🎀 like it's literally just a lil note to the compiler saying "hey, this buffer? here's how big it is".

---

🦋 SYNOPSIS 🦋

#include <SDL3/SDL_stdinc.h>

#define SDL_OUT_Z_CAP(x) _Out_z_cap_(x)

---

💅 DESCRIPTION 💅

So picture this: you're annotating snprintf, right? It would look like this:

int snprintf(SDL_OUT_Z_CAP(maxlen) char *text, size_t maxlen, const char *fmt, ...);

And what that's telling everyone is that text is a null-terminated C string 🌈, that it should be maxlen bytes in size, and that it's only written to by the function — nobody's reading from it, no cap.

The way this pays off? The compiler or other analysis tools can warn you when that doesn't appear to be the case 👀 which is iconic behaviour honestly.

and if you're on a compiler that doesn't have this annotation mechanism? it's just defined to nothing. no drama, no warnings, just vibes 💀

---

⭐ AVAILABILITY ⭐

This macro is available since SDL 3.2.0 🫶

---

mwah 💋 that's the whole page, you ate it. this was brought to you by Simple Directmedia Layer, sitting pretty at version SDL 3.4.18 — go forth and annotate, bestie, ily 🎀✨🦋