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
Parameter | Type | Required | Description |
nMaskColor | Number | Yes | Specifies the color for the mask. |
nMaskOpacity | Number | No | Optional parameter which specifies the opacity of the mask. |
nMask | Mask (Enumeration) | No | Optional parameter which specifies the mask method. |
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
2 MarblecoreImaging.LoadFromFile("example-effectmask-before.jpg");
3
4
5 MarblecoreImaging.EffectMask(0);
6
7
8 MarblecoreImaging.SaveToFile("example-effectmask-after.jpg");
Category
Effects
See also
EffectBorder |
EffectButton |
EffectColorOverlay |
EffectInnerBevel |
EffectInnerGlow |
EffectOuterGlow |
EffectShadow |
EffectSoftenBorder