Colors & Transparency

• Color Information
  • Read Color of a Pixel
  • Read all Colors of Certain Pixels in Animated Images
• Transforming Colors
  • Transform Colors to String Values
  • Transform Colors Between Colorspaces
  • Change the Brightness of the Color
  • Change the Saturation of the Color
  • Invert the Color
  • Change the Transparency of the Color
• Colorspaces
  • Read the Image Colorspace
  • Change the Image Colorspace
• Color Profiles
  • Read Color Profiles
  • Set Color Profiles
  • Remove Color Profiles
• Transparency
  • Merge Transparent Areas with Color
  • Read the Background Color
  • Set the background Color

Color Information

Read Color of a Pixel

public Image::colorAt(int $x, int $y, int $frame = 0): ColorInterface

Reads the color of the pixel specified by the X and Y coordinates. You can also pass the key of the frame from which the color is taken in an animated image.

Parameters

Name	Type	Description
x	int	X-Coordinate of the pixel position
y	int	Y-Coordinate of the pixel position
frame	int	Optional key of the frame from which the color information is read

Example

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

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

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

// read color information for frame 10 at position 23/9
$color = $image->colorAt(23, 9, 10);

// 'f3fbe6'
$hex = $color->toHex();

// 'rgb(243 251 230)'
$string = $color->toString();

// (int) 243
$red = $color->red()->toInt();

// (int) 251
$green = $color->green()->toInt();

// (int) 230
$blue = $color->blue()->toInt();

// (int) 255
$alpha = $color->alpha()->toInt();

Read all Colors of Certain Pixels in Animated Images

public Image::colorsAt(int $x, int $y): CollectionInterface

Reads all colors of the pixel specified via the X and Y coordinates and returns them in a collection. For animated images, this collection will contain all colors of the specified position for all frames. For non-animated images, the collection will contain only one color, because the image also contains only one frame.

Parameters

Name	Type	Description
x	int	X-Coordinate of the pixel position
y	int	Y-Coordinate of the pixel position

Example

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

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

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

// read color information at position
$colors = $image->colorsAt(10, 10);

// first color
$color = $colors->first();

// color for certain frame
$color = $colors->get(6);

Transforming Colors

Once a color of an image has been read into an object, more options are available.

Transform Colors to String Values

public ColorInterface::toString(): ColorInterface

Each color object can also be output as a string. You can use the toString() method or to cast the object directly. Of course, the output depends on the respective color space.

use Intervention\Image\ImageManager;
use Intervention\Image\Colors\Hsl\Colorspace as HslColorspace;
use Intervention\Image\Drivers\Gd\Driver;

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

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

// read pixel color
$color = $image->colorAt(20, 10);

// transform color to string format
$result = $color->toString(); // "rgb(255 55 0)"

// same result
$result = (string) $color;

Transform Colors Between Colorspaces

public ColorInterface::toColorspace(string|ColorspaceInterface $colorspace): ColorInterface

Each color object has a method for converting into other color spaces. The target color space can be specified either as a string or as an object. This works even if the current driver does not support the target color space.

The following color spaces are available.

• Intervention\Image\Colors\Rgb\Colorspace
• Intervention\Image\Colors\Cmyk\Colorspace
• Intervention\Image\Colors\Hsv\Colorspace
• Intervention\Image\Colors\Hsl\Colorspace
• Intervention\Image\Colors\Oklab\Colorspace
• Intervention\Image\Colors\Oklch\Colorspace

use Intervention\Image\ImageManager;
use Intervention\Image\Colors\Hsl\Colorspace as Hsl;
use Intervention\Image\Drivers\Imagick\Driver;

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

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

// read pixel color
$color = $image->colorAt(20, 10);

$result = $color->toString(); // "rgb(0 255 255)"

// transform color to hsl format
$hslColor = $color->toColorspace(Hsl::class);

$result = $hslColor->toString(); // "hsl(180 100 50)"

Change the Brightness of the Color

public ColorInterface::withBrightness(int $level): ColorInterface

Return a copy of the current color with adjusted brightness in a range from -100 to 100. Positive values lighten, negative values darken.

Parameters

Name	Type	Description
level	int	Level of brightness change.

Example

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

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

// create new image
$image = $manager->createImage(300, 200);

// instantiate color
$color = Color::parse('ff5500');

// fill image with color
$image->fill($color);

// draw pixels with slightly darker color
$image->drawPixel(10, 10, $color->withBrightness(-45));
$image->drawPixel(11, 11, $color->withBrightness(-45));
$image->drawPixel(12, 12, $color->withBrightness(-45));

Change the Saturation of the Color

public ColorInterface::withSaturation(int $level): ColorInterface

Return a copy of the current color with adjusted saturation in a range from -100 to 100. Positive values raise the saturation, negative values lower the saturation.

Parameters

Name	Type	Description
level	int	Level of saturation change.

Example

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

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

// create new image
$image = $manager->createImage(300, 200);

// instantiate color
$color = Color::parse('ff5500');

// fill image with color
$image->fill($color);

// draw pixels with different saturated color
$image->drawPixel(10, 10, $color->withSaturation(-80));
$image->drawPixel(11, 11, $color->withSaturation(-80));
$image->drawPixel(12, 12, $color->withSaturation(-80));

Invert the Color

public ColorInterface::withInversion(): ColorInterface

Return an inverted copy of the color.

Example

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

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

// create new image
$image = $manager->createImage(300, 200);

// instantiate color
$color = Color::parse('ff5500');

// fill image with color
$image->fill($color);

// draw pixels with inverted color
$image->drawPixel(10, 10, $color->withInversion());
$image->drawPixel(11, 11, $color->withInversion());
$image->drawPixel(12, 12, $color->withInversion());

Change the Transparency of the Color

public ColorInterface::withTransparency(float $transparency): ColorInterface

Return a copy of the color with a new transparency in a range from 0 to 1.

Parameters

Name	Type	Description
transparency	float	Transparency value for the new color.

Example

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

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

// create new image
$image = $manager->createImage(300, 200);

// instantiate color
$color = Color::parse('ff5500');

// fill image with color
$image->fill($color);

// draw rectangle with different half-transparent color
$image->drawRectangle(function (RectangleFactory $rectangle) use ($color): void {
    $rectangle->at(10, 10);
    $rectangle->size(100, 100);
    $rectangle->background($color->withTransparency(.4));
});

Colorspaces

The supported colorspaces depend mainly on the driver used. While the Imagick and Vips driver support multiple colorspaces, the GD driver is limited to the RGB.

When reading CMYK images with Intervention Image using the GD driver the images are automatically converted to RGB colorspace.

Read the Image Colorspace

public Image::colorspace(): ColorspaceInterface

This function reads the colorspace of the current image instance.

Example

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

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

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

// read the colorspace object
$colorspace = $image->colorspace();

Change the Image Colorspace

public Image::setColorspace(string|ColorspaceInterface $colorspace): ImageInterface

This function converts the current image to the specified colorspace. The target colorspace can be specified either as an object, as a class name, or as an abbreviation of the colorspace.

Parameters

Name	Type	Description
colorspace	string or ColorspaceInterface	Target colorspace

Example

use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Imagick\Driver;
use Intervention\Image\Colors\Rgb\Colorspace as Rgb;
use Intervention\Image\Colors\Cmyk\Colorspace as Cmyk;

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

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

// transform image to CMYK
$colorspace = $image->setColorspace(Cmyk::class);

Color Profiles

Currently Intervention Image can only handle color profiles with the ìmagick and vips driver.

Read Color Profiles

public Image::profile(): ProfileInterface

This function reads the ICC color profile from the current image instance. If no profile is found an AnalyzerException is thrown.

Example

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

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

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

// read the icc profile
$profile = $image->profile();

// save profile in file system
$profile->save('myProfile.icc')

Set Color Profiles

public function setProfile(ProfileInterface $profile): ImageInterface

This function applies a given ICC color profile to the current image instance. The function takes an instance of ProfileInterface::class as an argument.

Parameters

Name	Type	Description
profile	ProfileInterface	Target icc profile

Example

use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Imagick\Driver;
use Intervention\Image\Colors\Profile;

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

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

// set the new color profile
$image->setProfile(Profile::fromPath('profiles/profile.icc'));

Remove Color Profiles

public function removeProfile(): ImageInterface

Removes all color profile information from the current image.

Example

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

// create new manager instance with desired driver and read image
$image = ImageManager::usingDriver(Driver::class)
    ->decode('images/example.jpg')

// remove profile
$image = $image->removeProfile();

Transparency

Intervention Image supports image formats with alpha channels. Transparent areas are preserved as long as the output format supports transparency.

If the output format does not support transparency, no alpha channel can be preserved. In this case the transparent areas will be blended with an opaque color.

This background color can be specified in advance in the initial configuration of the image manager or as an optional argument in the following method. It is also possible to set or get the background color at runtime.

Merge Transparent Areas with Color

public function fillTransparentAreas(null|string|ColorInterface $color = null): ImageInterface

Replace all transparent areas with the configured background color or the given color. If the image has no transparent areas the effect is not visible.

By default, the current or previously configured background color is used by this method. Optionally you can pass a custom color in the common color formats. Note that any transparency values in the background color will be ignored.

Parameters

Name	Type	Description
color	null, string or ColorInterface	Color to replace transparent areas (optional).

Example

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

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

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

// fill the transparent areas with orange
$image->fillTransparentAreas('f50');

Read the Background Color

public function backgroundColor(): ColorInterface

Return the currently set background color as an instance of ColorInterface::class. This corresponds either to the color originally configured through the ImageManager or the background color that was last set.

Set the background Color

public function setBackgroundColor(string|ColorInterface $color): ImageInterface

Set a new background color in the configuration of the current image instance. This color will be used as the default for all subsequent background blending operations that use a background color to replace transparency, overwriting the original value defined in the ImageManager configuration.

Parameters

Name	Type	Description
color	string or ColorInterface	New background color in supported color formats.

Example

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

// create new manager instance with desired driver and red as background color
$manager = ImageManager::usingDriver(Driver::class, backgroundColor: 'ff0000');

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

// read configured background color
$backgroundColor = $image->backgroundColor(); // 'ff0000'

// set gray as background color
$image->setBackgroundColor('cccccc');

// read last set background color
$backgroundColor = $image->backgroundColor(); // 'cccccc'