RIPPLEDLGPARAMS

typedef struct _RIPPLEDLGPARAMS 
{ 
   L_UINT uStructSize; 
   pBITMAPHANDLE pBitmap; 
   L_BOOL bZoomToFit; 
   L_UINT uAmplitude; 
   L_UINT uFrequency; 
   L_INT nPhase; 
   L_UINT uAttenuation; 
   POINT ptCenter; 
   COLORREF crFill; 
   L_UINT uRippleFlag; 
   L_UINT32 uDlgFlags; 
   LTCOMMDLGHELPCB pfnHelpCallback; 
   L_VOID  *pHelpCallBackUserData; 
} RIPPLEDLGPARAMS,  * LPRIPPLEDLGPARAMS; 

The RIPPLEDLGPARAMS structure provides information used to initialize the dialog box created by the LDialogImageEffect::DoModalRipple function. After the user closes the dialog box, this structure is updated with information about the user's selections.

Members

uStructSize

Size of this structure, in bytes. Use the sizeof operator to calculate this value.

pBitmap

Pointer to the bitmap handle that references the bitmap used for preview or processing.

bZoomToFit

Flag that indicates the initial zoom level for previewing the image. Possible values are:

uAmplitude

Wave magnitude(amount of displacement). The values range from 1 to the length of the image's diagonal.

uFrequency

Number of repeated waves along the radial line. The values range from 1 to one-half the length of the image's diagonal. ( 1 - (length of image diagonal)/2 ).

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

uAttenuation

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

ptCenter

POINT structure that contains the center of the Ripple wave. The center point must be defined inside the bitmap or inside the region, if the bitmap has a region.

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.

uRippleFlag

Flag that indicates how to handle exposed areas. Possible values are:

uDlgFlags

User interface flags for this dialog, which determine the layout and action of the dialog. Possible values are:

pfnHelpCallback

Ignored.

pHelpCallBackUserData

Ignored.