L_ClearBitmap

#include "l_bitmap.h"

L_LTKRN_API L_INT 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.

Regions are not supported on the Windows CE platform.

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

Win32, x64, Linux.

Example

For complete sample code, refer to the COMPCB example. This example loads a bitmap and clears it.

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName 
L_INT ClearBitmapExample(L_VOID) 
{ 
   L_INT nRet; 
   BITMAPHANDLE LeadBitmap;   /* Bitmap handle to hold the loaded image. */ 
   /* Load the bitmap, keeping the bits per pixel of the file */ 
   nRet = L_LoadBitmap (MAKE_IMAGE_PATH(TEXT("IMAGE1.CMP")), &LeadBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL); 
   if(nRet != SUCCESS) 
      return nRet; 
   /* Clear the bitmap */ 
   nRet = L_ClearBitmap(&LeadBitmap); 
   if(nRet != SUCCESS) 
      return nRet; 
   nRet = L_SaveBitmap(MAKE_IMAGE_PATH(TEXT("Result.BMP")), &LeadBitmap, FILE_BMP, 24, 0, NULL); 
   if(nRet != SUCCESS) 
      return nRet; 
   if(LeadBitmap.Flags.Allocated) 
      L_FreeBitmap(&LeadBitmap); 
   return SUCCESS; 
}

Help Version 19.0.2017.10.27

Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help

Introduction

Version History

Getting Started

LEADTOOLS Raster Imaging Features

Redistributables/Files To Be Included With Your Application

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