php man page for imagexbm

IMAGEXBM(3)								 1							       IMAGEXBM(3)

imagexbm - Output an XBM image to browser or file

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

DESCRIPTION
	Outputs or save an XBM version of the given $image.

PARAMETERS
	      o $
		image -An image resource, returned by one of the image creation functions, such as imagecreatetruecolor(3).

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

	      o $foreground
		-  You	can set the foreground color with this parameter by setting an identifier obtained from imagecolorallocate(3). The default
		foreground color is black.

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

       Example #2

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

NOTES
PHP Documentation Group 													       IMAGEXBM(3)