docs/man3/SDL_Flip.3
changeset 3352 6dc250ebdd80
parent 3351 8e0182c236d8
child 3353 6b14223dd5c7
     1.1 --- a/docs/man3/SDL_Flip.3	Wed Oct 07 06:11:53 2009 +0000
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,20 +0,0 @@
     1.4 -.TH "SDL_Flip" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
     1.5 -.SH "NAME"
     1.6 -SDL_Flip \- Swaps screen buffers
     1.7 -.SH "SYNOPSIS"
     1.8 -.PP
     1.9 -\fB#include "SDL\&.h"
    1.10 -.sp
    1.11 -\fBint \fBSDL_Flip\fP\fR(\fBSDL_Surface *screen\fR);
    1.12 -.SH "DESCRIPTION"
    1.13 -.PP
    1.14 -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
    1.15 -.PP
    1.16 -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\&.
    1.17 -.SH "RETURN VALUE"
    1.18 -.PP
    1.19 -This function returns \fB0\fR if successful, or \fB-1\fR if there was an error\&.
    1.20 -.SH "SEE ALSO"
    1.21 -.PP
    1.22 -\fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_UpdateRect\fP\fR, \fI\fBSDL_Surface\fR\fR
    1.23 -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01