LBitmap::Wave

#include "ltwrappr.h"

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

L_UINT uAmplitude;

waves size

L_UINT uWaveLen;

waves length

L_INT nAngle;

waves rotation angle

L_UINT uHorzFact;

size of horizontal wave

L_UINT uVertFact;

size of vertical wave

COLORREF crFill;

fill color

L_UINT uFlags;

flags

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

Parameter Description
uAmplitude Waves magnitude. The values range from 1 to the length of the image's diagonal.
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.
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).
uHorzFact Size of the horizontal wave, given as a percentage. The valid range is from 0 to 100.
uVertFact Size of the vertical wave, given as a percentage. The valid range is from 0 to 100.
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, 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

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.

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.

Help Version 20.0.2020.2.17
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help