Scroll to navigation

SDL_ISPIXELFORMAT_ARRAY(3) SDL3 FUNCTIONS SDL_ISPIXELFORMAT_ARRAY(3)

NAME

SDL_ISPIXELFORMAT_ARRAY - A macro to determine if an SDL_PixelFormat is an array format.

SYNOPSIS

#include <SDL3/SDL_pixels.h>
#define SDL_ISPIXELFORMAT_ARRAY(format) \
    (!SDL_ISPIXELFORMAT_FOURCC(format) && \
     ((SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU8) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU16) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYU32) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYF16) || \
      (SDL_PIXELTYPE(format) == SDL_PIXELTYPE_ARRAYF32)))

DESCRIPTION

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

MACRO PARAMETERS

an SDL_PixelFormat to check.

RETURN VALUE

Returns true if the format is an array, false otherwise.

THREAD SAFETY

It is safe to call this macro from any thread.

AVAILABILITY

This macro is available since SDL 3.2.0.

SDL 3.2.14 Simple Directmedia Layer