Man page - sdl_bytesperpixel(3)

Packages contains this manual

Package: libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:

Manual

SDL_BYTESPERPIXEL

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
RETURN VALUE
THREAD SAFETY
AVAILABILITY
SEE ALSO

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.