LBitmap::Vignette

#include "ltwrappr.h"

L_INT LBitmap::Vignette(pVignetteInfo, uFlags = 0)

Draws a specified shape and feathers it to the bitmap.

Parameters

pVIGNETTEINFO pVignetteInfo

Pointer to the VIGNETTEINFO structure that contains information about the vignette effect.

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 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.

For an example, click here

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.

Support for 12 and 16-bit grayscale and 48 and 64-bit color images is available only in the Document/Medical toolkits.

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

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 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

Platforms

Win32, x64.

See Also

Functions

Topics

Example

L_INT LBitmap__VignetteExample(LBitmapWindow m_LBitmapWnd) 
{ 
   L_INT nRet; 
   VIGNETTEINFO VignetteInfo;   /* Structure which stores the required parameters*/ 
   /*Fill the structures with the required parameters: Use an elliptical Vignette shape, perform feathering */ 
   /* inside the vignette object, center the ellipse, use a fading color of 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 = m_LBitmapWnd.GetHeight()/ 2; 
   VignetteInfo.uWidth = m_LBitmapWnd.GetWidth()/ 2; 
   VignetteInfo.ptCenter.x = m_LBitmapWnd.GetWidth()/ 2; 
   VignetteInfo.ptCenter.y = m_LBitmapWnd.GetHeight()/ 2;   
   LBitmap LeadBitmap; 
 
   nRet =LeadBitmap.Load(MAKE_IMAGE_PATH(TEXT("IMAGE1.CMP")), 0,ORDER_BGR); 
   if(nRet !=SUCCESS) 
      return nRet; 
   nRet =LeadBitmap.Vignette(&VignetteInfo); 
   if(nRet !=SUCCESS) 
      return nRet; 
   return SUCCESS; 
} 
Help Version 21.0.2021.7.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help