| Home
| Previous
| Next
| Up

GM_swapDirtyBuffers

Swaps the display buffers for the game with dirty rectangles

Declaration

void MGLAPI GM_swapDirtyBuffers(
region_t *dirty,
MGL_waitVRTFlagType waitVRT)

Prototype In

gm/gm.h

Parameters

dirty | Region of dirty rectangles to blit
waitVRT | Wait for vertical retrace flag

Description

Swaps the display buffers for the Game Framework game by blitting the list of dirty rectangles to the display. The list of dirty rectangles is passed in as an MGL region, which you can construct using the MGL region manipulation functions.

If there are multiple hardware display pages enabled for the game, the waitVRT flag (of MGL_waitVRTFlagType) is used to determine if the MGL should wait for the vertical retrace before swapping display pages or not.

Note: You should make sure you first call MGL_optimiseRegion before you call this function to minimise the number of rectangles in the dirty rectangle list. If you dont do this, the result will be the same but it may take longer to perform the blitting.

Note: If you did not specifically request a system memory back buffer, this function will behave identically to GM_swapBuffers and no blitting will occur.

See Also

GM_swapBuffers

Copyright © 2002 SciTech Software, Inc. Visit our web site at http://www.scitechsoft.com