SDL_ISPIXELFORMAT_PACKED - Man Page

A macro to determine if an SDL_PixelFormat is a packed format.

Synopsis

#include <SDL3/SDL_pixels.h>

#define SDL_ISPIXELFORMAT_PACKED(format) \
    (!SDL_ISPIXELFORMAT_FOURCC(format) && \
     ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED8) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED16) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_PACKED32)))

Description

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

Macro Parameters

format

an SDL_PixelFormat to check.

Return Value

Returns true if the format is packed, false otherwise.

Thread Safety

It is safe to call this macro from any thread.

Availability

This macro is available since SDL 3.2.0.

Info

SDL 3.2.16 Simple Directmedia Layer SDL3 FUNCTIONS