Marblecore Imaging Library Documentation

Documentation Introduction
Documentation / Marblecore Imaging / Methods / FilterWhirlPinch

FilterWhirlPinch method

Applies a whirl and pinch distortion effect to the image.

Syntax

Boolean FilterWhirlPinch(nWhirl As Number, nPinch As Number, 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
nWhirlNumberYesSpecifies the amount of whirl ranging from -360...360.
nPinchNumberYesSpecifies the amount of pinch ranging from -100...100.
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-filterwhirlpinch-before.jpg");
3 
4 // Execute the operation
5 MarblecoreImaging.FilterWhirlPinch(120, 50);
6 
7 // Save the modified image to the specified file
8 MarblecoreImaging.SaveToFile("example-filterwhirlpinch-after.jpg");

Category

Filters, Distortion

See also

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