PHP 7.0.0 RC 1 Released

imagexbm

(PHP 5, PHP 7)

imagexbmOutput an XBM image to browser or file

Description

bool imagexbm ( resource $image , string $filename [, int $foreground ] )

Outputs or save an XBM version of the given image.

Note: imagexbm() doesn't apply any padding, so the image width has to be a multiple of 8.

Parameters

image

An image resource, returned by one of the image creation functions, such as imagecreatetruecolor().

filename

The path to save the file to. If not set or NULL, the raw image stream will be outputted directly.

foreground

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.

Examples

Example #1 Saving an XBM file

<?php
// Create a blank image and add some text
$im imagecreatetruecolor(12020);
$text_color imagecolorallocate($im2331491);
imagestring($im155,  'A Simple Text String'$text_color);

// Save the image
imagexbm($im'simpletext.xbm');

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

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

<?php
// Create a blank image and add some text
$im imagecreatetruecolor(12020);
$text_color imagecolorallocate($im2331491);
imagestring($im155,  'A Simple Text String'$text_color);

// Set a replacement foreground color
$foreground_color imagecolorallocate($im25500);

// Save the image
imagexbm($imNULL$foreground_color);

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

Notes

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top