view docs/man3/SDL_CreateYUVOverlay.3 @ 4440:7bb8f748a14d SDL-1.2

Fixed bug 978 Yann Leprince 2010-03-31 11:07:53 PDT Please add a #serial line as below to sdl.m4 and increase the serial number with each revision of this file. This allows using aclocal --install, thereby enabling automatic updating of sdl.m4 in SDL-based packages that distribute it. # serial 1 The complete documentation and rationale for #serial can be found in the Automake documentation: <http://www.gnu.org/software/automake/manual/html_node/Serials.html>.
author Sam Lantinga <slouken@libsdl.org>
date Fri, 23 Apr 2010 02:19:19 -0700
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