Crops the class object's bitmap, resulting in a new bitmap that is the size of the specified rectangle. If a region is defined for the bitmap, the region is also cropped if necessary.


#include "ltwrappr.h"

virtual L_INT LBitmapBase::Trim(nCol, nRow, uWidth, uHeight)

virtual L_INT LBitmapBase::Trim(prcTrim)


L_INT nCol

The X coordinate of the pixel within the bitmap that is the origin of the rectangle to keep.

L_INT nRow

The Y coordinate of the pixel within the bitmap that is the origin of the rectangle to keep.

L_UINT uWidth

Width of the rectangle to keep (in pixels).

L_UINT uHeight

Height of the rectangle to keep (in pixels).

LPRECT prcTrim

Pointer to a RECT structure that contains information about the rectangle to keep.


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


Use this function instead of LBitmapBase::CopyRect when the original bitmap is not needed after cropping.

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

Required DLLs and Libraries


Win32, x64.

See Also




This is an example for LBitmapBase::Trim(nCol,
nRow, uWidth, uHeight):

L_INT LBitmapBase__TrimExample() 
   L_INT nRet; 
   LBitmapBase MyBitmap; 
   nRet =MyBitmap.Load(24); 
   if(nRet !=SUCCESS) 
      return nRet; 
   nRet =MyBitmap.Trim(10,15,100,200); 
   if(nRet !=SUCCESS) 
      return nRet; 
   return SUCCESS; 

Help Version 22.0.2023.2.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help