PHP: Hypertext Preprocessor (original) (raw)

imagexbm

(PHP 5, PHP 7, PHP 8)

imagexbm — Output an XBM image to browser or file

Description

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

Parameters

image

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

filename

The path to save the file to, given as string. If [null](reserved.constants.php#constant.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](reserved.constants.php#constant.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.

Return Values

Returns [true](reserved.constants.php#constant.true) on success or [false](reserved.constants.php#constant.false) on failure.

Caution

However, if libgd fails to output the image, this function returns [true](reserved.constants.php#constant.true).

Changelog

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

Examples

Example #1 Saving an XBM file

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

<?php // Create a blank image and add some text $im = imagecreatetruecolor(120, 20); <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>t</mi><mi>e</mi><mi>x</mi><msub><mi>t</mi><mi>c</mi></msub><mi>o</mi><mi>l</mi><mi>o</mi><mi>r</mi><mo>=</mo><mi>i</mi><mi>m</mi><mi>a</mi><mi>g</mi><mi>e</mi><mi>c</mi><mi>o</mi><mi>l</mi><mi>o</mi><mi>r</mi><mi>a</mi><mi>l</mi><mi>l</mi><mi>o</mi><mi>c</mi><mi>a</mi><mi>t</mi><mi>e</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">text_color = imagecolorallocate(</annotation></semantics></math>textcolor=imagecolorallocate(im, 233, 14, 91); imagestring($im, 1, 5, 5, 'A Simple Text String', $text_color);// Set a replacement foreground color <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>f</mi><mi>o</mi><mi>r</mi><mi>e</mi><mi>g</mi><mi>r</mi><mi>o</mi><mi>u</mi><mi>n</mi><msub><mi>d</mi><mi>c</mi></msub><mi>o</mi><mi>l</mi><mi>o</mi><mi>r</mi><mo>=</mo><mi>i</mi><mi>m</mi><mi>a</mi><mi>g</mi><mi>e</mi><mi>c</mi><mi>o</mi><mi>l</mi><mi>o</mi><mi>r</mi><mi>a</mi><mi>l</mi><mi>l</mi><mi>o</mi><mi>c</mi><mi>a</mi><mi>t</mi><mi>e</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">foreground_color = imagecolorallocate(</annotation></semantics></math>foregroundcolor=imagecolorallocate(im, 255, 0, 0);// Save the image imagexbm($im, NULL, $foreground_color); ?>

Found A Problem?

There are no user contributed notes for this page.