SDL-mirror/docs/man3/SDL_GetRGB.3
Sam Lantinga f037300cd2 Erik Heckers fixed bug #493
Searching the installed man pages for SDL functions fails, e.g.
  man -k SDL_ |grep Video
After investigating this I found that "makewhatis", the tool that generates
the "whatis" database, reads the SDL_* man pages, but doesn't produce
entries in the "whatis" database for the SDL_* man pages.
After some more debugging I found the reason is a missing space.
After editing SDL_Init.3(.gz) and replacing
   SDL_Init\- Initializes SDL
with
   SDL_Init \- Initializes SDL
everything works fine.
After running "makewhatis" I can successfully do a
   man -k SDL_
and SDL_Init is listed in the output.

--HG--
branch : SDL-1.2
extra : convert_revision : svn%3Ac70aab31-4412-0410-b14c-859654838e24/branches/SDL-1.2%402660
2007-12-29 02:34:53 +00:00

17 lines
862 B
Groff

.TH "SDL_GetRGB" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetRGB \- Get RGB values from a pixel in the specified pixel format\&.
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBvoid \fBSDL_GetRGB\fP\fR(\fBUint32 pixel, SDL_PixelFormat *fmt, Uint8 *r, Uint8 *g, Uint8 *b\fR);
.SH "DESCRIPTION"
.PP
Get RGB component values from a pixel stored in the specified pixel format\&.
.PP
This function uses the entire 8-bit [0\&.\&.255] range when converting color components from pixel formats with less than 8-bits per RGB component (e\&.g\&., a completely white pixel in 16-bit RGB565 format would return [0xff, 0xff, 0xff] not [0xf8, 0xfc, 0xf8])\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_GetRGBA\fP\fR, \fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_MapRGBA\fP\fR, \fI\fBSDL_PixelFormat\fR\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01