L_CopyBitmap

Summary

Copies an entire image of a source bitmap and places it into a destination bitmap. This also copies all fields in the bitmap handle.

Syntax

#include "l_bitmap.h"

L_LTKRN_API L_INT L_CopyBitmap(pBitmapDst, pBitmapSrc, uStructSize)

Parameters

pBITMAPHANDLE pBitmapDst

Points to the destination bitmap handle to hold the copied image.

pBITMAPHANDLE pBitmapSrc

Points to the source bitmap handle. You must have a valid image loaded into the bitmap for this function to work.

L_UINT uStructSize

Size in bytes, of the structure pointed to by pBitmapDst, for versioning. Use sizeof(BITMAPHANDLE).

Returns

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

Comments

The destination bitmap must not be allocated before this function is called. If the bitmap is already allocated, you must free it.

If a region is defined for the bitmap, the region is also copied.

Required DLLs and Libraries

Platforms

Win32, x64, Linux.

See Also

Functions

Topics

Example

For complete sample code, refer to the CHILD.C module of the DEMO
example.
This example loads TmpBitmap and copies it to LeadBitmap.

L_INT CopyBitmapExample(pBITMAPHANDLE pBitmap) 
{ 
   L_INT nRet; 
   BITMAPHANDLE TmpBitmap;    /* Bitmap handle for the initial image */ 
 
   /* Load a bitmap at its own bits per pixel */ 
   nRet = L_LoadBitmap (MAKE_IMAGE_PATH(TEXT("ImageProcessingDemo\\Image3.cmp")), &TmpBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL); 
   if(nRet != SUCCESS) 
      return nRet; 
   /* Copy the temporary bitmap to the new bitmap */ 
   if(pBitmap->Flags.Allocated) 
      L_FreeBitmap(pBitmap); 
   nRet = L_CopyBitmap(pBitmap, &TmpBitmap, sizeof(BITMAPHANDLE)); 
   if(nRet != SUCCESS) 
      return nRet; 
   /* Clean up */ 
   if(TmpBitmap.Flags.Allocated)   
      L_FreeBitmap(&TmpBitmap); 
   return SUCCESS; 
} 

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

LEADTOOLS Raster Imaging C API Help

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