Home > PHP > Function > > HaruImage::setMaskImage()

HaruImage::setMaskImage()

HaruImage::setMaskImage - Set the image mask

Syntax

bool HaruImage::setMaskImage (object $mask_image)

Arguments

  • mask_image - A valid HaruImageinstance.

Description

Sets the image used as image-mask. It must be 1bit gray-scale color image.

Version

PHP PECL haru >= 0.0.1

Return value

Returns TRUE on success.