SDL_BYTESPERPIXEL(3)

SDL_BYTESPERPIXEL3

A macro to determine an sdl_pixelformat

Usage

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

Header file

Defined in SDL3/SDL_pixels.h

Overview

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.