In This Topic ▼

L_ZigZagBitmap

#include "l_bitmap.h"

L_LTIMGSFX_API L_INT L_ZigZagBitmap(pBitmap, uAmplitude, uAttenuation, uFrequency, nPhase, CenterPt, crFill, uFlags)

Radially distorts the bitmap by creating waves that twist the image around a specified center.

Parameters

pBITMAPHANDLE pBitmap

Pointer to the bitmap handle that references the bitmap on which to apply the effect.

L_UINT uAmplitude

Non-zero value that represents the magnitude of the wave (amount of displacement), if ZG_RAD is set in the uFlags parameter. The valid range is from 1 - 100.

L_UINT uAttenuation

Attenuation value. The attenuation value indicates how rapidly the wave amplitude decays as the wave travels along the radial line. The valid range is from 0 - 1000.

L_UINT uFrequency

Number of times the waves repeat along the radial line.

L_INT 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).

POINT CenterPt

POINT structure that contains the center of the zigzag wave.

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, and the wave radiation 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 wave radiation type:

Value	Meaning
ZG_RAD	[0x0000] Create distortion waves around the `CenterPt`.
ZG_POND	[0x0010] Create distortion waves that resemble the ripples in a pond.

Returns

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

Comments

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.

For an example, click here

To create other zigzag forms refer to L_RippleBitmap, L_ZoomWaveBitmap and L_RadWaveBitmap.

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 in the Document and Medical Imaging toolkits.

To update a status bar or detect a user interrupt during execution of this function, refer to L_SetStatusCallback.

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.

Functions

Topics

Example

L_INT ZigZagBitmapExample(L_VOID) 
{ 
   L_INT nRet; 
   BITMAPHANDLE LeadBitmap;   /* Bitmap handle for the image */ 
   POINT CenterPt; 
   /* Load a bitmap at its own bits per pixel  */ 
   nRet = L_LoadBitmap(MAKE_IMAGE_PATH(TEXT("sample5.cmp")), &LeadBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL); 
   if(nRet !=SUCCESS) 
      return nRet; 
   /* Apply ZigZag waves from the center of the image*/ 
   CenterPt.x  =  LeadBitmap.Width/2; 
   CenterPt.y  =  LeadBitmap. Height/2; 
   nRet = L_ZigZagBitmap(&LeadBitmap, 50, 1000, 10, 0, CenterPt, 0, FILL_RPT | ZG_POND); 
   if(nRet !=SUCCESS) 
      return nRet; 
   nRet = L_SaveBitmap(MAKE_IMAGE_PATH(TEXT("Result.BMP")), &LeadBitmap, FILE_BMP, 24, 0, NULL); 
   if(nRet !=SUCCESS) 
      return nRet; 
   //free bitmap  
   if(LeadBitmap.Flags.Allocated)   
      L_FreeBitmap(&LeadBitmap);   
   return SUCCESS; 
}