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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision: 1.16 $ -->
<!-- splitted from ./en/functions/image.xml, last change in rev 1.2 -->
<refentry id="function.imagettftext">
<refnamediv>
<refname>imagettftext</refname>
<refpurpose>Write text to the image using TrueType fonts</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>imagettftext</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam><type>float</type><parameter>size</parameter></methodparam>
<methodparam><type>float</type><parameter>angle</parameter></methodparam>
<methodparam><type>int</type><parameter>x</parameter></methodparam>
<methodparam><type>int</type><parameter>y</parameter></methodparam>
<methodparam><type>int</type><parameter>color</parameter></methodparam>
<methodparam><type>string</type><parameter>fontfile</parameter></methodparam>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<para>
<variablelist>
<varlistentry>
<term><parameter>image</parameter></term>
<listitem>
<simpara>
The image resource. See <function>imagecreate</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<simpara>
The font size. Depending on your version of GD, this should be
specified as the pixel size (GD1) or point size (GD2).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>angle</parameter></term>
<listitem>
<simpara>
The angle in degrees, with 0 degrees being left-to-right reading text.
Higher values represent a counter-clockwise rotation. For example,
a value of 90 would result in bottom-to-top reading text.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x</parameter></term>
<listitem>
<simpara>
The coordinates given by <parameter>x</parameter> and
<parameter>y</parameter> will define the basepoint of the first
character (roughly the lower-left corner of the character). This
is different from the <function>imagestring</function>, where
<parameter>x</parameter> and <parameter>y</parameter> define the
upper-left corner of the first character. For example, "top left"
is 0, 0.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>y</parameter></term>
<listitem>
<simpara>
The y-ordinate. This sets the position of the fonts baseline, not
the very bottom of the character.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>color</parameter></term>
<listitem>
<simpara>
The color index. Using the negative of a color index has
the effect of turning off antialiasing.
See <function>imagecolorallocate</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fontfile</parameter></term>
<listitem>
<simpara>
The path to the TrueType font you wish to use.
</simpara>
<simpara>
Depending on which version of the GD library PHP is using, <emphasis>when
<parameter>fontfile</parameter> does not begin with a leading
<literal>/</literal> then <literal>.ttf</literal> will be appended</emphasis>
to the filename and the library will attempt to search for that
filename along a library-defined font path.
</simpara>
<simpara>
When using versions of the GD library lower than 2.0.18, a <literal>space</literal> character,
rather than a semicolon, was used as the 'path separator' for different font files.
Unintentional use of this feature will result in the warning message:
<literal>Warning: Could not find/open font</literal>. For these affected versions, the
only solution is moving the font to a path which does not contain spaces.
</simpara>
<para>
In many cases where a font resides in the same directory as the script using it
the following trick will alleviate any include problems.
<programlisting role="php">
<![CDATA[
<?php
// Set the enviroment variable for GD
putenv('GDFONTPATH=' . realpath('.'));
// Name the font to be used (note the lack of the .ttf extension)
$font = 'SomeFont';
?>
]]>
</programlisting>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>text</parameter></term>
<listitem>
<simpara>
The text string.
</simpara>
<simpara>
May include decimal numeric character references (of the form:
&#8364;) to access characters in a font beyond position 127.
Strings in UTF-8 encoding can be passed directly.
</simpara>
<simpara>
If a character is used in the string which is not supported by the
font, a hollow rectangle will replace the character.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
<function>imagettftext</function> returns an array with 8
elements representing four points making the bounding box of the
text. The order of the points is lower left, lower right, upper
right, upper left. The points are relative to the text
regardless of the angle, so "upper left" means in the top
left-hand corner when you see the text horizontally.
</para>
<para>
<example>
<title><function>imagettftext</function> example</title>
<para>
This example script will produce a white PNG 400x30 pixels, with
the words "Testing..." in black (with grey shadow), in the font Arial.
</para>
<programlisting role="php">
<![CDATA[
<?php
// Set the content-type
header("Content-type: image/png");
// Create the image
$im = imagecreate(400, 30);
// Create some colors
$white = imagecolorallocate($im, 255, 255, 255);
$grey = imagecolorallocate($im, 128, 128, 128);
$black = imagecolorallocate($im, 0, 0, 0);
// The text to draw
$text = 'Testing...';
// Replace path by your own font path
$font = 'arial.ttf';
// Add some shadow to the text
imagettftext($im, 20, 0, 11, 21, $grey, $font, $text);
// Add the text
imagettftext($im, 20, 0, 10, 20, $black, $font, $text);
// Using imagepng() results in clearer text compared with imagejpeg()
imagepng($im);
imagedestroy($im);
?>
]]>
</programlisting>
</example>
</para>
<para>
This function requires both the GD library and the <ulink
url="&url.freetype;">FreeType</ulink> library.
</para>
<para>
See also <function>imagettfbbox</function>.
</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:"../../../../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
-->
|
