#include "ltwrappr.h"

virtual L_INT LBitmap::AverageFilter(uDim=3, uFlags = 0)

Changes the color of each pixel in the class object's bitmap to the average color of pixels in its neighborhood. This results in a blur effect.



Size of the averaging neighborhood. It is the length, in pixels, of one side of a square.

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.


You control the amount of blur by specifying the size of the neighborhood that is used for averaging.

To update a status bar or detect a user interrupt during execution of this function, refer to LBase::EnableStatusCallback.

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.

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 LBitmap__AverageFilterExample() 
   L_INT nRet; 
   LBitmap m_Bitmap; 
   //Load the Image as its resolution 
   nRet =m_Bitmap.Load(MAKE_IMAGE_PATH(TEXT("sample2.cmp")), 0,ORDER_BGR); 
   if(nRet !=SUCCESS) 
      return nRet; 
   //Average Bitmap by 10 
   nRet =m_Bitmap.AverageFilter(10); 
   if(nRet !=SUCCESS) 
      return nRet; 
   return SUCCESS; 
Help Version 22.0.2021.11.10
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help