PHP | ImagickDraw getClipUnits() Function

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

Syntax:

int ImagickDraw::getClipUnits( void )

Parameters: This function doesn’t accept any parameter.

Return Value: This function returns 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)

Exceptions: This function throws ImagickException on error.

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

Program 1:

<?php

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

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

Output:

0 // which corresponds to imagick::RESOLUTION_UNDEFINED.

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.getclipunits.php