Tao.Sdl SDK Documentation

Sdl.SDL_MapRGB Method 

Map a RGB color value to a pixel format.

[Visual Basic]
Public Shared Function SDL_MapRGB( _
   ByVal format As IntPtr, _
   ByVal r As Byte, _
   ByVal g As Byte, _
   ByVal b As Byte _
) As Integer
[C#]
public static int SDL_MapRGB(
   IntPtr format,
   byte r,
   byte g,
   byte b
);

Parameters

format
IntPtr to Sdl.SDL_PixelFormat
r
g
b

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).

Remarks

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).

Binds to C-function call in SDL_video.h:

extern DECLSPEC Uint32 SDLCALL SDL_MapRGB (SDL_PixelFormat *format, Uint8 r, Uint8 g, Uint8 b)

See Also

Sdl Class | Tao.Sdl Namespace | SDL_GetRGB | SDL_GetRGBA | SDL_MapRGBA | SDL_PixelFormat