LEADTOOLS Raster Imaging C DLL Help > Function References > L_AddBorder |
#include "l_bitmap.h"
L_LTIMGEFX_API L_INT L_AddBorder(pBitmap, pAddBorderInfo, uFlags)
pBITMAPHANDLE pBitmap; |
/* pointer to the bitmap handle */ |
pADDBORDERINFO pAddBorderInfo; |
/* pointer to a structure */ |
L_UINT32 uFlags; |
/* flags*/ |
Adds a border to the specified bitmap. The border is specified by the pAddBorderInfo parameter.
Parameter |
Description |
pBitmap |
Pointer to the bitmap handle referencing the destination bitmap. This is the bitmap that the function updates. |
pAddBorderInfo |
Pointer to an ADDBORDERINFO structure that contains information about the border to add. |
uFlags |
Reserved for future use. Must be 0. |
Returns
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.
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.
See Also
Functions: |
L_AddFrame, L_BricksTextureBitmap, L_CanvasBitmap, L_DisplaceMapBitmap, L_FragmentBitmap, L_VignetteBitmap |
Topics: |
|
|
|
|
Example
This example loads a bitmap and adds a simple border to it.
#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName #if defined (LEADTOOLS_V16_OR_LATER) L_INT AddBorderExample(L_VOID) { L_INT nRet; BITMAPHANDLE pBitmap; pADDBORDERINFO pAddBorderInfo; pAddBorderInfo = (pADDBORDERINFO) GlobalAllocPtr(GHND, sizeof(ADDBORDERINFO)); if(!pAddBorderInfo) return ERROR_NO_MEMORY; /* Load the bitmap, keeping the bits per pixel of the file */ nRet = L_LoadBitmap (MAKE_IMAGE_PATH(TEXT("IMAGE1.CMP")), &pBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL); if(nRet !=SUCCESS) return nRet; pAddBorderInfo->uStructSize = sizeof(ADDBORDERINFO); pAddBorderInfo->nTopThickness = 20; pAddBorderInfo->nBottomThickness= 20; pAddBorderInfo->nLeftThickness = 20; pAddBorderInfo->nRightThickness = 20; pAddBorderInfo->crGradientStart = RGB(200, 150,150); pAddBorderInfo->nLocation = BORDER_OUTSIDE; pAddBorderInfo->nStyle = BORDER_STYLE_OPAQUE; nRet = L_AddBorder(&pBitmap, pAddBorderInfo, 0); if(nRet !=SUCCESS) return nRet; GlobalFreePtr(pAddBorderInfo); nRet = L_SaveBitmap(MAKE_IMAGE_PATH(TEXT("esult.BMP")), &pBitmap, FILE_BMP, 24, 0, NULL); if(nRet !=SUCCESS) return nRet; //free bitmap if(pBitmap.Flags.Allocated) L_FreeBitmap(&pBitmap); return SUCCESS; } #else L_INT AddBorderExample(L_VOID) { L_INT nRet; BITMAPHANDLE pBitmap; pADDBORDERINFO pAddBorderInfo; pAddBorderInfo = (pADDBORDERINFO) GlobalAllocPtr(GHND, sizeof(ADDBORDERINFO)); if(!pAddBorderInfo) return ERROR_NO_MEMORY; /* Load the bitmap, keeping the bits per pixel of the file */ nRet = L_LoadBitmap (MAKE_IMAGE_PATH(TEXT("IMAGE1.CMP")), &pBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL); if(nRet !=SUCCESS) return nRet; pAddBorderInfo->uStructSize = sizeof(ADDBORDERINFO); pAddBorderInfo->nTopThickness = 20; pAddBorderInfo->nBottomThickness= 20; pAddBorderInfo->nLeftThickness = 20; pAddBorderInfo->nRightThickness = 20; pAddBorderInfo->crGradientStart = RGB(200, 150,150); pAddBorderInfo->nLocation = BORDER_OUTSIDE; pAddBorderInfo->nStyle = BORDER_STYLE_OPAQUE; nRet = L_AddBorder(&pBitmap, pAddBorderInfo); if(nRet !=SUCCESS) return nRet; GlobalFreePtr(pAddBorderInfo); nRet = L_SaveBitmap(MAKE_IMAGE_PATH(TEXT("result.BMP")), &pBitmap, FILE_BMP, 24, 0, NULL); if(nRet !=SUCCESS) return nRet; //free bitmap if(pBitmap.Flags.Allocated) L_FreeBitmap(&pBitmap); return SUCCESS; } #endif // LEADTOOLS_V16_OR_LATER