SDL_PROP_NAME_STRING(3)

💖 NAME 💖

SDL_PROP_NAME_STRING — bestie, it's a generic property for naming things. that's the whole gig. it's giving "hello, my name is". ✨

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_properties.h>

#define SDL_PROP_NAME_STRING "SDL.name"

like. one header. one define. immaculate. no cap. 🎀

---

🦋 DESCRIPTION 🦋

okay so here's the vibe: this property is intended to be added to any SDL_PropertiesID that needs a generic name attached to the property set. that's its whole purpose and it's serving it. 💅

now, is it guaranteed that any given property set will actually include this key? nope. it's not. it's just genuinely convenient to have a standard key that any piece of code could reasonably agree to use. a little handshake. a little "we all know what this means" moment. 🤝

for example:

• the properties hanging off an SDL_Texture might have a name string of "player sprites"
• an SDL_AudioStream might have "background music"
• and honestly this could also be useful for an SDL_IOStream to list the path to its asset. 📁

etc. you get it. etc.

---

✨ there is no format for the value you set with this key. ✨ none. zero. it's expected to be human-readable and informational in nature — possibly for logging or debugging purposes. so like, be normal about it. it's for humans, not parsers. 🙈

---

and now the tea, because you need to know: SDL does not currently set this property on any objects it creates, but this may change in later versions. so right now the expectation is that apps and external libraries take advantage of it, when appropriate. it's a community key. it's grassroots. it's main character energy but in a collaborative way. 👑

---

⭐ AVAILABILITY ⭐

this macro has been available since SDL 3.4.0. iconic behavior honestly. 🫶

---

and that's the page bestie!! written by the lovely people over at Simple Directmedia Layer, from the SDL 3.4.18 era. go name ur properties. slay. 💖✨🎀🦋🌸💅