MaskImageHandle (ImageKit Control/ Effect Property)

This property refers to the image handle for the input mask image

[C++Builder] imagekitcontrolname->Effect->MaskImageHandle[= NativeUInt ]

[Delphi] imagekitcontrolname.Effect.MaskImageHandle[= THandle ]

Property Value

The image handle for the input mask image

Explanation

The MaskImageHandle property refers to the image handle for the input mask image. The mask image determines which portion of the image (whose image handle is the ImageHandle property) will be processed. The mask image must be a 1-bit color, black and white image. The input mask image must have the same height and width as the image set in the ImageHandle property

Both the MaskImageHandle property and the MaskFileName property refer to the mask image, however, the last of these properties that is set will determine the mask image that will be used when an effect is processed.

If the effect is successful then the mask image will be automatically be set MaskImageHandle property. It is not necessary to manually free this image handle.

The MaskImageHandle property replaces the Effect Control's InMskHandle and OutMsHandle properties in earlier versions of the ImageKit.

Setting this value

This value can be set during execution.

Retrieving this value

This value is retrieved during execution.