#include "ltwrappr.h"

virtual L_INT LBitmap::Light (pLightInfo, uLightNo, uBright, uAmbient, crAmbientClr, uFlags = 0)

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;


Adds many spots of directed light sources to the bitmap.




Pointer to an array of LIGHTINFO structures that contains information on each light source.


The number of light sources.


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.


Factor used when mixing the ambient color with the image.


The COLORREF value that specifies the ambient color of the light sources in the pLightInfo array.


Reserved for future use. Must be 0.



The function was successful.

< 1

An error occurred. Refer to Return Codes.


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

For an example, click here

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

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


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


LBitmap::AdjustTint. LBitmap::ColorHalfTone, LBitmap::BricksTexture, LBitmap::Canvas, LBitmap::Clouds, LBitmap::ColoredBalls, LBitmap::DiffuseGlow, LBitmap::DisplaceMap, LBitmap::Fragment, LBitmap::HalfTonePattern, LBitmap::MaskConvolution, LBitmap::MosaicTiles, LBitmap::Offset, LBitmap::Perspective, LBitmap::PlasmaFilter, LBitmap::Pointillist, LBitmap::RomanMosaic, LBitmap::Vignette, LBitmap::ZigZag, LBitmap::AddNoise, LBitmap::Emboss, LBitmap::Mosaic, LBitmap::MotionBlur, LBitmap::Oilify, LBitmap::Posterize, LBitmap::RemoveRedeye, LBitmap::Solarize, LBitmapBase::Underlay, LBitmap::BumpMap, LBitmap::Cubism, LBitmap::DrawStar, LBitmap::Dry, LBitmap::FreePlaneBend, LBitmap::FreeRadBend, LBitmap::GlassEffect, LBitmap::GlowFilter, LBitmap::LensFlare, LBitmap::Light, LBitmap::Ocean, LBitmap::PlaneBend, LBitmap::Plane, LBitmap::SampleTarget, LBitmap::Tunnel, LBitmap::Bending, LBitmap::Cylindrical, LBitmap::FreeHandShear, LBitmap::FreeHandWave, LBitmap::Impressionist, LBitmap::Pixelate, LBitmap::Polar, LBitmap::Punch, LBitmap::RadialBlur, LBitmap::RadWave, LBitmap::Ripple, LBitmap::Spherize, LBitmap::Swirl, LBitmap::Wave, LBitmap::Wind, LBitmap::ZoomBlur, LBitmap::ZoomWave


Raster Image Functions: Modifying Intensity Values


Raster Image Functions: Artistic Effects


Applying Artistic Effects


Using Color Values in LEADTOOLS


Raster Image Functions: Correcting Colors


L_INT LBitmap__LightExample(LAnimationWindow *BitmapWindow) 
   LIGHTINFO LightInfo; 
   LightInfo.uStructSize = sizeof(LIGHTINFO); 
   LightInfo.crFill = RGB(255, 255, 255); 
   LightInfo.nAngle = 0; 
   LightInfo.ptCenter.x  = BitmapWindow->GetWidth()/2; 
   LightInfo.ptCenter.y  = BitmapWindow->GetHeight()/2; 
   LightInfo.uEdge = 0; 
   LightInfo.uBright = 100; 
   LightInfo.uFlag = LGT_SPOTLIGHT; 
   LightInfo.uHeight = min(BitmapWindow->GetHeight(), BitmapWindow->GetWidth())/2; 
   LightInfo.uWidth  = max(BitmapWindow->GetHeight(), BitmapWindow->GetWidth())/2; 
   LightInfo.uOpacity  = 100; 
   return BitmapWindow->Light(&LightInfo, 1, 100, 100, RGB(255,255,255)); 

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C++ Class Library Help