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

NAME

6       SDL_MapRGBA - Map a RGBA color value to a pixel format.
7

SYNOPSIS

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

DESCRIPTION

15       Maps the RGBA color value to the specified pixel format and returns the
16       pixel value as a 32-bit int.
17
18       If  the  format has a palette (8-bit) the index of the closest matching
19       color in the palette will be returned.
20
21       If the specified pixel format has no alpha component  the  alpha  value
22       will be ignored (as it will be in formats with a palette).
23

RETURN VALUE

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

SEE ALSO

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