References ▼
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 L_DlgRipple function. After the user closes the dialog box, this structure is updated with information about the user's selections.
Size of this structure, in bytes. Use the sizeof operator to calculate this value.
Pointer to the bitmap handle that references the bitmap used for preview or processing.
Flag that indicates the initial zoom level for previewing the image. Possible values are:
| Value | Meaning |
|---|---|
| TRUE | Set the initial zoom level to "Zoom to fit". |
| FALSE | Set the initial zoom level to "Normal (1:1)". |
Wave magnitude(amount of displacement). The values range from 1 to the length of the image's diagonal.
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 ).
Wave phase shift, in hundredths of degrees. The valid range is from −36000 to 36000 (The value in degrees is nPhase divided by 100).
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.
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.
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.
Flag that indicates how to handle exposed areas. Possible values are:
| Value | Meaning |
|---|---|
| FILL_CLR | [0x0000] fill exposed areas with the color in crFill. |
| FILL_RPT | [0x0001] stretch the edges of the image to fill exposed areas. |
| FILL_NOCHG | [0x0002] do not change or process exposed areas. |
User interface flags for this dialog, which determine the layout and action of the dialog. Possible values are:
| Value | Meaning |
|---|---|
| DLG_RIPPLE_AUTOPROCESS | [0x00000001] process the image on OK. The pBitmap member of this structure should contain a valid bitmap. |
| DLG_RIPPLE_SHOW_CONTEXTHELP | [0x00000002] dialog should contain a context sensitive help icon. |
| DLG_RIPPLE_SHOW_PREVIEW | [0x00000004] show a preview of the image in the dialog. The pBitmap member of this structure should contain a valid bitmap. |
| DLG_RIPPLE_SHOW_TOOL_ZOOMLEVEL | [0x00000008] show the "Zoom to fit" and "Zoom Normal" toolbar buttons. The DLG_RIPPLE_SHOW_PREVIEW flag must be set in order to show these buttons. |
| DLG_RIPPLE_SHOW_APPLY | [0x00000080] Show the Apply button in the dialog. The dialog will not apply any effect unless the user presses the Apply button. |
Pointer to an optional help callback function. If you do not wish to provide help to this dialog, use NULL as the value of this parameter. To provide help to this dialog, use the function pointer as the value of this parameter. The callback function must adhere to the prototype described in LTCOMMDLGHELPCB.
Void pointer that you can use to pass one or more additional parameters that the callback function needs. To use this feature, assign a value to a variable or create a structure that contains as many fields as you need. Then, in this parameter, pass the address of the variable or structure, casting it to L_VOID *. The callback function, which receives the address in its own pHelpCallBackUserData parameter, can cast it to a pointer of the appropriate data type to access your variable or structure. If the additional parameters are not needed, you can pass NULL in this parameter.