Marblecore Imaging Library Documentation

Documentation Introduction
Documentation / Marblecore Imaging / Methods / FilterCheckerboard

FilterCheckerboard method

Draws a checkboard grid on the image.

Syntax

Boolean FilterCheckerboard(nSize As Number, nColorLight As Number, nColorDark As Number, nOpacity As Number, nLeft As Number, nTop As Number, nWidth As Number, nHeight As Number)

Return value

Returns true if the function succeeded.

Parameters

ParameterTypeRequiredDescription
nSizeNumberNoOptional parameter which specifies the size of a square in pixels.
nColorLightNumberNoOptional parameter which specifies the light color.
nColorDarkNumberNoOptional parameter which specifies the dark color.
nOpacityNumberNoOptional parameter which specifies the opacity of the checkboard (only available for 32-bits images).
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-filtercheckerboard-before.jpg");
3 
4 // Execute the operation
5 MarblecoreImaging.FilterCheckerboard();
6 
7 // Save the modified image to the specified file
8 MarblecoreImaging.SaveToFile("example-filtercheckerboard-after.jpg");

Category

Filters, Artistic

See also

FilterEmboss | FilterOilPaint | FilterPosterize | FilterSplash