LBitmap::GetAutoTrimRect

#include "ltwrappr.h"

virtual L_INT LBitmap::GetAutoTrimRect(uThreshold, pRect, uFlags = 0)

L_UINT uThreshold;	/* delta value for detecting blank space */
LPRECT pRect;	/* address of the variable to be updated */
L_UINT32 uFlags;	/* flags */

Gets the rectangle that would be used to trim the class object's bitmap if LBitmap::AutoTrim were used.

Parameter	Description
uThreshold	Delta value for detecting blank space. Starting at each edge of the bitmap and evaluating toward the center, any change in intensity that is less than or equal to uThreshold is considered blank space. Valid values are 0 to 255.
pRect	Address of the RECT variable to be updated.
uFlags	Reserved for future use. Must be 0.

Returns

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

Comments

Use this function in conjunction with LBitmapBase::Trim instead of LBitmap::AutoTrim when you want to modify the trim rectangle. For example, you could let the user preview the rectangle, or you could add a margin.

This function uses bitmap coordinates to specify the area to be trimmed. Therefore, you must account for the view perspective of the bitmap. For information about bitmap coordinates, refer to Accounting for View Perspective.

This function supports 12 and 16-bit grayscale and 48 and 64-bit color images. Support for 12 and 16-bit grayscale and 48 and 64-bit color images is available only in the Document/Medical toolkits.

This function does not support signed data images. It returns the error code ERROR_SIGNED_DATA_NOT_SUPPORTED if a signed data image is passed to this function.

This function does not support 32-bit grayscale images. It returns the error code ERROR_GRAY32_UNSUPPORTED if a 32-bit grayscale image is passed to this function.

Required DLLs and Libraries

LTDIS
LTFIL
LTIMGCOR

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

See Also

Functions:	LBitmap::AutoTrim, LBitmapBase::Trim, LBitmapBase::CopyRect, LBitmap::WindowLevel, Class Members
Topics:	Raster Image Functions: Doing Geometric Transformations

Example

L_INT LBitmap__GetAutoTrimRectExample()
{
   L_INT nRet;
   LBitmap LeadBitmap;
   RECT rcTrimRect;
   L_TCHAR szDummyBuffer[256];
   nRet =LeadBitmap.Load(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\image1.cmp"), 0,ORDER_BGR);
   if(nRet !=SUCCESS)
      return nRet;
   nRet =LeadBitmap.GetAutoTrimRect(100, &rcTrimRect);
   if(nRet !=SUCCESS)
      return nRet;
   wsprintf(szDummyBuffer, TEXT("Left: %d\t Top: %d\nRight: %d\tBottom: %d"), rcTrimRect.left, 
            rcTrimRect.top, rcTrimRect.right, rcTrimRect.bottom);
   MessageBox(0, szDummyBuffer, TEXT("GetAutoTrimRect"), MB_OK);
  
   return SUCCESS;
}