#include "l_bitmap.h"

L_LTIMGSFX_API L_INT L_LensFlareBitmap(pBitmap, ptCenter, uBright, uFlags, crColor)

Simulates the secondary reflections caused when bright lights are facing the camera lens. The lens flare is refracted into a series of lightened circles that surround the flare.



Pointer to the bitmap handle that references the bitmap on which to apply the effect.

POINT ptCenter

POINT structure that contains the point around which the effect is centered.

L_UINT uBright

The brightness of the flare. This value is divided internally by 100. This parameter affects the brightness of both the flare, and any lightened circles surrounding the flare.

L_UINT uFlags

Flag that indicates the lens type. Possible values are:

Value Meaning
LNS_TYPE_1 [0x0000] Standard lens.
LNS_TYPE_2 [0x0001] Moderate wide-angle lens.
LNS_TYPE_3 [0x0002] Moderate telephoto lens.


The COLORREF value that represents the color of the main flare.


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


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.

Secondary reflections are caused when bright lights are facing the camera lens. These reflections can show up as spots or banding. The function adds this effect to the bitmap by controlling their number, position, brightness and size of the spots or banding. Each lens type has its own spot distribution and ray thickness.

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:

ptCenter = (150, 162);
uBright = 100;
uFlags = LNS_TYPE_1;
crColor = RGB(255,128,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


Win32, x64.

See Also




L_INT LensFlareBitmapExample(L_VOID) 
   L_INT nRet; 
   BITMAPHANDLE LeadBitmap;   /* Bitmap handle for the image */ 
   POINT ptCenter;       /*Effect center point*/  
   /* Load a bitmap at its own bits per pixel  */ 
   nRet = L_LoadBitmap(MAKE_IMAGE_PATH(TEXT("sample5.cmp")), &LeadBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL); 
   if(nRet !=SUCCESS) 
      return nRet; 
   /*Set the center point in the middle of the first square */ 
   ptCenter.x = LeadBitmap.Width/4; 
   ptCenter.y = LeadBitmap.Height/4; 
   /* Apply the lens flare effect to the bitmap*/ 
   nRet = L_LensFlareBitmap(&LeadBitmap, ptCenter, 100, LNS_TYPE_1, RGB(100, 150, 10)); 
   if(nRet !=SUCCESS) 
      return nRet; 
   nRet = L_SaveBitmap(MAKE_IMAGE_PATH(TEXT("Result.BMP")), &LeadBitmap, FILE_BMP, 24, 0, NULL); 
   if(nRet !=SUCCESS) 
      return nRet; 
   //free bitmap  
   return SUCCESS; 
Help Version 21.0.2021.4.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help