PHP | ImagickDraw setClipUnits() Function

The ImagickDraw::setClipUnits() function is an inbuilt function in PHP which is used to set the interpretation of clip path units.

Syntax:

bool ImagickDraw::setClipUnits( int $clip_units )

Parameters: This function accept a single parameter $clip_units which is an integer value corresponding to one of RESOLUTION constants.

List of RESOLUTION constants are given below:

• imagick::RESOLUTION_UNDEFINED (0)
• imagick::RESOLUTION_PIXELSPERINCH (1)
• imagick::RESOLUTION_PIXELSPERCENTIMETER (2)

Return Value: This function returns TRUE on success.

Exceptions: This function throws ImagickException on error.

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

Program 1:

<?php

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

// Set clipUnits
$draw->setClipUnits(imagick::RESOLUTION_PIXELSPERCENTIMETER);

// Get clipUnits
echo $draw->getClipUnits();
?>

Output:

2 // which corresponds to one of imagick::RESOLUTION_PIXELSPERCENTIMETER.

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->setClipUnits(imagick::RESOLUTION_PIXELSPERINCH);

$draw->setFontSize(24);

$draw->annotation(160, 125,
                  'The clipUnits is '
                  . $draw->getClipUnits() . '.');

// 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.setclipunits.php