Work around MinGW mangling of "host:/path"
[msysgit/historical-msysgit.git] / mingw / man / man3 / SDL_Flip.3
blob9c38ef5a64cfee8c7f15311f0c711a982d205920
1 .TH "SDL_Flip" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
2 .SH "NAME"
3 SDL_Flip\- Swaps screen buffers
4 .SH "SYNOPSIS"
5 .PP
6 \fB#include "SDL\&.h"
7 .sp
8 \fBint \fBSDL_Flip\fP\fR(\fBSDL_Surface *screen\fR);
9 .SH "DESCRIPTION"
10 .PP
11 On hardware that supports double-buffering, this function sets up a flip and returns\&. The hardware will wait for vertical retrace, and then swap video buffers before the next video surface blit or lock will return\&. On hardware that doesn\&'t support double-buffering, this is equivalent to calling \fISDL_UpdateRect\fR\fB(screen, 0, 0, 0, 0)\fR
12 .PP
13 The \fBSDL_DOUBLEBUF\fP flag must have been passed to \fISDL_SetVideoMode\fR, when setting the video mode for this function to perform hardware flipping\&.
14 .SH "RETURN VALUE"
15 .PP
16 This function returns \fB0\fR if successful, or \fB-1\fR if there was an error\&.
17 .SH "SEE ALSO"
18 .PP
19 \fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_UpdateRect\fP\fR, \fI\fBSDL_Surface\fR\fR
20 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01