Marblecore Imaging Library Documentation

Documentation Introduction
Documentation / Marblecore Imaging / Methods / EffectMask

EffectMask method

Creates a mask of the image.

Syntax

Boolean EffectMask(nMaskColor As Number, nMaskOpacity As Number, nMask As Mask, nLeft As Number, nTop As Number, nWidth As Number, nHeight As Number)

Return value

Returns true if the function succeeded.

Parameters

ParameterTypeRequiredDescription
nMaskColorNumberYesSpecifies the color for the mask.
nMaskOpacityNumberNoOptional parameter which specifies the opacity of the mask.
nMaskMask (Enumeration)NoOptional parameter which specifies the mask method.
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-effectmask-before.jpg");
3 
4 // Execute the operation
5 MarblecoreImaging.EffectMask(0);
6 
7 // Save the modified image to the specified file
8 MarblecoreImaging.SaveToFile("example-effectmask-after.jpg");

Category

Effects

See also

EffectBorder | EffectButton | EffectColorOverlay | EffectInnerBevel | EffectInnerGlow | EffectOuterGlow | EffectShadow | EffectSoftenBorder