ImageGear for C and C++ on Windows v20.0 - Updated
IG_FX_directional_wave
API Reference Guide > Core Component API Reference > Core Component Functions Reference > FX Functions > IG_FX_directional_wave

Applies a directional wave effect on the current hIGear image.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_FX_directional_wave(
        HIGEAR hIGear, 
        AT_FLOAT fAngle,
        AT_FLOAT fAmplitude,
        AT_FLOAT fFrequency,
        AT_FLOAT fPhase, 
        AT_FLOAT fAttenuation, 
        AT_BOOL bInterpolate,
        HIGPIXEL hbkColor, 
        LPAT_RECT lpRect 
);

Arguments:

Name Type Description
hIGear HIGEAR Image to which to apply the effect.
fAngle AT_FLOAT Wave direction, in radians.
fAmplitude AT_FLOAT Wave amplitude. Measurement units - pixel / 100.
fFrequency AT_FLOAT Wave frequency. The frequency is defined as 1 / T, where T is a wave period, in pixels.
fPhase AT_FLOAT Wave phase, in radians.
fAttenuation AT_FLOAT Wave attenuation. The attenuation factor of the wave is calculated as exp(-attenuation * r), where r is a distance from the wave center to the current wave point.
bInterpolate AT_BOOL If TRUE, interpolation is used during processing.
hbkColor HIGPIXEL Background color. It should have the same color space and channel depths as the image to which the effect is applied.
lpRect LPAT_RECT Rectangular area to apply the effect to, or NULL for whole image.

Return Value:

Returns the number of ImageGear errors that occurred during this function call.

Supported Raster Image Formats:

When bInterpolate is FALSE, all pixel formats supported by ImageGear for C and C++, except:

When bInterpolate is TRUE, all pixel formats supported by ImageGear for C and C++, except:

Is this page helpful?
Yes No
Thanks for your feedback.