Marblecore Imaging Library Documentation

Documentation / Marblecore Imaging / Methods / FilterBlinds

FilterBlinds method

Syntax

Boolean FilterBlinds(nSize As Number, bVertical As Boolean, bInvert As Boolean, nColor As Number, nOpacity As Number, bAlphaBlending 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
nSize	Number	Yes	Specifies the width or height of the blinds in pixels.
bVertical	Boolean	Yes	Specifies if the blinds are vertical (or horizontal).
bInvert	Boolean	Yes	Specifies if the blinds are inverted (closed to open instead of open to closed).
nColor	Number	Yes	Specifies the color for the blinds.
nOpacity	Number	No	Optional parameter which specifies the opacity percentage of the blinds effect.
bAlphaBlending	Boolean	No	Enables or disables alpha channel blending (only available for 32-bits images).
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 // Load the specified image in memory
2 MarblecoreImaging.LoadFromFile("example-filterblinds-before.jpg");
3 
4 // Execute the operation
5 MarblecoreImaging.FilterBlinds(20, false, false, 16711680);
6 
7 // Save the modified image to the specified file
8 MarblecoreImaging.SaveToFile("example-filterblinds-after.jpg");

Category

Filters, Light

See also

FilterLensFlare | FilterSoftGlow | FilterTileReflect