GXAbortFrame

C Specification

#include <revolution/gx.h>
void GXAbortFrame( void );

Arguments

None

Return Values

None

Description

This function will abort the current frame. When this function is called, it will reset the entire graphics pipeline, including any commands in the graphics FIFO that are not processed by the graphics processor yet. This command is intended to be used where an application should terminate current graphics task immediately and move to next process. For example, such case is considered to happen in games where the designers would rather drop some graphics than drop frames.

This command resets all states in the graphics processor, so the application cannot count on retained state from frame to frame. Since it might also raise some inconsistencies with shadowed states in the GX library, it's recommended that you would set up all graphics states again after GXAbortFrame is called.

Texture memory will not be reset, so currently loaded textures will still be valid. However, when loading texture using GXPreLoadEntireTexture or TLUTs using GXLoadTlut, you must make sure the command completed before GXAbortFrame is called. (For such a purpose, you can use the draw sync mechanism to do this, see GXSetDrawSync and GXReadDrawSync.)

See Also

Revision History

03/01/2006 Initial version.