LBitmap::RadWave
#include "ltwrappr.h"
virtual L_INT LBitmap::RadWave(uAmplitude, uWaveLen, nPhase, CenterPt, crFill, uFlags)
L_UINT uAmplitude; |
/* radial wave size */ |
L_UINT uWaveLen; |
/* wave’s length */ |
L_INT nPhase; |
/* wave phase shift */ |
POINT CenterPt; |
/* radial wave center */ |
COLORREF crFill; |
/* fill color */ |
L_UINT uFlags; |
/* flags */ |
Distorts a bitmap using a wave radiating from the specified center. This function is available in the Raster Pro and above toolkits.
Parameter |
Description |
|
pBitmap |
Pointer to the bitmap handle that references the bitmap on which to apply the effect. |
|
uAmplitude |
An integer that represents the magnitude of the wave. Valid values range from 0 to 100. |
|
uWaveLen |
Value that represents the wave length, if DIS_PER is set in the uFlags parameter. Possible values range from 1 – 100 and give the wavelength as a percentage of the bitmap dimensions. If DIS_FRQ is set in uFlags, this value is the number of repeated waves. |
|
nPhase |
Wave phase shift, in hundredths of degrees. The valid range is from –36000 to 36000 (The value in degrees is nPhase divided by 100). |
|
CenterPt |
POINT structure that contains the point from which the wave radiates. |
|
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 and what type of information is in the uWaveLen parameter. You can use a bitwise OR (|) to specify one flag from each group. |
|
|
The following are the flags that indicate how to handle 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 the type of information contained in the uWaveLength parameter: |
|
|
Value |
Meaning |
|
DIS_PER |
[0x0000] The value in uWaveLen is a wavelength given as a percent of the bitmap dimensions. If this value is set, the valid range of uWaveLen is from 0 to 100. |
|
DIS_FRQ |
[0x0010] The value in uWaveLen is the frequency, or the number of times the wave repeats. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
The function applies a sinusoidal wave radiating from the specified center. 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.
Required DLLs and Libraries
LTIMG For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
See Also
Example
void MyTestFunction(LAnimationWindow * LAniWnd)
{
POINT CenterPt;
CenterPt.x = (LAniWnd->GetHandle ())->Width/2;
CenterPt.y = (LAniWnd->GetHandle ())->Height/2;
LAniWnd->RadWave(5, 25, 0, CenterPt, 0, FILL_RPT | DIS_FRQ);
}