ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / Core Component API Reference / Core Component Functions Reference / FX Functions / IG_FX_ripple
In This Topic
    IG_FX_ripple
    In This Topic

    This function provides the ripple effect on the image, as if it is looked at through a relief glass.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_FX_ripple(
            HIGEAR hIGear,
            AT_FLOAT depth, 
            AT_INT xPeriod,
            AT_INT yPeriod,
            enumIGFXRipplePattern type,
            AT_FLOAT smoothness, 
            AT_BOOL bInvert
    );
    

    Arguments:

    Name Type Description
    hIGear HIGEAR Image to which to apply the effect.
    depth AT_FLOAT Strength of the ripple effect.
    xPeriod AT_INT X period of the ripple pattern, in pixels.
    yPeriod AT_INT Y period of the ripple pattern, in pixels.
    type enumIGFXRipplePattern Identifies a predefined ripple pattern.
    smoothness AT_FLOAT Specifies how much the ripple pattern should be smoothed before applying.
    bInvert AT_BOOL Inverts the ripple pattern, effectively swapping "convex" and "concave" areas.

    Return Value:

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

    Supported Raster Image Formats:

    All pixel formats supported by ImageGear for C and C++.

    Sample:

    Image Processing

    Remarks:

    The function uses one of the predefined ripple patterns defined in enumIGFXRipplePattern.