---
name: "SDL_GetMasksForPixelFormat"
section: "3"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_GetMasksForPixelFormat"
---

# SDL\_GetMasksForPixelFormat(3)

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

## NAME

SDL\_GetMasksForPixelFormat - Convert one of the enumerated pixel formats to a bpp value and RGBA masks.

## HEADER FILE

Defined in SDL3/SDL\_pixels.h

## SYNOPSIS

```
#include "SDL3/SDL.h"
```

**bool SDL\_GetMasksForPixelFormat(SDL\_PixelFormat format, int \*bpp, Uint32 \*Rmask, Uint32 \*Gmask, Uint32 \*Bmask, Uint32 \*Amask);**

## FUNCTION PARAMETERS

- *format*

  one of the  **SDL\_PixelFormat**\
    values.

- *bpp*

  a bits per pixel value; usually 15, 16, or 32.

- *Rmask*

  a pointer filled in with the red mask for the format.

- *Gmask*

  a pointer filled in with the green mask for the format.

- *Bmask*

  a pointer filled in with the blue mask for the format.

- *Amask*

  a pointer filled in with the alpha mask for the format.

## RETURN VALUE

Returns true on success or false on failure; call

**SDL\_GetError** () for more information.

## THREAD SAFETY

It is safe to call this function from any thread.

## AVAILABILITY

This function is available since SDL 3.2.0.

## SEE ALSO

**•**(3), [**SDL\_GetPixelFormatForMasks**(3)](/SDL_GetPixelFormatForMasks/3.md)