Marblecore Imaging Library Documentation

Documentation Introduction
Documentation / Marblecore Imaging / Methods / Clear

Clear method

Clears the contents of the image.

Syntax

Boolean Clear(nBackgroundColor As Number, nBackgroundOpacity As Number, nLeft As Number, nTop As Number, nWidth As Number, nHeight As Number)

Return value

Returns true if the function succeeded.

Parameters

ParameterTypeRequiredDescription
nBackgroundColorNumberNoOptional parameter which specifies the background color if expanding occurs.
nBackgroundOpacityNumberNoOptional parameter which specifies the background opacity.
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.

Category

Transformations

See also

Crop | Expand | FlipHorizontal | FlipVertical | Opacity | Resize | Rotate | RotateLeft | RotateRight | RoundEdges | Shear | Shrink | Skew | Straighten | Thumbnail