SDL_GetPixelFormatForMasks - Man Page
Convert a bpp value and RGBA masks to an enumerated pixel format.
Header File
Defined in SDL3/SDL_pixels.h
Synopsis
#include "SDL3/SDL.h" SDL_PixelFormat SDL_GetPixelFormatForMasks(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
- bpp
a bits per pixel value; usually 15, 16, or 32.
- Rmask
the red mask for the format.
- Gmask
the green mask for the format.
- Bmask
the blue mask for the format.
- Amask
the alpha mask for the format.
Return Value
( SDL_PixelFormat ) Returns the
SDL_PixelFormat
value corresponding to the format masks, or SDL_PIXELFORMAT_UNKNOWN
if there isn't a match.
Thread Safety
It is safe to call this function from any thread.
Availability
This function is available since SDL 3.2.0.
See Also
Referenced By
SDL_GetMasksForPixelFormat(3).
SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS