Man page - sdl_ispixelformat_alpha(3)

Packages contains this manual

Package:  libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:
• libsdl3-doc
• libsdl3-dev

Manual

SDL_ISPIXELFORMAT_ALPHA

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
RETURN VALUE
THREAD SAFETY
AVAILABILITY

---

NAME

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

HEADER FILE

Defined in SDL3/SDL_pixels.h

SYNOPSIS

#include "SDL3/SDL.h"

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

DESCRIPTION

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

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.

---