PHP 5, PHP 7, PHP 8
imagexbm - Output an XBM image to browser or file
Code Examples

imagexbm( GdImage$image, string|null$filename, [int|null$foreground_color = null] ): bool

Outputs or save an XBM version of the given image.


imagexbm doesn't apply any padding, so the image width has to be a multiple of 8. This restriction does no longer apply as of PHP 7.0.9.



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


The path to save the file to, given as string. If null, the raw image stream will be output directly.

The filename (without the .xbm extension) is also used for the C identifiers of the XBM, whereby non alphanumeric characters of the current locale are substituted by underscores. If filename is set to null, image is used to build the C identifiers.


You can set the foreground color with this parameter by setting an identifier obtained from imagecolorallocate. The default foreground color is black. All other colors are treated as background.

Return Values

Returns true on success or false on failure.


However, if libgd fails to output the image, this function returns true.


Version Description
8.0.0 image expects a GdImage instance now; previously, a resource was expected.
8.0.0 foreground_color is now nullable.
8.0.0 The fourth parameter, which was unused, has been removed.

Example of imagexbm

Show all examples for imagexbm

PHP Version:

Function imagexbm:

Image Processing and GD Functions

Most used PHP functions