Mercurial > sdl-ios-xcode

view docs/man3/SDL_CreateYUVOverlay.3 @ 4358:df306a61a61d SDL-1.2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Recommendation from Lennart Poettering: In ALSA_PlayAudio() it is a good idea to use snd_pcm_recover() instead of checking for the error codes yourself.
author Sam Lantinga <slouken@libsdl.org>
date Mon, 19 Oct 2009 02:33:07 +0000
parents 1238da4a7112
children
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