Adds light to the bitmap according to a function-based distribution. This light will be generated by one of the following methods: linear, quadratic, sine, cosine, or using freehand points.


#include "ltwrappr.h"

virtual L_INT LBitmap::FunctionalLight(pLightParams, uFlags = 0)



Pointer to the LPLIGHTPARAMS structure that contains information about the required light.

L_UINT32 uFlags

Reserved for future use. Must be 0.


Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.


Controls the brightness of the bitmap according to the method selected for generating the light.

This function supports all bits/pixel supported by LEADTOOLS.

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.

Functional Light Function - Before

Functional Light Function - Before

Functional Light Function - After

Functional Light Function - After

View additional platform support for this Functional Light function.

Required DLLs and Libraries


Win32, x64.

See Also




L_INT LBitmap__FunctionalLightExample(LBitmap *pLeadBitmap)  
   /* This example generates a linear lighting effect with a center at (uXOrigin,uYOrigin). */ 
   LIGHTPARAMS  LightParams;  
   /* Initialize all needed members in the LIGHTPARAMS structure to achieve the linear lighting effect. */ 
   LightParams.uStructSize  = sizeof(LIGHTPARAMS);  
   LightParams. uRAmp  =  75;  
   LightParams. uFlags  =  FL_LINEAR_QUADRATIC | FL_LINEAR_OUTER;  
   LightParams. uXOrigin  =   (L_UINT)(pLeadBitmap->GetWidth ()/2);  
   LightParams. uYOrigin  =   (L_UINT)(pLeadBitmap->GetHeight()/2);  
   /* Apply the linear lighting effect */ 
   return pLeadBitmap->FunctionalLight (&LightParams);  
Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help