PictureEffects Xojo and Real Studio Plugin

SurfaceWave Method

To create a surface wave effect where it will seem as a stone has been thrown onto a liquid picture then use the SurfaceWave function.

SurfaceWave(
   src as Picture,
   waves as Double,
   mask as Picture,
   progress as IProgressHandler) as Picture

Parameters

src
The source picture to work with.
waves
The number of waves to generate.
mask
To limit the filtering to certain pixels then set a picture defining the mask to this parameter. Pass nil to this parameter if the filtering should not be limited to certain pixels.

The mask picture must be a 32 bit picture and must be same size as the src picture. If the mask picture is not 32 bits and same size as the src picture then the function will fail and leave the result picture unchanged.
progress
Use this parameter to use a progress class to get progress feedback from this function. This class must be a class that Implements the IProgressHandler Interface which is defined in this plugin.

Pass nil to this parameter if you don't need progress feedback.

Progress feedback will slow the filter down.

Returns

Picture
If the filter was successful: A reference to the modified picture.

If the src picture was not 32 bits then a nil will be returned.

This filter will allocate memory so a Nil is also returned if not enough memory could be allocated for it or if the mask parameter contained invalid mask picture.

Remarks

Supported Platforms:

  • MacOS X Carbon
  • MacOS X Cocoa
  • Win32 - Windows
  • Linux x86

    Unsupported Platforms:

  • MacOS X Carbon

    See Also

    GlobalMethods Global