IKRotationEx

This function rotates a raster image.

[C++Builder] BOOL IKRotationEx(PTR_IKSELECT_IMAGE SrcHandle, PTR_IKSELECT_IMAGE DstHandle, int Angle, BOOL TurnX, BOOL TurnY, BOOL Mode, BYTE Red, BYTE Green, BYTE Blue, BOOL Clip, IKPROCESSPROC UserProc, LPCTSTR Caption, LPCTSTR Message, LPCTSTR Button);

[Delphi] function IKRotationEx(var SrcHandle, DstHandle: IKSELECT_IMAGE; Angle: Integer; TurnX, TurnY, Mode: LongBool; Red, Green, Blue: Byte; Clip: LongBool; UserProc: LONG_PTR; Caption, Message, Button: PChar): LonBool;

Parameters

Name	Explanation
SrcHandle	A structure containing the image handle and the mask image handle member variables hImgBmh can be 1, 4, 8, 16, 24, or 32 bit images
DstHandle	A structure whose member variables contain the created image handle and mask image handle (if unsuccessful the members of the structure return 0) Note: DstHandle is used by the IKRotationEx function only
Angle	Angle of rotation (-35999 to 35999, in 1/100 degree units)
TurnX	Reverses image along the x axis (False(0): no reversal, True (nonzero): reversal)
TurnY	Reverses image along the y axis (False(0): no reversal, True (nonzero): reversal)
Mode	Sets whether on not linear interpolation is used (False (0): does not interpolate, True (nonzero): interpolates). Interpolation is enabled for 8 bit grayscale, 16, 24, and 32 bit images only.
Red	The red component of the background color (from 0 to 255)
Green	The green component of the background color (from 0 to 255)
Blue	The blue component of the background color (from 0 to 255)
Clip	Sets whether or not the image is clipped (False(0): No clipping, True(nonzero) clipping)
UserProc	The address of the user function (If not using the user function then set to 0)
Caption	Sets the text displayed in the title bar of the progress dialog box
Message	Sets the message displayed in the progress dialog box
Button	Sets the name of the button displayed in the progress dialog box

Return Value

Returns True if successful. Returns False if unsuccessful.

Explanation

The IKRotationEx function rotates a raster image.

If the Angle parameter value is positive, the image is rotated counterclockwise, if the Angle parameter value is negative, the image is rotated clockwise. When the Clip parameter is True and the rotated image is larger than the original, the excess areas are cut.

Note: the image handles passed to IKSELECT_IMAGE are NOT automatically freed after executing this function.

If the user function is set or if the Caption, Message, and Button parameters are blank then the Progress dialog box is not displayed. If the Progress dialog box is displayed, it indicates the percentage of the current process completed. For more information about the user functions please refer to the Definition of User Function in the Ik10Effect.dll, Ik10EffectA.dll, Ik10Effect64.dll, Ik10Effect64A.dlll section.