imagexbm.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 62126c55f1c6ed444043e7272c4f9e233818a44b Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<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>
   <function>imagewbmp</function> は、指定した
   <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>画像の保存先のパスを文字列で指定します。&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> で
       取得した ID を使用してください。デフォルトの前景色は黒です。
       その他の色はすべて、背景色として扱われます。
      </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> は、
       nullable になりました。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       使われていなかった第4引数は削除されました。
      </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');

// メモリを開放します
imagedestroy($im);
?>
]]>
    </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);

// メモリを開放します
imagedestroy($im);
?>
]]>
    </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
-->