Scroll to navigation

SDL_PIXELORDER(3) SDL3 FUNCTIONS SDL_PIXELORDER(3)

NAME

SDL_PIXELORDER - A macro to retrieve the order of an SDL_PixelFormat.

SYNOPSIS

#include <SDL3/SDL_pixels.h>
#define SDL_PIXELORDER(format)   (((format) >> 20) & 0x0F)

DESCRIPTION

This is usually a value from the SDL_BitmapOrder, SDL_PackedOrder, or SDL_ArrayOrder enumerations, depending on the format type.

MACRO PARAMETERS

an SDL_PixelFormat to check.

RETURN VALUE

Returns the order of format.

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.16 Simple Directmedia Layer