API Reference Guide > Core Component API Reference > Core Component Functions Reference > FX Functions > IG_FX_ripple_texture |
This function provides the ripple effect on the image, as if it is looked at through a relief glass.
Copy Code
|
|
---|---|
AT_ERRCOUNT ACCUAPI IG_FX_ripple_texture( HIGEAR hIGear, HIGEAR hTexture, AT_FLOAT depth, AT_FLOAT scale, AT_INT xOffset, AT_INT yOffset, AT_FLOAT smoothness, AT_BOOL bInvert ); |
Name | Type | Description |
---|---|---|
hIGear | HIGEAR | Image to which to apply the effect. |
hTexture | HIGEAR | Image to use as a ripple pattern. |
depth | AT_FLOAT | Strength of the ripple effect. |
scale | AT_FLOAT | Specifies the scaling factor for pattern image. |
xOffset | AT_INT | Horizontal offset at which the upper left corner of the ripple texture shall be placed. |
yOffset | AT_INT | Horizontal offset at which the upper left corner of the ripple texture shall be placed. |
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. |
Returns the number of ImageGear errors that occurred during this function call.
All pixel formats supported by ImageGear for C and C++.
Image Processing
The function uses an image as a ripple pattern. If the scaled ripple pattern image is smaller than the source image, or if offsets are greater than 0, pattern is repeated over the image.