imagexbm

Output an XBM image to browser or file

&reftitle.description; `bool` `imagexbm` `GdImage` `image` ``string``null```filename` ``int``null```foreground_color`&null;

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.

&reftitle.parameters;

&gd.image.description;

`filename`

- 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.

`foreground_color`

- 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.

&reftitle.returnvalues;

&return.success;

&gd.return.trueonerror;
&reftitle.changelog;

&Version; | &Description;
&gd.changelog.image-param;
8.0.0 | `foreground_color` is now nullable.
8.0.0 | The fourth parameter, which was unused, has been removed.

&reftitle.examples;

### Saving an XBM file

    <?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 image
    imagexbm($im, 'simpletext.xbm');

    // Free up memory
    imagedestroy($im);
    ?>

### Saving an XBM file with a different foreground color

    <?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);

    // Set a replacement foreground color
    $foreground_color = imagecolorallocate($im, 255, 0, 0);

    // Save the image
    imagexbm($im, NULL, $foreground_color);

    // Free up memory
    imagedestroy($im);
    ?>

&reftitle.notes;