L_ClearBitmap

#include "l_bitmap.h"

L_INT EXT_FUNCTION L_ClearBitmap(pBitmap)

/* pointer to the bitmap handle */

Sets all bits to 0 in the specified bitmap, making it a black bitmap.

Parameter	Description
pBitmap	Pointer to the bitmap handle referencing the bitmap to clear.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

To update a status bar or detect a user interrupt during execution of this function, refer to L_SetStatusCallback.

Required DLLs and Libraries

LTKRN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Windows 95 / 98 / Me, Windows 2000 / XP, Windows CE.

See Also

Functions:	L_AccessBitmap, L_ReleaseBitmap, L_GetBitmapRow,
	L_PutBitmapRow, L_GetBitmapRowCol,
	L_PutBitmapRowCol, L_GetPixelColor,
	L_PutPixelColor, L_ClearNegativePixels
Topics:	Raster Image Functions: Getting and Setting Pixel Values

Example

For complete sample code, refer to the COMPCB example.

/* This example loads a bitmap and clears it. */
BITMAPHANDLE LeadBitmap; /* Bitmap handle to hold the loaded image. */
/* Load the bitmap, keeping the bits per pixel of the file */
L_LoadBitmap (TEXT("IMAGE1.CMP"), &LeadBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL);
/* Clear the bitmap */
L_ClearBitmap(&LeadBitmap);