mirror of
https://github.com/joel16/SDL2.git
synced 2024-12-15 07:20:03 +00:00
21 lines
1015 B
Groff
21 lines
1015 B
Groff
.TH "SDL_Flip" "3" "Sun 10 Jun 2001, 19:41" "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, Sun 10 Jun 2001, 19:41
|