In This Topic ▼

L_AddFrame

Summary

Adds a frame to the specified bitmap. The frame is specified by the pAddFrameInfo parameter.

Syntax

#include "l_bitmap.h"

L_LTIMGEFX_API L_INT L_AddFrame(pBitmap, pAddFrameInfo, uFlags)

Parameters

pBITMAPHANDLE pBitmap

Pointer to the bitmap handle referencing the destination bitmap. This is the bitmap that the function updates.

pADDFRAMEINFO pAddFrameInfo

Pointer to an ADDFRAMEINFO structure that contains information about the frame to add.

L_UINT32 uFlags

Reserved for future use. Must be 0.

Returns

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

Comments

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.

To update a status bar or detect a user interrupt during execution of this function, refer to L_SetStatusCallback.

This function does not support 12 and 16-bit grayscale and 48 and 64-bit color images. If the image is 12 and 16-bit grayscale and 48 and 64-bit color, the function will not return an error.

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.

Frame Add Function - Before

Frame Add Function - After

View additional platform support for this Frame Add function.

Required DLLs and Libraries

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

Platforms

Win32, x64.

Example

This example loads a bitmap and adds a frame to it.

L_INT AddFrameExample(L_VOID) 
{ 
   L_INT nRet; 
   BITMAPHANDLE pBitmap; 
   BITMAPHANDLE pBitmapFrame; 
   pADDFRAMEINFO pAddFrameInfo; 
 
   pAddFrameInfo = (pADDFRAMEINFO)GlobalAllocPtr(GHND, sizeof(ADDFRAMEINFO)); 
   if (!pAddFrameInfo) 
      return ERROR_INV_PARAMETER; 
 
   /* Load the bitmap, keeping the bits per pixel of the file */ 
   nRet = L_LoadBitmap(MAKE_IMAGE_PATH(TEXT("IMAGE2.CMP")), &pBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   nRet = L_LoadBitmap(MAKE_IMAGE_PATH(TEXT("testframe1.jpg")), &pBitmapFrame, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   pAddFrameInfo->uStructSize = sizeof(ADDFRAMEINFO); 
   pAddFrameInfo->pBitmapFrame = &pBitmapFrame; 
   pAddFrameInfo->bKeepFrameState = TRUE; 
   pAddFrameInfo->SmoothEdge = 40; 
 
   nRet = L_AddFrame(&pBitmap, pAddFrameInfo, 0); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   nRet = L_SaveBitmap(MAKE_IMAGE_PATH(TEXT("Result.BMP")), &pBitmap, FILE_BMP, 24, 0, NULL); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   GlobalFreePtr(pAddFrameInfo); 
 
   //free bitmap 
   if (pBitmap.Flags.Allocated) 
      L_FreeBitmap(&pBitmap); 
 
   if (pBitmapFrame.Flags.Allocated) 
      L_FreeBitmap(&pBitmapFrame); 
 
   return SUCCESS; 
}