NAME¶

SDL_ISPIXELFORMAT_ALPHA - A macro to determine if an SDL_PixelFormat has an alpha channel.

SYNOPSIS¶

#include <SDL3/SDL_pixels.h>

#define SDL_ISPIXELFORMAT_ALPHA(format)   \
    ((SDL_ISPIXELFORMAT_PACKED(format) && \
      ((SDL_PIXELORDER(format) == SDL_PACKEDORDER_ARGB) || \
       (SDL_PIXELORDER(format) == SDL_PACKEDORDER_RGBA) || \
       (SDL_PIXELORDER(format) == SDL_PACKEDORDER_ABGR) || \
       (SDL_PIXELORDER(format) == SDL_PACKEDORDER_BGRA))) || \
     (SDL_ISPIXELFORMAT_ARRAY(format) && \
      ((SDL_PIXELORDER(format) == SDL_ARRAYORDER_ARGB) || \
       (SDL_PIXELORDER(format) == SDL_ARRAYORDER_RGBA) || \
       (SDL_PIXELORDER(format) == SDL_ARRAYORDER_ABGR) || \
       (SDL_PIXELORDER(format) == SDL_ARRAYORDER_BGRA))))

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 has alpha, false otherwise.

THREAD SAFETY¶

It is safe to call this macro from any thread.

AVAILABILITY¶

This macro is available since SDL 3.2.0.