L_RippleBitmap (original) (raw)
Summary
Warps the image in concentric rings.
Syntax
#include "l_bitmap.h"
L_LTIMGSFX_API L_INT L_RippleBitmap (pBitmap, uAmplitude, uFrequency, nPhase, uAttenuation, CenterPt, crFill, uFlags)
Parameters
pBITMAPHANDLE pBitmap
Pointer to the bitmap handle that references the bitmap on which to apply the effect.
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.
COLORREF 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.
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. |
Returns
Value | Meaning |
---|---|
SUCCESS | The function was successful. |
< 1 | An error occurred. Refer to Return Codes. |
Comments
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 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 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.
Ripple Function - Before
Ripple Function - After
View additional platform support for this Ripple function.
Required DLLs and Libraries
- LTIMGSFX
- For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.
Platforms
Win32, x64.
See Also
Functions
- L_AddBitmapNoise
- L_EmbossBitmap
- L_MosaicBitmap
- L_MotionBlurBitmap
- L_OilifyBitmap
- L_PosterizeBitmap
- L_RemoveRedeyeBitmap
- L_SolarizeBitmap
- L_UnderlayBitmap
- L_BendingBitmap
- L_CylindricalBitmap
- L_FreeHandShearBitmap
- L_FreeHandWaveBitmap
- L_PixelateBitmap
- L_ImpressionistBitmap
- L_PolarBitmap
- L_PunchBitmap
- L_RadialBlurBitmap
- L_RadWaveBitmap
- L_SpherizeBitmap
- L_SwirlBitmap
- L_WaveBitmap
- L_WindBitmap
- L_ZoomBlurBitmap
- L_ZoomWaveBitmap
- L_BumpMapBitmap
- L_CubismBitmap
- L_DrawStarBitmap
- L_DryBitmap
- L_FreePlaneBendBitmap
- L_FreeRadBendBitmap
- L_GlassEffectBitmap
- L_GlowFilterBitmap
- L_LensFlareBitmap
- L_LightBitmap
- L_OceanBitmap
- L_PlaneBendBitmap
- L_PlaneBitmap
- L_SampleTargetBitmap
- L_TunnelBitmap
- L_DlgRippler
- L_BricksTextureBitmap
- L_CanvasBitmap
- L_CloudsBitmap
- L_ColoredBallsBitmap
- L_DiffuseGlowBitmap
- L_DisplaceMapBitmap
- L_FragmentBitmap
- L_HalfTonePatternBitmap
- L_MaskConvolutionBitmap
- L_MosaicTilesBitmap
- L_OffsetBitmap
- L_PerspectiveBitmap
- L_PlasmaFilterBitmap
- L_PointillistBitmap
- L_RomanMosaicBitmap
- L_VignetteBitmap
- L_ZigZagBitmap
Topics
- Raster Image Functions: Doing Geometric Transformations
- Processing an Image
- Applying Artistic Effects
- Using Color Values in LEADTOOLS
Example
L_INT RippleBitmapExample(L_VOID)
{
L_INT nRet;
BITMAPHANDLE LeadBitmap; /* Bitmap handle for the image */
POINT CenterPt;
/* 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;
/* Ripple bitmap*/
CenterPt.x = LeadBitmap.Width / 2;
CenterPt.y = LeadBitmap.Height / 2;
nRet = L_RippleBitmap(&LeadBitmap, 20, 10, 0, 0, CenterPt, 0, FILL_RPT);
if (nRet != SUCCESS)
return nRet;
nRet = L_SaveBitmap(MAKE_IMAGE_PATH(TEXT("Result.BMP")), &LeadBitmap, FILE_BMP, 24, 0, NULL);
if (nRet != SUCCESS)
return nRet;
//free bitmap
if (LeadBitmap.Flags.Allocated)
L_FreeBitmap(&LeadBitmap);
return SUCCESS;
}