SDL_ISPIXELFORMAT_FLOAT(3)

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

✨ NAME ✨

SDL_ISPIXELFORMAT_FLOAT — a macro that checks whether an SDL_PixelFormat is giving floating point format energy 💅

Like, it's the SDL_ISPIXELFORMAT_FLOAT(3) page bestie, and we're about to make pixel format checks make sense fr fr.

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_pixels.h>

#define SDL_ISPIXELFORMAT_FLOAT(format)    \
      (!SDL_ISPIXELFORMAT_FOURCC(format) && \
       ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYF16) || \
        (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYF32)))

🎀 DESCRIPTION 🎀

Okay so real talk: this macro double-evaluates its parameter. Do NOT put expressions with side-effects in there, bestie. That's the warning, and it's not a drill 😭

It checks if the format is a floating point format, and it does it by first making sure it's not a FourCC format, then checking whether the pixel type is SDL_PIXELTYPE_ARRAYF16 or SDL_PIXELTYPE_ARRAYF32. Iconic behavior honestly.

⚠️ Side effects in the parameter = chaos. Double evaluation means your expression runs twice. Not me warning you twice because it literally runs twice 💀

🦋 MACRO PARAMETERS 🦋

  • format — an SDL_PixelFormat to check. That's the one, the only, the format being vibe-checked ✨

💖 RETURN VALUE 💖

Returns true if the format is a floating point, false otherwise. Simple. Clean. Slay.

🔥 THREAD SAFETY 🔥

It is safe to call this macro from any thread. No cap, go off wherever you need to 🫶

👑 AVAILABILITY 👑

This macro is available since SDL 3.2.0. Periodt.

Simple Directmedia Layer • SDL 3.4.18 • SDL_ISPIXELFORMAT_FLOAT(3)

That's the whole page, bestie 💖 Go check those pixel formats, stay hydrated, and remember: double evaluation is real and it will catch you slipping. Mwah 🎀✨🦋

📦 where this page comes from