LBitmap::Vignette

#include "ltwrappr.h"

L_INT LBitmap::Vignette(pVignetteInfo)

/* pointer to a structure */

Draws a specified shape and feathers it to the bitmap. This function is available in the Raster Pro and above toolkits.

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

Returns

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.

As an example, if you use the following figure:

$image\Replacecolor_Befor_1.gif$

and you call LBitmap::Vignette using the following values:

Parameter	Value
ptCenter	(144, 181)
nFading	50
uFadingRate	33
uWidth	145
uHeight	181
crVigColor	White
uFlags	VIG_ELLIPSE \| VIG_FILLIN

The following figure results:

$image\TulipsVignette.gif$

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.

Required DLLs and Libraries

LTIMG

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

See Also

Functions:	LBitmapBase::Underlay, LBitmapBase::Combine, LBitmapBase::FeatherAlphaBlend, LBitmapBase::CreateFadedMask, LBitmap::TextureAlphaBlend
Topics:	Raster Image Functions: Combining Images
	Applying Artistic Effects
	Raster Image Functions: Artistic Effects
	Raster Image Functions: Functions Where the Region Preempts the Bitmap

Example

   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 = VIGNETTE_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;
   LeadBitmap.Load(TEXT("C:\\IMAGE4.CMP"), 0,ORDER_BGR);
   L_INT nRet =   LeadBitmap.Vignette(&VignetteInfo);