LEADTOOLS Raster Imaging C++ Class Library Help > Classes and Member Functions > LBitmap > LBitmap Member Functions > LBitmap::Punch |
#include "ltwrappr.h"
virtual L_INT LBitmap::Punch (nValue, uStress, CenterPt, crFill, uFlags)
L_INT nValue; |
/* stretch amount */ |
L_UINT uStress; |
/* punching intensity */ |
POINT CenterPt; |
/* effect center */ |
COLORREF crFill; |
/* fill color */ |
L_UINT uFlags; |
/* flags */ |
Warps the bitmap by pinching it toward the center or expanding the bitmap away from its center.
Parameter |
Description |
|
nValue |
Amount of stretching where : |
|
|
Positive values: pinch the image toward its center. |
|
|
Negative values: expand the image away from its center. |
|
|
Valid values range from 500 to 500. |
|
uStress |
Amount of punching intensity. This value is ignored when nValue is less than 0. Valid values range from 0 to 1000. |
|
CenterPt |
POINT structure that contains the point around which the image will be pinched or punched. |
|
crFill |
The COLORREF value that specifies the fill color for any exposed areas. You can specify a COLORREF value, such as the return value of the Windows RGB macro, or you can use the PALETTEINDEX macro to specify a palette color. |
|
uFlags |
Flags that indicate how to handle exposed areas, both centrally and peripherally. You can use a bitwise OR (|) to specify one flag from each group. |
|
|
The following are the flags that indicate how to handle peripherally exposed areas: |
|
|
Value |
Meaning |
|
FILL_CLR |
[0x0000] Fill any exposed areas with crFill. |
|
FILL_RPT |
[0x0001] Stretch the image edges to fill the exposed area. |
|
FILL_NOCHG |
[0x0002] Leave the exposed area as is, without changing it. |
|
The following are the flags that indicate how to handle centrally exposed areas: |
|
|
Value |
Meaning |
|
FILL_ROT |
[0x0000] Rotate the image inside the pinch pattern. |
|
FILL_WOUTROT |
[0x0010] Fill the exposed center the same way the peripherally exposed areas are filled. |
|
This flag is ignored if the nValue is positive. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
This function will punch or pinch the bitmap around the specified CenterPt. The center point must be defined inside the bitmap or inside the region, if the bitmap has a region.
If the bitmap has a region, the effect will be applied on the region only.
This function supports 12 and 16-bit grayscale and 48 and 64-bit color images. Support for 12 and 16-bit grayscale and 48 and 64-bit color images is available only in the Document/Medical toolkits.
This function does not support signed data images. It returns the error code ERROR_SIGNED_DATA_NOT_SUPPORTED if a signed data image is passed to this function.
This function does not support 32-bit grayscale images. It returns the error code ERROR_GRAY32_UNSUPPORTED if a 32-bit grayscale image is passed to this function.
Required DLLs and Libraries
LTIMGSFX For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
Win32, x64.
See Also
Example
L_INT LBitmap__PunchExample(LAnimationWindow * LAniWnd) { POINT CenterPt; CenterPt.x = (LAniWnd->GetHandle ())->Width/2; CenterPt.y = (LAniWnd->GetHandle ())->Height/2; return LAniWnd->Punch(100, 100, CenterPt, 0, FILL_RPT | FILL_WOUTROT); }