SDL_GetNumberProperty(3)

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

💖 SDL_GetNumberProperty 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, where we are pulling a number property out of a whole lil group of properties ✨ it's giving "reach into the bag and grab the number" energy and honestly? obsessed.

✨ NAME ✨

SDL_GetNumberProperty — get a number property from a group of properties 🎀

✨ SYNOPSIS ✨

#include <SDL3/SDL_properties.h>

Sint64 SDL_GetNumberProperty(SDL_PropertiesID props, const char *name, Sint64 default_value);

✨ DESCRIPTION ✨

so like, you hand it a property name, it hands you back a number. slay. 💅

and if you're sitting there like "bestie… does this property even exist?? is it even a number tho??" — you can use SDL_GetPropertyType() to query whether the property exists and is a number property 🦋 no guessing required, no cap.

✨ FUNCTION PARAMETERS ✨

  • props — the properties to query 🌸 like, the whole group you're digging through.
  • name — the name of the property to query 💜 the one you're looking for by name, main character style.
  • default_value — the default value of the property 🎀 your lil fallback bff, waiting patiently in case things don't work out.

✨ RETURN VALUE ✨

Returns the value of the property 🔥 or, if it is not set or not a number property, it just gives you back default_value 🫶 no drama, no crash, just the fallback. periodt.

✨ THREAD SAFETY ✨

It is safe to call this function from any thread 🌈 fr fr, any thread, go wild, call it from wherever you want. iconic behaviour honestly.

✨ AVAILABILITY ✨

This function is available since SDL 3.2.0 ⭐ so if you're on something older… yeah, that's a vibe check you're failing, bestie 😭

✨ SEE ALSO ✨

iykyk — go read those next, they're the whole friend group 🦋

lowkey important: this one only does numbers. if the property is set but it's a different type, you're getting default_value back, not a surprise conversion. 🙈

and that's the whole page bestie!! brought to you by Simple Directmedia Layer 💜 running the SDL 3.4.18 era, and yes this is SDL_GetNumberProperty(3) signing off 👑 go get those numbers, you ate 💅🌸

📦 where this page comes from