LBitmap::Wave

Summary

Distorts the bitmap with two perpendicular waves at the specified angle and with the specified wave type.

Syntax

#include "ltwrappr.h"

virtual L_INT LBitmap::Wave (uAmplitude, uWaveLen, nAngle, uHorzFact, uVertFact, crFill, uFlags)

Parameters

L_UINT uAmplitude

Waves magnitude. The values range from 1 to the length of the image's diagonal.

L_UINT uWaveLen

Value that represents the wave length, if DIS_PER is set in the uFlags parameter. Possible values range from 1 to 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.

L_INT nAngle

Waves rotation angle in hundredths of degrees. The valid range is from -18000 to 18000 (The value in degrees is nAngle divided by 100).

L_UINT uHorzFact

Size of the horizontal wave, given as a percentage. The valid range is from 0 to 100.

L_UINT uVertFact

Size of the vertical wave, given as a percentage. The valid range is from 0 to 100.

COLORREF 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.

L_UINT uFlags

Flags that indicate how to handle exposed areas, the type of information in the uWaveLength parameter and the wave type. 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 in the uWaveLen 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 used, 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.

The following are the flags that indicate the wave type:

Value	Meaning
WV_SIN	[0x0000] The wave is a sinusoidal wave.
WV_COS	[0x0100] The wave is a sinusoidal wave shifted by 90 degrees.
WV_SQUARE	[0x0200] The wave is a square wave.
WV_TRIANG	[0x0300] The wave is a triangular wave.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

The function applies two perpendicular waves. The uHorzFact and uVertFact parameters control the size of these waves.

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.

Wave Function - Before

Wave Function - After

View additional platform support for this Wave 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.

Platforms

Win32, x64.

Example

L_INT LBitmap__WaveExample(LAnimationWindow * LAniWnd)  
{ 
   L_INT nRet; 
   POINT   CenterPt;  
   CenterPt.x  =  (LAniWnd->GetHandle ())->Width/2;  
   CenterPt.y  =  (LAniWnd->GetHandle ())->Height/2;  
    
   nRet = LAniWnd->Wave(20, 25, 0, 100 , 100, 0, FILL_RPT |  DIS_PER| WV_SIN); 
 
   return nRet; 
    
}