Intervention Image

https://github.com/intervention/image
Admin
Intervention Image is a PHP image processing library offering a simple interface for creating,...
Tokens:275,176
Snippets:2,032
Trust Score:7.9
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Creating Size instances with new and Size::create()

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/07-Size.md

Example usage of the constructor and the static create() method. The second example passes a custom pivot Point(250, 250).

```php
use Intervention\Image\Size;
use Intervention\Image\Geometry\Point;

$size = new Size(1920, 1080);
$size = Size::create(500, 500, new Point(250, 250));
```

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

### Composer Installation Command

Source: https://github.com/intervention/image/blob/develop/readme.md

Installs the Intervention Image package via Composer's `require` command. Requires PHP >= 8.3 and the Mbstring PHP Extension.

```bash
composer require intervention/image
```

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

### Usage example for convenience decode methods

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/01-ImageManager.md

Example of using the convenience decode methods with an Imagick driver. Creates an ImageManager using ImagickDriver and decodes images from a filesystem path, binary data, base64 string, data URI, and stream resource.

```php
use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Imagick\Driver as ImagickDriver;

$manager = ImageManager::usingDriver(ImagickDriver::class);

$fromPath   = $manager->decodePath('images/example.webp');
$fromBinary = $manager->decodeBinary(file_get_contents('images/example.png'));
$fromBase64 = $manager->decodeBase64($base64String);
$fromUri    = $manager->decodeDataUri('data:image/png;base64,iVBORw0KG...');
$fromStream = $manager->decodeStream(fopen('images/example.jpg', 'r'));
```

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

### Creating a Collection instance

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/06-Collection.md

Example of instantiating a Collection with initial items and using the static create() method. Both produce a collection with the same key-value pairs.

```php
use Intervention\Image\Collection;

$collection = new Collection(['a' => 1, 'b' => 2]);
$same       = Collection::create(['a' => 1, 'b' => 2]);
```

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

### Color factory usage example

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/05-Color.md

Shows how to create color objects using the static factory methods. The example parses a hex string, creates RGB, CMYK, and OKLCH colors with optional alpha.

```php
use Intervention\Image\Color;

$brand = Color::parse('#ff5500');
$col   = Color::rgb(255, 85, 0, alpha: 0.5);
$cmyk  = Color::cmyk(0, 67, 100, 0);
$oklch = Color::oklch(0.6, 0.15, 25);
```

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

### Using image meta methods

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/02-Image.md

Example usage of width(), height(), exif() with dot notation query, and setResolution(). The exif() call returns a single value for the 'EXIF.FNumber' query.

```php
$width  = $image->width();
$height = $image->height();
$exifFNumber = $image->exif('EXIF.FNumber');
$image->setResolution(300, 300);
```

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

### Create and configure a Font instance

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/10-Typography.md

Example usage: instantiate Font with a filepath, size, and color, then chain setStrokeWidth, setStrokeColor, and setWrapWidth. Requires the font file to exist and be readable.

```php
use Intervention\Image\Typography\Font;

$font = new Font('fonts/roboto.ttf', size: 32, color: '#333333');
$font->setStrokeWidth(2)->setStrokeColor('ffffff')->setWrapWidth(300);
```

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

### Line::setStart

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/09-Drawables.md

Sets the start point of the line.

```APIDOC
## Line::setStart

### Description
Sets the start point of the line.

### Method
`setStart`

### Signature
```php
public function setStart(PointInterface $start): self
```

### Parameters
- **start** (PointInterface) - Required - The new start point.

### Return Value
- **self** - Returns the instance for chaining.

```

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

### Encoder instantiation examples

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/14-Encoders.md

Shows how to create JpegEncoder, PngEncoder, and WebpEncoder instances with constructor options. JpegEncoder uses quality 80 and progressive mode, PngEncoder uses interlaced mode, WebpEncoder uses default quality 75.

```php
use Intervention\Image\Encoders\JpegEncoder;
use Intervention\Image\Encoders\PngEncoder;

$jpeg = new JpegEncoder(quality: 80, progressive: true);
$png  = new PngEncoder(interlaced: true);
$webp = new WebpEncoder();   // quality 75
```

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

### Using the theme to get vibrant color and palette

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/17-Palette.md

Shows how to retrieve the theme from an image, access the vibrant swatch, and convert the theme to a palette.

```php
$theme  = $image->colors()->theme();
$vibrant = $theme->vibrant;                       // ?ColorInterface
$palette = $theme->toPalette();
```

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

### Using colors() to extract palette and theme

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/02-Image.md

Shows how to call `colors()->popular(limit: 16)` to get the most popular colors and `colors()->theme()` to get a color theme from the image.

```php
$palette = $image->colors()->popular(limit: 16);
$theme   = $image->colors()->theme();
```

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

### Line::start

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/09-Drawables.md

Returns the start point of the line.

```APIDOC
## Line::start

### Description
Returns the start point of the line.

### Method
`start`

### Signature
```php
public function start(): PointInterface
```

### Return Value
- **PointInterface** - The start point.

```

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

### Size resize calculation usage example

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/07-Size.md

Example of using cover, contain, and scale on a Size instance. cover(800, 800) computes an 800x600 crop box, contain(200, 200) fits within bounds preserving aspect ratio, and scale(width: 2000) produces 2000x1500.

```php
$size  = new Size(4000, 3000);
$thumb = $size->cover(800, 800);         // 800 x 600 crop-box calculation
$fit   = $size->contain(200, 200);       // contained with aspect ratio
$half  = $size->scale(width: 2000);      // 2000 x 1500
```

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

### Polygon instantiation example

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/09-Drawables.md

Creates a Polygon with three points. The points are provided as Point objects with x and y coordinates.

```php
$polygon = new Polygon([
    new Point(10, 10),
    new Point(110, 10),
    new Point(60, 80),
]);
```

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

### Line::from

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/09-Drawables.md

Moves the start point by the given coordinates.

```APIDOC
## Line::from

### Description
Moves the start point by the given coordinates.

### Method
`from`

### Signature
```php
public function from(int $x, int $y): self
```

### Parameters
- **x** (int) - Required - The x-coordinate offset.
- **y** (int) - Required - The y-coordinate offset.

### Return Value
- **self** - Returns the instance for chaining.

```

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

### Line::__construct

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/09-Drawables.md

Creates a new Line instance with start and end points and optional width.

```APIDOC
## Line::__construct

### Description
Creates a new Line instance with start and end points and optional width.

### Method
`__construct`

### Signature
```php
public function __construct(protected PointInterface $start, protected PointInterface $end, protected int $width = 1)
```

### Parameters
- **start** (PointInterface) - Required - The start point.
- **end** (PointInterface) - Required - The end point.
- **width** (int) - Optional - The line width, defaults to 1.

```

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

### Point usage example with move, setPosition, and rotate

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/08-Point.md

Demonstrates fluent coordinate manipulation: move adds deltas, setPosition replaces both coordinates, and rotate rotates clockwise around a pivot. Comments show resulting coordinates.

```php
$p = (new Point(10, 10))
    ->move(5, -3)          // (15, 7)
    ->setPosition(0, 0);   // (0, 0)

$rotated = (new Point(10, 0))->rotate(90, new Point(0, 0)); // (~0, 10)
```

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

### Format enum usage example

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/11-Enums.md

Shows how to create Format instances from strings and use the encoder method with options.

```php
use Intervention\Image\Format;

$format = Format::create('image/jpeg');   // Format::JPEG
$format = Format::create('png');          // Format::PNG
$enc    = Format::JPEG->encoder(quality: 80);
```

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

### Catch ImageException with try/catch

Source: https://github.com/intervention/image/blob/develop/_autodocs/errors.md

Use this snippet to catch any library error (decode, config, modifier, encoder, filesystem) by type-hinting the most specific class or a common ancestor. The example uses ImageManager::usingDriver(GdDriver::class)->decodePath() and scale()->save().

```php
use Intervention\Image\Exceptions\ImageException;

try {
    $manager = ImageManager::usingDriver(GdDriver::class)->decodePath($input);
    $manager->scale(width: 500)->save('out.jpg');
} catch (ImageException $e) {
    // any library error — decode, config, modifier, encoder, filesystem
}
```

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

### text() usage example

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/03-Image-Modifiers.md

Renders 'Hello World' at position (10,20) using a callable that configures the font file, size, color, alignment, angle, line height, and wrap width.

```php
$image->text('Hello World', 10, 20, function ($font) {
    $font->file('fonts/arial.ttf')->size(48)->color('ffffff')
         ->align('center', 'top')->angle(0)->lineHeight(1.6)->wrap(400);
});
```

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

### Colorspace, background and profile usage example

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/02-Image.md

Reads a pixel color at (10, 20) and converts it to hex, sets a black background, and converts the image to CMYK colorspace using the Intervention\Image\Colors\Cmyk\Colorspace class.

```php
$color = $image->colorAt(10, 20);
$hex   = $color->toHex(true); // e.g. "#ff55aa"

$image->setBackgroundColor('000000');
$image->setColorspace(Intervention\Image\Colors\Cmyk\Colorspace::class);
```

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

### Image::save() usage examples

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/02-Image.md

Shows two common save calls: saving back to the original path and saving to a new path with a quality option. The quality option is forwarded to the encoder.

```php
$image->save();                       // back to the original path
$image->save('out/thumbnail.jpg', quality: 80);
```

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

### File::fromPath usage example

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/04-EncodedImage.md

Creates a File instance from a path and retrieves its size in bytes. The size() method uses fstat and throws StreamException on failure.

```php
$file = Intervention\Image\File::fromPath('images/example.jpg');
$size = $file->size(); // bytes
```

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

### Resize usage examples (resize, scale, scaleDown)

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/03-Image-Modifiers.md

Shows typical calls: resize(400, 300) forces exact size and may distort; scale(width: 800) keeps aspect ratio; scaleDown(height: 600) never exceeds original height. Provide exactly one dimension and let the other be computed; passing both null raises an error.

```php
$image->resize(400, 300);     // exact size, may distort
$image->scale(width: 800);    // width 800, height keeps ratio
$image->scaleDown(height: 600); // never exceeds original height
```

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

### Creating and configuring a Config instance

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/12-Config.md

Shows how to instantiate Config with named arguments and then update options using an associative array. The setOptions call changes backgroundColor to '000000' and strip to true.

```php
use Intervention\Image\Config;

$config = new Config(autoOrientation: false, decodeAnimation: false);
$config->setOptions(['backgroundColor' => '000000', 'strip' => true]);
```

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

### get(int|string $key, mixed $default = null): mixed

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/06-Collection.md

Retrieves an item from the collection using dot-notation lookup. For example, `get('EXIF.FNumber')` traverses nested arrays. Missing keys return the default value.

```APIDOC
## Method: `get(int|string $key, mixed $default = null): mixed`

### Description
Retrieves an item from the collection using dot-notation lookup. Missing keys return the default value.

### Parameters
- **$key** (int|string) - Required - The key to retrieve, supporting dot-notation for nested arrays.
- **$default** (mixed) - Optional - The default value to return if the key is not found.

### Returns
- **mixed** - The value associated with the key, or the default value if not found.

### Example
```php
$camera = $exif->get('IFD0.Make', fallback: 'unknown');
```
```

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

### Effects usage example

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/03-Image-Modifiers.md

Example of applying multiple effects in a chain, including grayscale, contrast, sharpen, rotate, flip, and reduceColors. Uses the Direction enum for vertical flip and named arguments for background colors.

```php
use Intervention\Image\Direction;

$image->grayscale()->contrast(10)->sharpen(5);
$image->rotate(-45, background: 'ffffff');
$image->flip(Direction::VERTICAL);
$image->reduceColors(32, background: 'ffffff');
```

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

### Using GD and Imagick drivers with ImageManager

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/13-Drivers.md

Shows how to create ImageManager instances using the GD and Imagick drivers. The driver id and version are accessible, and supports() checks format support depending on the PHP build.

```php
use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Gd\Driver as GdDriver;
use Intervention\Image\Drivers\Imagick\Driver as ImagickDriver;

$gd      = ImageManager::usingDriver(GdDriver::class);
$imagick = ImageManager::usingDriver(ImagickDriver::class);

$gd->driver()->id();          // "GD"
$imagick->driver()->id();     // "Imagick"

var_dump($gd->driver()->supports('webp'));   // true/false depending on PHP build
echo $imagick->driver()->version();
```

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

### RGB color usage example

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/05-Color.md

Creates an RGB color, converts to hex and string, then converts to HSL colorspace. The toHex output is '#ff0080' and toString returns 'rgb(255 0 128)'. The converted HSL output is shown as an example.

```php
$rgb = Color::rgb(255, 0, 128);
echo $rgb->toHex(true);          // "#ff0080"
echo $rgb->toString();           // "rgb(255 0 128)"

$converted = $rgb->toColorspace(Intervention\Image\Colors\Hsl\Colorspace::class);
echo $converted;                 // e.g. "hsl(330 100% 50%)"
```

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

### cover(int|Fraction $width, int|Fraction $height, string|Alignment $alignment = Alignment::CENTER)

Source: https://github.com/intervention/image/blob/develop/_autodocs/types.md

Resizes the image to cover the given dimensions, cropping if necessary.

```APIDOC
## cover(int|Fraction $width, int|Fraction $height, string|Alignment $alignment = Alignment::CENTER)

### Description
Resizes the image to cover the given dimensions, cropping if necessary.

### Method
`cover(int|Fraction $width, int|Fraction $height, string|Alignment $alignment = Alignment::CENTER)`

### Parameters
- **$width** (int|Fraction) - Required - The target width.
- **$height** (int|Fraction) - Required - The target height.
- **$alignment** (string|Alignment) - Optional - The alignment for cropping. Defaults to CENTER.

### Returns
- **self** - Returns the current image instance for chaining.
```

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

### resize(null|int|Fraction $width = null, null|int|Fraction $height = null)

Source: https://github.com/intervention/image/blob/develop/_autodocs/types.md

Resizes the image to the given dimensions.

```APIDOC
## resize(null|int|Fraction $width = null, null|int|Fraction $height = null)

### Description
Resizes the image to the given dimensions.

### Method
`resize(null|int|Fraction $width = null, null|int|Fraction $height = null)`

### Parameters
- **$width** (null|int|Fraction) - Optional - The target width.
- **$height** (null|int|Fraction) - Optional - The target height.

### Returns
- **self** - Returns the current image instance for chaining.
```

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

### colorize(int $red = 0, int $green = 0, int $blue = 0)

Source: https://github.com/intervention/image/blob/develop/_autodocs/types.md

Applies a color tint to the image.

```APIDOC
## colorize(int $red = 0, int $green = 0, int $blue = 0)

### Description
Applies a color tint to the image.

### Method
`colorize(int $red = 0, int $green = 0, int $blue = 0)`

### Parameters
- **$red** (int) - Optional - Red adjustment. Defaults to 0.
- **$green** (int) - Optional - Green adjustment. Defaults to 0.
- **$blue** (int) - Optional - Blue adjustment. Defaults to 0.

### Returns
- **self** - Returns the current image instance for chaining.
```

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

### Run a single test file

Source: https://github.com/intervention/image/blob/develop/AGENTS.md

Runs a single test file by providing its path to the tests service.

```bash
docker compose run --rm tests tests/Unit/ImageManagerTest.php
```

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

### Line::setPosition

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/09-Drawables.md

Sets the start point of the line.

```APIDOC
## Line::setPosition

### Description
Sets the start point of the line.

### Method
`setPosition`

### Signature
```php
public function setPosition(PointInterface $position): self
```

### Parameters
- **position** (PointInterface) - Required - The new start point.

### Return Value
- **self** - Returns the instance for chaining.

```

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

### Line::position

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/09-Drawables.md

Returns the start point of the line.

```APIDOC
## Line::position

### Description
Returns the start point of the line.

### Method
`position`

### Signature
```php
public function position(): PointInterface
```

### Return Value
- **PointInterface** - The start point.

```

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

### scale(null|int|Fraction $width = null, null|int|Fraction $height = null)

Source: https://github.com/intervention/image/blob/develop/_autodocs/types.md

Scales the image to the given dimensions.

```APIDOC
## scale(null|int|Fraction $width = null, null|int|Fraction $height = null)

### Description
Scales the image to the given dimensions.

### Method
`scale(null|int|Fraction $width = null, null|int|Fraction $height = null)`

### Parameters
- **$width** (null|int|Fraction) - Optional - The target width.
- **$height** (null|int|Fraction) - Optional - The target height.

### Returns
- **self** - Returns the current image instance for chaining.
```

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

### Run all tests with PHPUnit

Source: https://github.com/intervention/image/blob/develop/AGENTS.md

Runs the full PHPUnit test suite inside the Docker development environment.

```bash
docker compose run --rm tests
```

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

### sliceAnimation()

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/02-Image.md

Keeps only the frame range starting at the given offset with the specified length. Returns the modified image instance.

```APIDOC
## sliceAnimation()

### Description
Keeps only the frame range starting at the given offset with the specified length. Returns the modified image instance.

### Method
sliceAnimation

### Signature
public function sliceAnimation(int $offset = 0, ?int $length = null): ImageInterface

### Parameters
- **$offset** (int) - Required - Starting frame index.
- **$length** (?int) - Optional - Number of frames to keep. If null, keeps all frames from offset to end.

### Return Value
- **ImageInterface** - Returns the modified image instance.

### Example
```php
$image->sliceAnimation(0, 10); // keep first 10 frames
```
```

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

### __debugInfo()

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/02-Image.md

Returns an array with width and height for var_dump() output. Never throws.

```APIDOC
## __debugInfo()

### Description
Returns an array with width and height for var_dump() output. Never throws.

### Method
__debugInfo()

### Returns
- **array{width: ?int, height: ?int}** - Width and height values

### Example
```php
var_dump($image);
```
```

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

### crop(int|Fraction $width, int|Fraction $height, int $x = 0, int $y = 0, null|string|ColorInterface $background = null, string|Alignment $alignment = Alignment::TOP_LEFT)

Source: https://github.com/intervention/image/blob/develop/_autodocs/types.md

Crops the image to the given dimensions and position.

```APIDOC
## crop(int|Fraction $width, int|Fraction $height, int $x = 0, int $y = 0, null|string|ColorInterface $background = null, string|Alignment $alignment = Alignment::TOP_LEFT)

### Description
Crops the image to the given dimensions and position.

### Method
`crop(int|Fraction $width, int|Fraction $height, int $x = 0, int $y = 0, null|string|ColorInterface $background = null, string|Alignment $alignment = Alignment::TOP_LEFT)`

### Parameters
- **$width** (int|Fraction) - Required - The crop width.
- **$height** (int|Fraction) - Required - The crop height.
- **$x** (int) - Optional - The x offset. Defaults to 0.
- **$y** (int) - Optional - The y offset. Defaults to 0.
- **$background** (null|string|ColorInterface) - Optional - The background color.
- **$alignment** (string|Alignment) - Optional - The alignment for cropping. Defaults to TOP_LEFT.

### Returns
- **self** - Returns the current image instance for chaining.
```

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

### fill

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/03-Image-Modifiers.md

Fills the entire image with a color, or performs a flood fill starting at given coordinates.

```APIDOC
## fill

### Description
With coordinates, performs a flood fill starting at ($x, $y). Without coordinates, fills the whole image.

### Method
fill

### Signature
```php
public function fill(string|ColorInterface $color, ?int $x = null, ?int $y = null): ImageInterface
```

### Parameters
- **$color** (string|ColorInterface) - Required - The fill color.
- **$x** (?int) - Optional - X-coordinate for flood fill start.
- **$y** (?int) - Optional - Y-coordinate for flood fill start.

### Return Value
- **ImageInterface** - The modified image instance.

### Example
```php
$image->fill('ff0000');
```
```

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

### Run static analysis with PHPStan

Source: https://github.com/intervention/image/blob/develop/AGENTS.md

Runs PHPStan static analysis to find potential bugs.

```bash
docker compose run --rm analysis
```

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

### FileInterface

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/04-EncodedImage.md

Interface for file objects. Provides methods to create from path, save, stream, get size, and convert to string.

```APIDOC
## FileInterface

### Description
Interface for file objects. Provides methods to create from path, save, stream, get size, and convert to string.

### Methods

#### fromPath(string $path): self
- Creates a new instance from a file path.

#### save(string $path): void
- Saves the file to the specified path.

#### toStream()
- Returns a stream resource for the file.

#### size(): int
- Returns the file size in bytes.

#### toString(): string
- Returns the file contents as a string.

```

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

### OriginInterface definition

Source: https://github.com/intervention/image/blob/develop/_autodocs/types.md

Defines the OriginInterface with methods for media type, file path, extension, and format. The format() method throws NotSupportedException for unknown media types.

```php
interface OriginInterface
{
    public function mediaType(): string;
    public function setMediaType(string|MediaType $type): self;
    public function filePath(): ?string;
    public function setFilePath(string $path): self;
    public function fileExtension(): ?string;
    public function format(): Format;      // throws NotSupportedException for unknown media types
}
```

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

### analyze(AnalyzerInterface $analyzer)

Source: https://github.com/intervention/image/blob/develop/_autodocs/types.md

Runs an analyzer on the image and returns the result.

```APIDOC
## analyze(AnalyzerInterface $analyzer)

### Description
Runs an analyzer on the image and returns the result.

### Method
`analyze(AnalyzerInterface $analyzer)`

### Parameters
- **$analyzer** (AnalyzerInterface) - Required - The analyzer to run.

### Returns
- **mixed** - The analyzer result.
```

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

### at(int $key = 0, mixed $default = null): mixed

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/06-Collection.md

Retrieves an item by its numeric position in the values, not by its key. The position starts at 0.

```APIDOC
## Method: `at(int $key = 0, mixed $default = null): mixed`

### Description
Retrieves an item by its numeric position in the values, not by its key. The position starts at 0.

### Parameters
- **$key** (int) - Optional - The numeric position (starting at 0) in the values.
- **$default** (mixed) - Optional - The default value to return if the position is not found.

### Returns
- **mixed** - The value at the given position, or the default value if not found.
```

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

### driver()

Source: https://github.com/intervention/image/blob/develop/_autodocs/types.md

Returns the driver instance associated with the image.

```APIDOC
## driver()

### Description
Returns the driver instance associated with the image.

### Method
`driver()`

### Returns
- **DriverInterface** - The driver instance.
```

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

### Usage: direct color frames

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/18-AnimationFactory.md

Example of creating an animation with solid color frames by passing hex color strings as sources, which are treated as colors when decoding fails.

```php
$animation = ImageManager::usingDriver(GdDriver::class)
    ->createImage(200, 200, function ($factory) {
        $factory->add('ff0000', 0.5);   // solid red frame (undecodable source = color)
        $factory->add('00ff00', 0.5);
        $factory->add('0000ff', 0.5);
    });
```

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

### coverDown(int|Fraction $width, int|Fraction $height, string|Alignment $alignment = Alignment::CENTER)

Source: https://github.com/intervention/image/blob/develop/_autodocs/types.md

Resizes the image down to cover the given dimensions, cropping if necessary.

```APIDOC
## coverDown(int|Fraction $width, int|Fraction $height, string|Alignment $alignment = Alignment::CENTER)

### Description
Resizes the image down to cover the given dimensions, cropping if necessary.

### Method
`coverDown(int|Fraction $width, int|Fraction $height, string|Alignment $alignment = Alignment::CENTER)`

### Parameters
- **$width** (int|Fraction) - Required - The target width.
- **$height** (int|Fraction) - Required - The target height.
- **$alignment** (string|Alignment) - Optional - The alignment for cropping. Defaults to CENTER.

### Returns
- **self** - Returns the current image instance for chaining.
```

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

### Animation usage example

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/02-Image.md

Checks if the image is animated, slices the first 10 frames, sets infinite looping, and keeps the middle frame via removeAnimation('50%').

```php
if ($image->isAnimated()) {
    $image->sliceAnimation(0, 10)->setLoops(0);
    $still = $image->removeAnimation('50%'); // keep middle frame
}
```

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

### resizeCanvas(null|int|Fraction $width = null, null|int|Fraction $height = null, null|string|ColorInterface $background = null, string|Alignment $alignment = Alignment::CENTER)

Source: https://github.com/intervention/image/blob/develop/_autodocs/types.md

Resizes the canvas of the image, adding background color if needed.

```APIDOC
## resizeCanvas(null|int|Fraction $width = null, null|int|Fraction $height = null, null|string|ColorInterface $background = null, string|Alignment $alignment = Alignment::CENTER)

### Description
Resizes the canvas of the image, adding background color if needed.

### Method
`resizeCanvas(null|int|Fraction $width = null, null|int|Fraction $height = null, null|string|ColorInterface $background = null, string|Alignment $alignment = Alignment::CENTER)`

### Parameters
- **$width** (null|int|Fraction) - Optional - The new canvas width.
- **$height** (null|int|Fraction) - Optional - The new canvas height.
- **$background** (null|string|ColorInterface) - Optional - The background color.
- **$alignment** (string|Alignment) - Optional - The alignment of the image on the canvas. Defaults to CENTER.

### Returns
- **self** - Returns the current image instance for chaining.
```

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

### Usage: create animated GIF with frames

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/18-AnimationFactory.md

Example of creating an animated image using ImageManager with a callable that adds frames and applies a resize to every frame, then encodes as GIF.

```php
use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Gd\Driver as GdDriver;

$manager = ImageManager::usingDriver(GdDriver::class);

$animation = $manager->createImage(100, 100, function ($factory) {
    $factory->add('frames/frame-01.png', delay: 0.1);
    $factory->add('frames/frame-02.png', delay: 0.1);
    $factory->add('frames/frame-03.png', delay: 0.1);
    $factory->resize(width: 50);      // applied to every frame
});

$animation->encodeUsingFormat(Intervention\Image\Format::GIF)->save('animated.gif');
```

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

### Config::__construct()

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/12-Config.md

Creates a new Config instance with options for auto-orientation, animation decoding, background color, and metadata stripping. These options control driver behavior during image decoding and encoding.

```APIDOC
## Config::__construct()

### Description
Creates a new Config instance with options for auto-orientation, animation decoding, background color, and metadata stripping. These options control driver behavior during image decoding and encoding.

### Method
Constructor

### Signature
```php
public function __construct(
    public bool $autoOrientation = true,
    public bool $decodeAnimation = true,
    public string|ColorInterface $backgroundColor = 'ffffff',
    public bool $strip = false,
)
```

### Parameters
- **$autoOrientation** (bool) - Optional - Automatically orient images according to EXIF data when decoding.
- **$decodeAnimation** (bool) - Optional - Decode animated images frame-by-frame; when `false` only the first frame is decoded.
- **$backgroundColor** (string|ColorInterface) - Optional - Color used to replace transparent areas when encoding to formats without alpha support and for `Image::fillTransparentAreas()` / `Image::backgroundColor()`.
- **$strip** (bool) - Optional - Strip metadata (e.g. EXIF) from the image during decoding.

### Example
```php
use Intervention\Image\Config;

$config = new Config(autoOrientation: false, decodeAnimation: false);
```
```

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

### Typography\Line::__construct

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/10-Typography.md

Creates a new Line instance representing a single text line split into segments. Accepts optional text and a starting position.

```APIDOC
## `Typography\Line::__construct`

### Description
Creates a new Line instance representing a single text line split into segments (words for space-separated scripts; characters for CJK/Thai via `mb_str_split`).

### Method
Constructor

### Signature
```php
public function __construct(?string $text = null, protected PointInterface $position = new Point())
```

### Parameters
- **$text** (?string) - Optional - The initial text for the line.
- **$position** (PointInterface) - Optional - The starting position of the line, defaults to a new Point.

### Returns
- A new `Typography\Line` instance.
```

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

### Using ImageManager::usingDriver with config options

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/12-Config.md

Demonstrates passing driver configuration options directly to ImageManager::usingDriver. The options are forwarded to the driver's Config via setOptions.

```php
use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Gd\Driver as GdDriver;

$manager = ImageManager::usingDriver(
    GdDriver::class,
    autoOrientation: false,
    decodeAnimation: true,
    backgroundColor: '#123456',
);
```

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

### scaleDown(null|int|Fraction $width = null, null|int|Fraction $height = null)

Source: https://github.com/intervention/image/blob/develop/_autodocs/types.md

Scales the image down to the given dimensions, preserving aspect ratio.

```APIDOC
## scaleDown(null|int|Fraction $width = null, null|int|Fraction $height = null)

### Description
Scales the image down to the given dimensions, preserving aspect ratio.

### Method
`scaleDown(null|int|Fraction $width = null, null|int|Fraction $height = null)`

### Parameters
- **$width** (null|int|Fraction) - Optional - The target width.
- **$height** (null|int|Fraction) - Optional - The target height.

### Returns
- **self** - Returns the current image instance for chaining.
```

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

### Config constructor with default options

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/12-Config.md

Defines the constructor for the Config class, accepting named parameters for autoOrientation, decodeAnimation, backgroundColor, and strip. Defaults are true, true, 'ffffff', and false respectively.

```php
public function __construct(
    public bool $autoOrientation = true,
    public bool $decodeAnimation = true,
    public string|ColorInterface $backgroundColor = 'ffffff',
    public bool $strip = false,
)
```

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

### Using Fraction in image resizing

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/11-Enums.md

Example usage of Fraction enum in image scaling and resizing methods. scale() with Fraction::HALF reduces width to 50%; resize() accepts Fraction::DOUBLE for both dimensions.

```php
use Intervention\Image\Fraction;

$image->scale(width: Fraction::HALF);   // 50% width
$image->resize(Fraction::DOUBLE, Fraction::DOUBLE);
```

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

### Collection constructor and create() method signatures

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/06-Collection.md

Shows the constructor and static create() method signatures for the Collection class. The constructor accepts an optional array of items with int or string keys; create() is a static factory returning a new instance.

```php
public function __construct(protected array $items = [])
public static function create(array $items = []): self
```

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

### OriginInterface

Source: https://github.com/intervention/image/blob/develop/_autodocs/types.md

OriginInterface defines operations for the origin of an image, including media type, file path, file extension, and format.

```APIDOC
## OriginInterface

### Description
OriginInterface defines operations for the origin of an image, including media type, file path, file extension, and format.

### Methods

#### mediaType()
- **Returns**: string - The media type of the image.

#### setMediaType(string|MediaType $type)
- **Parameters**: `$type` (string|MediaType) - The media type to set.
- **Returns**: self - Returns the instance for chaining.

#### filePath()
- **Returns**: ?string - The file path, or null if not set.

#### setFilePath(string $path)
- **Parameters**: `$path` (string) - The file path to set.
- **Returns**: self - Returns the instance for chaining.

#### fileExtension()
- **Returns**: ?string - The file extension, or null if not set.

#### format()
- **Returns**: Format - The format of the image.
- **Throws**: NotSupportedException - If the media type is unknown.
```

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

### Using Collection with EXIF data

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/06-Collection.md

Demonstrates retrieving EXIF data from an image as a Collection, using dot-notation get() to access nested values, converting to an array, and mapping values to uppercase. The map() callback receives each item and returns a new collection.

```php
$exif = $image->exif();                      // Collection

$camera = $exif->get('IFD0.Make', fallback: 'unknown');
$items  = $exif->toArray();

$mapped = $exif->map(fn(mixed $v): mixed => is_scalar($v) ? strtoupper((string) $v) : $v);
```

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

### ArrayAccess and iteration on Size object

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/07-Size.md

Shows how to read width and height via array access. Assigning to an index or unsetting throws RuntimeException; use setWidth() or setHeight() instead. foreach yields [width, height] and __debugInfo() returns width, height, and pivot.

```php
$width  = $size[0];              // == $size->width()
$width  = $size['width'];        // same
$height = $size[1];              // == $size->height()
$size['width'] = 100;            // throws RuntimeException ('use setWidth() or setHeight()')
unset($size[0]);                 // throws RuntimeException
```

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

### Font Getters and Setters

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/10-Typography.md

Provides methods to get and set font properties such as size, angle, filepath, color, stroke, alignment, line height, and wrap width. These methods allow fluent configuration of the Font object.

```APIDOC
## Font Getters and Setters

### Description
Provides methods to get and set font properties such as size, angle, filepath, color, stroke, alignment, line height, and wrap width. These methods allow fluent configuration of the Font object.

### Methods

#### setSize(float $size): FontInterface
Sets the font size.

#### size(): float
Returns the current font size.

#### setAngle(float $angle): FontInterface
Sets the rotation angle in degrees (clockwise).

#### angle(): float
Returns the current rotation angle.

#### setFilepath(string $path): FontInterface
Sets the path to the font file. Validates the path immediately; throws exceptions if invalid.

#### filepath(): ?string
Returns the font file path, or null if not set or no longer readable.

#### hasFile(): bool
Checks if a font file is set.

#### setColor(string|ColorInterface $color): FontInterface
Sets the text color.

#### color(): null|string|ColorInterface
Returns the current text color.

#### setStrokeColor(string|ColorInterface $color): FontInterface
Sets the stroke color.

#### strokeColor(): null|string|ColorInterface
Returns the current stroke color.

#### setStrokeWidth(int $width): FontInterface
Sets the stroke width (0-10). Throws InvalidArgumentException if out of range.

#### strokeWidth(): int
Returns the current stroke width.

#### hasStrokeEffect(): bool
Checks if a stroke effect is enabled.

#### setAlignmentHorizontal(string|Alignment $alignment): FontInterface
Sets the horizontal alignment. Accepts an Alignment enum or a string matching an enum case.

#### alignmentHorizontal(): Alignment
Returns the current horizontal alignment.

#### setAlignmentVertical(string|Alignment $alignment): FontInterface
Sets the vertical alignment. Accepts an Alignment enum or a string matching an enum case.

#### alignmentVertical(): Alignment
Returns the current vertical alignment.

#### setLineHeight(float $height): FontInterface
Sets the line height multiplier.

#### lineHeight(): float
Returns the current line height multiplier.

#### setWrapWidth(?int $width): FontInterface
Sets the maximum wrap width.

#### wrapWidth(): ?int
Returns the current wrap width.

### Exceptions
- **InvalidArgumentException** - Thrown when the stroke width is not in the range 0-10, or when an invalid alignment value is provided.
- **DirectoryNotFoundException** - Thrown when the font file directory does not exist.
- **FileNotFoundException** - Thrown when the font file does not exist.
- **FileNotReadableException** - Thrown when the font file is not readable.

### Example
```php
use Intervention\Image\Typography\Font;

$font = new Font('fonts/roboto.ttf', size: 32, color: '#333333');
$font->setStrokeWidth(2)->setStrokeColor('ffffff')->setWrapWidth(300);
```
```

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

### resizeDown(null|int|Fraction $width = null, null|int|Fraction $height = null)

Source: https://github.com/intervention/image/blob/develop/_autodocs/types.md

Resizes the image down to the given dimensions, preserving aspect ratio.

```APIDOC
## resizeDown(null|int|Fraction $width = null, null|int|Fraction $height = null)

### Description
Resizes the image down to the given dimensions, preserving aspect ratio.

### Method
`resizeDown(null|int|Fraction $width = null, null|int|Fraction $height = null)`

### Parameters
- **$width** (null|int|Fraction) - Optional - The target width.
- **$height** (null|int|Fraction) - Optional - The target height.

### Returns
- **self** - Returns the current image instance for chaining.
```

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

### Conversion between FileExtension and MediaType

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/11-Enums.md

Shows the conversion chain: FileExtension::create() accepts a known extension or a known media type (via MediaType::from() fallback, src/FileExtension.php:60). The example creates FileExtension::WEBP from 'image/webp' and MediaType::IMAGE_JPEG from 'jpg'.

```php
use Intervention\Image\FileExtension;
use Intervention\Image\MediaType;

$ext = FileExtension::create('image/webp');  // FileExtension::WEBP
$mt  = MediaType::create('jpg');             // MediaType::IMAGE_JPEG
```

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

### Usage Example for Insert, Fill, and FillTransparentAreas

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/03-Image-Modifiers.md

Shows how to insert a watermark image at the bottom-right with 80% transparency, fill the entire image with red, and replace transparent areas with white. The fillTransparentAreas call can also be made without arguments to use the configured background color.

```php
$image->insert('images/watermark.png', alignment: Alignment::BOTTOM_RIGHT, transparency: 0.8);
$image->fill('ff0000');
$image->fillTransparentAreas('ffffff'); // or $image->fillTransparentAreas()
```

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

### Usage examples for cover, contain, resizeCanvas, crop, trim

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/03-Image-Modifiers.md

Shows typical calls using the Alignment enum and named arguments. cover creates a square thumbnail, contain letterboxes with a background, resizeCanvas expands the canvas, crop cuts a centered rectangle, and trim removes borders with a tolerance.

```php
use Intervention\Image\Alignment;

$image->cover(300, 300, Alignment::TOP_RIGHT);          // square thumbnail
$image->contain(400, 300, background: 'ffffff');        // letterbox
$image->resizeCanvas(width: 1000, background: '000000', alignment: Alignment::CENTER);
$image->crop(200, 200, alignment: Alignment::CENTER);
$image->trim(tolerance: 10);
```

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

### Size constructor and create() signatures

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/07-Size.md

Constructor and static factory for Size. Width and height must be ≥ 0; negative values throw InvalidArgumentException. Pivot defaults to a new Point at (0,0).

```php
public function __construct(
    protected int $width,
    protected int $height,
    protected PointInterface $pivot = new Point(),
)
public static function create(int $width, int $height, PointInterface $pivot = new Point()): self
```

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

### AbstractDriver specialization methods

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/13-Drivers.md

Public methods to specialize modifiers, analyzers, encoders, and decoders. Objects not implementing SpecializableInterface are returned unchanged; already-specialized objects get the driver attached; otherwise the short class name is resolved in the driver's namespace and instantiated with specializationArguments(). Missing specialized class throws NotSupportedException.

```php
public function specializeModifier(ModifierInterface $modifier): ModifierInterface
public function specializeAnalyzer(AnalyzerInterface $analyzer): AnalyzerInterface
public function specializeEncoder(EncoderInterface $encoder): EncoderInterface
public function specializeDecoder(DecoderInterface $decoder): DecoderInterface
```

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

### MissingDependencyException Handling

Source: https://github.com/intervention/image/blob/develop/_autodocs/api-reference/13-Drivers.md

Shows how to handle missing driver dependencies when using ImageManager::usingDriver with a driver that requires an unavailable PHP extension.

```APIDOC
## Missing Dependency Handling

### Description
When using a driver that requires a PHP extension that is not available, `ImageManager::usingDriver` throws a `MissingDependencyException`. This example demonstrates how to catch and handle that exception.

### Usage Example
```php
use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Imagick\Driver as ImagickDriver;
use Intervention\Image\Exceptions\MissingDependencyException;

try {
    $manager = ImageManager::usingDriver(ImagickDriver::class);
} catch (MissingDependencyException $e) {
    // Imagick extension not available
}
```
```

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

### reduceColors(int $limit, null|string|ColorInterface $background = null)

Source: https://github.com/intervention/image/blob/develop/_autodocs/types.md

Reduces the number of colors in the image.

```APIDOC
## reduceColors(int $limit, null|string|ColorInterface $background = null)

### Description
Reduces the number of colors in the image.

### Method
`reduceColors(int $limit, null|string|ColorInterface $background = null)`

### Parameters
- **$limit** (int) - Required - The maximum number of colors.
- **$background** (null|string|ColorInterface) - Optional - The background color for transparency.

### Returns
- **self** - Returns the current image instance for chaining.
```

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

### core()

Source: https://github.com/intervention/image/blob/develop/_autodocs/types.md

Returns the core representation of the image.

```APIDOC
## core()

### Description
Returns the core representation of the image.

### Method
`core()`

### Returns
- **CoreInterface** - The core image data.
```
Tokens:
Raw