<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: 9960a09a5705102bf4dd0ce63e03d9ec716d0015 Maintainer: HonestQiao Status: ready -->

<!-- CREDITS: mowangjuanzi, Luffy -->

<refentry xml:id="function.imagexbm" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>imagexbm</refname>

<refpurpose>输出 XBM 图像到浏览器或文件</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>bool</type><methodname>imagexbm</methodname>

<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>

<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>filename</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>foreground_color</parameter><initializer>&null;</initializer></methodparam>

</methodsynopsis>

<para>

输出或保存 <parameter>image</parameter> 的 <acronym>XBM</acronym> 版本。

</para>

<note>

<simpara>

<function>imagexbm</function> 不应用任何填充，因此图片宽度必须是

8 的倍数。从 PHP 7.0.9 起此限制不再适用。

</simpara>

</note>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

&gd.image.description;

<varlistentry>

<term><parameter>filename</parameter></term>

<listitem>

<para>&string; 格式，给出保存到文件的路径。如果为 &null;，将直接输出原始图像流。</para>

<para>

<parameter>filename</parameter>（不带 .xbm 扩展名）也用于 <acronym>XBM</acronym> 的 C

标识符，其中当前区域设置的非字母数字字符将由下划线替换。如果 <parameter>filename</parameter>

设置为 &null;，则 <literal>image</literal> 用于构建 C 标识符。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>foreground_color</parameter></term>

<listitem>

<para>

通过设置从 <function>imagecolorallocate</function> 获得的标识符来使用此参数设置前景色。默认前景色是黑色。所有的其它颜色都视为背景。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

&return.success;

</para>

&gd.return.trueonerror;

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

&gd.changelog.image-param;

<row>

<entry>8.0.0</entry>

<entry>

<parameter>foreground_color</parameter> 现在允许为 null。

</entry>

</row>

<row>

<entry>8.0.0</entry>

<entry>

第四个参数未使用，已移除。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>保存 XBM 文件</title>

<programlisting role="php">

<![CDATA[

<?php

// 创建空白图像并添加文字

$im = imagecreatetruecolor(120, 20);

$text_color = imagecolorallocate($im, 233, 14, 91);

imagestring($im, 1, 5, 5, 'A Simple Text String', $text_color);

// 保存图像

imagexbm($im, 'simpletext.xbm');

?>

]]>

</programlisting>

</example>

</para>

<para>

<example>

<title>以不同前景色保存一个 XBM 文件</title>

<programlisting role="php">

<![CDATA[

<?php

// 创建空白图像并添加文字

$im = imagecreatetruecolor(120, 20);

$text_color = imagecolorallocate($im, 233, 14, 91);

imagestring($im, 1, 5, 5, 'A Simple Text String', $text_color);

// 设置替换的前景色

$foreground_color = imagecolorallocate($im, 255, 0, 0);

// 保存图像

imagexbm($im, NULL, $foreground_color);

?>

]]>

</programlisting>

</example>

</para>

</refsect1>

</refentry>

<!-- Keep this comment at the end of the file

Local variables:

mode: sgml

sgml-omittag:t

sgml-shorttag:t

sgml-minimize-attributes:nil

sgml-always-quote-attributes:t

sgml-indent-step:1

sgml-indent-data:t

indent-tabs-mode:nil

sgml-parent-document:nil

sgml-default-dtd-file:"~/.phpdoc/manual.ced"

sgml-exposed-tags:nil

sgml-local-catalogs:nil

sgml-local-ecat-files:nil

End:

vim600: syn=xml fen fdm=syntax fdl=2 si

vim: et tw=78 syn=sgml

vi: ts=1 sw=1

-->