plucky (3) SDL_MapRGBA.3.gz

NAME

       SDL_MapRGBA - Map an RGBA quadruple to a pixel value for a given pixel format.

HEADER FILE

       Defined in SDL3/SDL_pixels.h

SYNOPSIS

       #include "SDL3/SDL.h"

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

DESCRIPTION

       This  function  maps  the RGBA color value to the specified pixel format and returns the pixel value best
       approximating the given RGBA color value for the given pixel format.

       If the specified pixel format has no alpha component the alpha value will be ignored (as it  will  be  in
       formats with a palette).

       If  the  format  has  a  palette  (8-bit)  the index of the closest matching color in the palette will be
       returned.

       If the pixel format bpp (color depth) is less than 32-bpp then the unused upper bits of the return  value
       can  safely  be  ignored  (e.g.,  with a 16-bpp format the return value can be assigned to a Uint16 , and
       similarly a Uint8 for an 8-bpp format).

FUNCTION PARAMETERS

       format a pointer to SDL_PixelFormatDetails
               describing the pixel format.

       palette
              an optional palette for indexed formats, may be NULL.

       r      the red component of the pixel in the range 0-255.

       g      the green component of the pixel in the range 0-255.

       b      the blue component of the pixel in the range 0-255.

       a      the alpha component of the pixel in the range 0-255.

RETURN VALUE

       ( Uint32 ) Returns a pixel value.

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.

SEE ALSO

       •(3),    SDL_GetPixelFormatDetails(3),    •(3),    SDL_GetRGBA(3),     •(3),     SDL_MapRGB(3),     •(3),
       SDL_MapSurfaceRGBA(3)