SDL_BYTESPERPIXEL - Man Page

A macro to determine an SDL_PixelFormat

Header File

Defined in SDL3/SDL_pixels.h

Synopsis

#include "SDL3/SDL.h"

#define SDL_BYTESPERPIXEL(format) .BI (SDL_ISPIXELFORMAT_FOURCC(format)?.BI        ((((format) == SDL_PIXELFORMAT_YUY2) || .BI ((format)==SDL_PIXELFORMAT_UYVY)||.BI          ((format) == SDL_PIXELFORMAT_YVYU) || .BI ((format)==SDL_PIXELFORMAT_P010))?2:1):(((format)>>0)&0xFF))

Description

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

FourCC formats do their best here, but many of them don't have a meaningful measurement of bytes per pixel.

Return Value

Returns the bytes-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

·(3), SDL_BITSPERPIXEL(3)

Referenced By

SDL_BITSPERPIXEL(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS