Spatie Image

https://github.com/spatie/image
Admin
A PHP package for manipulating images with an expressive API, supporting resizing, cropping,...
Tokens:67,716
Snippets:445
Trust Score:10
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install spatie/image via Composer

Source: https://github.com/spatie/image/blob/main/docs/installation-and-setup.md

Use Composer to install the spatie/image package. The package supports three image drivers: Imagick (default), GD, and Vips.

```bash
composer require spatie/image
```

--------------------------------

### Install PHP bindings for Vips driver

Source: https://github.com/spatie/image/blob/main/docs/installation-and-setup.md

Require the PHP bindings for the Vips driver via Composer. Requires libvips to be installed on your system. Vips is faster and uses less memory than Imagick or GD, ideal for large images or high-volume processing.

```bash
composer require jcupitt/vips
```

--------------------------------

### Image manipulation examples with Spatie Image

Source: https://github.com/spatie/image/blob/main/README.md

Shows how to use the Spatie Image package to resize, convert to greyscale, adjust brightness and quality, and rotate/sharpen images. Each example loads an image, applies operations, and saves the result.

```php
use Spatie\Image\Image;

// modifying the image so it fits in a 100x100 rectangle without altering aspect ratio
Image::load($pathToImage)
   ->width(100)
   ->height(100)
   ->save($pathToNewImage);
   
// overwriting the original image with a greyscale version   
Image::load($pathToImage)
   ->greyscale()
   ->save();
   
// make image darker and save it in low quality
Image::load($pathToImage)
   ->brightness(-30)
   ->quality(25)
   ->save();
   
// rotate the image and sharpen it
Image::load($pathToImage)
   ->orientation(90)
   ->sharpen(15)
   ->save();
```

--------------------------------

### Testing commands

Source: https://github.com/spatie/image/blob/main/README.md

Commands to install pixelmatch and run the test suite.

```bash
npm i pixelmatch
composer test
```

--------------------------------

### Fit::FillMax example with background color

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Example of setting background colour to fill remaining pixels when using Fit::FillMax. Requires importing Spatie\Image\Enums\Fit.

```php
# 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 of fit with Fit::Stretch

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Loads an image and stretches it to 450x150 using Fit::Stretch, then saves.

```php
use Spatie\Image\Enums\Fit;

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

--------------------------------

### Example usage of width and height

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Loads an image and sets both width and height to 250 pixels, then saves.

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

--------------------------------

### Example usage of crop

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Loads an image and crops to 250x250 from the top-right corner, then saves.

```php
use Spatie\Image\Enums\CropPosition;

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

--------------------------------

### Apply repeated manipulations immediately

Source: https://github.com/spatie/image/blob/main/docs/usage/basic-usage.md

Each manipulation call is applied immediately. Calling the same method multiple times applies each call in sequence. This example lowers brightness by 40% then by 20%.

```php
use Spatie\Image\Image;

// This will lower the brightness first by 40% and then by 20%
Image::load('example.jpg')
    ->brightness(-40)
    ->brightness(-20)
    ->save();
```

--------------------------------

### Save the image to a specified file

Source: https://github.com/spatie/image/blob/main/docs/usage/basic-usage.md

Calling `save` on an `Image` saves the modifications to the specified file. This example resizes the width to 50 and saves as 'modified-example.jpg'.

```php
use Spatie\Image\Image;

Image::load('example.jpg')
    ->width(50)
    ->save('modified-example.jpg');
```

--------------------------------

### Get image width and height with Image::load()->getWidth() and getHeight()

Source: https://github.com/spatie/image/blob/main/docs/usage/retrieving-properties.md

Use these methods to retrieve the dimensions of an image. The getWidth() method returns the width in pixels, and getHeight() returns the height in pixels. The example shows loading 'example.jpg' and getting width 1600 and height 1052.

```php
Image::load('example.jpg')->getWidth() // returns 1600
Image::load('example.jpg')->getHeight() // returns 1052
```

--------------------------------

### Apply chained image manipulations

Source: https://github.com/spatie/image/blob/main/docs/usage/basic-usage.md

Apply any image manipulation method to the loaded `Image`. All manipulation methods can be chained. This example applies sepia and blur effects before saving.

```php
use Spatie\Image\Image;

Image::load('example.jpg')
    ->sepia()
    ->blur(50)
    ->save();
```

--------------------------------

### Retrieve a base64 string with custom parameters

Source: https://github.com/spatie/image/blob/main/docs/usage/basic-usage.md

Pass extra parameters to `base64` to alter the format and whether to prefix with the mime type. This example uses 'jpeg' format and disables the prefix.

```php
Image::load('example.jpg')
    ->base64('jpeg', $prefixWithFormat = false);
```

--------------------------------

### Set watermark size with width and height units

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/adding-a-watermark.md

Sets the watermark width and height, optionally using percentages. The example covers the top half of the image.

```php
$image->watermark('watermark.png',
    AlignPosition::Top,
	width: 100,
	widthUnit: Unit::Percent,
	height: 50,
	heightUnit: Unit::Percent
);
```

--------------------------------

### Manual crop method signature

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Crops a specific area by specifying start positions and dimensions in pixels.

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

--------------------------------

### Set watermark padding with unit

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/adding-a-watermark.md

Sets padding around the watermark using pixels or percentages. The example uses 10% padding.

```php
$image->watermark('watermark.png',
    paddingX: 10,
    paddingY: 10,
    paddingUnit: Unit::Percent
); // 10% padding around the watermark
```

--------------------------------

### manualCrop(int $width, int $height, int $x, int $y)

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Crops a specific area of the image by specifying the starting position and the crop dimensions in pixels.

```APIDOC
## manualCrop(int $width, int $height, int $x, int $y)

### Description
Crops a specific area of the image by specifying the starting position and the crop dimensions in pixels.

### Method
manualCrop

### Parameters
- **$width** (int) - Required - The desired width of the crop in pixels.
- **$height** (int) - Required - The desired height of the crop in pixels.
- **$x** (int) - Required - The X coordinate of the starting position.
- **$y** (int) - Required - The Y coordinate of the starting position.

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

--------------------------------

### Set watermark opacity with alpha parameter

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/adding-a-watermark.md

Sets the opacity of the watermark as a percentage between 0 and 100. The example uses 50% opacity.

```php
$image->watermark('watermark.png',alpha: 50);
```

--------------------------------

### Set watermark fit resize with Fit::Stretch

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/adding-a-watermark.md

Changes how the watermark is resized within the given boundaries using a Fit enum value. The example stretches the watermark over the bottom half.

```php
$image->watermark('watermark.png',AlignPosition::Top,
	width:100,widthUnit:Unit::Percent,
	height:50,heightUnit:Unit::Percent,
	fit: Fit::Stretch);
```

--------------------------------

### Creating an Image instance in v3

Source: https://github.com/spatie/image/blob/main/docs/upgrading.md

Shows the three ways to create a new image instance in v3: via constructor, static load method, or selecting a driver first.

```php
// 1. By passing the path to the image in the constructor.
$image = new Image('path/to/image.jpg');

// 2. Using the static load method. 
$image = Image::load('path/to/image.jpg');

// 3. Selecting a driver and then loading the image.
$image = Image::useImageDriver(ImageDriver::Imagick)->load('path/to/image.jpg');
```

--------------------------------

### Select a driver with Image::useImageDriver

Source: https://github.com/spatie/image/blob/main/docs/usage/basic-usage.md

By default, the Imagick driver is used. The package supports Imagick, GD, and Vips. Use `Image::useImageDriver` with the `ImageDriver` enum to select GD or Vips. Vips requires libvips and the `jcupitt/vips` package.

```php
use Spatie\Image\Image;
use Spatie\Image\Enums\ImageDriver;

// Use GD
Image::useImageDriver(ImageDriver::Gd)->loadFile(string $pathToImage);

// Use Vips (requires libvips and jcupitt/vips package)
Image::useImageDriver(ImageDriver::Vips)->loadFile(string $pathToImage);
```

--------------------------------

### Load an image with Image::load

Source: https://github.com/spatie/image/blob/main/docs/usage/basic-usage.md

Load an image by calling the static `load` method on the `Image` class and passing the path to the image.

```php
use Spatie\Image\Image;

$image = Image::load(string $pathToImage);
```

--------------------------------

### Convert transparent PNG to JPG

Source: https://github.com/spatie/image/blob/main/docs/introduction.md

Converts a PNG to JPG by saving with a .jpg extension. Applies fit, background, and border manipulations before saving.

```php
Image::load('github-logo.png')
    ->fit(Fit::Fill, 500, 300)
    ->background('lightblue')
    ->border(15, BorderType::Expand, '007698')
    ->save('example.jpg');
```

--------------------------------

### Pass a custom ImageDriver implementation

Source: https://github.com/spatie/image/blob/main/docs/usage/basic-usage.md

You can pass an implementation of `ImageDriver` directly to `useImageDriver`. Build your own driver from scratch or extend one of the provided drivers (`ImagickDriver`, `GdDriver`, or `VipsDriver`).

```php
use Spatie\Image\Image;

Image::useImageDriver(MyDriver::class)->loadFile(string $pathToImage);
```

--------------------------------

### Manual crop with manualCrop

Source: https://github.com/spatie/image/blob/main/docs/introduction.md

Uses the manualCrop method to crop a specific region of the image. Parameters specify width, height, and x/y offsets.

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

--------------------------------

### Optimize an image with the optimize method

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/optimizing-images.md

Call the `optimize` method on an Image instance to reduce file size. The optimization is performed as the last operation in the chain, regardless of where it is called.

```php
Image::load('example.jpg')
    ->optimize()
    ->save('example-optimized.jpg');
```

--------------------------------

### Resize method

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Resize both width and height at the same time using the resize method.

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

--------------------------------

### Set font size with fontSize parameter

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/text.md

Sets the font size in pixels using the `fontSize` parameter.

```php
$image->text('Hello there!', fontSize: 100);
```

--------------------------------

### Set text position with x and y parameters

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/text.md

Positions the text at specific coordinates using the `x` and `y` parameters.

```php
$image->text('Hello there!', x: 10, y: 10);
```

--------------------------------

### resize(int $width, int $height)

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Resizes both the width and height of the image at the same time. The image will be resized to the given dimensions.

```APIDOC
## resize(int $width, int $height)

### Description
Resizes both the width and height of the image at the same time. The image will be resized to the given dimensions.

### Method
resize

### Parameters
- **$width** (int) - Required - The desired width in pixels.
- **$height** (int) - Required - The desired height in pixels.

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

--------------------------------

### Customize optimization with OptimizerChain and setTimeout

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/optimizing-images.md

Pass a custom OptimizerChain to the `optimize` method to configure optimizers and set a timeout. The default timeout is 60 seconds; adjust it for large images.

```php
$optimizerChain = (new OptimizerChain)
    ->addOptimizer(new Jpegoptim([
        '--strip-all',
        '--all-progressive',
        '-m85'
    ]))
    ->setTimeout(90);

Image::load('example.jpg')
    ->optimize($optimizerChain)
    ->save();
```

--------------------------------

### Retrieve a base64 string with default format

Source: https://github.com/spatie/image/blob/main/docs/usage/basic-usage.md

Calling `base64` on an `Image` returns a base64 string of the image. By default, it is formatted as a jpeg and includes the mime type.

```php
use Spatie\Image\Image;

Image::load('example.jpg')
    ->base64();
```

--------------------------------

### fit(Fit $fit, int $width, int $height)

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Fits the image within the given width and height dimensions using a specified fit method. The fit method determines how the image is resized and whether cropping or background filling occurs.

```APIDOC
## fit(Fit $fit, int $width, int $height)

### Description
Fits the image within the given width and height dimensions using a specified fit method. The fit method determines how the image is resized and whether cropping or background filling occurs.

### Method
fit

### Parameters
- **$fit** (Fit) - Required - The fit method to use. Available values: `Fit::Contain`, `Fit::Max`, `Fit::Fill`, `Fit::Stretch`, `Fit::Crop`, `Fit::FillMax`.
- **$width** (int) - Required - The desired width in pixels.
- **$height** (int) - Required - The desired height in pixels.

### Fit Methods
- **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
```php
use Spatie\Image\Enums\Fit;

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

--------------------------------

### Wrap text with width parameter

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/text.md

Defines a maximum width in pixels for the text using the `width` parameter. The package automatically wraps the text to fit within this width.

```php
$image->text('Hello there! This is a long piece of text that we should wrap.', width: 1000);
```

--------------------------------

### Save image with default behavior

Source: https://github.com/spatie/image/blob/main/docs/usage/saving-images.md

Applies manipulations and saves to the original file.

```php
Image::load('example.jpg')
    ->sepia()
    ->save();
```

--------------------------------

### Sepia and blur effect

Source: https://github.com/spatie/image/blob/main/docs/introduction.md

Chains the sepia() and blur() methods to apply a sepia tone and blur effect to an image, then saves it. The blur level is set to 50.

```php
Image::load('example.jpg')
    ->sepia()
    ->blur(50)
    ->save();
```

--------------------------------

### Focal crop method signature

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Crops around an exact position using focalX and focalY percentages (0-100). Optional zoom from 1 to 100, suggested 1-10.

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

--------------------------------

### Specify font family with fontPath parameter

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/text.md

Specifies a path to a font file using the `fontPath` parameter. This parameter is required when using the `GD` driver.

```php
$image->text('Hello there!', fontPath: __DIR__ . '/arial.ttf');
```

--------------------------------

### Save image to a new location

Source: https://github.com/spatie/image/blob/main/docs/usage/saving-images.md

Passes an optional output path to save a copy.

```php
Image::load('example.jpg')
    ->sepia()
    ->save('sepia-example.jpg');
```

--------------------------------

### Adjust contrast with contrast()

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/adjustments.md

Adjusts the contrast of the image. Accepts a value between -100 and 100.

```php
$image->contrast(20);
```

--------------------------------

### Save image in a different format

Source: https://github.com/spatie/image/blob/main/docs/usage/saving-images.md

Changes the extension in the output path to save as a different format.

```php
Image::load('example.jpg')
    ->save('example.png');
```

--------------------------------

### Width and height methods

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Modify the width or height of an image, preserving aspect ratio. Pass desired dimensions in pixels.

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

--------------------------------

### width(int $width)

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Sets the width of the image in pixels, maintaining the aspect ratio. The image will be contained within the given width.

```APIDOC
## width(int $width)

### Description
Sets the width of the image in pixels, maintaining the aspect ratio. The image will be contained within the given width.

### Method
width

### Parameters
- **$width** (int) - Required - The desired width in pixels.

### Example
```php
Image::load('example.jpg')->width(250)->save();
```
```

--------------------------------

### Colorize image with colorize()

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/adjustments.md

Colorizes the image. Accepts values between -100 and 100 for red, green, and blue.

```php
$image->colorize(100, 0, 0);
```

--------------------------------

### height(int $height)

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Sets the height of the image in pixels, maintaining the aspect ratio. The image will be contained within the given height.

```APIDOC
## height(int $height)

### Description
Sets the height of the image in pixels, maintaining the aspect ratio. The image will be contained within the given height.

### Method
height

### Parameters
- **$height** (int) - Required - The desired height in pixels.

### Example
```php
Image::load('example.jpg')->height(250)->save();
```
```

--------------------------------

### Crop method signature

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Crops part of the image to given dimensions. Specify crop position via CropPosition enum, default is Center.

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

--------------------------------

### Image::load()->getWidth()

Source: https://github.com/spatie/image/blob/main/docs/usage/retrieving-properties.md

Retrieves the width of the loaded image in pixels. This method is called on an Image instance created by the load method.

```APIDOC
## Image::load()->getWidth()

### Description
Retrieves the width of the loaded image in pixels.

### Method
`getWidth()`

### Parameters
None

### Return Value
- **int** - The width of the image in pixels.

### Example
```php
Image::load('example.jpg')->getWidth() // returns 1600
```
```

--------------------------------

### Adjust brightness with brightness()

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/adjustments.md

Adjusts the brightness of the image. Accepts a value between -100 and 100.

```php
$image->brightness(-20);
```

--------------------------------

### Fit method signature

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Fits the image within given dimensions using a specified fit method from the Fit enum.

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

--------------------------------

### Adjust gamma with gamma()

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/adjustments.md

Adjusts the gamma of the image. Accepts a value between 0.1 and 9.99.

```php
$image->gamma(4.1);
```

--------------------------------

### text()

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/text.md

Adds text to an image. By default, the text is placed in the top left corner. Supports positioning, font size, color, font path, and wrapping.

```APIDOC
## text()

### Description
Adds text to an image. By default, the text is placed in the top left corner. Supports positioning, font size, color, font path, and wrapping.

### Method
`text`

### Parameters
- **text** (string) - Required - The text to add to the image.
- **x** (int) - Optional - The x-coordinate for the text position. Defaults to 0 (top left).
- **y** (int) - Optional - The y-coordinate for the text position. Defaults to 0 (top left).
- **fontSize** (int) - Optional - The font size in pixels.
- **color** (string) - Optional - The font color. Can be a color name or hexadecimal RGB(A).
- **fontPath** (string) - Required when using GD - The path to the font file.
- **width** (int) - Optional - The maximum width in pixels for text wrapping.

### Example Usage
```php
$image->text('Hello there!');
$image->text('Hello there!', x: 10, y: 10);
$image->text('Hello there!', fontSize: 100);
$image->text('Hello there!', color: '');
$image->text('Hello there!', fontPath: __DIR__ . '/arial.ttf');
$image->text('Hello there! This is a long piece of text that we should wrap.', width: 1000);
```

```

--------------------------------

### Set font color with color parameter

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/text.md

Sets the font color using the `color` parameter. The color can be a color name or hexadecimal RGB(A).

```php
$image->text('Hello there!', color: '');
```

--------------------------------

### Image::load()->getHeight()

Source: https://github.com/spatie/image/blob/main/docs/usage/retrieving-properties.md

Retrieves the height of the loaded image in pixels. This method is called on an Image instance created by the load method.

```APIDOC
## Image::load()->getHeight()

### Description
Retrieves the height of the loaded image in pixels.

### Method
`getHeight()`

### Parameters
None

### Return Value
- **int** - The height of the image in pixels.

### Example
```php
Image::load('example.jpg')->getHeight() // returns 1052
```
```

--------------------------------

### watermark()

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/adding-a-watermark.md

Adds a watermark to the image. By default, the watermark is placed in the bottom right corner. Supports positioning, padding, size, fit, and opacity options.

```APIDOC
## watermark()

### Description
Adds a watermark to the image. By default, the watermark is placed in the bottom right corner. Supports positioning, padding, size, fit, and opacity options.

### Method
watermark()

### Parameters
- **$watermark** (string) - Required - Path to the watermark image file.
- **$position** (AlignPosition) - Optional - Position of the watermark. Default: AlignPosition::BottomRight.
- **$paddingX** (int) - Optional - Horizontal padding from the edges. Default: 0.
- **$paddingY** (int) - Optional - Vertical padding from the edges. Default: 0.
- **$paddingUnit** (Unit) - Optional - Unit for padding values. Default: Unit::Pixel.
- **$width** (int) - Optional - Width of the watermark. Default: null (auto).
- **$height** (int) - Optional - Height of the watermark. Default: null (auto).
- **$widthUnit** (Unit) - Optional - Unit for width. Default: Unit::Pixel.
- **$heightUnit** (Unit) - Optional - Unit for height. Default: Unit::Pixel.
- **$fit** (Fit) - Optional - Fit mode for resizing. Default: Fit::Contain.
- **$alpha** (int) - Optional - Opacity percentage (0-100). Default: 100.

### Example Usage
```php
$image->watermark('watermark.png');
```

### Response
Returns the image instance for method chaining.
```

--------------------------------

### Sharpen image with sharpen method

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/effects.md

Sharpens the image using the sharpen method. The method accepts a value between 0 and 100.

```php
$image->sharpen(40);
```

--------------------------------

### Pick pixel color with pickColor method

Source: https://github.com/spatie/image/blob/main/docs/usage/colors.md

Use the pickColor method to retrieve the color of a pixel at specified coordinates. The method returns a color in the format specified by the ColorFormat enum, such as Rgba, Hex, Int, or Array.

```php
$image = Image::load(string $pathToImage)->pickColor($x, $y, ColorFormat::Rgba);
```

--------------------------------

### crop(int $width, int $height, CropPosition $position = CropPosition::Center)

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Crops a part of the image to the given width and height dimensions. The crop position determines which part of the image is cropped out.

```APIDOC
## crop(int $width, int $height, CropPosition $position = CropPosition::Center)

### Description
Crops a part of the image to the given width and height dimensions. The crop position determines which part of the image is cropped out.

### Method
crop

### Parameters
- **$width** (int) - Required - The desired width in pixels.
- **$height** (int) - Required - The desired height in pixels.
- **$position** (CropPosition) - Optional - The crop position. Defaults to `CropPosition::Center`. Available values: `TopLeft`, `Top`, `TopRight`, `Left`, `Center`, `Right`, `BottomLeft`, `Bottom`, `BottomRight`.

### Example
```php
use Spatie\Image\Enums\CropPosition;

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

--------------------------------

### Add watermark with default position

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/adding-a-watermark.md

Places the watermark in the bottom right corner by default.

```php
$image->watermark('watermark.png');
```

--------------------------------

### Add text with default position

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/text.md

Uses the `text` method to add text to an image. By default, the text is placed in the top left corner.

```php
$image->text('Hello there!');
```

--------------------------------

### Convert image to greyscale

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/effects.md

Converts the image to greyscale using the greyscale method.

```php
$image->greyscale();
```

--------------------------------

### Change JPEG quality

Source: https://github.com/spatie/image/blob/main/docs/usage/saving-images.md

Sets JPEG quality in percent (0-100) before saving.

```php
Image::load('example.jpg')
    ->quality(20)
    ->save();
```

--------------------------------

### Set watermark position with AlignPosition enum

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/adding-a-watermark.md

Positions the watermark using an AlignPosition enum value, e.g., center.

```php
$image->watermark('watermark.png', AlignPosition::center);
```

--------------------------------

### greyscale

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/effects.md

Converts the image to greyscale.

```APIDOC
## greyscale

### Description
Converts the image to greyscale.

### Method
`greyscale`

### Parameters
None.

### Example
```php
$image->greyscale();
```
```

--------------------------------

### Add border to image with width, type, and color

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/image-canvas.md

Adds a border with specified width, border type, and color. The border type can be Overlay, Shrink, or Expand.

```php
$image->border(15, BorderType::Shrink, '007698');
```

--------------------------------

### contrast

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/adjustments.md

Adjusts the contrast of the image. Accepts a value between -100 and 100.

```APIDOC
## contrast

### Description
Adjusts the contrast of the image. Accepts a value between -100 and 100.

### Method
contrast

### Parameters
- **value** (int) - Required - Contrast adjustment value between -100 and 100.

### Request Example
```php
$image->contrast(20);
```
```

--------------------------------

### focalCrop(int $width, int $height, int $cropCenterX = null, $cropCenterY = null)

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/resizing-images.md

Crops the image around a focal point specified by the center coordinates in percent (0-100). Optionally, a zoom level can be applied to zoom into the focal point.

```APIDOC
## focalCrop(int $width, int $height, int $cropCenterX = null, $cropCenterY = null)

### Description
Crops the image around a focal point specified by the center coordinates in percent (0-100). Optionally, a zoom level can be applied to zoom into the focal point.

### Method
focalCrop

### Parameters
- **$width** (int) - Required - The desired width in pixels.
- **$height** (int) - Required - The desired height in pixels.
- **$cropCenterX** (int) - Optional - The X coordinate of the focal point in percent (0-100). Defaults to null.
- **$cropCenterY** (int) - Optional - The Y coordinate of the focal point in percent (0-100). Defaults to null.

### Notes
- 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.
```

--------------------------------

### flip

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/image-canvas.md

Flips or mirrors the image horizontally, vertically, or both.

```APIDOC
## flip

### Description
Flips or mirrors the image horizontally, vertically, or both.

### Method
`flip`

### Parameters
- `$direction` (FlipDirection) - Required - Direction of flip: `FlipDirection::Vertical`, `FlipDirection::Horizontal`, or `FlipDirection::Both`.

### Example
```php
$image->flip(FlipDirection::Horizontal);
```
```

--------------------------------

### Add sepia filter to image

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/effects.md

Adds a sepia filter to the image using the sepia method.

```php
$image->sepia();
```

--------------------------------

### Flip or mirror image horizontally, vertically, or both

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/image-canvas.md

Flips or mirrors the image in the specified direction. Accepted values are Vertical, Horizontal, and Both.

```php
$image->flip(FlipDirection::Horizontal);
```

--------------------------------

### pickColor

Source: https://github.com/spatie/image/blob/main/docs/usage/colors.md

Picks the color of a pixel at a given coordinate in the image. The color format can be specified using one of the available ColorFormat constants.

```APIDOC
## pickColor

### Description
Picks the color of a pixel at a given coordinate in the image. The color format can be specified using one of the available ColorFormat constants.

### Method
pickColor

### Endpoint
Image::load(string $pathToImage)->pickColor($x, $y, ColorFormat::Rgba)

### Parameters
- **$x** (int) - Required - The x-coordinate of the pixel.
- **$y** (int) - Required - The y-coordinate of the pixel.
- **$format** (ColorFormat) - Required - The format of the returned color. Available formats: `ColorFormat::Rgba`, `ColorFormat::Hex`, `ColorFormat::Int`, `ColorFormat::Array`.

### Request Example
```php
$image = Image::load(string $pathToImage)->pickColor($x, $y, ColorFormat::Rgba);
```

### Response
Returns a color value in the specified format:
- `ColorFormat::Rgba` - Returns a color in the format `rgba(255, 255, 255, 1)`
- `ColorFormat::Hex` - Returns a color in the format `#ffffff`
- `ColorFormat::Int` - Returns a color in the format `16777215`
- `ColorFormat::Array` - Returns a color in the format `[255, 255, 255, 1]`
```

--------------------------------

### Blur image with blur method

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/effects.md

Applies a blur effect to the image. The blur method accepts a value between 0 and 100.

```php
$image->blur(50);
```

--------------------------------

### brightness

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/adjustments.md

Adjusts the brightness of the image. Accepts a value between -100 and 100.

```APIDOC
## brightness

### Description
Adjusts the brightness of the image. Accepts a value between -100 and 100.

### Method
brightness

### Parameters
- **value** (int) - Required - Brightness adjustment value between -100 and 100.

### Request Example
```php
$image->brightness(-20);
```
```

--------------------------------

### sharpen

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/effects.md

Sharpens the image. Accepts a value between 0 and 100.

```APIDOC
## sharpen

### Description
Sharpens the image. Accepts a value between 0 and 100.

### Method
`sharpen`

### Parameters
- **value** (int) - Required - Sharpening intensity between 0 and 100.

### Example
```php
$image->sharpen(40);
```
```

--------------------------------

### sepia

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/effects.md

Adds a sepia filter to the image.

```APIDOC
## sepia

### Description
Adds a sepia filter to the image.

### Method
`sepia`

### Parameters
None.

### Example
```php
$image->sepia();
```
```

--------------------------------

### border

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/image-canvas.md

Adds a border with a specified width, border type, and color to the image. The border type determines how the border is applied (overlay, shrink, or expand).

```APIDOC
## border

### Description
Adds a border with a specified width, border type, and color to the image. The border type determines how the border is applied (overlay, shrink, or expand).

### Method
`border`

### Parameters
- `$width` (int) - Required - Width of the border.
- `$borderType` (BorderType) - Required - Type of border: `BorderType::Overlay`, `BorderType::Shrink`, or `BorderType::Expand`.
- `$color` (string) - Required - Color of the border (hexadecimal RGB(A) or color name).

### Example
```php
$image->border(15, BorderType::Shrink, '007698');
```
```

--------------------------------

### colorize

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/adjustments.md

Colorizes the image. Accepts values between -100 and 100 for red, green, and blue.

```APIDOC
## colorize

### Description
Colorizes the image. Accepts values between -100 and 100 for red, green, and blue.

### Method
colorize

### Parameters
- **red** (int) - Required - Red adjustment value between -100 and 100.
- **green** (int) - Required - Green adjustment value between -100 and 100.
- **blue** (int) - Required - Blue adjustment value between -100 and 100.

### Request Example
```php
$image->colorize(100, 0, 0);
```
```

--------------------------------

### gamma

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/adjustments.md

Adjusts the gamma of the image. Accepts a value between 0.1 and 9.99.

```APIDOC
## gamma

### Description
Adjusts the gamma of the image. Accepts a value between 0.1 and 9.99.

### Method
gamma

### Parameters
- **value** (float) - Required - Gamma adjustment value between 0.1 and 9.99.

### Request Example
```php
$image->gamma(4.1);
```
```

--------------------------------

### background

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/image-canvas.md

Sets the background color for transparent images. The color can be a color name or hexadecimal RGB(A) value.

```APIDOC
## background

### Description
Sets the background color for transparent images. The color can be a color name or hexadecimal RGB(A) value.

### Method
`background`

### Parameters
- `$color` (string) - Required - Color name or hexadecimal RGB(A) value.

### Example
```php
$image->background('darkgray');
```
```

--------------------------------

### Rotate image using Orientation enum

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/image-canvas.md

Rotates the image by passing an Orientation enum value. When no parameters are passed, orientation is derived from EXIF data.

```php
$image->orientation(Orientation::Rotate180);
```

```php
$image->orientation();
```

--------------------------------

### Set background color for transparent images

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/image-canvas.md

Sets the background color for transparent images. The color can be a color name or hexadecimal RGB(A).

```php
$image->background('darkgray');
```

--------------------------------

### orientation

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/image-canvas.md

Rotates the image based on an Orientation enum value. If no parameters are passed, the orientation is derived from the EXIF data of the image.

```APIDOC
## orientation

### Description
Rotates the image based on an Orientation enum value. If no parameters are passed, the orientation is derived from the EXIF data of the image.

### Method
`orientation`

### Parameters
- `$orientation` (Orientation) - Optional - Orientation value: `Orientation::Rotate0`, `Orientation::Rotate90`, `Orientation::Rotate180`, or `Orientation::Rotate270`.

### Examples
```php
$image->orientation(Orientation::Rotate180);
$image->orientation();
```
```

--------------------------------

### blur

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/effects.md

Blurs the image. Accepts a value between 0 and 100.

```APIDOC
## blur

### Description
Blurs the image. Accepts a value between 0 and 100.

### Method
`blur`

### Parameters
- **value** (int) - Required - Blur intensity between 0 and 100.

### Example
```php
$image->blur(50);
```
```

--------------------------------

### Pixelate image with pixelate method

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/effects.md

Applies a pixelation effect to the image. The pixelate method accepts a value between 0 and 100.

```php
$image->pixelate(50);
```

--------------------------------

### pixelate

Source: https://github.com/spatie/image/blob/main/docs/image-manipulations/effects.md

Pixelates the image. Accepts a value between 0 and 100.

```APIDOC
## pixelate

### Description
Pixelates the image. Accepts a value between 0 and 100.

### Method
`pixelate`

### Parameters
- **value** (int) - Required - Pixelation intensity between 0 and 100.

### Example
```php
$image->pixelate(50);
```
```
Tokens:
Raw