SDL_CreateTray(3)

💖 SDL_CreateTray(3) 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the group chat, where we're talking about SDL_CreateTray — the function that makes you an icon in the operating system's tray, or the equivalent thing on whatever platform you're on 🎀

---

✨ NAME ✨

SDL_CreateTray — Create an icon to be placed in the operating system's tray, or equivalent. 🦋

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_tray.h>

SDL_Tray * SDL_CreateTray(SDL_Surface *icon, const char *tooltip);

---

💅 DESCRIPTION 💅

so like, here's the tea ☕ — many platforms advise not using a system tray unless persistence is a necessary feature. Translation: don't just slap a tray icon down because you can, okay? Avoid needlessly creating a tray icon, because the user may feel like it clutters their interface 😭 nobody wants their little corner of the screen looking like a messy desk.

Also, using tray icons requires the video subsystem. no video subsystem, no tray vibes, periodt 💀

---

🫶 FUNCTION PARAMETERS 🫶

• icon — a surface to be used as icon. May be NULL. 🖼️
• tooltip — a tooltip to be displayed when the mouse hovers the icon, in UTF-8 encoding. Not supported on all platforms. May be NULL. 💬

---

⭐ RETURN VALUE ⭐

Returns the newly created system tray icon. that's your little guy, your main character, your tray baby 👑

---

🧚 THREAD SAFETY 🧚

This function should only be called on the main thread. no side-quest threads for this one, bestie 💀

---

🌈 AVAILABILITY 🌈

This function is available since SDL 3.2.0. ✨

---

👑 SEE ALSO 👑

• SDL_CreateTrayMenu(3)
• SDL_GetTrayMenu(3)
• SDL_DestroyTray(3)

(go read those next, iykyk 🍓)

---

and that's the whole page, fr fr 💜 this one came straight out of the Simple Directmedia Layer crew, version SDL 3.4.18 — mwah, iconic, no cap 🎀✨