imagegd2
GdImage$image,
[string|null$file = null],
[int$chunk_size = 128],
[int$mode = IMG_GD2_RAW]
): bool
Outputs a GD2 image to the given file.
Parameters
- image
A GdImage object, returned by one of the image creation functions, such as imagecreatetruecolor.
- file
-
The 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_size
-
Chunk size.
- mode
-
Either IMG_GD2_RAW or IMG_GD2_COMPRESSED. Default is IMG_GD2_RAW.
Return Values
Returns true on success or false on failure.
Caution:
However, if libgd fails to output the image, this function returns true.
Notes
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.
Warning:
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.
Changelog
| Version | Description |
| 8.0.3 | file is now nullable. |
| 8.0.0 | image expects a GdImage instance now; previously, a resource was expected. |