GXCopyDisp

Syntax

#include <revolution/gx.h>

void GXCopyDisp( void* dest, GXBool clear );

Arguments

dest Pointer to the external framebuffer. dest should be 32-byte aligned.
clear Flag that indicates frame buffer should be cleared if GX_TRUE.

Return Values

None.

Description

This function copies the embedded frame buffer (EFB) to an external framebuffer (XFB) in main memory. The first pixel is copied to address dest. The stride (number of pixels from dest to the next line) of the XFB is set using the GXSetDispCopyDst function. The source image in the EFB is described using the GXSetDispCopySrc function.

The graphics processor (GP) will stall all graphics commands until the copy is complete.

If the clear flag is GX_TRUE, the color and Z buffers will be cleared during the copy. They will be cleared to the constant values specified using the GXSetCopyClear function.

See Also

Render Modes, GXSetDispCopySrc, GXSetDispCopyDst, GXSetDispCopyFrame2Field, GXSetDispCopyYScale, GXSetCopyFilter

Revision History

2007/03/05 Corrected error in the See Also section.
2006/03/01 Initial version.


CONFIDENTIAL