Marblecore Imaging Library Documentation

Documentation Introduction
Documentation / Marblecore Imaging / Methods / FilterRipple

FilterRipple method

Applies a ripple distortion effect to the image.

Syntax

Boolean FilterRipple(nWave As Number, nAmplitude As Number, bVertical As Boolean, bSaw As Boolean, bInvert As Boolean, bAntiAliasing As Boolean, nLeft As Number, nTop As Number, nWidth As Number, nHeight As Number)

Return value

Returns true if the function succeeded.

Parameters

ParameterTypeRequiredDescription
nWaveNumberYesSpecifies the wave length of the distortion.
nAmplitudeNumberYesSpecifies the amplitude of the distortion.
bVerticalBooleanNoOptional parameter which specifies if the effect should be applied vertically or horizontally.
bSawBooleanNoOptional parameter which specifies the shape of the ripple (sawtooth or sinus).
bInvertBooleanNoOptional parameter which specifies if the ripple effect is inverted.
bAntiAliasingBooleanNoOptional parameter which enables or disables anti-aliasing.
nLeftNumberNoOptional parameter which can be used to specify a clipping rectangle. This parameter specifies the left coordinate of the rectangle.
nTopNumberNoOptional parameter which can be used to specify a clipping rectangle. This parameter specifies the top coordinate of the rectangle.
nWidthNumberNoOptional parameter which can be used to specify a clipping rectangle. This parameter specifies the width of the rectangle.
nHeightNumberNoOptional parameter which can be used to specify a clipping rectangle. This parameter specifies the height of the rectangle.

Example

The example below shows the effect of this method and how to use it. You can slide the marker in the before/after picture to see the difference. If you take a look at the example code, assume there is a reference to the Marblecore Imaging object with the name 'MarblecoreImaging'. Transparent parts of the image are displayed using a checkerboard pattern.
 
before
after
 
1 // Load the specified image in memory
2 MarblecoreImaging.LoadFromFile("example-filterripple-before.jpg");
3 
4 // Execute the operation
5 MarblecoreImaging.FilterRipple(40, 10);
6 
7 // Save the modified image to the specified file
8 MarblecoreImaging.SaveToFile("example-filterripple-after.jpg");

Category

Filters, Distortion

See also

FilterCylinder | FilterFractalTrace | FilterIllusion | FilterLens | FilterPinch | FilterPixelate | FilterShift | FilterStripe | FilterWave | FilterWhirl | FilterWhirlPinch