Home| base |src.lib|graphic|fbuffer| FrameBufferClear Index

FrameBufferClear

Syntax
int FrameBufferClear(struct FrameBuffer *ptr,unsigned int color, unsigned char m);
Header
base/rfbuffer.h
Library
rfbuf
Description

The FrameBufferClear function sets all the pixels in the frame buffer to the same color.

The argument ptr is a pointer to the frame buffer.

The color used to clear the frame buffer is given by the color which is a 32-bit number that represents the alpha,red,green and blue components of the color as 8-bit numbers. The alpha channel occupies the most significant bits and the blue channel occupies the least significant bits. The argument m defines which color channels are active. Setting this argument to (0x0f) will output the color to all four channels. The most significant bit controls the alpha channel and the least significant bit controls the blue channel.

Returns
Returns zero on success. On error, (-1) is returned.
Errors
On error, (-1) is returned.
Example
None