SDL_GetPixelFormatForMasks

sdl3_sys::pixels

Function SDL_GetPixelFormatForMasks 

Source 
pub extern "C" fn SDL_GetPixelFormatForMasks(
    bpp: c_int,
    Rmask: Uint32,
    Gmask: Uint32,
    Bmask: Uint32,
    Amask: Uint32,
) -> SDL_PixelFormat
Expand description

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

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

§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

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