SDL_ISPIXELFORMAT_INDEXED

A macro to determine if an SDL_PixelFormat is an indexed format.

Header File

Defined in <SDL3/SDL_pixels.h>

Syntax

#define SDL_ISPIXELFORMAT_INDEXED(format)   \
    (!SDL_ISPIXELFORMAT_FOURCC(format) && \
     ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX1) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX2) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX4) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_INDEX8)))

Macro Parameters

format an SDL_PixelFormat to check.

Return Value

Returns true if the format is indexed, false otherwise.

Remarks

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

Thread Safety

It is safe to call this macro from any thread.

Version

This macro is available since SDL 3.2.0.

CategoryAPI, CategoryAPIMacro, CategoryPixels