(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

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.1.3.

---

CategoryAPI, CategoryAPIMacro, CategoryPixels

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.