Mercurial > sdl-ios-xcode

view docs/man3/SDL_CreateYUVOverlay.3 @ 4107:4e3b250c950e SDL-1.2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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_CreateYUVOverlay" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_CreateYUVOverlay \- Create a YUV video overlay
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBSDL_Overlay *\fBSDL_CreateYUVOverlay\fP\fR(\fBint width, int height, Uint32 format, SDL_Surface *display\fR);
.SH "DESCRIPTION"
.PP
\fBSDL_CreateYUVOverlay\fP creates a YUV overlay of the specified \fBwidth\fR, \fBheight\fR and \fBformat\fR (see \fI\fBSDL_Overlay\fR\fR for a list of available formats), for the provided \fBdisplay\fR\&. A \fI\fBSDL_Overlay\fR\fR structure is returned\&.
.PP
The term \&'overlay\&' is a misnomer since, unless the overlay is created in hardware, the contents for the display surface underneath the area where the overlay is shown will be overwritten when the overlay is displayed\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_Overlay\fR\fR, \fI\fBSDL_DisplayYUVOverlay\fP\fR, \fI\fBSDL_FreeYUVOverlay\fP\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01