Available in LEADTOOLS Imaging Pro, Vector, Document, and Medical Imaging toolkits. |
#include "l_bitmap.h"
L_LTIMGSFX_API L_INT L_VignetteBitmap(pBitmap, pVignetteInfo, uFlags)
pBITMAPHANDLE pBitmap; |
/* pointer to the bitmap handle */ |
pVIGNETTEINFO pVignetteInfo; |
/* pointer to a structure */ |
L_UINT32 uFlags; |
/* flags */ |
Draws a specified shape and feathers it to the bitmap.
Parameter |
Description |
pBitmap |
Pointer to the bitmap handle that references the bitmap to which to apply the effect. |
pVignetteInfo |
Pointer to the VIGNETTEINFO structure that contains information about the vignette effect. |
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.
This function can be used to draw a circle, ellipse, rectangle or square to create a vignette shape and then a color is feathered to the bitmap, filling either the inside or the outside of the vignette shape.
This function can process the whole image or a region of the image. If a bitmap has a region, the effect is applied only to the region.
This function supports 12 and 16-bit grayscale and 48 and 64-bit color images. Support for 12 and 16-bit grayscale and 48 and 64-bit color images is available in the Document and Medical Imaging toolkits.
To update a status bar or detect a user interrupt during execution of this function, Refer to L_SetStatusCallback.
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
LTIMGSFX 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.
See Also
Functions: |
L_UnderlayBitmap, L_CombineBitmap, L_FeatherAlphaBlendBitmap, L_CreateFadedMask, L_TextureAlphaBlendBitmap |
Topics: |
|
|
|
|
|
|
Example
#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName #if defined (LEADTOOLS_V16_OR_LATER) L_INT VignetteBitmapExample(L_VOID) { L_INT nRet; BITMAPHANDLE LeadBitmap;/* Bitmap handle for the image */ VIGNETTEINFO VignetteInfo; /* Structure which store the required parameters*/ /* Load a bitmap at its own bits per pixel */ nRet = L_LoadBitmap(MAKE_IMAGE_PATH(TEXT("IMAGE1.CMP")), &LeadBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGRORGRAY, NULL, NULL); if(nRet !=SUCCESS) return nRet; /*Fill the structures with the required parameters, Vignette shape is ellipse, Feathering inside the vignette object, the ellipse is centered, fading color is blue*/ VignetteInfo.uStructSize = sizeof(VIGNETTEINFO); VignetteInfo.crVigColor = RGB(0,0,255); VignetteInfo.nFading = 50; VignetteInfo.uFlags = VIG_ELLIPSE | VIG_FILLIN; VignetteInfo.uFadingRate = 100; VignetteInfo.uHeight = LeadBitmap.Height / 2; VignetteInfo.uWidth = LeadBitmap.Width / 2; VignetteInfo.ptCenter.x = LeadBitmap.Width / 2; VignetteInfo.ptCenter.y = LeadBitmap.Height / 2; nRet = L_VignetteBitmap(&LeadBitmap, &VignetteInfo, 0); if(nRet !=SUCCESS) return nRet; nRet = L_SaveBitmap(MAKE_IMAGE_PATH(TEXT("Result.BMP")), &LeadBitmap, FILE_BMP, 24, 0, NULL); if(nRet !=SUCCESS) return nRet; //free bitmap if(LeadBitmap.Flags.Allocated) L_FreeBitmap(&LeadBitmap); return SUCCESS; } #else L_INT VignetteBitmapExample(L_VOID) { L_INT nRet; BITMAPHANDLE LeadBitmap;/* Bitmap handle for the image */ VIGNETTEINFO VignetteInfo; /* Structure which store the required parameters*/ /* Load a bitmap at its own bits per pixel */ nRet = L_LoadBitmap(MAKE_IMAGE_PATH(TEXT("IMAGE1.CMP")), &LeadBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGRORGRAY, NULL, NULL); if(nRet !=SUCCESS) return nRet; /*Fill the structures with the required parameters, Vignette shape is ellipse, Feathering inside the vignette object, the ellipse is centered, fading color is blue*/ VignetteInfo.uStructSize = sizeof(VIGNETTEINFO); VignetteInfo.crVigColor = RGB(0,0,255); VignetteInfo.nFading = 50; VignetteInfo.uFlags = VIG_ELLIPSE | VIG_FILLIN; VignetteInfo.uFadingRate = 100; VignetteInfo.uHeight = LeadBitmap.Height / 2; VignetteInfo.uWidth = LeadBitmap.Width / 2; VignetteInfo.ptCenter.x = LeadBitmap.Width / 2; VignetteInfo.ptCenter.y = LeadBitmap.Height / 2; nRet = L_VignetteBitmap(&LeadBitmap, &VignetteInfo); if(nRet !=SUCCESS) return nRet; nRet = L_SaveBitmap(MAKE_IMAGE_PATH(TEXT("Result.BMP")), &LeadBitmap, FILE_BMP, 24, 0, NULL); if(nRet !=SUCCESS) return nRet; //free bitmap if(LeadBitmap.Flags.Allocated) L_FreeBitmap(&LeadBitmap); return SUCCESS; } #endif // LEADTOOLS_V16_OR_LATER