#include "ltimgkrn.h"

L_LTIMGKRN_API L_INT L_ImgKrnCropImage(bitmap, rect)

Crops the bitmap, resulting in a bitmap having the size of the specified rectangle.



Pointer to the bitmap handle referencing the bitmap to be cropped.

const L_RECT *rect

The rectangular area to which the bitmap will be cropped.


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


This function uses bitmap coordinates to specify the area to be cropped. Therefore, you must account for the view perspective of the bitmap.

Note: All functions with the L_ImgKrn prefix modify the underlying properties of the input BITMAPHANDLE, including but not limited to:

To avoid BITMAPHANDLE property fidelity loss, pass a copy of your BITMAPHANDLE to all L_ImgKrn* functions.

Required DLLs and Libraries


Win32, x64, Linux.

See Also




This example loads an image and crops it.

L_INT KrnCropImageExample(L_VOID) 
   L_INT ret; 
   BITMAPHANDLE bitmap;   /* Bitmap handle to hold the loaded image. */ 
   L_RECT cropBounds;     /* Area to keep. */ 
   /* Load the bitmap */ 
   ret = L_LoadBitmap(MAKE_IMAGE_PATH(TEXT("cannon.jpg")), &bitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL); 
   if (ret != SUCCESS) 
      return ret; 
   /* Crop half the image */ 
   cropBounds.left = 0; 
   cropBounds.top = 0; 
   cropBounds.right = bitmap.Width / 2; 
   cropBounds.bottom = bitmap.Height; 
   ret = L_ImgKrnCropImage(&bitmap, &cropBounds); 
   if (ret == SUCCESS) 
      ret = L_SaveBitmap(MAKE_IMAGE_PATH(TEXT("Result.BMP")), &bitmap, FILE_BMP, 24, 0, NULL); 
   return ret; 

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

LEADTOOLS Raster Imaging C API Help