Marblecore Imaging Library Documentation

Documentation / Marblecore Imaging / Methods / DrawCheckerboard

DrawCheckerboard method

Syntax

Boolean DrawCheckerboard(nSize As Number, nColorLight As Number, nColorDark As Number, nOpacity As Number, nOverlayOpacity As Number, 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	No	Optional parameter which specifies the size of a square.
nColorLight	Number	No	Optional parameter which specifies the light color.
nColorDark	Number	No	Optional parameter which specifies the dark color.
nOpacity	Number	No	Optional parameter which specifies the opacity of the checkboard (only available for transparent images).
nOverlayOpacity	Number	No	Optional parameter which specifies the opacity of the image overlay.
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-drawcheckerboard-before.jpg");
3 
4 // Execute the operation
5 MarblecoreImaging.DrawCheckerboard();
6 
7 // Save the modified image to the specified file
8 MarblecoreImaging.SaveToFile("example-drawcheckerboard-after.jpg");

Category

Drawing

See also

DrawArc | DrawArrow | DrawBackground | DrawBezier | DrawCurve | DrawCurveBorder | DrawCurveFilled | DrawCurveGradient | DrawEllipse | DrawEllipseBorder | DrawEllipseFilled | DrawEllipseGradient | DrawFloodFill | DrawLine | DrawPie | DrawPieBorder | DrawPieFilled | DrawPieGradient | DrawPixel | DrawPolygon | DrawPolygonBorder | DrawPolygonFilled | DrawPolygonGradient | DrawRectangle | DrawRectangleBorder | DrawRectangleFilled | DrawRectangleGradient | DrawRectangleTransparent | DrawRhombus | DrawRhombusBorder | DrawRhombusFilled | DrawRhombusGradient | DrawRoundRectangle | DrawRoundRectangleBorder | DrawRoundRectangleFilled | DrawRoundRectangleGradient | DrawTriangle | DrawTriangleBorder | DrawTriangleFilled | DrawTriangleGradient | GetPixelColor | LineTo | MoveTo