logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_MapRGB - Map an RGB triple to an opaque pixel value for a given pixel format.

Availability

       This function is available since SDL 3.2.0.

Description

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

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

       If the specified pixel format has an alpha component it will be returned as all 1 bits (fully opaque).

       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.

Name

       SDL_MapRGB - Map an RGB triple to an opaque pixel value for a given pixel format.

Return Value

       Returns a pixel value.

See Also

SDL_GetPixelFormatDetails(3), SDL_GetRGB(3), SDL_MapRGBA(3), SDL_MapSurfaceRGB(3)

Simple Directmedia Layer                           SDL 3.2.20                                      SDL_MapRGB(3)

Synopsis

#include<SDL3/SDL_pixels.h>Uint32SDL_MapRGB(constSDL_PixelFormatDetails*format,constSDL_Palette*palette,Uint8r,Uint8g,Uint8b);

Thread Safety

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

See Also