mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
127 lines
3.2 KiB
XML
127 lines
3.2 KiB
XML
<?xml version='1.0' encoding='iso-8859-1'?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.imagexbm" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>imagexbm</refname>
|
|
<refpurpose>Output XBM image to browser or file</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>imagexbm</methodname>
|
|
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>foreground</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Outputs or save an <acronym>XBM</acronym> version of the given
|
|
<parameter>image</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
&gd.image.description;
|
|
<varlistentry>
|
|
<term><parameter>filename</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The path to save the file to. If not set or &null;, the raw image stream
|
|
will be outputted directly.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>foreground</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
You can set the foreground color with this parameter by setting an
|
|
identifier obtained from <function>imagecolorallocate</function>.
|
|
The default foreground color is black.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Saving an XBM file</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?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);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title>Saving an XBM file with a different foreground color</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?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);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
¬e.bundled.gd;
|
|
</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
|
|
-->
|