IMAGECOLORALLOCATE(3) 1 IMAGECOLORALLOCATE(3)
imagecolorallocate - Allocate a color for an image
SYNOPSIS
int imagecolorallocate (resource $image, int $red, int $green, int $blue)
DESCRIPTION
Returns a color identifier representing the color composed of the given RGB components.
imagecolorallocate(3) must be called to create each color that is to be used in the image represented by $image.
Note
The first call to imagecolorallocate(3) fills the background color in palette-based images - images created using imagecreate(3).
PARAMETERS
o $
image -An image resource, returned by one of the image creation functions, such as imagecreatetruecolor(3).
o $red
-Value of red component.
o $green
-Value of green component.
o $blue
-Value of blue component.
These parameters are integers between 0 and 255 or hexadecimals between 0x00 and 0xFF.
RETURN VALUES
A color identifier or FALSE if the allocation failed.
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 |
| | |
+--------+---------------------------------------------------+
| 5.1.3 | |
| | |
| | Returns FALSE if the allocation failed. Previ- |
| | ously -1 was returned. |
| | |
+--------+---------------------------------------------------+
EXAMPLES
Example #1
imagecolorallocate(3) example
<?php
$im = imagecreate(100, 100);
// sets background to red
$background = imagecolorallocate($im, 255, 0, 0);
// sets some colors
$white = imagecolorallocate($im, 255, 255, 255);
$black = imagecolorallocate($im, 0, 0, 0);
// hexadecimal way
$white = imagecolorallocate($im, 0xFF, 0xFF, 0xFF);
$black = imagecolorallocate($im, 0x00, 0x00, 0x00);
?>
SEE ALSO
imagecolorallocatealpha(3), imagecolordeallocate(3).
PHP Documentation Group IMAGECOLORALLOCATE(3)