L_LightBitmap

#include "l_bitmap.h"

L_LTIMGSFX_API L_INT L_LightBitmap(pBitmap, pLightInfo, uLightNo, uBright, uAmbient, crAmbientClr, uFlags)

pBITMAPHANDLE pBitmap;	/* pointer to the bitmap handle */
pLIGHTINFO pLightInfo;	/* array of light sources information */
L_UINT uLightNo;	/* number of light sources */
L_UINT uBright;	/* image intensity */
L_UINT uAmbient;	/* ambient intensity */
COLORREF crAmbientClr;	/* ambient color */
L_UINT32 uFlags;	/* flags*/

Adds many spots of directed light sources to the bitmap.

Parameter	Description
pBitmap	Pointer to the bitmap handle that references the bitmap on which to apply the effect.
pLightInfo	Pointer to an array of LIGHTINFO structures that contains information on each light source.
uLightNo	The number of light sources.
uBright	Value that represents the brightness of the ambient light of the entire image. This can be any number that is 0 or greater. If it is 0 the image will be black. This value is divided internally by 100.
uAmbient	Factor used when mixing the ambient color with the image.
crAmbientClr	The COLORREF value that specifies the ambient color of the light sources in the pLightInfo array.
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.

The pLIGHTINFO->uStructSize must be set to sizeof(LIGHTINFO) before calling this function. For an array of structures, only the first structure in the array needs to have uStructSize member set.

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.

For an example, click here

To obtain this effect, the following settings were used with the function:

pLightInfo:
{
   ptCenter = (pBitmap->Width/2, pBitmap->Height/2);
   uWidth = pBitmap->Width;
   uHeight = pBitmap->Width * 4/3;
   nAngle = 13500;
   uBright = 100;
   uEdge = 75;
   crFill = RGB(0,0,255);
   uOpacity = 100;
   uFlag = LGT_SPOTLIGHT;
}

uLightNo = 1;
uBright = 100;
uAmbient = 100;
crAmbientClr = RGB(255,255,0);

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

Windows 2000 / XP/Vista.

See Also

Functions:	L_AddBitmapNoise, L_EmbossBitmap, L_MosaicBitmap, L_MotionBlurBitmap, L_OilifyBitmap, L_PosterizeBitmap, L_RemoveRedeyeBitmap, L_SolarizeBitmap, L_UnderlayBitmap, L_BumpMapBitmap, L_CubismBitmap, L_DrawStarBitmap, L_FreePlaneBendBitmap, L_FreeRadBendBitmap, L_DryBitmap, L_GlowFilterBitmap, L_GlassEffectBitmap, L_LensFlareBitmap, L_OceanBitmap, L_PlaneBendBitmap, L_PlaneBitmap, L_SampleTargetBitmap, L_TunnelBitmap, L_BendingBitmap, L_CylindricalBitmap, L_FreeHandShearBitmap, L_FreeHandWaveBitmap, L_ImpressionistBitmap, L_PixelateBitmap, L_PolarBitmap, L_PunchBitmap, L_RadialBlurBitmap, L_RadWaveBitmap, L_RippleBitmap, L_SpherizeBitmap, L_SwirlBitmap, L_WaveBitmap, L_WindBitmap, L_ZoomBlurBitmap, L_ZoomWaveBitmap, L_BricksTextureBitmap, L_CanvasBitmap, L_CloudsBitmap, L_ColoredBallsBitmap, L_DiffuseGlowBitmap, L_DisplaceMapBitmap, L_FragmentBitmap, L_HalfTonePatternBitmap, L_MaskConvolutionBitmap, L_MosaicTilesBitmap, L_OffsetBitmap, L_PerspectiveBitmap, L_PlasmaFilterBitmap, L_PointillistBitmap, L_RomanMosaicBitmap, L_VignetteBitmap, L_ZigZagBitmap, L_AdjustBitmapTint, L_ColorHalfToneBitmap
Topics:	Raster Image Functions: Artistic Effects
	Raster Image Functions: Modifying Intensity Values
	Applying Artistic Effects
	Using Color Values in LEADTOOLS
	Raster Image Functions: Correcting Colors

Example

#if defined (LEADTOOLS_V16_OR_LATER)
 L_INT LightBitmapExample(L_VOID)
{
   L_INT nRet;
   BITMAPHANDLE LeadBitmap;   /* Bitmap handle for the image */
   LIGHTINFO LightInfo;

   /* Load a bitmap at its own bits per pixel  */
   nRet = L_LoadBitmap(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\IMAGE3.CMP"), &LeadBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL);
   if(nRet !=SUCCESS)
      return nRet;

   LightInfo.uStructSize = sizeof(LIGHTINFO);
   LightInfo.crFill = RGB(255, 255, 255);
   LightInfo.nAngle = 0;
   LightInfo.ptCenter.x  = LeadBitmap.Width/2;
   LightInfo.ptCenter.y  = LeadBitmap.Height/2;
   LightInfo.uEdge = 0;
   LightInfo.uBright  = 100;
   LightInfo.uFlag = LGT_SPOTLIGHT;
   LightInfo.uHeight = min(LeadBitmap.Height, LeadBitmap.Width)/2;
   LightInfo.uWidth  = max(LeadBitmap.Height, LeadBitmap.Width)/2;
   LightInfo.uOpacity  = 100;

   nRet = L_LightBitmap(&LeadBitmap, &LightInfo, 1, 100, 100, RGB(255,255,255), 0);
   if(nRet !=SUCCESS)
      return nRet;
   nRet = L_SaveBitmap(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\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 LightBitmapExample(L_VOID)
{
   L_INT nRet;
   BITMAPHANDLE LeadBitmap;   /* Bitmap handle for the image */
   LIGHTINFO LightInfo;

   /* Load a bitmap at its own bits per pixel  */
   nRet = L_LoadBitmap(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\IMAGE3.CMP"), &LeadBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL);
   if(nRet !=SUCCESS)
      return nRet;

   LightInfo.uStructSize = sizeof(LIGHTINFO);
   LightInfo.crFill = RGB(255, 255, 255);
   LightInfo.nAngle = 0;
   LightInfo.ptCenter.x  = LeadBitmap.Width/2;
   LightInfo.ptCenter.y  = LeadBitmap.Height/2;
   LightInfo.uEdge = 0;
   LightInfo.uBright  = 100;
   LightInfo.uFlag = LGT_SPOTLIGHT;
   LightInfo.uHeight = min(LeadBitmap.Height, LeadBitmap.Width)/2;
   LightInfo.uWidth  = max(LeadBitmap.Height, LeadBitmap.Width)/2;
   LightInfo.uOpacity  = 100;

   nRet = L_LightBitmap(&LeadBitmap, &LightInfo, 1, 100, 100, RGB(255,255,255));
   if(nRet !=SUCCESS)
      return nRet;
   nRet = L_SaveBitmap(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\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