SDL_SetTexturePalette(3)

📦
version 3.4.18 · 5 versions
, in fedora 43, fedora 44

💖 SDL_SetTexturePalette 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, and today's main character is SDL_SetTexturePalette(3) — she's a real one, no cap. 🎀

✨ NAME ✨

SDL_SetTexturePalette — literally just: set the palette used by a texture. that's it, that's the whole job. 💅

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_render.h>

bool SDL_SetTexturePalette(SDL_Texture *texture, SDL_Palette *palette);

look at her. two args, one bool. so clean. 🦋

💜 DESCRIPTION 💜

So here's the tea: when you set the palette, SDL keeps an internal reference to it. which means — and this is the slay part — you can safely destroy your palette afterwards and it's still fine. no dangling drama, no use-after-free energy. ✨

And bestie, you're not limited to one texture per palette either: a single palette can be shared with many textures. it's giving community. it's giving sharing is caring. iconic honestly. 👑

🫶 FUNCTION PARAMETERS 🫶

  • texture — the texture you wanna update. your girl. the one getting a glow-up. 💖
  • palette — the SDL_Palette structure to use. the whole color situation. 🌈

⭐ RETURN VALUE ⭐

Returns true on success or false on failure. and if it fails? call SDL_GetError() for more information, because she will tell you exactly what went wrong. 😭

🔥 THREAD SAFETY 🔥

main thread only, bestie!! this function should only be called on the main thread. do not be out here spawning threads and calling this. that's not the vibe. 💀

🧚 AVAILABILITY 🧚

This function is available since SDL 3.4.0. so if you're on anything older, sorry babe, you're not invited to the party. 🎀

🦋 SEE ALSO 🦋

go read those next, iykyk. 💅

mwah 💋 that's the whole page! brought to you by the lovely folks at Simple Directmedia Layer, running SDL 3.4.18 — and yes, this is SDL_SetTexturePalette(3), the one and only. go set some palettes, bestie, you got this. 🫶✨💖

📦 where this page comes from