aboutsummaryrefslogtreecommitdiffstats
path: root/distrib/sdl-1.2.15/docs/man3/SDL_Flip.3
diff options
context:
space:
mode:
Diffstat (limited to 'distrib/sdl-1.2.15/docs/man3/SDL_Flip.3')
-rw-r--r--distrib/sdl-1.2.15/docs/man3/SDL_Flip.320
1 files changed, 20 insertions, 0 deletions
diff --git a/distrib/sdl-1.2.15/docs/man3/SDL_Flip.3 b/distrib/sdl-1.2.15/docs/man3/SDL_Flip.3
new file mode 100644
index 0000000..b3b2d65
--- /dev/null
+++ b/distrib/sdl-1.2.15/docs/man3/SDL_Flip.3
@@ -0,0 +1,20 @@
+.TH "SDL_Flip" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
+.SH "NAME"
+SDL_Flip \- Swaps screen buffers
+.SH "SYNOPSIS"
+.PP
+\fB#include "SDL\&.h"
+.sp
+\fBint \fBSDL_Flip\fP\fR(\fBSDL_Surface *screen\fR);
+.SH "DESCRIPTION"
+.PP
+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
+.PP
+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\&.
+.SH "RETURN VALUE"
+.PP
+This function returns \fB0\fR if successful, or \fB-1\fR if there was an error\&.
+.SH "SEE ALSO"
+.PP
+\fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_UpdateRect\fP\fR, \fI\fBSDL_Surface\fR\fR
+.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01