PictureEffects Xojo Plugin |

# SepiaEffect.Apply Method

Applies the effect on a given 32 bit source image with a given 32 bit mask and returns the result to a new image.

Apply(
source as Picture,
value as Integer,
mask as Picture) as Picture

#### Parameters

source
  The source image.
value
  The value can be from 10 to 55. Lower gives more black and white result while higher value gives more brown tones. The Example project defaults to 30 for this value.
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.

#### Returns

Picture
  The result image or nil if failure.If the filter was successful: A reference to the modified picture.
  If nil was returned then see the ErrorCode property to get hints for cause of the error.

#### Remarks

#### See Also

SepiaEffect Class