#include "ltwrappr.h"

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

L_UINT uAmplitude;

wave's magnitude

L_UINT uFrequency;

number of repeated waves

L_INT nPhase;

wave phase shift

L_UINT uAttenuation;

amplitude decay rate

POINT CenterPt;

effect center


color value

L_UINT uFlags;


Warps the image in concentric rings.

Parameter Description
uAmplitude Wave magnitude (amount of displacement).
uFrequency Number of repeated waves along the radial line.
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).
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.
CenterPt POINT structure that contains the center of the Ripple wave.
crFill 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.
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.



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.

Required DLLs and Libraries


For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.


Win32, x64.

Help Version 20.0.2019.12.4
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help