Applies various 3d effects to a bitmap.


#include "ltwrappr.h"

L_INT LBitmap::MaskConvolution(nAngle, uDepth, uHeight, uFlags)


L_INT nAngle

Angle of apparent light source, in hundredths of degrees. Possible values range from -36000 to 36000.

L_UINT uDepth

The depth of the 3D effect. (This value is divided internally by 100). This value is used as a multiplier for the individual mask values.

L_UINT uHeight

Non-zero value greater than 2, that represents the height of the mask matrix. This value determines the height of the 3D effect. The larger the value, the more complex and time-consuming the operations will be.

L_UINT uFlags

Flag that indicates which mask to use in the convolution process. Possible values are:

Value Meaning
MSKC_EMBOSS [0x0000] Apply the Emboss Mask on the Bitmap.
MSKC_EDGE [0x0001] Apply the Edge Detection Mask on the Bitmap.
MSKC_ESPLOTCH [0x0002] Apply the Emboss-Splotch Mask on the Bitmap.
MSKC_SPLOTCH [0x0003] Apply the Splotch Mask on the Bitmap.


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


For MSKC_EDGE, the results are the same for opposite angles. For example, angles 0 and 180 have the same result when used with the edge detection mask.

When an image undergoes image convolution each pixel of the image is multiplied by a mask to create a new pixel value. The mask is an array of values that describes the weight that should be given to each of the pixels surrounding a specific pixel. The new pixel value is the result of the mask sum being divided by the mask weight. Using different masks result in different alterations of the image. The masks used in this function result in different types of edge detection.

For an example, click here

To obtain these bitmaps, the following settings were used:

Parameter Emboss Edge Esplotch Splotch
nAngle 0 0 180 0
uDepth 3 3 3 3
uHeight 250 250 100 100

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.

Mask Convolution Function - Before

Mask Convolution Function - Before

Mask Convolution Function - After

Mask Convolution Function - After

View additional platform support for this Mask Convolution function.

Required DLLs and Libraries


Win32, x64.

See Also




L_INT LBitmap__MaskConvolutionExample() 
   L_INT nRet; 
   LBitmap LeadBitmap; 
   nRet =LeadBitmap.Load(MAKE_IMAGE_PATH(TEXT("ImageProcessingDemo\\NaturalFruits.jpg")), 0,ORDER_BGR); 
   if(nRet !=SUCCESS) 
      return nRet; 
   nRet =LeadBitmap.MaskConvolution(500, 45, 3, MSKC_EMBOSS); 
   if(nRet !=SUCCESS) 
      return nRet; 
   return SUCCESS; 
Help Version 22.0.2023.2.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help