This method pastes a raster image into another raster image.
Parameters
Name | Explanation |
---|---|
AHandle | The handle of the bottom image. This is the image onto which another image is pasted (supports 1, 4, 8, 16, 24, 32 bit images) |
Angle | Angle of rotation (-35999 to 35999, in 1/100 degree units) |
TurnX | Reversal of the x axis (False(0): no reversal, True (nonzero): reversal) |
TurnY | Reversal of the y axis (False(0): no reversal, True (nonzero): reversal) |
Trans | The level of transparency (from 0 to 255, as this value increases, the top image becomes visible) |
TransColor | Sets whether or not there is a transparent color in the top image. (False(0)No transparent color, True(nonzero):transparent color) |
TransRed | Sets the red component of the transparent color in the top image. (from 0 to 255) |
TransGreen | Sets the green component of the transparent color in the top image. (from 0 to 255) |
TransBlue | Sets the blue component of the transparent color in the top image. (from 0 to 255) |
BackRed | Sets the red component of the background color. This color is drawn in the area not in either the top image or the bottom image (from 0 to 255) |
BackGreen | Sets the green component of the background color. This color is drawn in the area not in either the top image or the bottom image (from 0 to 255) |
BackBlue | Sets the blue component of the background color. This color is drawn in the area not in either the top image or the bottom image (from 0 to 255) |
x,y | The attachment coordinates (in pixels) |
Clip | Sets whether or not the image is clipped (False(0): no clipping, True (nonzero): clipping) |
Return Value
Returns True if successful, otherwise returns False.
Explanation
The PasteImage method pastes one raster image into another raster image. The bottom image, (the image that another image is pasted into) is set into the Handle parameter. The top image, the image you want to paste into the bottom image, is set in the LayerNo property (either the ImageHandle property or the Layer(LayerNo).ImageHandle property). If using a mask image (to determine an area on the image to be processed), then set the image handle of the mask image in the MaskImageHandle property. The PasteImage method supports 1, 4, 8, 16, 24, 32 bit images.
The Angle, TurnX, and TurnY parameters apply to the images in the LayerNo property and MaskImageHandle property. The x,y parameters determine the coordinates on the bottom image (the image in the AHandle parameter) where the CENTER of the LayerNo and MaskImageHandle images are pasted. When the Clip parameter is True, the result is the same size as the bottom image (the image in the AHandle parameter) and any excess is clipped. When the TransColor parameter is True, the color specified in the TransRed, TransGreen and TransBlue parameters is transparent.
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. Note: The memory block of the image data set in the Handle parameter is not freed after this method is executed.
An explanation of the output bitcounts:
- When the Trans parameter is NOT 0 or 255, then the output will be 24 bit color.
- When ImageHandle and AHandle are both 8 bits or less and their bitcounts are the same and their palettes are IDENTICAL (same colors in the same order), then the output will be the same bitcount as the input images.
- If ImageHandle and AHandle have different bitcounts, or their palettes are not IDENTICAL (same colors in the same order), then the output will be a 24 bit image.
- If either ImageHandle and AHandle are 16 bits or more, the output will be in the largest bitcount.
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.