SDL_Flip

Name

SDL_Flip -- Swaps screen buffers.

Synopsis

#include "SDL.h"

int SDL_Flip(SDL_Surface *screen);

Description

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 or if SDL_SWSURFACE was set, this is equivalent to calling SDL_UpdateRect(screen, 0, 0, 0, 0)

A software screen surface is also updated automatically when parts of a SDL window are redrawn, caused by overlapping windows or by restoring from an iconified state. As a result there is no proper double buffer behaviour in windowed mode for a software screen, in contrast to a fullscreen software mode.

The SDL_DOUBLEBUF flag must have been passed to SDL_SetVideoMode, when setting the video mode for this function to perform hardware flipping.

Return Value

This function returns 0 if successful, or -1 if there was an error.

Example

See Also

SDL_SetVideoMode, SDL_UpdateRect, SDL_Surface

SDL_Flip (last edited 2008-05-13 19:25:16 by 77)