PHP | ImagickDraw setStrokeDashOffset() Function

The ImagickDraw::setStrokeDashOffset() function is an inbuilt function in PHP which is used to set the offset into the dash pattern to start the dash.

Syntax:

bool ImagickDraw::setStrokeDashOffset( float $dash_offset )

Parameters: This function accepts a single parameter $dash_offset which holds the dash offset.

Return Value: This function returns TRUE on success.

Exceptions: This function throws ImagickException on error.

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

Program 1:

<?php

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

// Set the stroke dash offset
$draw->setStrokeDashOffset(5);

// Get the stroke dash offset
$offset = $draw->getStrokeDashOffset();
echo $offset;
?>

Output:

5

Program 2:

<?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 dash array
$draw->setStrokeDashArray([15, 5, 15]);

// Set the stroke dash offset
$draw->setStrokeDashOffset(20);

// Draw a circle using ellipse function
$draw->ellipse(400, 100, 70, 70, 60, 900);

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