SDL_BITSPERPIXEL - Man Page

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

Synopsis

#include <SDL3/SDL_pixels.h>

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

Description

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.

Macro Parameters

format

an SDL_PixelFormat to check.

Return Value

Returns the bits-per-pixel of format.

Thread Safety

It is safe to call this macro from any thread.

Availability

This macro is available since SDL 3.2.0.

See Also

SDL_BYTESPERPIXEL(3)

Referenced By

SDL_BYTESPERPIXEL(3).

SDL 3.2.16 Simple Directmedia Layer SDL3 FUNCTIONS