#include "l_bitmap.h"

L_LTIMGSFX_API L_INT L_FreeHandWaveBitmap (pBitmap, pAmplitudes, uAmplitudesCount, uScale, uWaveLen, nAngle, crFill, uFlags)

Distorts the bitmap by the wave specified in pAmplitudes and the rotation angle specified in nAngle.



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

L_INT *pAmplitudes

Array of integers that represent wave values. The real value of the array elements is divided by 1000, and the valid value of each element in pAmplitudes array is between -1000 and 1000. These values are generally obtained from the L_GetCurvePoints function. They may also be obtained through the FreeHandWave Dialog.

L_UINT uAmplitudesCount

Number of entries in the pAmplitudes array.

L_UINT uScale

Factor used to increase or decrease the various amplitude values in the pAmplitudes array. Each value in the pAmplitudes array is multiplied by this factor. The real factor value is the uScale value divided by 100.

L_UINT uWaveLen

Value that represents the wave length, if DIS_PER is set in the uFlags parameter. Possible values range from 1 to 100 and give the wavelength as a percentage of the bitmap dimensions. If DIS_FRQ is set in uFlags, this value is the number of repeated waves.

L_INT nAngle

Wave rotation angle in hundredths of a degree (+/-). The valid range is from -36000 to 36000. The value in degrees is nAngle divided by 100.


The COLORREF value that specifies the fill color for any exposed areas. You can specify a COLORREF value, such as the return value of the Windows RGB macro, or you can use the PALETTEINDEX macro to specify a palette color.

L_UINT uFlags

Flags that indicate how to handle exposed areas and the type of information contained in uWaveLen. You can use a bitwise OR (|) to specify one flag from each group.

The following are the flags that indicate how to handle exposed areas:

Value Meaning
FILL_CLR [0x0000] Fill any exposed areas with crFill.
FILL_RPT [0x0001] Stretch the image edges to fill the exposed area.
FILL_NOCHG [0x0002] Leave the exposed area as is, without changing it.

The following are the flags that indicate the type of information in the uWaveLen parameter:

Value Meaning
DIS_PER [0x0000] The value in uWaveLen is a wavelength given as a percent of the bitmap dimensions. If this value is set, the valid range of uWaveLen is from 1 to 100.
DIS_FRQ [0x0010] The value in uWaveLen is the frequency, or the number of times the wave repeats.


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.

The function applies the wave in the pAmplitudes array. You can repeat and rotate the wave in any direction. The pAmplitude data can be obtained from the L_GetCurvePoints function, or from the FreeHandWave Dialog.

If the bitmap has a region, the effect will be applied on the region only.

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.

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




This example will apply triangular wave on the loaded image.

L_INT FreeHandWaveBitmapExample(L_VOID) 
   L_INT nRet; 
   BITMAPHANDLE LeadBitmap;   /* Bitmap handle for the image */ 
   POINT apUserPoint [4]; 
   L_INT pAmplitudes[13]; 
   /* 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; 
   apUserPoint [0].x = 0; 
   apUserPoint [0].y = 0; 
   apUserPoint [1].x = 3; 
   apUserPoint [1].y = 10; 
   apUserPoint [2].x = 9; 
   apUserPoint [2].y = -10; 
   apUserPoint [3].x = 12; 
   apUserPoint [3].y = 0;  
   nRet = L_GetCurvePoints(pAmplitudes, apUserPoint, 4, NULL, GUB_LINEAR); 
   if(nRet !=SUCCESS) 
      return nRet; 
   nRet = L_FreeHandWaveBitmap (&LeadBitmap, pAmplitudes, 13, 100, 10, 0, 0, FILL_RPT | DIS_FRQ); 
   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