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_MapSurfaceRGB - Map an RGB triple to an opaque pixel value for a surface.

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 surface has a palette, the index of the closest matching color in the palette will be returned.

       If the surface 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

surface
              the surface to use for the pixel format and palette.

       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.

Header File

       Defined in SDL3/SDL_surface.h

Name

       SDL_MapSurfaceRGB - Map an RGB triple to an opaque pixel value for a surface.

Return Value

       ( Uint32 ) Returns a pixel value.

See Also

(3), SDL_MapSurfaceRGBA(3)

Simple Directmedia Layer                           SDL 3.2.10                               SDL_MapSurfaceRGB(3)

Synopsis

#include"SDL3/SDL.h"Uint32SDL_MapSurfaceRGB(SDL_Surface*surface,Uint8r,Uint8g,Uint8b);

Thread Safety

       It is safe to call this function from any thread.

See Also