Man page - sdl_getrgba(3)

Packages contains this manual

Package: libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:

Manual

SDL_GetRGBA

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
THREAD SAFETY
AVAILABILITY
SEE ALSO

NAME

SDL_GetRGBA - Get RGBA values from a pixel in the specified format.

HEADER FILE

Defined in SDL3/SDL_pixels.h

SYNOPSIS

#include "SDL3/SDL.h"

void SDL_GetRGBA(Uint32 pixel, const SDL_PixelFormatDetails *format, const SDL_Palette *palette, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a);

DESCRIPTION

This function uses the entire 8-bit [0..255] range when converting color components from pixel formats with less than 8-bits per RGB component (e.g., a completely white pixel in 16-bit RGB565 format would return [0xff, 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).

If the surface has no alpha component, the alpha will be returned as 0xff (100% opaque).

FUNCTION PARAMETERS

	pixel		a pixel value.
	format		a pointer to SDL_PixelFormatDetails

describing the pixel format.

palette

an optional palette for indexed formats, may be NULL.

	r		a pointer filled in with the red component, may be NULL.
	g		a pointer filled in with the green component, may be NULL.
	b		a pointer filled in with the blue component, may be NULL.
	a		a pointer filled in with the alpha component, may be NULL.

THREAD SAFETY

It is safe to call this function from any thread, as long as the palette is not modified.

AVAILABILITY

This function is available since SDL 3.2.0.