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
Parameter | Type | Required | Description |
nWave | Number | Yes | Specifies the wave length of the distortion. |
nAmplitude | Number | Yes | Specifies the amplitude of the distortion. |
bVertical | Boolean | No | Optional parameter which specifies if the effect should be applied vertically or horizontally. |
bSaw | Boolean | No | Optional parameter which specifies the shape of the ripple (sawtooth or sinus). |
bInvert | Boolean | No | Optional parameter which specifies if the ripple effect is inverted. |
bAntiAliasing | Boolean | No | Optional parameter which enables or disables anti-aliasing. |
nLeft | Number | No | Optional parameter which can be used to specify a clipping rectangle. This parameter specifies the left coordinate of the rectangle. |
nTop | Number | No | Optional parameter which can be used to specify a clipping rectangle. This parameter specifies the top coordinate of the rectangle. |
nWidth | Number | No | Optional parameter which can be used to specify a clipping rectangle. This parameter specifies the width of the rectangle. |
nHeight | Number | No | Optional 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.
1
2 MarblecoreImaging.LoadFromFile("example-filterripple-before.jpg");
3
4
5 MarblecoreImaging.FilterRipple(40, 10);
6
7
8 MarblecoreImaging.SaveToFile("example-filterripple-after.jpg");
Category
Filters, Distortion
See also
FilterCylinder |
FilterFractalTrace |
FilterIllusion |
FilterLens |
FilterPinch |
FilterPixelate |
FilterShift |
FilterStripe |
FilterWave |
FilterWhirl |
FilterWhirlPinch