misc/builddeps/win64/sdl/share/man/man3/SDL_MapRGB.3

   1 .TH "SDL_MapRGB" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
   2 .SH "NAME"
   3 SDL_MapRGB \- Map a RGB color value to a pixel format\&.
   4 .SH "SYNOPSIS"
   5 .PP
   6 \fB#include "SDL\&.h"
   7 .sp
   8 \fBUint32 \fBSDL_MapRGB\fP\fR(\fBSDL_PixelFormat *fmt, Uint8 r, Uint8 g, Uint8 b\fR);
   9 .SH "DESCRIPTION"
  10 .PP
  11 Maps the RGB color value to the specified pixel format and returns the pixel value as a 32-bit int\&.
  12 .PP
  13 If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned\&.
  14 .PP
  15 If the specified pixel format has an alpha component it will be returned as all 1 bits (fully opaque)\&.
  16 .SH "RETURN VALUE"
  17 .PP
  18 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 \fBUint16\fP, and similarly a \fBUint8\fP for an 8-bpp format)\&.
  19 .SH "SEE ALSO"
  20 .PP
  21 \fI\fBSDL_GetRGB\fP\fR, \fI\fBSDL_GetRGBA\fP\fR, \fI\fBSDL_MapRGBA\fP\fR, \fI\fBSDL_PixelFormat\fR\fR
  22 .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01