Parameters
| Name | Explanation |
|---|---|
| x | An array of x coordinate values defining points of a polygonal area on the image. (in pixels) * |
| y | An array of y coordinate values defining points of a polygonal area on the image. (in pixels) * |
| Points | The number of points defining the polygonal area on the image. |
| MskPattern | Sets the direction of the emboss (0: Left to Right, 1: Top Left to Bottom Right, 2: Top to Bottom, 3: Top Right to Bottom Left, 4: Right to Left, 5: Bottom Right to Top Left, 6: Bottom to Top, 7: Bottom Left to Top Right) |
| Edge | Sets the depth of the emboss (from 1 to 5; where 5 is the deepest emboss) |
| Level | Sets the brightness of the emboss (from 0 to 255; where 255 is the brightest) |
| * In Visual C++, pass the pointer to the first element in the x and y arrays. In Visual Basic, the arguments are returned in the first elements of the arrays x(0) and Y(0). |
|
Return Value
Returns True (nonzero) if successful, otherwise returns False (0).
Explanation
The Emboss method creates an emboss effect on a raster
image. To execute the Emboss method, set the image handle of
the image in the ImageHandle property or the
Layer(LayerNo).ImageHandle
property. The Emboss method supports 8-bit grayscale, 16,
24, and 32 bit images.
Before executing the Emboss 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 0. Set the mask image handle in the MaskImageHandle property
- To process the total image, set the SelectMode property to 1
- To process the polygonal area on the image, set the SelectMode property to 2. Select the polygon by setting the appropriate coordinate values for the points of the polygon in two arrays, one array for the x coordinate values and one array for the y coordinate values. The pass these arrays to the x and y arguments of the Emboss method. The number of points defining the polygon must be 3 or more
- To process an elliptical area on the image, set the SelectMode property to 3. Select the ellipse by setting the appropriate values for the bounding rectangle in the RectLeft, RectTop, RectRight, and RectBottom properties
When the SelectMode
property is set to values other than 2 (ikEffectPolygon), please
set dummy arrays in the x and y parameters and set the Points
parameter to 0.
When the SelectMode property
is set to 2 or 3, the appropriate value must be set in the InOut property. If successful the resulting
raster image data is set in the LayerNo property (the ImageHandle property or the
Layer(LayerNo).ImageHandle
property. If unsuccessful, 0 is returned.
When the Caption, Message, and ButtonName properties are blank, the
progress dialog box will not be displayed. When the progress dialog
box is displayed, the percentage that the processing has completed
will be shown in the dialog box.
For scripting languages and other programs that require variant
types, please refer to the EmbossVariant method.