Marblecore Imaging Library Documentation

Documentation Introduction
Documentation / Marblecore Imaging / Methods / DrawBackground

DrawBackground method

Draws a background behind a transparent image.

Syntax

Boolean DrawBackground(nColor 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

ParameterTypeRequiredDescription
nColorNumberNoOptional parameter which specifies the background color.
nOpacityNumberNoOptional parameter which specifies the background opacity.
nOverlayOpacityNumberNoOptional parameter which specifies the opacity of the image overlay.
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 how to use the method. 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 // Creates a new transparent image
2 MarblecoreImaging.Create(150, 150, true);
3 
4 // Execute the operation
5 MarblecoreImaging.DrawBackground(16711680, 75, 0, 25, 25, 100, 100);
6 
7 // Save the modified image to the specified file
8 MarblecoreImaging.SaveToFile("example-drawbackground.jpg");

Category

Drawing

See also

DrawArc | DrawArrow | DrawBezier | DrawCheckerboard | 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