Warps the image in concentric rings.


#include "ltwrappr.h"

virtual L_INT LBitmap::Ripple (uAmplitude, uFrequency, nPhase, uAttenuation, CenterPt, crFill, uFlags)


L_UINT uAmplitude

Wave magnitude (amount of displacement).

L_UINT uFrequency

Number of repeated waves along the radial line.

L_INT nPhase

Wave phase shift, in hundredths of degrees. The valid range is from -36000 to 36000 (The value in degrees is nPhase divided by 100).

L_UINT uAttenuation

Attenuation value. The attenuation value indicates how rapidly the wave amplitude decays as the wave travels along the radial line. The values range from 0 - 1000.

POINT CenterPt

POINT structure that contains the center of the Ripple wave.


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

Flag that indicates how to handle exposed areas. Possible values are:

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.


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


This function will warp the image as a series of rings radiating out from the CenterPt. The center point must be defined inside the bitmap or inside the region, if the bitmap has a region.

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 only in the Document/Medical toolkits.

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.

Ripple Function - Before

Ripple Function - Before

Ripple Function - After

Ripple Function - After

View additional platform support for this Ripple function.

Required DLLs and Libraries


Win32, x64.

See Also




L_INT LBitmap__RippleExample(LAnimationWindow * LAniWnd)  
   POINT   CenterPt;  
   CenterPt.x  =  (LAniWnd->GetHandle ())->Width/2;  
   CenterPt.y  =  (LAniWnd->GetHandle ())->Height/2;  
   return LAniWnd->Ripple(20, 10, 0, 0, CenterPt, 0, FILL_RPT);  
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