SDL_SetHint(3)

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

💖 SDL_SetHint(3) 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, where today's main character is SDL_SetHint — she sets a hint with normal priority and she does it fabulously. no cap.

✨ NAME ✨

SDL_SetHint — set a hint with normal priority. that's it, that's the whole job description. 🎀

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_hints.h>

bool SDL_SetHint(const char *name, const char *value);

look at her. two lil const char * besties and a bool return. iconic.

🦋 DESCRIPTION 🦋

so here's the tea, and it's important tea: hints will not be set if there's already an existing override hint or an environment variable that takes precedence over yours. like, sorry babe, someone more important already claimed that seat. 💅

if you really need to force your hint through, you can use SDL_SetHintWithPriority() to set the hint with override priority instead. that's the "i'm the main character now" option. periodt.

🎀 FUNCTION PARAMETERS 🎀

  • name — the hint to set. literally just the name of the hint you're trying to set, bestie. 🍓
  • value — the value of the hint variable. this is the actual juice you're putting in the hint. ✨

⭐ RETURN VALUE ⭐

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

🧚 THREAD SAFETY 🧚

it is safe to call this function from any thread. go wild. no vibes will be harmed. 🌈

👑 AVAILABILITY 👑

this function has been available since SDL 3.2.0. she's been around a minute. 💜

🔥 SEE ALSO 🔥

the whole hint squad, iykyk. 🫶

lowkey a warning but also just facts: if an override hint or an environment variable is already winning, your SDL_SetHint call is getting politely ignored. know the hierarchy, bestie. 💀

and that's the page!! brought to you by Simple Directmedia Layer, version SDL 3.4.18 — mwah, love you, go set some hints responsibly 🌸💖✨

📦 where this page comes from