L_BitmapHasRgn

#include "l_bitmap.h"

L_LTDIS_API L_BOOL L_BitmapHasRgn(pBitmap)

pBITMAPHANDLE pBitmap;

/* pointer to the bitmap handle */

Determines whether the bitmap has a region.

Parameter

Description

pBitmap

Pointer to the bitmap handle referencing the bitmap to test.

Returns

TRUE

The specified bitmap has a region.

FALSE

The specified bitmap does not have a region.

Comments

When a bitmap has a region, the LEADTOOLS functions that modify the pixel values (for example L_PosterizeBitmap) act on the region, rather than the whole bitmap. In addition, the LEADTOOLS functions that flip, reverse, rotate, shear, or resize a bitmap also transform the region to match the bitmap. For example, if you were to shear the bitmap that had a rectangular region, the region would become a parallelogram.

To remove a bitmap region, use the L_FreeBitmapRgn function.

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

Windows 2000 / XP/Vista.

See Also

Functions:

L_FrameBitmapRgn, L_FreeBitmapRgn,

 

L_GetBitmapRgnArea, L_IsPtInBitmapRgn

Topics:

Raster Image Functions: Creating and Using a Region

 

Raster Image Functions: Region Processing

 

Defining and Using a Bitmap Region

Example

For an example, refer to L_FrameBitmapRgn.