In This Topic ▼

L_GetBitmapRgnArea

Summary

Gets the total number of pixels in the bitmap region.

Syntax

#include "l_bitmap.h"

L_LTDIS_API L_INT L_GetBitmapRgnArea(pBitmap, puArea)

Parameters

pBITMAPHANDLE pBitmap

Pointer to the bitmap handle referencing the bitmap that has the region.

L_SIZE_T* puArea

Address of the variable to be updated with the pixel count.

Returns

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

Comments

Before calling this function, you must declare an L_UINT32 variable for the pixel count. You can then pass the address of the variable in the puArea parameter, and the function will update the variable.

Required DLLs and Libraries

LTDIS
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 a complete sample code, refer to the FEATURE3 example.
This example displays the area of the current bitmap region.

L_INT GetBitmapRgnAreaExample(pBITMAPHANDLE pBitmap) 
{ 
   L_INT    nRet; 
   L_TCHAR  szMessage[80]; /* Buffer for the MessageBox string */ 
   L_SIZE_T zArea;         /* Number of pixels in the region */ 
 
   /* Get the number of pixels in the region */ 
   nRet = L_GetBitmapRgnArea(pBitmap, &zArea); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   /* Display the result in a message */ 
   wsprintf(szMessage, TEXT("NOTE: The region area is %ld pixels"), (int)zArea); 
   _tprintf(_T("%s"), szMessage); 
 
   return SUCCESS; 
}