1SDL_MapRGB(3)                  SDL API Reference                 SDL_MapRGB(3)
2
3
4

NAME

6       SDL_MapRGB - Map a RGB color value to a pixel format.
7

SYNOPSIS

9       #include "SDL.h"
10
11       Uint32 SDL_MapRGB(SDL_PixelFormat *fmt, Uint8 r, Uint8 g, Uint8 b);
12

DESCRIPTION

14       Maps  the RGB color value to the specified pixel format and returns the
15       pixel value as a 32-bit int.
16
17       If the format has a palette (8-bit) the index of the  closest  matching
18       color in the palette will be returned.
19
20       If  the  specified  pixel  format  has  an  alpha  component it will be
21       returned as all 1 bits (fully opaque).
22

RETURN VALUE

24       A pixel value best approximating the given RGB color value for a  given
25       pixel format. If the pixel format bpp (color depth) is less than 32-bpp
26       then the unused upper bits of the return value can  safely  be  ignored
27       (e.g.,  with  a  16-bpp  format  the  return value can be assigned to a
28       Uint16, and similarly a Uint8 for an 8-bpp format).
29

SEE ALSO

31       SDL_GetRGB, SDL_GetRGBA, SDL_MapRGBA, SDL_PixelFormat
32
33
34
35SDL                         Tue 11 Sep 2001, 23:01               SDL_MapRGB(3)