Drawing

• Colors & Pixels
  • Fill Images with Color
  • Draw Pixels
• Geometric Shapes
  • Draw a Rectangle
  • Draw Ellipses
  • Draw a Circle
  • Draw a Line
  • Draw a Polygon
  • Draw Bezier Curves

Colors & Pixels

Fill Images with Color

public Image::fill(string|ColorInterface $color, null|int $x = null, null|int $y = null): ImageInterface

Fills the current image with the specified color. Optionally, it is possible to pass a position where the color fill should start. If these X and Y values are specified, the color will be applied with flood fill. This means that only colors that are at the specified position will be filled. If no position is passed, the entire image will be filled.

Parameters

Name	Type	Description
color	string or ColorInterface	Fill color in one of the different color formats
x	int	Optional x-coordinate of the filling position
y	int	Optional y-coordinate of the filling position

Example

use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Gd\Driver;

// create new manager instance with desired driver
$manager = ImageManager::usingDriver(Driver::class);

// read an image
$image = $manager->decode('images/example.png');

// flood fill image with color
$image = $image->fill('#b53717', 10, 10);

Draw Pixels

public Image::drawPixel(int $x, int $y, string|ColorInterface $color): ImageInterface

Draw a single pixel at the specified position defined by the coordinates x and y in a given color.

Parameters

Name	Type	Description
x	integer	Position of pixel on x-axis of the current image
y	integer	Position of pixel on y-axis of the current image
color	string or ColorInterface	Color of the pixel in a valid format

Example

use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Imagick\Driver;
use Intervention\Image\Color;
use Intervention\Image\Colors\NamedColor;

// create an test image from a file
$image = ImageManager::usingDriver(Driver::class)->decode('test.png');

// draw pixels at different positions with different color formats
$image->drawPixel(200, 2, Color::rgb(255, 55, 0, .2));
$image->drawPixel(12, 30, 'ff00ff');
$image->drawPixel(100, 1, 'rgb(255, 255, 0)');
$image->drawPixel(200, 2, 'orange');
$image->drawPixel(200, 2, NamedColor::STEELBLUE);

Geometric Shapes

Draw a Rectangle

public Image::drawRectangle(callable|Rectangle $rectangle): ImageInterface

Draw a rectangle on the current image. Define the overall appearance of the shape by passing an callback or a rectangle object.

Parameters

Name	Type	Description
rectangle	callable or Intervention\Image\Geometry\Rectangle	The rectangle or a callback on a rectangle factory. See example.

Example

use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Gd\Driver;
use Intervention\Image\Geometry\Factories\RectangleFactory;

// create an test image from a file
$image = ImageManager::usingDriver(Driver::class)->decode('test.png');

// draw an orange rectangle with a border
$image->drawRectangle(function (RectangleFactory $rectangle): void {
    $rectangle->at(10, 10); // position of the rectangle on the image
    $rectangle->size(180, 125); // width & height of rectangle
    $rectangle->background('ff5500'); // background color of rectangle
    $rectangle->border('white', 2); // border color & size of rectangle
});

Draw Ellipses

public Image::drawEllipse(callable|Ellipse $ellipse): ImageInterface

Draw a ellipse on the current image. Define the overall appearance of the shape by passing an callback or a ellipse object.

Parameters

Name	Type	Description
ellipse	callable or Intervention\Image\Geometry\Ellipse	The ellipse or a callback on a ellipse factory. See example.

Example

use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Gd\Driver;
use Intervention\Image\Geometry\Factories\EllipseFactory;

// create an test image from a file
$image = ImageManager::usingDriver(Driver::class)->decode('test.png');

// draw an ellipse with a border
$image->drawEllipse(function (EllipseFactory $ellipse): void {
    $ellipse->at(10, 10); // position of the ellipse on the image
    $ellipse->size(180, 125); // width & height of ellipse
    $ellipse->background('ff5500'); // background color of ellipse
    $ellipse->border('white', 2); // border color & size of ellipse
});

Draw a Circle

public Image::drawCircle(callable|Circle $circle): ImageInterface

Draw a circle on the current image. Define the overall appearance of the shape by passing an callback or a circle object.

Parameters

Name	Type	Description
circle	callable or Intervention\Image\Geometry\Circle	The circle or a callback on a circle factory. See example.

Example

use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Gd\Driver;
use Intervention\Image\Geometry\Factories\CircleFactory;

// create an test image from a file
$image = ImageManager::usingDriver(Driver::class)->decode('test.png');

// draw an circle with a border
$image->drawCircle(function (CircleFactory $circle): void {
    $circle->at(10, 10); // position of the circle on the image
    $circle->diameter(180); // diameter of circle
    $circle->background('ff5500'); // background color of circle
    $circle->border('white', 2); // border color & size of circle
});

Draw a Line

public Image::drawLine(callable|Line $line): ImageInterface

Draw a line on the current image. Define the overall appearance of the shape by passing an callback or a line object.

Parameters

Name	Type	Description
line	callable or Intervention\Image\Geometry\line	The line or a callback on a line factory. See example.

Example

use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Gd\Driver;
use Intervention\Image\Geometry\Factories\LineFactory;

// create an test image from a file
$image = ImageManager::usingDriver(Driver::class)->decode('test.png');

// draw a line
$image->drawline(function (LineFactory $line): void {
    $line->from(10, 10);
    $line->to(180, 25);
    $line->color('ff5500');
});

Draw a Polygon

public Image::drawPolygon(callable|Polygon $polygon): ImageInterface

Draw a polygon on the current image. Define the overall appearance of the shape by passing an callback or a polygon object.

Parameters

Name	Type	Description
polygon	callable or Intervention\Image\Geometry\Polygon	The polygon or a callback on a polygon factory. See example.

Example

use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Gd\Driver;
use Intervention\Image\Geometry\Factories\PolygonFactory;

// create an test image from a file
$image = ImageManager::usingDriver(Driver::class)->decode('test.png');

// draw a polygon
$image->drawpolygon(function (PolygonFactory $polygon): void {
    $polygon->background('ff5500');
    $polygon->point(100, 100);
    $polygon->point(10, 10);
    $polygon->point(20, 10);
    $polygon->point(90, 110);
    $polygon->point(130, 10);
});

Draw Bezier Curves

public Image::drawBezier(callable|Bezier $bezier): ImageInterface

This method draws Bézier curves, the shape of which is defined by a set of control points specified in the callback. The type of curve drawn depends on the number of control points specified, which must be either three or four. With three control points, the result is a quadratic Bézier curve, while four points result in a cubic Bézier curve. The first and last control points define the start and end points of the curve.

The color, width and background color of the curve can also be set.

Parameters

Name	Type	Description
init	Closure or Intervention\Image\Geometry\Bezier	Callback to define the appearance and position of the bézier curve or object. See example.

Example

use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Gd\Driver;
use Intervention\Image\Geometry\Factories\BezierFactory;

// create a new image
$image = ImageManager::usingDriver(Driver::class)
    ->createImage(500, 500)
    ->fill('666');

// draw a yellow quadratic bezier curve with a filled red background
$image->drawBezier(function (BezierFactory $bezier) {
    $bezier->point(300, 260); // control point 1
    $bezier->point(150, 335); // control point 2
    $bezier->point(300, 410); // control point 3
    $bezier->background('f00'); // background color
    $bezier->border('ff0'); // border color
});

// draw a 4px red cubic bezier curve with four control points
$image->drawBezier(function (BezierFactory $bezier) {
    $bezier->point(50, 50); // control point 1
    $bezier->point(200, 50); // control point 2
    $bezier->point(150, 200); // control point 3
    $bezier->point(300, 200); // control point 4
    $bezier->border('ff0000', 4); // border color & size
});