PHP | ImagickDraw setClipRule() Function

The ImagickDraw::setClipRule() function is an inbuilt function in PHP which is used to set the polygon fill rule to be used by the clipping path. This usually doesn’t have any impact on the final image but still provides different FILLRULE methods to complete the same task.

Syntax:

bool ImagickDraw::setClipRule( int $fill_rule )

Parameters: This function accepts a single parameter $fill_rule which holds an integer corresponding to one of FILLRULE constants.

List of FILLRULE constants are given below:

• imagick::FILLRULE_UNDEFINED (0)
• imagick::FILLRULE_EVENODD (1)
• imagick::FILLRULE_NONZERO (2)

Return Value: This function returns TRUE on success.

Exceptions: This function throws ImagickException on error.

Below given programs illustrate the ImagickDraw::setClipRule() function in PHP:

Program 1:

<?php

// Create a new ImagickDraw object
$draw = new ImagickDraw();

// Set the clipRule
$draw->setClipRule(imagick::FILLRULE_NONZERO);

// Get clipRule
echo $draw->getClipRule();
?>

Output:

2 // which corresponds to imagick::FILLRULE_NONZERO.

Program 2:

<?php

// Create a new imagick object
$imagick = new Imagick();

// Create a image on imagick object
$imagick->newImage(500, 250, 'green');

// Create a new ImagickDraw object
$draw = new ImagickDraw();

$draw->setClipRule(imagick::FILLRULE_EVENODD);

$draw->setFontSize(24);

$draw->annotation(160, 125,
                  'The clipRule is '
                  . $draw->getClipRule() . '.');

// Render the draw commands
$imagick->drawImage($draw);

// Show the output
$imagick->setImageFormat('png');
header("Content-Type: image/png");
echo $imagick->getImageBlob();
?>

Output:

Reference: https://www.php.net/manual/en/imagickdraw.setcliprule.php