View Source: SDL_MapRGB(3) - Waikato Linux Users Group

Edit PageHistory Diff Info LikePages

SDL_MapRGB
!!!SDL_MapRGB
NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
SEE ALSO
----
!!NAME


SDL_MapRGB- Map a RGB color value to a pixel format.
!!SYNOPSIS


__#include __


__Uint32 SDL_MapRGB__(__SDL_!PixelFormat *fmt, Uint8 r,
Uint8 g, Uint8 b__);
!!DESCRIPTION


Maps the RGB color value to the specified pixel format and
returns the pixel value as a 32-bit int.


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).
!!RETURN VALUE


A pixel value best approximating the given RGB color value
for a given pixel format. 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).
!!SEE ALSO


__SDL_GetRGB__, __SDL_GetRGBA__, __SDL_MapRGBA__,
__SDL_!PixelFormat__
----

One page links to SDL_MapRGB(3):

SDLManPages

This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.

Last edited on Monday, June 3, 2002 6:53:46 pm by "perry"

Edit PageHistory Diff Info LikePages