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

SDL_ISPIXELFORMAT_ALPHA

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

Header File

Defined in <SDL3/SDL_pixels.h>

Syntax

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

Macro Parameters

format

an SDL_PixelFormat to check.

Return Value

Returns true if the format has alpha, 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.