PHP | ImagickDraw getStrokeLineCap() Function

The ImagickDraw::getStrokeLineCap() function is an inbuilt function in PHP which is used to get the shape to be used at the end of open subpaths when they are stroked.

Syntax:

int ImagickDraw::getStrokeLineCap( void )

Parameters: This function doesn’t accepts any parameters.

Return Value: This function returns an integer value corresponding to one of LINECAP constants.

List of LINECAP constants are given below:

• imagick::LINECAP_UNDEFINED (0)
• imagick::LINECAP_BUTT (1)
• imagick::LINECAP_ROUND (2)
• imagick::LINECAP_SQUARE (3)

Exceptions: This function throws ImagickException on error.

Below programs illustrate the ImagickDraw::getStrokeLineCap() function in PHP:

Program 1:

<?php

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

// Get the stroke line cap
$lineCap = $draw->getStrokeLineCap();
echo $lineCap;
?>

Output:

1 // Which corresponds to imagick::LINECAP_BUTT

Program 2:

<?php

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

// Set the stroke line cap
$draw->setStrokeLineCap(3);

// Get the stroke line cap
$lineCap = $draw->getStrokeLineCap();
echo $lineCap;
?>

Output:

3 // Which corresponds to imagick::LINECAP_SQUARE

Program 3:

<?php

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

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

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

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

// Set the fill color
$draw->setFillColor('black');

// Set the color of stroke
$draw->setStrokeColor('white');

// Set the stroke width
$draw->setStrokeWidth(3);

// Set the font size
$draw->setFontSize(25);

 // Set the stroke dash array
$draw->setStrokeDashArray([20, 5, 19, 15, 5, 15]);

// Draw a rectangle
$draw->rectangle(100, 50, 225, 175);

// Annotate a text
$draw->annotation(10, 220, 'The strokeLineCap here is '
         . $draw->getStrokeLineCap());

// Set the stroke line cap
$draw->setStrokeLineCap(2);

// Draw a rectangle
$draw->rectangle(500, 50, 625, 175);

// Annotate a text
$draw->annotation(400, 220, 'The strokeLineCap here is '
         . $draw->getStrokeLineCap());

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

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

Output: