This method creates a mosaic effect on a raster image.
Parameters
xSize
The width of the mosaic (in pixels)
ySize
The height of the mosaic (in pixels)
Return Value
Returns True if successful. Returns False if unsuccessful.
Explanation
The Mosaic method creates a mosaic effect on a raster
image. To execute the Mosaic method, set the image handle of
the image in the Image
property
or the Layer(LayerNumber).Image property.
The Mosaic method supports 1, 4, 8, 16, 24, and 32 bit
images.
If both of the values set in the XSize and YSize parameters are less than 1, this method does not produce an mosaic effect on a raster image.
Before executing the Mosaic method, you must set the area on the image that will be affected. There are 4 ways to do this.
- To use a mask image, set the SelectMode property to EffectMask. Set the mask image handle in the SourceMask property
- To process the total image, set the SelectMode property to EffectAll
- To process the polygonal area on the image, set the SelectMode property to EffectPolygon. Select the polygon by setting the appropriate coordinate values for the points of the polygon in the Point property
- To process an elliptical area on the image, set the SelectMode property to EffectEllipse. Select the ellipse by setting the appropriate values for the bounding rectangle in the Rect property
When the SelectMode property is set to EffectPolygon or EffectEllipse, the appropriate values must be set in the Inside property.
If the Mosaic method is successful and the DestinationAsImageKitImage property is True, the resulting image will be set in the Image property or in the Layer(LayerNumber).Image property, according to the value set in the LayerNumber property.
If the Mosaic method is successful and the DestinationAsImageKitImage property is False, the resulting image will be set in the DestinationImage property.