imagecolorsforindex

(PHP 4, PHP 5, PHP 7, PHP 8)

imagecolorsforindexGet the colors for an index

Description

imagecolorsforindex(GdImage $image, int $color): array

Gets the color for a specified index.

Parameters

image

A GdImage object, returned by one of the image creation functions, such as imagecreatetruecolor().

color

The color index.

Return Values

Returns an associative array with red, green, blue and alpha keys that contain the appropriate values for the specified color index.

Changelog

Version Description
8.0.0 image expects a GdImage instance now; previously, a valid gd resource was expected.
8.0.0 imagecolorsforindex() now throws a ValueError exception if color is out of range; previously, false was returned instead.

Examples

Example #1 imagecolorsforindex() example

<?php

// open an image
$im = imagecreatefrompng('nexen.png');

// get a color
$start_x = 40;
$start_y = 50;
$color_index = imagecolorat($im, $start_x, $start_y);

// make it human readable
$color_tran = imagecolorsforindex($im, $color_index);

// what is it ?
print_r($color_tran);

?>

The above example will output something similar to:

Array
(
   [red] => 226
   [green] => 222
   [blue] => 252
   [alpha] => 0
)

See Also