(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_BITSPERPIXEL

A macro to determine an SDL_PixelFormat's bits per pixel.

Header File

Defined in <SDL3/SDL_pixels.h>

Syntax

#define SDL_BITSPERPIXEL(format) \
    (SDL_ISPIXELFORMAT_FOURCC(format) ? 0 : (((format) >> 8) & 0xFF))

Macro Parameters

format

an SDL_PixelFormat to check.

Return Value

Returns the bits-per-pixel of format.

Remarks

Note that this macro double-evaluates its parameter, so do not use expressions with side-effects here.

FourCC formats will report zero here, as it rarely makes sense to measure them per-pixel.

Thread Safety

It is safe to call this macro from any thread.

Version

This macro is available since SDL 3.1.3.

See Also

• SDL_BYTESPERPIXEL

---

CategoryAPI, CategoryAPIMacro, CategoryPixels

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.