#include "ltimgkrn.h"

L_LTIMGKRN_API L_INT L_ImgKrnCropImage(bitmap, rect)

BITMAPHANDLE *bitmap; pointer to the bitmap handle
const L_RECT *rect; rectangular area

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

Parameter Description
bitmap Pointer to the bitmap handle referencing the bitmap to be cropped.
rect The rectangular area to which the bitmap will be cropped.


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.

Required DLLs and Libraries

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


Win32, x64, Linux.

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.

See Also

Functions: L_ImgKrnCopyImage, L_ImgKrnCreateImage, L_ImgKrnDetectDocument, L_ImgKrnDetectGlare, L_ImgKrnFromYUV, L_ImgKrnInvertImage, L_ImgKrnManualPerspectiveCorrection, L_ImgKrnRotateFlipImage, L_ImgKrnSignalToNoiseRatio

Raster Image Functions: Doing Geometric Transformations


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 20.0.2018.7.30
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help