(PHP 4 >= 4.0.7, PHP 5, PHP 7, PHP 8)
imagegd2 — Output GD2 image to browser or file
$image,$file = null,$chunk_size = 128,$mode = IMG_GD2_RAW
Outputs or saves the given image in GD2 format.
imageA GdImage object, returned by one of the image creation functions, such as imagecreatetruecolor().
fileThe path or an open stream resource (which is automatically closed after this function returns) to save the file to. If not set or null, the raw image stream will be output directly.
chunk_sizeChunk size.
mode
Either IMG_GD2_RAW or
IMG_GD2_COMPRESSED. Default is
IMG_GD2_RAW.
Returns true on success or false on failure.
However, if libgd fails to output the image, this function returns true.
| Version | Description |
|---|---|
| 8.0.3 |
file is now nullable.
|
| 8.0.0 |
image expects a GdImage
instance now; previously, a valid gd resource was expected.
|
Example #1 Outputting a GD2 image
<?php
// Create a blank image and add some text
$im = imagecreatetruecolor(120, 20);
$text_color = imagecolorallocate($im, 233, 14, 91);
imagestring($im, 1, 5, 5, "A Simple Text String", $text_color);
// Output the image
imagegd2($im);
?>
Example #2 Saving a GD2 image
<?php
// Create a blank image and add some text
$im = imagecreatetruecolor(120, 20);
$text_color = imagecolorallocate($im, 233, 14, 91);
imagestring($im, 1, 5, 5, "A Simple Text String", $text_color);
// Save the gd2 image
// The file format for GD2 images is .gd2, see http://www.libgd.org/GdFileFormats
imagegd2($im, 'simple.gd2');
?>Note:
The GD2 format is commonly used to allow fast loading of parts of images. Note that the GD2 format is only usable in GD2-compatible applications.
The GD and GD2 image formats are proprietary image formats of libgd. They have to be regarded obsolete, and should only be used for development and testing purposes.