Scroll to navigation

SDL_GetPixelFormatEnumForMasks(3) SDL3 FUNCTIONS SDL_GetPixelFormatEnumForMasks(3)

NAME

SDL_GetPixelFormatEnumForMasks - Convert a bpp value and RGBA masks to an enumerated pixel format.

SYNOPSIS

#include "SDL3/SDL.h"
SDL_PixelFormatEnum SDL_GetPixelFormatEnumForMasks(int bpp,
                                  Uint32 Rmask,
                                  Uint32 Gmask,
                                  Uint32 Bmask,
                                  Uint32 Amask);

DESCRIPTION

This will return SDL_PIXELFORMAT_UNKNOWN if the conversion wasn't possible.

FUNCTION PARAMETERS

a bits per pixel value; usually 15, 16, or 32
the red mask for the format
the green mask for the format
the blue mask for the format
the alpha mask for the format

RETURN VALUE

Returns the SDL_PixelFormatEnum
value corresponding to the format masks, or SDL_PIXELFORMAT_UNKNOWN

if there isn't a match.

AVAILABILITY

This function is available since SDL 3.0.0.

SEE ALSO

SDL_GetMasksForPixelFormatEnum(3)

SDL 3.1.0 SDL