1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imagexbm" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imagexbm</refname>
<refpurpose>Output an XBM image to browser or file</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>
Outputs or save an <acronym>XBM</acronym> version of the given
<parameter>image</parameter>.
</para>
<note>
<simpara>
<function>imagexbm</function> 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.
</simpara>
</note>
</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, given as &string;. If &null;, the raw image stream will be output directly.</para>
<para>
The <parameter>filename</parameter> (without the .xbm extension) is also
used for the C identifiers of the <acronym>XBM</acronym>, whereby non
alphanumeric characters of the current locale are substituted by
underscores. If <parameter>filename</parameter> is set to &null;,
<literal>image</literal> is used to build the C identifiers.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>foreground_color</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. All other colors are treated as
background.
</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> is now nullable.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
The fourth parameter, which was unused, has been removed.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</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');
?>
]]>
</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);
?>
]]>
</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
-->
|
