ClearImage

Frame the frame buffer with a specified pixel value

int ClearImage (
        RECT* recp,
        u_char r,
        u_char g,
        u_char b
)

Arguments

recp Pointer to the rectangular area to be cleared in the frame buffer
r,g,b Pixel value to be used for clearing

Return Value

The slot number of the GPU's draw command queue where the command resides is returned.

Explanation

The rectangular area of the frame buffer specified by recp is cleared with the pixel value specified by (r,g,b).

Notes

This is a non-blocking function, therefore DrawSync() must be used to determine the completion of transfer. The transfer is not affected by clipping or offsetting that may be in effect for the drawing environment.