Scroll to navigation

SDL_BYTESPERPIXEL(3) SDL3 FUNCTIONS SDL_BYTESPERPIXEL(3)

NAME

SDL_BYTESPERPIXEL - 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)

SDL 3.2.0 Simple Directmedia Layer