imagecolorat

PHP 4, PHP 5, PHP 7, PHP 8
imagecolorat - Get the index of the color of a pixel
Manual
Code Examples

imagecolorat( GdImage$image, int$x, int$y ): int|false

Returns the index of the color of the pixel at the specified location in the image specified by image.

If the image is a truecolor image, this function returns the RGB value of that pixel as integer. Use bitshifting and masking to access the distinct red, green and blue component values:

Parameters

image

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

x

x-coordinate of the point.

y

y-coordinate of the point.

Return Values

Returns the index of the color or false on failure.

Warning:

This function may return Boolean false, but may also return a non-Boolean value which evaluates to false. Please read the section on Booleans for more information. Use the === operator for testing the return value of this function.

Changelog

Version Description
8.0.0 image expects a GdImage instance now; previously, a resource was expected.

Related Functions

Example of imagecolorat

Show all examples for imagecolorat

PHP Version:


Function imagecolorat:

Image Processing and GD Functions

Most used PHP functions