Mercurial > sdl-ios-xcode
view docs/man3/SDL_MapRGBA.3 @ 4107:4e3b250c950e SDL-1.2
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.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Sat, 29 Dec 2007 02:34:53 +0000 |
parents | e5bc29de3f0a |
children | 1238da4a7112 |
line wrap: on
line source
.TH "SDL_MapRGBA" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_MapRGBA \- Map a RGBA color value to a pixel format\&. .SH "SYNOPSIS" .PP \fB#include "SDL\&.h" .sp \fBUint32 \fBSDL_MapRGBA\fP\fR(\fBSDL_PixelFormat *fmt, Uint8 r, Uint8 g, Uint8 b, Uint8 a\fR); .SH "DESCRIPTION" .PP Maps the RGBA color value to the specified pixel format and returns the pixel value as a 32-bit int\&. .PP If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned\&. .PP If the specified pixel format has no alpha component the alpha value will be ignored (as it will be in formats with a palette)\&. .SH "RETURN VALUE" .PP A pixel value best approximating the given RGBA 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)\&. .SH "SEE ALSO" .PP \fISDL_GetRGB\fR, \fISDL_GetRGBA\fR, \fISDL_MapRGB\fR, \fISDL_PixelFormat\fR ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01