(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetMasksForPixelFormat

Convert one of the enumerated pixel formats to a bpp value and RGBA masks.

Header File

Defined in <SDL3/SDL_pixels.h>

Syntax

SDL_bool SDL_GetMasksForPixelFormat(SDL_PixelFormat format, int *bpp, Uint32 *Rmask, Uint32 *Gmask, Uint32 *Bmask, Uint32 *Amask);

Function Parameters

SDL_PixelFormat	format	one of the SDL_PixelFormat values.
int *	bpp	a bits per pixel value; usually 15, 16, or 32.
Uint32 *	Rmask	a pointer filled in with the red mask for the format.
Uint32 *	Gmask	a pointer filled in with the green mask for the format.
Uint32 *	Bmask	a pointer filled in with the blue mask for the format.
Uint32 *	Amask	a pointer filled in with the alpha mask for the format.

Return Value

(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.0.0.

See Also

• SDL_GetPixelFormatForMasks

---

CategoryAPI, CategoryAPIFunction, CategoryPixels

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.