Resizing images

##Width and height

The width and height of the Image can be modified by calling the width and height functions and passing in the desired dimensions in pixels. The resized image will be contained within the given $width and $height dimensions respecting the original aspect ratio.

$image->width(int $width);
$image->height(int $height);

##Example usage

Image::load('example.jpg')
    ->width(250)
    ->height(250)
    ->save();

##Resize

If you want to resize both height and width at the same time you can use the resize method.

Image::load('example.jpg')->resize(250, 200);

##Fit

The fit method fits the image within the given $width and $height dimensions (pixels) using a certain $fitMethod.

$image->fit(Fit $fit, int $width, int $height);

The following $fits are available through the Fit enum:

##Fit::Contain

Resizes the image to fit within the width and height boundaries without cropping, distorting or altering the aspect ratio.

##Fit::Max

Resizes the image to fit within the width and height boundaries without cropping, distorting or altering the aspect ratio, and will also not increase the size of the image if it is smaller than the output size.

##Fit::Fill

Resizes the image to fit within the width and height boundaries without cropping or distorting the image, and the remaining space is filled with the background color. The resulting image will match the constraining dimensions.

##Fit::Stretch

Stretches the image to fit the constraining dimensions exactly. The resulting image will fill the dimensions, and will not maintain the aspect ratio of the input image.

##Fit::Crop

Resizes the image to fill the width and height boundaries and crops any excess image data. The resulting image will match the width and height constraints without distorting the image.

##Fit::FillMax

Resizes the image to fit within the width and height boundaries without cropping but upscaling the image if it’s smaller. The finished image will have remaining space on either width or height (except if the aspect ratio of the new image is the same as the old image). The remaining space will be filled with the background color. The resulting image will match the constraining dimensions.

# Example of how to set background colour to fill remaining pixels
use Spatie\Image\Enums\Fit;

$image
    ->fit(fit: Fit::FillMax, desiredWidth:  497,  desiredHeight: 290, backgroundColor: '#ff5733');

##Example usage

use Spatie\Image\Enums\Fit;

Image::load('example.jpg')
    ->fit(Fit:Stretch, 450, 150)
    ->save();

##Crop

By calling the crop method part of the image will be cropped to the given $width and $height dimensions (pixels). Use the $cropMethod to specify which part will be cropped out.

$image->crop(int $width, int $height, CropPosition $position = CropPosition::Center);

The following CropPositions are available on the enum: TopLeft, Top, TopRight, Left, Center, Right, BottomLeft, Bottom, BottomRight.

##Example usage

use Spatie\Image\Enums\CropPosition;

Image::load('example.jpg')
    ->crop(250, 250, CropPosition::TopRight)
    ->save();

##Focal crop

The focalCrop method can be used to crop around an exact position. The center of the crop is controlled by the $focalX and $focalY values in percent (0 - 100).

You can also zoom into your focal point, if needed. Zoom is controlled by a floating point ranging from 1 to 100. Each step represents a 100% zoom, so passing 2 will be the same as viewing the image at 200%. The suggested range is 1-10.

$image->focalCrop(int $width, int $height, int $cropCenterX = null, $cropCenterY = null);

##Manual crop

The manualCrop method crops a specific area of the image by specifying the $startX and $startY positions and the crop's $width and $height in pixels.

$image->manualCrop(int $width, int $height, int $x, int $y);

##Example usage

Image::load('example.jpg')
    ->manualCrop(600, 400, 20, 620)
    ->save();